commonMain.io.kotest.assertions.json.schema.parse.kt Maven / Gradle / Ivy

Go to download
package io.kotest.assertions.json.schema

import io.kotest.assertions.json.ContainsSpecSerializer
import io.kotest.assertions.json.JsonNode
import io.kotest.common.ExperimentalKotest
import io.kotest.matchers.Matcher
import io.kotest.matchers.and
import io.kotest.matchers.doubles.beGreaterThan
import io.kotest.matchers.doubles.beGreaterThanOrEqualTo
import io.kotest.matchers.doubles.beLessThan
import io.kotest.matchers.doubles.beLessThanOrEqualTo
import io.kotest.matchers.doubles.beMultipleOf
import io.kotest.matchers.longs.beGreaterThan
import io.kotest.matchers.longs.beGreaterThanOrEqualTo
import io.kotest.matchers.longs.beLessThan
import io.kotest.matchers.longs.beLessThanOrEqualTo
import io.kotest.matchers.longs.beMultipleOf
import io.kotest.matchers.sequences.beUnique
import io.kotest.matchers.string.haveMaxLength
import io.kotest.matchers.string.haveMinLength
import io.kotest.matchers.string.match
import kotlinx.serialization.DeserializationStrategy
import kotlinx.serialization.KSerializer
import kotlinx.serialization.descriptors.buildClassSerialDescriptor
import kotlinx.serialization.descriptors.element
import kotlinx.serialization.encoding.CompositeDecoder
import kotlinx.serialization.encoding.Decoder
import kotlinx.serialization.encoding.Encoder
import kotlinx.serialization.encoding.decodeStructure
import kotlinx.serialization.json.Json
import kotlinx.serialization.json.JsonContentPolymorphicSerializer
import kotlinx.serialization.json.JsonElement
import kotlinx.serialization.json.jsonObject
import kotlinx.serialization.json.jsonPrimitive

private val schemaJsonConfig = Json {
   ignoreUnknownKeys = true
   classDiscriminator = "type"
}

/**
 * Parses a subset of JSON Schema into [JsonSchemaElement] which can be used to verify a json document with
 * [shouldMatchSchema]
 */
@ExperimentalKotest
fun parseSchema(jsonSchema: String): JsonSchema =
   JsonSchema(root = schemaJsonConfig.decodeFromString(SchemaDeserializer, jsonSchema))

@ExperimentalKotest
internal object SchemaDeserializer : JsonContentPolymorphicSerializer(JsonSchemaElement::class) {
   override fun selectDeserializer(element: JsonElement): DeserializationStrategy {
      return when (val type = element.jsonObject.get("type")?.jsonPrimitive?.content) {
         "array" -> JsonSchemaArraySerializer
         "object" -> JsonSchema.JsonObject.serializer()
         "string" -> JsonSchemaStringSerializer
         "integer" -> JsonSchemaIntegerSerializer
         "number" -> JsonSchemaNumberSerializer
         "boolean" -> JsonSchema.JsonBoolean.serializer()
         "null" -> JsonSchema.Null.serializer()
         else -> error("Unknown type: $type")
      }
   }
}

private infix fun  Matcher?.and(other: Matcher) =
   if (this != null) this and other else other

@ExperimentalKotest
internal object JsonSchemaArraySerializer : KSerializer {
   override fun deserialize(decoder: Decoder): JsonSchema.JsonArray =
      decoder.decodeStructure(descriptor) {
         var matcher: Matcher>? = null
         val minItems = runCatching { decodeIntElement(descriptor, 1) }.getOrDefault(1)
         val maxItems = runCatching { decodeIntElement(descriptor, 2) }.getOrDefault(Int.MAX_VALUE)
         val elementType =
            runCatching { decodeSerializableElement(descriptor, 4, SchemaDeserializer) }.getOrNull()
         val containsSpec =
            runCatching { decodeSerializableElement(descriptor, 5, ContainsSpecSerializer) }.getOrNull()
         while (true) {
            when (val index = decodeElementIndex(descriptor)) {
               3 -> matcher = if (decodeBooleanElement(descriptor, index)) matcher and beUnique() else matcher
               CompositeDecoder.DECODE_DONE -> break
            }
         }
         JsonSchema.JsonArray(minItems, maxItems, matcher, containsSpec, elementType)
      }

   override val descriptor = buildClassSerialDescriptor("JsonSchema.JsonArray") {
      element("type")
      element("minItems", isOptional = true)
      element("maxItems", isOptional = true)
      element("uniqueItems", isOptional = true)
      element("elementType", isOptional = true)
      element("contains", isOptional = true)
   }

