summaryrefslogtreecommitdiff
path: root/formats/json-tests/commonTest/src/kotlinx/serialization/json/JsonTransformingSerializerTest.kt
blob: 516587f5ed67dd669cf18b48ed4885de4f51cb8b (plain)
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
/*
 * Copyright 2017-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 */

package kotlinx.serialization.json

import kotlinx.serialization.*
import kotlinx.serialization.builtins.*
import kotlin.test.*

class JsonTransformingSerializerTest : JsonTestBase() {
    val json = Json { encodeDefaults = false }

    @Serializable
    data class Example(
        val name: String,
        @Serializable(UnwrappingJsonListSerializer::class) val data: StringData,
        @SerialName("more_data") @Serializable(WrappingJsonListSerializer::class) val moreData: List<StringData> = emptyList()
    )

    object WrappingJsonListSerializer :
        JsonTransformingSerializer<List<StringData>>(ListSerializer(StringData.serializer())) {
        override fun transformDeserialize(element: JsonElement): JsonElement =
            if (element !is JsonArray) JsonArray(listOf(element)) else element
    }

    object UnwrappingJsonListSerializer :
        JsonTransformingSerializer<StringData>(StringData.serializer()) {
        override fun transformDeserialize(element: JsonElement): JsonElement {
            if (element !is JsonArray) return element
            require(element.size == 1) { "Array size must be equal to 1 to unwrap it" }
            return element.first()
        }
    }

    object DroppingNameSerializer : JsonTransformingSerializer<Example>(Example.serializer()) {
        override fun transformSerialize(element: JsonElement): JsonElement =
            JsonObject(element.jsonObject.filterNot { (k, v) -> k == "name" && v.jsonPrimitive.content == "First" })
    }

    @Test
    fun testExampleCanBeParsed() = parametrizedTest { streaming ->
        val testDataInput = listOf(
            """{"name":"test","data":{"data":"str1"},"more_data":[{"data":"str2"}]}""",
            """{"name":"test","data":{"data":"str1"},"more_data":{"data":"str2"}}""",
            """{"name":"test","data":[{"data":"str1"}],"more_data":[{"data":"str2"}]}""",
            """{"name":"test","data":[{"data":"str1"}],"more_data":{"data":"str2"}}"""
        )
        val goldenVal = Example("test", StringData("str1"), listOf(StringData("str2")))


        for (i in testDataInput.indices) {
            assertEquals(
                goldenVal,
                json.decodeFromString(Example.serializer(), testDataInput[i], streaming),
                "failed test on ${testDataInput[i]}, jsonTestingMode = $streaming"
            )
        }
    }

    @Test
    fun testExampleDroppingNameSerializer() = parametrizedTest { streaming ->
        val testDataInput = listOf(
            Example("First", StringData("str1")),
            Example("Second", StringData("str1"))
        )

        val goldenVals = listOf(
            """{"data":{"data":"str1"}}""",
            """{"name":"Second","data":{"data":"str1"}}"""
        )
        for (i in testDataInput.indices) {
            assertEquals(
                goldenVals[i],
                json.encodeToString(DroppingNameSerializer, testDataInput[i], streaming),
                "failed test on ${testDataInput[i]}, jsonTestingMode = $streaming"
            )
        }
    }

    @Serializable
    data class DocExample(
        @Serializable(DocJsonListSerializer::class) val data: String
    )

    object DocJsonListSerializer :
        JsonTransformingSerializer<String>(serializer()) {
        override fun transformDeserialize(element: JsonElement): JsonElement {
            if (element !is JsonArray) return element
            require(element.size == 1) { "Array size must be equal to 1 to unwrap it" }
            return element.first()
        }
    }

    @Test
    fun testDocumentationSample() = parametrizedTest { streaming ->
        val correctExample = DocExample("str1")
        assertEquals(correctExample, json.decodeFromString(DocExample.serializer(), """{"data":["str1"]}""", streaming))
        assertEquals(correctExample, json.decodeFromString(DocExample.serializer(), """{"data":"str1"}""", streaming))
    }
}