refactor(evaluator)!: Turn licenseSource of violations to a Set

fviernau · tsteenbe · commit c2fdbec8a977 · 2025-12-01T12:56:00.000+01:00
Prepare for combining rule violations that stem from the same license
and package, but from different licenses sources.

Signed-off-by: Frank Viernau &lt;frank.viernau@gmail.com&gt;
diff --git a/evaluator/src/main/kotlin/Rule.kt b/evaluator/src/main/kotlin/Rule.kt
@@ -139,7 +139,7 @@ abstract class Rule(
             rule = name,
             pkg = pkgId,
             license = license,
-            licenseSource = licenseSource,
+            licenseSources = setOfNotNull(licenseSource),
             message = message,
             howToFix = howToFix
         )
diff --git a/evaluator/src/test/kotlin/EvaluatorTest.kt b/evaluator/src/test/kotlin/EvaluatorTest.kt
@@ -78,7 +78,7 @@ class EvaluatorTest : WordSpec({
                     rule = "rule 1",
                     pkg = Identifier("type:namespace:name:1.0"),
                     license = SpdxLicenseIdExpression("license-1"),
-                    licenseSource = LicenseSource.DETECTED,
+                    licenseSources = setOf(LicenseSource.DETECTED),
                     severity = Severity.ERROR,
                     message = "message 1",
                     howToFix = "how to fix 1"
@@ -88,7 +88,7 @@ class EvaluatorTest : WordSpec({
                     rule = "rule 2",
                     pkg = Identifier("type:namespace:name:2.0"),
                     license = SpdxLicenseIdExpression("license-2"),
-                    licenseSource = LicenseSource.DECLARED,
+                    licenseSources = setOf(LicenseSource.DECLARED),
                     severity = Severity.WARNING,
                     message = "message 2",
                     howToFix = "how to fix 2"
@@ -102,7 +102,7 @@ class EvaluatorTest : WordSpec({
                 rule shouldBe "rule 1"
                 pkg shouldBe Identifier("type:namespace:name:1.0")
                 license shouldBe "license-1".toSpdx()
-                licenseSource shouldBe LicenseSource.DETECTED
+                licenseSources should containExactlyInAnyOrder(LicenseSource.DETECTED)
                 severity shouldBe Severity.ERROR
                 message shouldBe "message 1"
                 howToFix shouldBe "how to fix 1"
@@ -112,7 +112,7 @@ class EvaluatorTest : WordSpec({
                 rule shouldBe "rule 2"
                 pkg shouldBe Identifier("type:namespace:name:2.0")
                 license shouldBe "license-2".toSpdx()
-                licenseSource shouldBe LicenseSource.DECLARED
+                licenseSources should containExactlyInAnyOrder(LicenseSource.DECLARED)
                 severity shouldBe Severity.WARNING
                 message shouldBe "message 2"
                 howToFix shouldBe "how to fix 2"
diff --git a/evaluator/src/test/kotlin/RuleTest.kt b/evaluator/src/test/kotlin/RuleTest.kt
@@ -20,6 +20,7 @@
 package org.ossreviewtoolkit.evaluator
 
 import io.kotest.core.spec.style.WordSpec
+import io.kotest.matchers.collections.containExactlyInAnyOrder
 import io.kotest.matchers.collections.haveSize
 import io.kotest.matchers.should
 import io.kotest.matchers.shouldBe
@@ -55,7 +56,7 @@ class RuleTest : WordSpec() {
                     violation.rule shouldBe rule.name
                     violation.pkg shouldBe id
                     violation.license shouldBe license
-                    violation.licenseSource shouldBe licenseSource
+                    violation.licenseSources should containExactlyInAnyOrder(licenseSource)
                     violation.severity shouldBe Severity.HINT
                     violation.message shouldBe message
                     violation.howToFix shouldBe howToFix
@@ -74,7 +75,7 @@ class RuleTest : WordSpec() {
                     violation.rule shouldBe rule.name
                     violation.pkg shouldBe id
                     violation.license shouldBe license
-                    violation.licenseSource shouldBe licenseSource
+                    violation.licenseSources should containExactlyInAnyOrder(licenseSource)
                     violation.severity shouldBe Severity.WARNING
                     violation.message shouldBe message
                     violation.howToFix shouldBe howToFix
@@ -93,7 +94,7 @@ class RuleTest : WordSpec() {
                     violation.rule shouldBe rule.name
                     violation.pkg shouldBe id
                     violation.license shouldBe license
-                    violation.licenseSource shouldBe licenseSource
+                    violation.licenseSources should containExactlyInAnyOrder(licenseSource)
                     violation.severity shouldBe Severity.ERROR
                     violation.message shouldBe message
                     violation.howToFix shouldBe howToFix
diff --git a/model/src/main/kotlin/RuleViolation.kt b/model/src/main/kotlin/RuleViolation.kt
@@ -38,9 +38,9 @@ data class RuleViolation(
     val license: SpdxSingleLicenseExpression?,
 
     /**
-     * The [source][LicenseSource] of the [license]. Can be null if the rule does not work on licenses.
+     * The [sources][licenseSources] of the [license]. Can be empty if the rule does not work on licenses.
      */
-    val licenseSource: LicenseSource?,
+    val licenseSources: Set<LicenseSource>,
 
     /**
      * The severity of the rule violation.
diff --git a/model/src/test/kotlin/OrtResultTest.kt b/model/src/test/kotlin/OrtResultTest.kt
@@ -512,7 +512,7 @@ class OrtResultTest : WordSpec({
                             rule = "rule id",
                             pkg = Identifier("Maven", "org.ossreviewtoolkit", "resolved-violation", "0.8.15"),
                             license = null,
-                            licenseSource = null,
+                            licenseSources = emptySet(),
                             severity = Severity.HINT,
                             message = "Rule violation message to resolve",
                             howToFix = ""
@@ -534,7 +534,7 @@ class OrtResultTest : WordSpec({
                             rule = "Resolved rule violation",
                             pkg = Identifier("Maven", "org.ossreviewtoolkit", "resolved-violation", "0.8.15"),
                             license = null,
-                            licenseSource = null,
+                            licenseSources = emptySet(),
                             severity = Severity.ERROR,
                             message = "Rule violation message to resolve",
                             howToFix = ""
@@ -543,7 +543,7 @@ class OrtResultTest : WordSpec({
                             rule = "Rule violation without resolution",
                             pkg = Identifier("Maven", "com.example", "package-without-resolution", "1.0.0"),
                             license = null,
-                            licenseSource = null,
+                            licenseSources = emptySet(),
                             severity = Severity.WARNING,
                             message = "Message without any resolution",
                             howToFix = ""
@@ -552,7 +552,7 @@ class OrtResultTest : WordSpec({
                             rule = "Rule violation below minSeverity",
                             pkg = Identifier("Maven", "com.example", "violation-below-threshold", "3.14"),
                             license = null,
-                            licenseSource = null,
+                            licenseSources = emptySet(),
                             severity = Severity.HINT,
                             message = "Message without any resolution",
                             howToFix = ""
diff --git a/model/src/test/kotlin/config/RuleViolationResolutionTest.kt b/model/src/test/kotlin/config/RuleViolationResolutionTest.kt
@@ -66,7 +66,7 @@ private fun ruleViolation(message: String) =
         rule = "",
         pkg = null,
         license = null,
-        licenseSource = null,
+        licenseSources = emptySet(),
         severity = Severity.ERROR,
         message = message,
         howToFix = ""
diff --git a/plugins/commands/evaluator/src/main/kotlin/EvaluateCommand.kt b/plugins/commands/evaluator/src/main/kotlin/EvaluateCommand.kt
@@ -375,11 +375,7 @@ private fun RuleViolation.format() =
 
         license?.let { license ->
             append(license)
-            licenseSource?.let { source ->
-                append(" (")
-                append(source)
-                append(")")
-            }
+            licenseSources.takeUnless { it.isEmpty() }?.joinToString(prefix = "(", postfix = ")") { it.toString() }
 
             append(" - ")
         }
diff --git a/plugins/reporters/evaluated-model/src/funTest/resources/evaluated-model-reporter-test-deduplicate-expected-output.yml b/plugins/reporters/evaluated-model/src/funTest/resources/evaluated-model-reporter-test-deduplicate-expected-output.yml
@@ -1070,7 +1070,8 @@ rule_violations:
   rule: "rule 1"
   pkg: 3
   license: 9
-  license_source: "DETECTED"
+  license_sources:
+  - "DETECTED"
   severity: "ERROR"
   message: "EPL-1.0 error"
   how_to_fix: "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify\
@@ -1079,7 +1080,8 @@ rule_violations:
   rule: "rule 2"
   pkg: 2
   license: 3
-  license_source: "DECLARED"
+  license_sources:
+  - "DECLARED"
   severity: "HINT"
   message: "Apache-2.0 hint"
   how_to_fix: "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify\
@@ -1090,7 +1092,8 @@ rule_violations:
   rule: "rule 3"
   pkg: 8
   license: 16
-  license_source: "CONCLUDED"
+  license_sources:
+  - "CONCLUDED"
   severity: "WARNING"
   message: "BSD-3-Clause warning"
   how_to_fix: "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify\
diff --git a/plugins/reporters/evaluated-model/src/funTest/resources/evaluated-model-reporter-test-expected-output.json b/plugins/reporters/evaluated-model/src/funTest/resources/evaluated-model-reporter-test-expected-output.json
@@ -1157,7 +1157,7 @@
     "rule" : "rule 1",
     "pkg" : 3,
     "license" : 9,
-    "license_source" : "DETECTED",
+    "license_sources" : [ "DETECTED" ],
     "severity" : "ERROR",
     "message" : "EPL-1.0 error",
     "how_to_fix" : "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify that overflow:scroll is working as expected.\n```"
@@ -1166,7 +1166,7 @@
     "rule" : "rule 2",
     "pkg" : 2,
     "license" : 3,
-    "license_source" : "DECLARED",
+    "license_sources" : [ "DECLARED" ],
     "severity" : "HINT",
     "message" : "Apache-2.0 hint",
     "how_to_fix" : "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify that overflow:scroll is working as expected.\n```",
@@ -1176,7 +1176,7 @@
     "rule" : "rule 3",
     "pkg" : 8,
     "license" : 16,
-    "license_source" : "CONCLUDED",
+    "license_sources" : [ "CONCLUDED" ],
     "severity" : "WARNING",
     "message" : "BSD-3-Clause warning",
     "how_to_fix" : "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify that overflow:scroll is working as expected.\n```"
diff --git a/plugins/reporters/evaluated-model/src/funTest/resources/evaluated-model-reporter-test-expected-output.yml b/plugins/reporters/evaluated-model/src/funTest/resources/evaluated-model-reporter-test-expected-output.yml
@@ -1070,7 +1070,8 @@ rule_violations:
   rule: "rule 1"
   pkg: 3
   license: 9
-  license_source: "DETECTED"
+  license_sources:
+  - "DETECTED"
   severity: "ERROR"
   message: "EPL-1.0 error"
   how_to_fix: "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify\
@@ -1079,7 +1080,8 @@ rule_violations:
   rule: "rule 2"
   pkg: 2
   license: 3
-  license_source: "DECLARED"
+  license_sources:
+  - "DECLARED"
   severity: "HINT"
   message: "Apache-2.0 hint"
   how_to_fix: "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify\
@@ -1090,7 +1092,8 @@ rule_violations:
   rule: "rule 3"
   pkg: 8
   license: 16
-  license_source: "CONCLUDED"
+  license_sources:
+  - "CONCLUDED"
   severity: "WARNING"
   message: "BSD-3-Clause warning"
   how_to_fix: "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify\
diff --git a/plugins/reporters/evaluated-model/src/funTest/resources/reporter-test-input.yml b/plugins/reporters/evaluated-model/src/funTest/resources/reporter-test-input.yml
@@ -820,23 +820,23 @@ evaluator:
   - rule: "rule 1"
     pkg: "Ant:junit:junit:4.12"
     license: "EPL-1.0"
-    license_source: "DETECTED"
+    license_sources: ["DETECTED"]
     severity: "ERROR"
     message: "EPL-1.0 error"
     how_to_fix: "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify\
       \ that overflow:scroll is working as expected.\n```"
   - rule: "rule 2"
     pkg: "Maven:org.apache.commons:commons-text:1.1"
     license: "Apache-2.0"
-    license_source: "DECLARED"
+    license_sources: ["DECLARED"]
     severity: "HINT"
     message: "Apache-2.0 hint"
     how_to_fix: "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify\
       \ that overflow:scroll is working as expected.\n```"
   - rule: "rule 3"
     pkg: "Maven:org.hamcrest:hamcrest-core:1.3"
     license: "BSD-3-Clause"
-    license_source: "CONCLUDED"
+    license_sources: ["CONCLUDED"]
     severity: "WARNING"
     message: "BSD-3-Clause warning"
     how_to_fix: "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify\
diff --git a/plugins/reporters/evaluated-model/src/main/kotlin/EvaluatedModelMapper.kt b/plugins/reporters/evaluated-model/src/main/kotlin/EvaluatedModelMapper.kt
@@ -393,7 +393,7 @@ internal class EvaluatedModelMapper(private val input: ReporterInput) {
             rule = ruleViolation.rule,
             pkg = pkg,
             license = license,
-            licenseSource = ruleViolation.licenseSource,
+            licenseSources = ruleViolation.licenseSources,
             severity = ruleViolation.severity,
             message = ruleViolation.message,
             howToFix = ruleViolation.howToFix,
diff --git a/plugins/reporters/evaluated-model/src/main/kotlin/EvaluatedRuleViolation.kt b/plugins/reporters/evaluated-model/src/main/kotlin/EvaluatedRuleViolation.kt
@@ -36,7 +36,7 @@ data class EvaluatedRuleViolation(
     @JsonInclude(JsonInclude.Include.NON_NULL)
     val license: LicenseId?,
     @JsonInclude(JsonInclude.Include.NON_NULL)
-    val licenseSource: LicenseSource?,
+    val licenseSources: Set<LicenseSource>,
     val severity: Severity,
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     val message: String,
diff --git a/plugins/reporters/opossum/src/funTest/resources/reporter-test-input.yml b/plugins/reporters/opossum/src/funTest/resources/reporter-test-input.yml
@@ -814,23 +814,23 @@ evaluator:
   - rule: "rule 1"
     pkg: "Ant:junit:junit:4.12"
     license: "EPL-1.0"
-    license_source: "DETECTED"
+    license_sources: ["DETECTED"]
     severity: "ERROR"
     message: "EPL-1.0 error"
     how_to_fix: "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify\
       \ that overflow:scroll is working as expected.\n```"
   - rule: "rule 2"
     pkg: "Maven:org.apache.commons:commons-text:1.1"
     license: "Apache-2.0"
-    license_source: "DECLARED"
+    license_sources: ["DECLARED"]
     severity: "HINT"
     message: "Apache-2.0 hint"
     how_to_fix: "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify\
       \ that overflow:scroll is working as expected.\n```"
   - rule: "rule 3"
     pkg: "Maven:org.hamcrest:hamcrest-core:1.3"
     license: "BSD-3-Clause"
-    license_source: "CONCLUDED"
+    license_sources: ["CONCLUDED"]
     severity: "WARNING"
     message: "BSD-3-Clause warning"
     how_to_fix: "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify\
diff --git a/plugins/reporters/static-html/src/funTest/resources/reporter-test-input.yml b/plugins/reporters/static-html/src/funTest/resources/reporter-test-input.yml
@@ -817,23 +817,23 @@ evaluator:
   - rule: "rule 1"
     pkg: "Ant:junit:junit:4.12"
     license: "EPL-1.0"
-    license_source: "DETECTED"
+    license_sources: ["DETECTED"]
     severity: "ERROR"
     message: "EPL-1.0 error"
     how_to_fix: "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify\
       \ that overflow:scroll is working as expected.\n```"
   - rule: "rule 2"
     pkg: "Maven:org.apache.commons:commons-text:1.1"
     license: "Apache-2.0"
-    license_source: "DECLARED"
+    license_sources: ["DECLARED"]
     severity: "HINT"
     message: "Apache-2.0 hint"
     how_to_fix: "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify\
       \ that overflow:scroll is working as expected.\n```"
   - rule: "rule 3"
     pkg: "Maven:org.hamcrest:hamcrest-core:1.3"
     license: "BSD-3-Clause"
-    license_source: "CONCLUDED"
+    license_sources: ["CONCLUDED"]
     severity: "WARNING"
     message: "BSD-3-Clause warning"
     how_to_fix: "* *Step 1*\n* __Step 2__\n* ***Step 3***\n```\nSome long text verify\
diff --git a/plugins/reporters/static-html/src/main/kotlin/StaticHtmlReporter.kt b/plugins/reporters/static-html/src/main/kotlin/StaticHtmlReporter.kt
@@ -320,7 +320,7 @@ class StaticHtmlReporter(override val descriptor: PluginDescriptor = StaticHtmlR
             td { +(ruleViolation.violation.pkg?.toCoordinates() ?: "-") }
             td {
                 +if (ruleViolation.violation.license != null) {
-                    "${ruleViolation.violation.licenseSource}: ${ruleViolation.violation.license}"
+                    "${ruleViolation.violation.licenseSources.joinToString()}: ${ruleViolation.violation.license}"
                 } else {
                     "-"
                 }

Original file line number	Diff line number	Diff line change
`@@ -139,7 +139,7 @@ abstract class Rule(`
`139`	`139`	`rule = name,`
`140`	`140`	`pkg = pkgId,`
`141`	`141`	`license = license,`
`142`		`- licenseSource = licenseSource,`
	`142`	`+ licenseSources = setOfNotNull(licenseSource),`
`143`	`143`	`message = message,`
`144`	`144`	`howToFix = howToFix`
`145`	`145`	`)`