refactor(model)!: Inline AdvisorRecord with AdvisorRun

The `AdvisorRecord` was only a holder for the map of advisor results per package. Inline it with `AdvisorRun` to reduce nesting in the data structures, similar to how `ScanRecord` was inlined with `ScannerRun` in 9d9a449. Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>
oss-review-toolkit · Jul 11, 2024 · 192736f · 192736f
1 parent ed44b6a
commit 192736f
Show file tree

Hide file tree

Showing 17 changed files with 311 additions and 357 deletions.
diff --git a/advisor/src/main/kotlin/Advisor.kt b/advisor/src/main/kotlin/Advisor.kt
@@ -27,7 +27,6 @@ import kotlinx.coroutines.withContext
 
 import org.apache.logging.log4j.kotlin.logger
 
-import org.ossreviewtoolkit.model.AdvisorRecord
 import org.ossreviewtoolkit.model.AdvisorResult
 import org.ossreviewtoolkit.model.AdvisorRun
 import org.ossreviewtoolkit.model.Identifier
@@ -106,10 +105,8 @@ class Advisor(
                 }
             }
 
-            val advisorRecord = AdvisorRecord(results)
-
             val endTime = Instant.now()
 
-            AdvisorRun(startTime, endTime, Environment(), config, advisorRecord)
+            AdvisorRun(startTime, endTime, Environment(), config, results)
         }
 }
diff --git a/advisor/src/test/kotlin/AdvisorTest.kt b/advisor/src/test/kotlin/AdvisorTest.kt
@@ -63,7 +63,7 @@ class AdvisorTest : WordSpec({
             val result = advisor.advise(originResult)
 
             result.advisor shouldNotBeNull {
-                results.advisorResults should beEmpty()
+                results should beEmpty()
             }
 
             coVerify(exactly = 0) {
@@ -104,7 +104,7 @@ class AdvisorTest : WordSpec({
             val result = advisor.advise(originResult)
 
             result.advisor shouldNotBeNull {
-                results.advisorResults shouldBe expectedResults
+                results shouldBe expectedResults
             }
         }
     }

diff --git a/cli/src/funTest/assets/semver4j-ort-result.yml b/cli/src/funTest/assets/semver4j-ort-result.yml
@@ -381,22 +381,21 @@ advisor:
         secrets:
           username: "user"
   results:
-    advisor_results:
-      Maven:junit:junit:4.12:
-      - advisor:
-          name: "NexusIQ"
-          capabilities:
-          - "VULNERABILITIES"
-        summary:
-          start_time: "2021-04-29T14:54:17.322191Z"
-          end_time: "2021-04-29T14:54:18.966672Z"
-        vulnerabilities:
-        - id: "CVE-2020-15250"
-          references:
-          - url: "http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-15250"
-            scoring_system: "CVSS2"
-            severity: "5.5"
-            severity_rating: "MEDIUM"
+    Maven:junit:junit:4.12:
+    - advisor:
+        name: "NexusIQ"
+        capabilities:
+        - "VULNERABILITIES"
+      summary:
+        start_time: "2021-04-29T14:54:17.322191Z"
+        end_time: "2021-04-29T14:54:18.966672Z"
+      vulnerabilities:
+      - id: "CVE-2020-15250"
+        references:
+        - url: "http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-15250"
+          scoring_system: "CVSS2"
+          severity: "5.5"
+          severity_rating: "MEDIUM"
 evaluator: null
 resolved_configuration:
   package_curations:

diff --git a/evaluator/src/main/kotlin/PackageRule.kt b/evaluator/src/main/kotlin/PackageRule.kt
@@ -76,7 +76,7 @@ open class PackageRule(
 
             override fun matches(): Boolean {
                 val run = ruleSet.ortResult.advisor ?: return false
-                return run.results.getVulnerabilities(pkg.metadata.id).isNotEmpty()
+                return run.getVulnerabilities(pkg.metadata.id).isNotEmpty()
             }
         }
     }
@@ -92,7 +92,7 @@ open class PackageRule(
 
             override fun matches(): Boolean {
                 val run = ruleSet.ortResult.advisor ?: return false
-                return run.results.getVulnerabilities(pkg.metadata.id).asSequence()
+                return run.getVulnerabilities(pkg.metadata.id).asSequence()
                     .filter { vulnerability -> !ruleSet.resolutionProvider.isResolved(vulnerability) }
                     .flatMap { it.references }
                     .filter { reference -> reference.scoringSystem == scoringSystem }

diff --git a/evaluator/src/test/kotlin/TestData.kt b/evaluator/src/test/kotlin/TestData.kt
@@ -24,7 +24,6 @@ import java.time.Instant
 
 import org.ossreviewtoolkit.model.AdvisorCapability
 import org.ossreviewtoolkit.model.AdvisorDetails
-import org.ossreviewtoolkit.model.AdvisorRecord
 import org.ossreviewtoolkit.model.AdvisorResult
 import org.ossreviewtoolkit.model.AdvisorRun
 import org.ossreviewtoolkit.model.AdvisorSummary
@@ -221,31 +220,29 @@ val ortResult = OrtResult(
         endTime = Instant.EPOCH,
         environment = Environment(),
         config = AdvisorConfiguration(),
-        results = AdvisorRecord(
-            advisorResults = mapOf(
-                packageWithVulnerabilities.id to listOf(
-                    AdvisorResult(
-                        advisor = AdvisorDetails("Advisor", enumSetOf(AdvisorCapability.VULNERABILITIES)),
-                        summary = AdvisorSummary(startTime = Instant.EPOCH, endTime = Instant.EPOCH),
-                        vulnerabilities = listOf(
-                            Vulnerability(
-                                id = "CVE-2021-critical",
-                                references = listOf(
-                                    VulnerabilityReference(
-                                        url = URI("https://oss-review-toolkit.org"),
-                                        scoringSystem = "CVSS3",
-                                        severity = "9.0"
-                                    )
+        results = mapOf(
+            packageWithVulnerabilities.id to listOf(
+                AdvisorResult(
+                    advisor = AdvisorDetails("Advisor", enumSetOf(AdvisorCapability.VULNERABILITIES)),
+                    summary = AdvisorSummary(startTime = Instant.EPOCH, endTime = Instant.EPOCH),
+                    vulnerabilities = listOf(
+                        Vulnerability(
+                            id = "CVE-2021-critical",
+                            references = listOf(
+                                VulnerabilityReference(
+                                    url = URI("https://oss-review-toolkit.org"),
+                                    scoringSystem = "CVSS3",
+                                    severity = "9.0"
                                 )
-                            ),
-                            Vulnerability(
-                                id = "CVE-2021-trivial",
-                                references = listOf(
-                                    VulnerabilityReference(
-                                        url = URI("https://oss-review-toolkit.org"),
-                                        scoringSystem = "CVSS3",
-                                        severity = "2.0"
-                                    )
+                            )
+                        ),
+                        Vulnerability(
+                            id = "CVE-2021-trivial",
+                            references = listOf(
+                                VulnerabilityReference(
+                                    url = URI("https://oss-review-toolkit.org"),
+                                    scoringSystem = "CVSS3",
+                                    severity = "2.0"
                                 )
                             )
                         )

diff --git a/model/src/main/kotlin/AdvisorRecord.kt b/model/src/main/kotlin/AdvisorRecord.kt