test(model): Factor out toJson()

Add an analog function to `toYaml()` for readability, and for re-use in upcoming changes. Note: Use `true` as default value for `prettyPrint`, because that best matches the YAML output which is inherently pretty, and also because the function is primarily used in tests where a pretty JSON is easier to read in diffs. Signed-off-by: Frank Viernau <[email protected]>
oss-review-toolkit · Jan 17, 2025 · 7d817f8 · 7d817f8
1 parent 255d294
commit 7d817f8
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/model/src/main/kotlin/Mappers.kt b/model/src/main/kotlin/Mappers.kt
@@ -72,4 +72,14 @@ inline fun <reified T> String.fromYaml(): T = yamlMapper.readValue(this)
 
 fun Any?.toYaml(): String = yamlMapper.writeValueAsString(this)
 
+fun Any?.toJson(prettyPrint: Boolean = true): String {
+    val writer = if (prettyPrint) {
+        jsonMapper.writerWithDefaultPrettyPrinter()
+    } else {
+        jsonMapper.writer()
+    }
+
+    return writer.writeValueAsString(this)
+}
+
 fun String.readJsonTree(): JsonNode = jsonMapper.readTree(this)
diff --git a/model/src/test/kotlin/ProvenanceTest.kt b/model/src/test/kotlin/ProvenanceTest.kt
@@ -29,7 +29,7 @@ import org.ossreviewtoolkit.utils.common.normalizeLineBreaks
 class ProvenanceTest : WordSpec({
     "UnknownProvenance" should {
         val provenance = UnknownProvenance
-        val json = jsonMapper.writerWithDefaultPrettyPrinter().writeValueAsString(provenance)
+        val json = provenance.toJson()
 
         "be serializable" {
             json shouldBe "{ }"
@@ -52,7 +52,7 @@ class ProvenanceTest : WordSpec({
             )
         )
 
-        val json = jsonMapper.writerWithDefaultPrettyPrinter().writeValueAsString(provenance)
+        val json = provenance.toJson()
 
         "be serializable" {
             json.normalizeLineBreaks() shouldBe """
@@ -92,7 +92,7 @@ class ProvenanceTest : WordSpec({
             resolvedRevision = "resolvedRevision"
         )
 
-        val json = jsonMapper.writerWithDefaultPrettyPrinter().writeValueAsString(provenance)
+        val json = provenance.toJson()
 
         "be serializable" {
             json.normalizeLineBreaks() shouldBe """