fix(evaluated-model): Fix inconsistency with path exclude serialization

Consistently refer path excludes (via indexes into the `pathExcludes` list) from the serialized repository configuration to simplify its parsing. Therefore add all path excludes to `pathExcludes`. While at it, do the same for resolutions for consistency. Signed-off-by: Frank Viernau <[email protected]>
oss-review-toolkit · Apr 25, 2024 · 04e78c1 · 04e78c1
1 parent fa3c887
commit 04e78c1
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 24 deletions.
diff --git a/...ed-model/src/funTest/assets/evaluated-model-reporter-test-deduplicate-expected-output.yml b/...ed-model/src/funTest/assets/evaluated-model-reporter-test-deduplicate-expected-output.yml
@@ -8,6 +8,9 @@ path_excludes:
   pattern: "**/*.java"
   reason: "EXAMPLE_OF"
   comment: "These are example files."
+- _id: 2
+  pattern: "analyzer/src/funTest/assets/projects/synthetic/gradle/lib/excluded-file.dat"
+  reason: "DATA_FILE_OF"
 scope_excludes:
 - _id: 0
   pattern: "testCompile"
@@ -976,9 +979,7 @@ repository:
       paths:
       - 0
       - 1
-      - _id: 2
-        pattern: "analyzer/src/funTest/assets/projects/synthetic/gradle/lib/excluded-file.dat"
-        reason: "DATA_FILE_OF"
+      - 2
       scopes:
       - 0
     resolutions:

diff --git a/...ers/evaluated-model/src/funTest/assets/evaluated-model-reporter-test-expected-output.json b/...ers/evaluated-model/src/funTest/assets/evaluated-model-reporter-test-expected-output.json
@@ -9,6 +9,10 @@
     "pattern" : "**/*.java",
     "reason" : "EXAMPLE_OF",
     "comment" : "These are example files."
+  }, {
+    "_id" : 2,
+    "pattern" : "analyzer/src/funTest/assets/projects/synthetic/gradle/lib/excluded-file.dat",
+    "reason" : "DATA_FILE_OF"
   } ],
   "scope_excludes" : [ {
     "_id" : 0,
@@ -1073,11 +1077,7 @@
     },
     "config" : {
       "excludes" : {
-        "paths" : [ 0, 1, {
-          "_id" : 2,
-          "pattern" : "analyzer/src/funTest/assets/projects/synthetic/gradle/lib/excluded-file.dat",
-          "reason" : "DATA_FILE_OF"
-        } ],
+        "paths" : [ 0, 1, 2 ],
         "scopes" : [ 0 ]
       },
       "resolutions" : {

diff --git a/...ters/evaluated-model/src/funTest/assets/evaluated-model-reporter-test-expected-output.yml b/...ters/evaluated-model/src/funTest/assets/evaluated-model-reporter-test-expected-output.yml
@@ -8,6 +8,9 @@ path_excludes:
   pattern: "**/*.java"
   reason: "EXAMPLE_OF"
   comment: "These are example files."
+- _id: 2
+  pattern: "analyzer/src/funTest/assets/projects/synthetic/gradle/lib/excluded-file.dat"
+  reason: "DATA_FILE_OF"
 scope_excludes:
 - _id: 0
   pattern: "testCompile"
@@ -980,9 +983,7 @@ repository:
       paths:
       - 0
       - 1
-      - _id: 2
-        pattern: "analyzer/src/funTest/assets/projects/synthetic/gradle/lib/excluded-file.dat"
-        reason: "DATA_FILE_OF"
+      - 2
       scopes:
       - 0
     resolutions:

diff --git a/plugins/reporters/evaluated-model/src/main/kotlin/EvaluatedModelMapper.kt b/plugins/reporters/evaluated-model/src/main/kotlin/EvaluatedModelMapper.kt
@@ -147,7 +147,7 @@ internal class EvaluatedModelMapper(private val input: ReporterInput) {
             vulnerabilitiesResolutions = vulnerabilitiesResolutions,
             vulnerabilities = vulnerabilities,
             statistics = with(input) { getStatistics(ortResult, licenseInfoResolver, ortConfig) },
-            repository = input.ortResult.repository.deduplicateResolutions(),
+            repository = input.ortResult.repository.deduplicateResolutionsAndExcludes(),
             severeIssueThreshold = input.ortConfig.severeIssueThreshold,
             severeRuleViolationThreshold = input.ortConfig.severeRuleViolationThreshold,
             repositoryConfiguration = input.ortResult.repository.config.toYaml(),
@@ -724,23 +724,26 @@ internal class EvaluatedModelMapper(private val input: ReporterInput) {
         values.map { addIfRequired(it) }.distinct()
 
     /**
-     * Return a copy of the [RepositoryConfiguration] with [Resolutions] that refer to the same instances as the
-     * [ResolvedConfiguration] for equal [Resolutions]. This is required for the [EvaluatedModel] to contain indexed
-     * references instead of duplicate [Resolutions].
+     * Return a copy of the [RepositoryConfiguration] with [Resolutions] and [Excludes] that refer to the same instances
+     * as the [ResolvedConfiguration] for equal entries. This is required for the [EvaluatedModel] to contain indexed
+     * entries instead of duplicate ones.
      */
-    private fun Repository.deduplicateResolutions(): Repository {
+    private fun Repository.deduplicateResolutionsAndExcludes(): Repository {
         val resolutions = with(config.resolutions) {
             copy(
-                issues = issues.map { resolution -> issueResolutions.find { resolution == it } ?: resolution },
-                ruleViolations = ruleViolations.map { resolution ->
-                    ruleViolationResolutions.find { resolution == it } ?: resolution
-                },
-                vulnerabilities = vulnerabilities.map { resolution ->
-                    vulnerabilitiesResolutions.find { resolution == it } ?: resolution
-                }
+                issues = issues.map { issueResolutions.addIfRequired(it) },
+                ruleViolations = ruleViolations.map { ruleViolationResolutions.addIfRequired(it) },
+                vulnerabilities = vulnerabilities.map { vulnerabilitiesResolutions.addIfRequired(it) }
+            )
+        }
+
+        val excludes = with(config.excludes) {
+            copy(
+                paths = paths.map { pathExcludes.addIfRequired(it) },
+                scopes = scopes.map { scopeExcludes.addIfRequired(it) }
             )
         }
 
-        return copy(config = config.copy(resolutions = resolutions))
+        return copy(config = config.copy(excludes = excludes, resolutions = resolutions))
     }
 }