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
|
/*
* Copyright 2017-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package kotlinx.serialization.features
import kotlinx.serialization.*
import kotlinx.serialization.builtins.*
import kotlinx.serialization.descriptors.*
import kotlinx.serialization.encoding.Decoder
import kotlinx.serialization.encoding.Encoder
import kotlinx.serialization.internal.*
import kotlinx.serialization.test.EnumSerializer
import kotlin.test.*
class SchemaTest {
enum class SampleEnum { OptionA, OptionB, OptionC }
@Serializable
data class Box<T>(val boxed: T)
@Serializable(Data1.Companion::class)
data class Data1(val l: List<Int> = emptyList(), val s: String) {
companion object: KSerializer<Data1> {
override val descriptor = buildClassSerialDescriptor("Data1") {
element("l", listSerialDescriptor<Int>(), isOptional = true)
element("s", serialDescriptor<String>())
}
override fun serialize(encoder: Encoder, value: Data1) = error("Should not be called")
override fun deserialize(decoder: Decoder): Data1 = error("Should not be called")
}
}
@Serializable
data class Data2(val l: List<Int> = emptyList(), val s: String)
@Serializable data class BoxHolder(val stringBox: Box<String>, val intBox: Box<Int>)
@Serializable
data class DataZoo(
@Transient val invisible: String = "",
val a: Int,
val b: String,
val c: List<Data1>,
val ll: List<List<Boolean>>,
val m: Map<String, Data2>?
)
@Serializable
data class DataZooIsomorphic(
@Transient val invisible: String = "",
val b: Int,
val a: String,
val cc: List<Data1>,
val lll: List<List<Boolean>>,
val mm: Map<String, Data2>? = null
)
@Serializable
private data class DataWithEnum(val s: String, val enum: SampleEnum, val enumList: List<SampleEnum> = emptyList())
private fun checkDescriptor(serialDescriptor: SerialDescriptor) {
val nested = serialDescriptor.getElementDescriptor(0)
assertTrue(nested is ListLikeDescriptor)
val elem = nested.getElementDescriptor(0)
assertTrue(elem.kind is PrimitiveKind.INT)
assertEquals("kotlin.Int", elem.serialName)
assertTrue(serialDescriptor.isElementOptional(0))
}
@Test
fun testManualSchema() {
checkDescriptor(Data1.serializer().descriptor)
}
@Test
fun testGeneratedSchema() {
checkDescriptor(Data2.serializer().descriptor)
}
@Test
fun testRichSchema() {
val d: SerialDescriptor = DataZoo.serializer().descriptor
val descs = d.elementDescriptors.toList()
assertEquals(5, descs.size)
assertEquals(listOf(PrimitiveKind.INT, PrimitiveKind.STRING, StructureKind.LIST),
descs.take(3).map { it.kind })
val listListDesc = descs[3]
assertFalse(listListDesc.isNullable)
assertEquals(listListDesc.kind, StructureKind.LIST)
assertEquals(1, listListDesc.elementsCount)
assertEquals(PrimitiveKind.BOOLEAN, listListDesc.elementDescriptors.first().elementDescriptors.first().kind)
val mapDesc = descs[4]
assertTrue(mapDesc.isNullable)
assertFalse(d.isElementOptional(4), "Expected value to be marked as optional")
assertEquals(2, mapDesc.elementsCount)
assertEquals(listOf(PrimitiveKind.STRING, StructureKind.CLASS), mapDesc.kinds())
}
@Test
fun testEqualDescriptors() {
val desc1: SerialDescriptor = DataZoo.serializer().descriptor
val desc2: SerialDescriptor = DataZooIsomorphic.serializer().descriptor
assertEquals(desc1.elementDescriptors.toList(), desc2.elementDescriptors.toList())
assertEquals(Int.serializer().descriptor.elementDescriptors.toList(), Int.serializer().descriptor.elementDescriptors.toList())
}
@Test
fun testGenericDescriptors() {
val boxes = BoxHolder.serializer().descriptor.elementDescriptors.toList()
assertTrue(boxes[0].getElementDescriptor(0).kind is PrimitiveKind.STRING)
assertTrue(boxes[1].getElementDescriptor(0).kind is PrimitiveKind.INT)
assertNotEquals(boxes[0], boxes[1])
val intBox = Box.serializer(Int.serializer()).descriptor
assertEquals(intBox.kind, boxes[1].kind)
}
@Test
fun testEnumDescriptors() {
val dataDescriptor = DataWithEnum.serializer().descriptor
val enumDesc = dataDescriptor.getElementDescriptor(1)
val serialName = "kotlinx.serialization.features.SchemaTest.SampleEnum"
val manualSerializer = EnumSerializer<SampleEnum>(serialName)
assertEquals(enumDesc, manualSerializer.descriptor)
assertEquals(enumDesc, dataDescriptor.getElementDescriptor(2).getElementDescriptor(0))
}
@Test
fun testKindNames() {
val classDesc = BoxHolder.serializer().descriptor
assertEquals("CLASS", classDesc.kind.toString())
val intDesc = classDesc.elementDescriptors.toList()[1].elementDescriptors.toList()[0]
assertEquals("INT", intDesc.kind.toString())
}
private fun SerialDescriptor.kinds(): List<SerialKind> {
return List(elementsCount) { getElementDescriptor(it).kind }
}
}
|