Make library comply to official JSON schema repository test-suites (#19)

Resolves #15

Author: OptimumCode

.github/workflows/check.yml

@@ -18,6 +18,8 @@ jobs:
     steps:
       - name: 'Checkout Repository'
         uses: actions/checkout@v3
+        with:
+          submodules: true
       - uses: actions/setup-java@v3
         with:
           distribution: temurin

.github/workflows/release.yml

@@ -31,6 +31,8 @@ jobs:
     steps:
       - name: 'Checkout Repository'
         uses: actions/checkout@v3
+        with:
+          submodules: true
       - uses: actions/setup-java@v3
         with:
           distribution: temurin

.github/workflows/snapshot_release.yml

@@ -11,6 +11,8 @@ jobs:
     steps:
       - name: 'Checkout Repository'
         uses: actions/checkout@v3
+        with:
+          submodules: true
       - uses: actions/setup-java@v3
         with:
           distribution: temurin

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "schema-test-suite"]
+	path = test-suites/schema-test-suite
+	url = [email protected]:json-schema-org/JSON-Schema-Test-Suite.git

README.md

@@ -167,6 +167,13 @@ val valid = schema.validate(elementToValidate, errors::add)
   |               | oneOf                | Supported                                                                                                                                       |
   |               | not                  | Supported                                                                                                                                       |
 
