From 623b2fa00ddb585cd36b4937015e474df76ecee6 Mon Sep 17 00:00:00 2001
From: Martin Nonnenmacher <martin.nonnenmacher@bosch.io>
Date: Wed, 22 Nov 2023 09:14:59 +0100
Subject: [PATCH] feat(model): Sort the detected license mapping during
 serialization

Sort `ScannerConfiguration.detectedLicenseMapping` during serialization
to have a stable order in ORT result files. This helps when comparing
ORT result files from different sources.

Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.io>
---
 model/src/main/kotlin/config/ScannerConfiguration.kt        | 2 ++
 .../scanner-integration-all-pkgs-expected-ort-result.yml    | 6 +++---
 .../scanner-integration-subset-pkgs-expected-ort-result.yml | 6 +++---
 3 files changed, 8 insertions(+), 6 deletions(-)

diff --git a/model/src/main/kotlin/config/ScannerConfiguration.kt b/model/src/main/kotlin/config/ScannerConfiguration.kt
index 6babde4b255ff..6e9bb79a5455c 100644
--- a/model/src/main/kotlin/config/ScannerConfiguration.kt
+++ b/model/src/main/kotlin/config/ScannerConfiguration.kt
@@ -21,6 +21,7 @@ package org.ossreviewtoolkit.model.config
 
 import com.fasterxml.jackson.annotation.JsonAlias
 import com.fasterxml.jackson.annotation.JsonInclude
+import com.fasterxml.jackson.annotation.JsonPropertyOrder
 
 import org.ossreviewtoolkit.model.utils.FileArchiver
 import org.ossreviewtoolkit.utils.ort.ORT_REPO_CONFIG_FILENAME
@@ -52,6 +53,7 @@ data class ScannerConfiguration(
      * Mappings from licenses returned by the scanner to valid SPDX licenses. Note that these mappings are only applied
      * in new scans, stored scan results are not affected.
      */
+    @JsonPropertyOrder(alphabetic = true)
     val detectedLicenseMapping: Map<String, String> = mapOf(
         // https://scancode-licensedb.aboutcode.org/?search=generic
         "LicenseRef-scancode-agpl-generic-additional-terms" to SpdxConstants.NOASSERTION,
diff --git a/scanner/src/funTest/assets/scanner-integration-all-pkgs-expected-ort-result.yml b/scanner/src/funTest/assets/scanner-integration-all-pkgs-expected-ort-result.yml
index 1deff2f300e08..7b16293a7b161 100644
--- a/scanner/src/funTest/assets/scanner-integration-all-pkgs-expected-ort-result.yml
+++ b/scanner/src/funTest/assets/scanner-integration-all-pkgs-expected-ort-result.yml
@@ -197,20 +197,20 @@ scanner:
     create_missing_archives: false
     detected_license_mapping:
       LicenseRef-scancode-agpl-generic-additional-terms: "NOASSERTION"
+      LicenseRef-scancode-free-unknown: "NOASSERTION"
       LicenseRef-scancode-generic-cla: "NOASSERTION"
       LicenseRef-scancode-generic-exception: "NOASSERTION"
       LicenseRef-scancode-generic-export-compliance: "NOASSERTION"
       LicenseRef-scancode-generic-tos: "NOASSERTION"
       LicenseRef-scancode-generic-trademark: "NOASSERTION"
       LicenseRef-scancode-gpl-generic-additional-terms: "NOASSERTION"
-      LicenseRef-scancode-patent-disclaimer: "NOASSERTION"
-      LicenseRef-scancode-warranty-disclaimer: "NOASSERTION"
       LicenseRef-scancode-other-copyleft: "NOASSERTION"
       LicenseRef-scancode-other-permissive: "NOASSERTION"
-      LicenseRef-scancode-free-unknown: "NOASSERTION"
+      LicenseRef-scancode-patent-disclaimer: "NOASSERTION"
       LicenseRef-scancode-unknown: "NOASSERTION"
       LicenseRef-scancode-unknown-license-reference: "NOASSERTION"
       LicenseRef-scancode-unknown-spdx: "NOASSERTION"
+      LicenseRef-scancode-warranty-disclaimer: "NOASSERTION"
     ignore_patterns:
     - "**/*.ort.yml"
     - "**/*.spdx.yml"
diff --git a/scanner/src/funTest/assets/scanner-integration-subset-pkgs-expected-ort-result.yml b/scanner/src/funTest/assets/scanner-integration-subset-pkgs-expected-ort-result.yml
index f6167d5026937..c479dc91c1f95 100644
--- a/scanner/src/funTest/assets/scanner-integration-subset-pkgs-expected-ort-result.yml
+++ b/scanner/src/funTest/assets/scanner-integration-subset-pkgs-expected-ort-result.yml
@@ -116,20 +116,20 @@ scanner:
     create_missing_archives: false
     detected_license_mapping:
       LicenseRef-scancode-agpl-generic-additional-terms: "NOASSERTION"
+      LicenseRef-scancode-free-unknown: "NOASSERTION"
       LicenseRef-scancode-generic-cla: "NOASSERTION"
       LicenseRef-scancode-generic-exception: "NOASSERTION"
       LicenseRef-scancode-generic-export-compliance: "NOASSERTION"
       LicenseRef-scancode-generic-tos: "NOASSERTION"
       LicenseRef-scancode-generic-trademark: "NOASSERTION"
       LicenseRef-scancode-gpl-generic-additional-terms: "NOASSERTION"
-      LicenseRef-scancode-patent-disclaimer: "NOASSERTION"
-      LicenseRef-scancode-warranty-disclaimer: "NOASSERTION"
       LicenseRef-scancode-other-copyleft: "NOASSERTION"
       LicenseRef-scancode-other-permissive: "NOASSERTION"
-      LicenseRef-scancode-free-unknown: "NOASSERTION"
+      LicenseRef-scancode-patent-disclaimer: "NOASSERTION"
       LicenseRef-scancode-unknown: "NOASSERTION"
       LicenseRef-scancode-unknown-license-reference: "NOASSERTION"
       LicenseRef-scancode-unknown-spdx: "NOASSERTION"
+      LicenseRef-scancode-warranty-disclaimer: "NOASSERTION"
     ignore_patterns:
     - "**/*.ort.yml"
     - "**/*.spdx.yml"