1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
/*
* Copyright 2017-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
@file:Suppress("UNCHECKED_CAST")
package sample
import kotlinx.serialization.*
import kotlinx.serialization.builtins.*
import kotlinx.serialization.json.*
import kotlinx.serialization.modules.*
import kotlin.reflect.*
import kotlin.test.*
val jsonWithDefaults = Json { encodeDefaults = true }
class JsonTest {
private val originalData = Data("Hello")
private val originalString =
"""{"s":"Hello","box":{"boxed":42},"boxes":{"desc":"boxes","boxes":[{"boxed":"foo"},{"boxed":"bar"}]},"m":{}}"""
private val nonstrict: Json = Json {
isLenient = true
ignoreUnknownKeys = true
allowSpecialFloatingPointValues = true
useArrayPolymorphism = true
encodeDefaults = true
}
@Test
fun testStringForm() {
val str = jsonWithDefaults.encodeToString(Data.serializer(), originalData)
assertEquals(originalString, str)
}
@Test
fun testSerializeBack() {
val restored = jsonWithDefaults.decodeFromString(Data.serializer(), originalString)
assertEquals(originalData, restored)
}
private fun genTestData(): Holder {
var cnt = -1
fun gen(): MessageWithId {
cnt++
return MessageWithId(cnt, "Message #$cnt")
}
return Holder(gen(), listOf(gen(), gen()), gen(), setOf(SimpleMessage()), DoubleSimpleMessage("DoubleSimple"), gen())
}
private val testModule = SerializersModule {
listOf(Message::class, IMessage::class, SimpleMessage::class).forEach { clz ->
polymorphic(clz as KClass<Any>) {
subclass(SimpleMessage::class)
subclass(DoubleSimpleMessage::class)
subclass(MessageWithId::class)
}
}
}
@Test
fun testEnablesImplicitlyOnInterfacesAndAbstractClasses() {
val json = Json(jsonWithDefaults) { useArrayPolymorphism = true; prettyPrint = false; serializersModule = testModule }
val data = genTestData()
assertEquals("""{"iMessage":["MessageWithId",{"id":0,"body":"Message #0"}],"iMessageList":[["MessageWithId",{"id":1,"body":"Message #1"}],""" +
"""["MessageWithId",{"id":2,"body":"Message #2"}]],"message":["MessageWithId",{"id":3,"body":"Message #3"}],"msgSet":[["SimpleMessage",""" +
"""{"body":"Simple"}]],"simple":["DoubleSimpleMessage",{"body":"Simple","body2":"DoubleSimple"}],"withId":{"id":4,"body":"Message #4"}}""",
json.encodeToString(Holder.serializer(), data)
)
}
@Test
fun testPolymorphicForGenericUpperBound() {
if (Platform.name == "JS") return // Does not work with JS IR, see #1072
val generic = GenericMessage<Message, Any>(MessageWithId(42, "body"), "body2")
val serial = GenericMessage.serializer(Message.serializer(), Int.serializer() as KSerializer<Any>)
val json = Json {
useArrayPolymorphism = true
prettyPrint = false
serializersModule = testModule + SerializersModule {
polymorphic(Any::class) {
subclass(Int::class)
subclass(String::class)
}
}
}
val s = json.encodeToString(serial, generic)
assertEquals("""{"value":["MessageWithId",{"id":42,"body":"body"}],"value2":["kotlin.String","body2"]}""", s)
}
@Test
@OptIn(ExperimentalSerializationApi::class)
fun testDescriptor() {
val desc = Holder.serializer().descriptor
assertEquals(PolymorphicSerializer(IMessage::class).descriptor, desc.getElementDescriptor(0))
}
@Test
fun canBeSerializedAsDerived() {
val derived = Derived(42)
val msg = jsonWithDefaults.encodeToString(Derived.serializer(), derived)
assertEquals("""{"publicState":"A","privateState":"B","derivedState":42,"rootState":"foo"}""", msg)
val d2 = jsonWithDefaults.decodeFromString(Derived.serializer(), msg)
assertEquals(derived, d2)
}
@Test
fun canBeSerializedAsParent() {
val derived = Derived(42)
val msg = jsonWithDefaults.encodeToString(SerializableBase.serializer(), derived)
assertEquals("""{"publicState":"A","privateState":"B"}""", msg)
val d2 = jsonWithDefaults.decodeFromString(SerializableBase.serializer(), msg)
assertEquals(SerializableBase(), d2)
// no derivedState
assertFailsWith<SerializationException> { jsonWithDefaults.decodeFromString(Derived.serializer(), msg) }
}
@Test
fun testWithOpenProperty() {
val d = Derived2("foo")
val msgFull = Json.encodeToString(Derived2.serializer(), d)
assertEquals("""{"state1":"foo","state2":"foo"}""", msgFull)
assertEquals("""{"state1":"foo"}""", Json.encodeToString(Base1.serializer(), d))
val restored = Json.decodeFromString(Derived2.serializer(), msgFull)
val restored2 =
Json.decodeFromString(Derived2.serializer(), """{"state1":"bar","state2":"foo"}""") // state1 is ignored anyway
assertEquals("""Derived2(state1='foo')""", restored.toString())
assertEquals("""Derived2(state1='foo')""", restored2.toString())
}
private fun checkNotRegisteredMessage(exception: SerializationException) {
val expectedText =
"is not found in the polymorphic scope of"
assertEquals(true, exception.message?.contains(expectedText))
}
@Test
fun failWithoutModulesWithCustomClass() {
checkNotRegisteredMessage(
assertFailsWith<SerializationException>("not registered") {
Json.encodeToString(
MyPolyData.serializer(),
MyPolyData(mapOf("a" to IntData(42)))
)
}
)
}
@Test
fun testWithModules() {
val json = Json {
useArrayPolymorphism = true; serializersModule = SerializersModule { polymorphic(Any::class) { subclass(IntData::class) } } }
assertStringFormAndRestored(
expected = """{"data":{"a":["sample.IntData",{"intV":42}]}}""",
original = MyPolyData(mapOf("a" to IntData(42))),
serializer = MyPolyData.serializer(),
format = json
)
}
/**
* This test should fail because PolyDerived registered in the scope of PolyBase, not kotlin.Any
*/
@Test
fun failWithModulesNotInAnyScope() {
val json = Json { serializersModule = BaseAndDerivedModule }
checkNotRegisteredMessage(
assertFailsWith<SerializationException> {
json.encodeToString(
MyPolyData.serializer(),
MyPolyData(mapOf("a" to PolyDerived("foo")))
)
}
)
}
private val baseAndDerivedModuleAtAny = SerializersModule {
polymorphic(Any::class) {
subclass(PolyDerived::class)
}
}
@Test
fun testRebindModules() {
val json = Json { useArrayPolymorphism = true; serializersModule = baseAndDerivedModuleAtAny }
assertStringFormAndRestored(
expected = """{"data":{"a":["sample.PolyDerived",{"id":1,"s":"foo"}]}}""",
original = MyPolyData(mapOf("a" to PolyDerived("foo"))),
serializer = MyPolyData.serializer(),
format = json
)
}
/**
* This test should fail because PolyDerived registered in the scope of kotlin.Any, not PolyBase
*/
@Test
fun failWithModulesNotInParticularScope() {
val json = Json { serializersModule = baseAndDerivedModuleAtAny }
checkNotRegisteredMessage(
assertFailsWith<SerializationException> {
json.encodeToString(
MyPolyDataWithPolyBase.serializer(),
MyPolyDataWithPolyBase(mapOf("a" to PolyDerived("foo")), PolyDerived("foo"))
)
}
)
}
@Test
fun testBindModules() {
val json = Json { useArrayPolymorphism = true; serializersModule = (baseAndDerivedModuleAtAny + BaseAndDerivedModule) }
assertStringFormAndRestored(
expected = """{"data":{"a":["sample.PolyDerived",{"id":1,"s":"foo"}]},"polyBase":["sample.PolyDerived",{"id":1,"s":"foo"}]}""",
original = MyPolyDataWithPolyBase(mapOf("a" to PolyDerived("foo")), PolyDerived("foo")),
serializer = MyPolyDataWithPolyBase.serializer(),
format = json
)
}
@Test
fun geoTest() {
val deser = nonstrict.decodeFromString(GeoCoordinate.serializer(), """{"latitude":1.0,"longitude":1.0}""")
assertEquals(GeoCoordinate(1.0, 1.0), deser)
}
@Test
fun geoTest2() {
val deser = nonstrict.decodeFromString(GeoCoordinate.serializer(), """{}""")
assertEquals(GeoCoordinate(0.0, 0.0), deser)
}
@Test
fun geoTestValidation() {
assertFailsWith<IllegalArgumentException> {
nonstrict.decodeFromString(GeoCoordinate.serializer(), """{"latitude":-1.0,"longitude":1.0}""")
}
}
}
inline fun <reified T : Any> assertStringFormAndRestored(
expected: String,
original: T,
serializer: KSerializer<T>,
format: Json = jsonWithDefaults,
printResult: Boolean = false
) {
val string = format.encodeToString(serializer, original)
if (printResult) println("[Serialized form] $string")
assertEquals(expected, string)
val restored = format.decodeFromString(serializer, string)
if (printResult) println("[Restored form] $original")
assertEquals(original, restored)
}
|