+## Compliance to JSON schema test suites
+
+This library uses official [JSON schema test suites](https://github.com/json-schema-org/JSON-Schema-Test-Suite)
+as a part of the CI to make sure the validation meet the expected behavior.
+Not everything is supported right now but the missing functionality might be added in the future.
+The test are located [here](test-suites).
+
 ## Future plans
 
 - [x] Add `$schema` property validation (if not set the latest supported will be used)

gradle/libs.versions.toml

@@ -3,6 +3,8 @@ kotlin = "1.8.22"
 kotest = "5.5.4"
 detekt = "1.23.0"
 ktlint = "0.50.0"
+okio = "3.4.0"
+serialization = "1.5.1"
 
 [plugins]
 kotlin-mutliplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
@@ -16,8 +18,11 @@ kotlin-binaryCompatibility = { id = "org.jetbrains.kotlinx.binary-compatibility-
 nexus-publish = { id = "io.github.gradle-nexus.publish-plugin", version = "1.3.0" }
 
 [libraries]
-kotlin-serialization-json = { group = "org.jetbrains.kotlinx", name = "kotlinx-serialization-json", version = "1.5.1" }
+kotlin-serialization-json = { group = "org.jetbrains.kotlinx", name = "kotlinx-serialization-json", version.ref = "serialization" }
+kotlin-serialization-json-okio = { group = "org.jetbrains.kotlinx", name = "kotlinx-serialization-json-okio", version.ref = "serialization" }
 kotest-assertions-core = { module = "io.kotest:kotest-assertions-core", version.ref = "kotest" }
 kotest-framework-engine = { module = "io.kotest:kotest-framework-engine", version.ref = "kotest" }
 kotest-runner-junit5 = { module = "io.kotest:kotest-runner-junit5", version.ref = "kotest" }
-uri = { group = "com.eygraber", name = "uri-kmp", version = "0.0.12" }
+uri = { group = "com.eygraber", name = "uri-kmp", version = "0.0.12" }
+okio-common = { group = "com.squareup.okio", name = "okio", version.ref = "okio" }
+okio-nodefilesystem = { group = "com.squareup.okio", name = "okio-nodefilesystem", version.ref = "okio" }

settings.gradle.kts

@@ -1 +1,3 @@
-rootProject.name = "json-schema-validator"
+rootProject.name = "json-schema-validator"
+
+include(":test-suites")

src/commonMain/kotlin/io/github/optimumcode/json/pointer/JsonPointer.kt

@@ -33,9 +33,7 @@ public sealed class JsonPointer(
       buildString {
         val pointer = this@JsonPointer.toString()
         append(pointer)
-        if (!pointer.endsWith(SEPARATOR)) {
-          append(SEPARATOR)
-        }
+        append(SEPARATOR)
         append(index)
       },
     )
@@ -53,10 +51,14 @@ public sealed class JsonPointer(
       buildString {
         val pointer = this@JsonPointer.toString()
         append(pointer)
-        if (!pointer.endsWith(SEPARATOR)) {
-          append(SEPARATOR)
+        append(SEPARATOR)
+        for (ch in property) {
+          when (ch) {
+            QUOTATION -> append(QUOTATION).append(QUOTATION_ESCAPE)
+            SEPARATOR -> append(QUOTATION).append(SEPARATOR_ESCAPE)
+            else -> append(ch)
+          }
         }
-        append(property)
       },
     )
 
@@ -87,6 +89,8 @@ public sealed class JsonPointer(
   public companion object {
     internal const val SEPARATOR: Char = '/'
     internal const val QUOTATION: Char = '~'
+    internal const val QUOTATION_ESCAPE: Char = '0'
+    internal const val SEPARATOR_ESCAPE: Char = '1'
 
     /**
      * An empty [JsonPointer]. The empty JSON pointer corresponds to the current JSON element.s
@@ -205,8 +209,8 @@ private fun StringBuilder.appendEscapedSegment(expr: String, start: Int, offset:
 
 private fun StringBuilder.appendEscaped(ch: Char) {
   val result = when (ch) {
-    '0' -> JsonPointer.QUOTATION
-    '1' -> JsonPointer.SEPARATOR
+    JsonPointer.QUOTATION_ESCAPE -> JsonPointer.QUOTATION
+    JsonPointer.SEPARATOR_ESCAPE -> JsonPointer.SEPARATOR
     else -> {
       append(JsonPointer.QUOTATION)
       ch

src/commonMain/kotlin/io/github/optimumcode/json/pointer/extensions.kt

@@ -57,13 +57,8 @@ public operator fun JsonPointer.plus(otherPointer: JsonPointer): JsonPointer {
   }
   return JsonPointer(
     buildString {
-      val pointer = this@plus.toString()
-      append(pointer)
-      if (pointer.endsWith(JsonPointer.SEPARATOR)) {
-        setLength(length - 1)
-      }
-      val other = otherPointer.toString()
-      append(other)
+      append(this@plus.toString())
+      append(otherPointer.toString())
     },
   )
 }

src/commonMain/kotlin/io/github/optimumcode/json/schema/internal/SchemaLoader.kt

@@ -195,8 +195,8 @@ private data class DefaultLoadingContext(
   private val baseId: Uri,
   override val schemaPath: JsonPointer = JsonPointer.ROOT,
   val additionalIDs: Set<IdWithLocation> = linkedSetOf(IdWithLocation(baseId, schemaPath)),
-  val references: MutableMap<RefId, AssertionWithPath> = hashMapOf(),
-  val usedRef: MutableSet<ReferenceLocation> = hashSetOf(),
+  val references: MutableMap<RefId, AssertionWithPath> = linkedMapOf(),
+  val usedRef: MutableSet<ReferenceLocation> = linkedSetOf(),
 ) : LoadingContext {
   override fun at(property: String): DefaultLoadingContext {
     return copy(schemaPath = schemaPath / property)
@@ -237,7 +237,7 @@ private data class DefaultLoadingContext(
         copy(
           additionalIDs = additionalIDs.run {
             this + IdWithLocation(
-              baseId.buildUpon().encodedPath(additionalId.path).build(),
+              additionalIDs.resolvePath(additionalId.path),
               schemaPath,
             )
           },
@@ -255,7 +255,10 @@ private data class DefaultLoadingContext(
     val refUri = Uri.parse(refId).buildUpon().build()
     return when {
       refUri.isAbsolute -> refUri.buildRefId()
-      !refUri.path.isNullOrBlank() -> baseId.buildUpon().encodedPath(refUri.path).buildRefId()
+      // the ref is absolute and should be resolved from current base URI host:port part
+      refId.startsWith('/') -> additionalIDs.last().id.buildUpon().encodedPath(refUri.path).buildRefId()
+      // in this case the ref must be resolved from the current base ID
+      !refUri.path.isNullOrBlank() -> additionalIDs.resolvePath(refUri.path).buildRefId()
       refUri.fragment != null -> additionalIDs.last().id.buildUpon().encodedFragment(refUri.fragment).buildRefId()
       else -> throw IllegalArgumentException("invalid reference $refId")
     }.also { usedRef += ReferenceLocation(schemaPath, it) }
@@ -271,7 +274,7 @@ private data class DefaultLoadingContext(
         when {
           !id.path.isNullOrBlank() -> register(
             // register JSON schema by related path
-            baseId.buildUpon().encodedPath(id.path).buildRefId(),
+            additionalIDs.resolvePath(id.path).buildRefId(),
             assertion,
           )
 
@@ -294,6 +297,24 @@ private data class DefaultLoadingContext(
   }
 }
 
+private fun Set<IdWithLocation>.resolvePath(path: String?): Uri {
+  return last().id.appendPathToParent(requireNotNull(path) { "path is null" })
+}
+private fun Uri.appendPathToParent(path: String): Uri {
+  val hasLastEmptySegment = toString().endsWith('/')
+  return if (hasLastEmptySegment) {
+    buildUpon() // don't need to drop anything. just add the path because / in the end means empty segment
+  } else {
+    buildUpon()
+      .path(null) // reset path in builder
+      .apply {
+        pathSegments.asSequence()
+          .take(pathSegments.size - 1) // drop last path segment
+          .forEach(this::appendPath)
+      }
+  }.appendEncodedPath(path)
+    .build()
+}
 private fun Uri.buildRefId(): RefId = RefId(this)
 
 private fun Builder.buildRefId(): RefId = build().buildRefId()