   override fun serialize(encoder: Encoder, value: JsonSchema.JsonArray) {
      TODO("Serialization of JsonSchema not supported atm")
   }
}

@ExperimentalKotest
internal object JsonSchemaStringSerializer : KSerializer {
   override fun deserialize(decoder: Decoder): JsonSchema.JsonString =
      decoder.decodeStructure(descriptor) {
         var matcher: Matcher? = null

         while (true) {
            when (val index = decodeElementIndex(descriptor)) {
               1 -> matcher = matcher and haveMinLength(decodeIntElement(descriptor, index))
               2 -> matcher = matcher and haveMaxLength(decodeIntElement(descriptor, index))
               3 -> matcher = matcher and match(decodeStringElement(descriptor, index).toRegex())
               // Formats: https://json-schema.org/understanding-json-schema/reference/string.html#built-in-formats
               // TODO: Map formats to matchers
               4 -> println("Formats are currently not supported")
               CompositeDecoder.DECODE_DONE -> break
            }
         }

         JsonSchema.JsonString(matcher)
      }

   override val descriptor = buildClassSerialDescriptor("JsonSchema.JsonString") {
      element("type")
      element("minLength", isOptional = true)
      element("maxLength", isOptional = true)
      element("pattern", isOptional = true)
      element("format", isOptional = true)
   }

   override fun serialize(encoder: Encoder, value: JsonSchema.JsonString) {
      TODO("Serialization of JsonSchema not supported atm")
   }
}

@ExperimentalKotest
internal object JsonSchemaIntegerSerializer : KSerializer {
   override fun deserialize(decoder: Decoder): JsonSchema.JsonInteger =
      decoder.decodeStructure(descriptor) {
         var matcher: Matcher? = null

         while (true) {
            when (val index = decodeElementIndex(descriptor)) {
               1 -> matcher = matcher and beMultipleOf(decodeLongElement(descriptor, index))
               2 -> matcher = matcher and beGreaterThanOrEqualTo(decodeLongElement(descriptor, index))
               3 -> matcher = matcher and beGreaterThan(decodeLongElement(descriptor, index))
               4 -> matcher = matcher and beLessThanOrEqualTo(decodeLongElement(descriptor, index))
               5 -> matcher = matcher and beLessThan(decodeLongElement(descriptor, index))
               CompositeDecoder.DECODE_DONE -> break
            }
         }

         JsonSchema.JsonInteger(matcher)
      }

   override val descriptor = buildClassSerialDescriptor("JsonSchema.JsonInteger") {
      element("type")
      element("multipleOf", isOptional = true)
      element("minimum", isOptional = true)
      element("exclusiveMinimum", isOptional = true)
      element("maximum", isOptional = true)
      element("exclusiveMaximum", isOptional = true)
   }

   override fun serialize(encoder: Encoder, value: JsonSchema.JsonInteger) {
      TODO("Not yet implemented")
   }
}

@ExperimentalKotest
internal object JsonSchemaNumberSerializer : KSerializer {
   override fun deserialize(decoder: Decoder): JsonSchema.JsonDecimal =
      decoder.decodeStructure(descriptor) {
         var matcher: Matcher? = null

         while (true) {
            when (val index = decodeElementIndex(descriptor)) {
               1 -> matcher = matcher and beMultipleOf(decodeDoubleElement(descriptor, index))
               2 -> matcher = matcher and beGreaterThanOrEqualTo(decodeDoubleElement(descriptor, index))
               3 -> matcher = matcher and beGreaterThan(decodeDoubleElement(descriptor, index))
               4 -> matcher = matcher and beLessThanOrEqualTo(decodeDoubleElement(descriptor, index))
               5 -> matcher = matcher and beLessThan(decodeDoubleElement(descriptor, index))
               CompositeDecoder.DECODE_DONE -> break
            }
         }

         JsonSchema.JsonDecimal(matcher)
      }

   override val descriptor = buildClassSerialDescriptor("JsonSchema.JsonDecimal") {
      element("type")
      element("multipleOf", isOptional = true)
      element("minimum", isOptional = true)
      element("exclusiveMinimum", isOptional = true)
      element("maximum", isOptional = true)
      element("exclusiveMaximum", isOptional = true)
   }

   override fun serialize(encoder: Encoder, value: JsonSchema.JsonDecimal) {
      TODO("Not yet implemented")
   }
}