test(aosd): Factor out JSON schema matching

Remove code redundancy and prepare for re-use in an upcoming change.

Note: The analog function from kotest lacks support for a couple of
      features, such as enums, see [1]. The new matcher function can be
      used (temporarily) to make assertions stronger.

[1]: https://github.com/kotest/kotest/blob/1c809c77390389478db10af0d4c73e774520664f/documentation/docs/assertions/json/schema.md

Signed-off-by: Frank Viernau <[email protected]>

Author: fviernau

plugins/reporters/aosd/build.gradle.kts

@@ -39,6 +39,5 @@ dependencies {
 
     funTestImplementation(testFixtures(projects.reporter))
 
-    funTestImplementation(libs.jsonSchemaValidator)
     funTestImplementation(libs.kotest.assertions.json)
 }

plugins/reporters/aosd/src/funTest/kotlin/Aosd20ReporterFunTest.kt

@@ -19,35 +19,28 @@
 
 package org.ossreviewtoolkit.plugins.reporters.aosd
 
-import com.networknt.schema.InputFormat
-import com.networknt.schema.JsonSchemaFactory
-import com.networknt.schema.SpecVersion
-
 import io.kotest.assertions.assertSoftly
 import io.kotest.assertions.json.shouldEqualJson
 import io.kotest.core.spec.style.WordSpec
 import io.kotest.engine.spec.tempdir
 import io.kotest.inspectors.forAll
-import io.kotest.matchers.collections.beEmpty
 import io.kotest.matchers.collections.shouldHaveSize
 import io.kotest.matchers.result.shouldBeSuccess
 import io.kotest.matchers.should
 
 import org.ossreviewtoolkit.reporter.ORT_RESULT
 import org.ossreviewtoolkit.reporter.ReporterInput
 import org.ossreviewtoolkit.utils.test.getResource
+import org.ossreviewtoolkit.utils.test.matchJsonSchema
 import org.ossreviewtoolkit.utils.test.readResource
 
 class Aosd20ReporterFunTest : WordSpec({
     "The example JSON report" should {
         "be valid according to the schema" {
-            val schemaResource = getResource("/aosd20/aosd.schema.json")
-            val schema = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V7).getSchema(schemaResource.toURI())
-
+            val schemaJson = readResource("/aosd20/aosd.schema.json")
             val example = readResource("/aosd20/aosd.example.json")
-            val errors = schema.validate(example, InputFormat.JSON)
 
-            errors should beEmpty()
+            example should matchJsonSchema(schemaJson)
         }
 
         "deserialize correctly" {
@@ -65,13 +58,11 @@ class Aosd20ReporterFunTest : WordSpec({
         val reportFiles = Aosd20Reporter().generateReport(ReporterInput(ORT_RESULT), outputDir)
 
         "be valid according to the schema" {
-            val schemaResource = getResource("/aosd20/aosd.schema.json")
-            val schema = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V7).getSchema(schemaResource.toURI())
+            val schemaJson = readResource("/aosd20/aosd.schema.json")
 
             reportFiles.forAll {
                 it shouldBeSuccess { reportFile ->
-                    val errors = schema.validate(reportFile.readText(), InputFormat.JSON)
-                    errors should beEmpty()
+                    reportFile.readText() should matchJsonSchema(schemaJson)
                 }
             }
         }

plugins/reporters/aosd/src/funTest/kotlin/Aosd21ReporterFunTest.kt

@@ -19,16 +19,11 @@
 
 package org.ossreviewtoolkit.plugins.reporters.aosd
 
-import com.networknt.schema.InputFormat
-import com.networknt.schema.JsonSchemaFactory
-import com.networknt.schema.SpecVersion
-
 import io.kotest.assertions.assertSoftly
 import io.kotest.assertions.json.shouldEqualJson
 import io.kotest.core.spec.style.WordSpec
 import io.kotest.engine.spec.tempdir
 import io.kotest.inspectors.forAll
-import io.kotest.matchers.collections.beEmpty
 import io.kotest.matchers.collections.shouldHaveSize
 import io.kotest.matchers.result.shouldBeSuccess
 import io.kotest.matchers.should
@@ -37,18 +32,16 @@ import io.kotest.matchers.shouldBe
 import org.ossreviewtoolkit.reporter.ORT_RESULT
 import org.ossreviewtoolkit.reporter.ReporterInput
 import org.ossreviewtoolkit.utils.test.getResource
+import org.ossreviewtoolkit.utils.test.matchJsonSchema
 import org.ossreviewtoolkit.utils.test.readResource
 
 class Aosd21ReporterFunTest : WordSpec({
     "The example JSON report" should {
         "be valid according to the schema" {
-            val schemaResource = getResource("/aosd21/AOSD2.1_Importscheme_V2.1.0.json")
-            val schema = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V7).getSchema(schemaResource.toURI())
-
+            val schemaJson = readResource("/aosd21/AOSD2.1_Importscheme_V2.1.0.json")
             val example = readResource("/aosd21/AOSD2.1_Example_Json_Import_File_V2.1.0.json")
-            val errors = schema.validate(example, InputFormat.JSON)
 
-            errors should beEmpty()
+            example should matchJsonSchema(schemaJson)
         }
 
         "deserialize correctly" {
@@ -69,13 +62,11 @@ class Aosd21ReporterFunTest : WordSpec({
         val reportFiles = Aosd21Reporter().generateReport(ReporterInput(ORT_RESULT), outputDir)
 
         "be valid according to the schema" {
-            val schemaResource = getResource("/aosd21/AOSD2.1_Importscheme_V2.1.0.json")
-            val schema = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V7).getSchema(schemaResource.toURI())
+            val schemaJson = readResource("/aosd21/AOSD2.1_Importscheme_V2.1.0.json")
 
             reportFiles.forAll {
                 it shouldBeSuccess { reportFile ->
-                    val errors = schema.validate(reportFile.readText(), InputFormat.JSON)
-                    errors should beEmpty()
+                    reportFile.readText() should matchJsonSchema(schemaJson)
                 }
             }
         }

utils/test/build.gradle.kts

@@ -37,6 +37,7 @@ dependencies {
 
     implementation(libs.diffUtils)
     implementation(libs.jackson.module.kotlin)
+    implementation(libs.jsonSchemaValidator)
     implementation(libs.kotest.extensions.junitXml)
     implementation(libs.kotest.framework.engine)
     implementation(libs.postgresEmbedded)

utils/test/src/main/kotlin/Matchers.kt

@@ -22,6 +22,10 @@ package org.ossreviewtoolkit.utils.test
 import com.github.difflib.DiffUtils
 import com.github.difflib.UnifiedDiffUtils
 
+import com.networknt.schema.InputFormat
+import com.networknt.schema.JsonSchemaFactory
+import com.networknt.schema.SpecVersion
+
 import io.kotest.matchers.Matcher
 import io.kotest.matchers.MatcherResult
 import io.kotest.matchers.collections.beEmpty
@@ -119,3 +123,15 @@ fun matchExpectedResult(
         )
     }
 }
+
+fun matchJsonSchema(schemaJson: String): Matcher<String> =
+    Matcher { actual ->
+        val schema = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V7).getSchema(schemaJson)
+        val violations = schema.validate(actual, InputFormat.JSON)
+
+        MatcherResult(
+            violations.isEmpty(),
+            { violations.joinToString(separator = "\n") { "${it.evaluationPath} => ${it.message}" } },
+            { "Expected some violation against JSON schema, but everything matched" }
+        )
+    }