RepositoryProvenance: Remove the originalVcsInfo property

cli/src/funTest/assets/semver4j-analyzer-result.yml

@@ -198,11 +198,6 @@ scanner:
                 revision: "7653e418d610ffcd2811bcb55fd72d00d420950b"
                 resolved_revision: "7653e418d610ffcd2811bcb55fd72d00d420950b"
                 path: ""
-              original_vcs_info:
-                type: "Git"
-                url: "https://github.com/vdurmont/semver4j.git"
-                revision: "7653e418d610ffcd2811bcb55fd72d00d420950b"
-                path: ""
             scanner:
               name: "ScanCode"
               version: "3.2.1-rc2"
@@ -249,11 +244,6 @@ scanner:
                 revision: "r4.12"
                 resolved_revision: "64155f8a9babcfcf4263cf4d08253a1556e75481"
                 path: ""
-              original_vcs_info:
-                type: "Git"
-                url: "https://github.com/junit-team/junit.git"
-                revision: "r4.12"
-                path: ""
             scanner:
               name: "ScanCode"
               version: "3.2.1-rc2"

downloader/src/funTest/kotlin/BeanUtilsFunTest.kt

@@ -72,7 +72,7 @@ class BeanUtilsFunTest : StringSpec() {
             provenance.shouldBeTypeOf<RepositoryProvenance>().apply {
                 vcsInfo.type shouldBe VcsType.SUBVERSION
                 vcsInfo.url shouldBe vcsFromCuration.url
-                vcsInfo.revision shouldBe "928490"
+                vcsInfo.revision shouldBe ""
                 vcsInfo.resolvedRevision shouldBe "928490"
                 vcsInfo.path shouldBe vcsFromCuration.path
             }

downloader/src/main/kotlin/Downloader.kt

@@ -262,19 +262,21 @@ class Downloader(private val config: DownloaderConfiguration) {
                 throw e
             }
         }
-        val revision = workingTree.getRevision()
+        val resolvedRevision = workingTree.getRevision()
 
-        log.info { "Finished downloading source code revision '$revision' to '${outputDirectory.absolutePath}'." }
+        log.info {
+            "Finished downloading source code revision '$resolvedRevision' to '${outputDirectory.absolutePath}'."
+        }
 
         val vcsInfo = VcsInfo(
             type = applicableVcs.type,
             url = pkg.vcsProcessed.url,
-            revision = pkg.vcsProcessed.revision.takeIf { it.isNotBlank() } ?: revision,
-            resolvedRevision = revision,
+            revision = pkg.vcsProcessed.revision,
+            resolvedRevision = resolvedRevision,
             path = pkg.vcsProcessed.path
         )
 
-        return RepositoryProvenance(vcsInfo, pkg.vcsProcessed.takeIf { it != vcsInfo })
+        return RepositoryProvenance(vcsInfo)
     }
 
     /**

model/src/main/kotlin/Provenance.kt

@@ -19,7 +19,6 @@
 
 package org.ossreviewtoolkit.model
 
-import com.fasterxml.jackson.annotation.JsonInclude
 import com.fasterxml.jackson.core.JsonParser
 import com.fasterxml.jackson.databind.DeserializationContext
 import com.fasterxml.jackson.databind.JsonNode
@@ -63,26 +62,15 @@ data class RepositoryProvenance(
     /**
      * The VCS repository that was downloaded.
      */
-    val vcsInfo: VcsInfo,
-
-    /**
-     * The original [VcsInfo] that was used to download the source code. It can be different to [vcsInfo] if any
-     * automatic detection took place. For example if the original [VcsInfo] does not contain any revision and the
-     * revision was automatically detected by searching for a tag that matches the version of the package there
-     * would be no way to match the package to the [Provenance] without downloading the source code and searching
-     * for the tag again.
-     */
-    @JsonInclude(JsonInclude.Include.NON_NULL)
-    val originalVcsInfo: VcsInfo? = null
+    val vcsInfo: VcsInfo
 ) : KnownProvenance() {
     override fun matches(pkg: Package): Boolean {
         // If no VCS information is present either, or it does not have a resolved revision, there is no way of
         // verifying matching provenance.
         if (vcsInfo.resolvedRevision == null) return false
 
-        // If pkg.vcsProcessed equals originalVcsInfo or vcsInfo this provenance was definitely created when
-        // downloading this package.
-        if (pkg.vcsProcessed == originalVcsInfo || pkg.vcsProcessed == vcsInfo) return true
+        // This provenance was definitely created when downloading this package.
+        if (pkg.vcsProcessed.equalsIgnoreResolvedRevision(vcsInfo)) return true
 
         return listOf(pkg.vcs, pkg.vcsProcessed).any {
             if (it.resolvedRevision != null) {
@@ -107,10 +95,12 @@ private class ProvenanceDeserializer : StdDeserializer<Provenance>(Provenance::c
             }
             node.has("vcs_info") -> {
                 val vcsInfo = jsonMapper.treeToValue<VcsInfo>(node["vcs_info"])!!
-                val originalVcsInfo = node["original_vcs_info"]?.let { jsonMapper.treeToValue<VcsInfo>(it)!! }
-                RepositoryProvenance(vcsInfo, originalVcsInfo)
+                RepositoryProvenance(vcsInfo)
             }
             else -> UnknownProvenance
         }
     }
 }
+
+private fun VcsInfo.equalsIgnoreResolvedRevision(other: VcsInfo): Boolean =
+    copy(resolvedRevision = "") == other.copy(resolvedRevision = "")

model/src/main/kotlin/ScanResult.kt

@@ -47,22 +47,16 @@ data class ScanResult(
      * Filter all detected licenses and copyrights from the [summary] which are underneath [path], and set the [path]
      * for [provenance]. Findings which [RootLicenseMatcher] assigns as root license files for [path] are also kept.
      */
-    fun filterByPath(path: String): ScanResult {
-        if (path.isBlank()) return this
-
-        val summary = summary.filterByPath(path)
-
-        return if (provenance is RepositoryProvenance) {
-            val vcsProvenance = provenance.copy(
-                vcsInfo = provenance.vcsInfo.copy(path = path),
-                originalVcsInfo = provenance.originalVcsInfo?.copy(path = path)
-            )
-
-            ScanResult(vcsProvenance, scanner, summary)
-        } else {
-            ScanResult(provenance, scanner, summary)
-        }
-    }
+    fun filterByPath(path: String): ScanResult =
+        takeIf { path.isBlank() } ?: ScanResult(
+            provenance = if (provenance is RepositoryProvenance) {
+                provenance.copy(vcsInfo = provenance.vcsInfo.copy(path = path))
+            } else {
+                provenance
+            },
+            scanner = scanner,
+            summary = summary.filterByPath(path),
+        )
 
     /**
      * Return a [ScanResult] whose [summary] contains only findings from the [provenance]'s [VcsInfo.path].

model/src/test/assets/advisor-result-initial.yml

@@ -240,11 +240,6 @@ scanner:
             revision: "7653e418d610ffcd2811bcb55fd72d00d420950b"
             resolved_revision: "7653e418d610ffcd2811bcb55fd72d00d420950b"
             path: ""
-          original_vcs_info:
-            type: "Git"
-            url: "https://github.com/vdurmont/semver4j.git"
-            revision: "7653e418d610ffcd2811bcb55fd72d00d420950b"
-            path: ""
         scanner:
           name: "ScanCode"
           version: "3.2.1-rc2"
@@ -290,11 +285,6 @@ scanner:
             revision: "r4.12"
             resolved_revision: "64155f8a9babcfcf4263cf4d08253a1556e75481"
             path: ""
-          original_vcs_info:
-            type: "Git"
-            url: "https://github.com/junit-team/junit4.git"
-            revision: "r4.12"
-            path: ""
         scanner:
           name: "ScanCode"
           version: "3.2.1-rc2"
@@ -365,11 +355,6 @@ scanner:
             revision: "36d525e1e425006939a77aec5183aecd7c775b05"
             resolved_revision: "36d525e1e425006939a77aec5183aecd7c775b05"
             path: ""
-          original_vcs_info:
-            type: "Git"
-            url: "ssh://git@github.com/hamcrest/JavaHamcrest.git"
-            revision: ""
-            path: ""
         scanner:
           name: "ScanCode"
           version: "3.2.1-rc2"

model/src/test/assets/advisor-result-vulnerability-refs.yml

@@ -274,11 +274,6 @@ scanner:
             revision: "7653e418d610ffcd2811bcb55fd72d00d420950b"
             resolved_revision: "7653e418d610ffcd2811bcb55fd72d00d420950b"
             path: ""
-          original_vcs_info:
-            type: "Git"
-            url: "https://github.com/vdurmont/semver4j.git"
-            revision: "7653e418d610ffcd2811bcb55fd72d00d420950b"
-            path: ""
         scanner:
           name: "ScanCode"
           version: "3.2.1-rc2"
@@ -324,11 +319,6 @@ scanner:
             revision: "r4.12"
             resolved_revision: "64155f8a9babcfcf4263cf4d08253a1556e75481"
             path: ""
-          original_vcs_info:
-            type: "Git"
-            url: "https://github.com/junit-team/junit4.git"
-            revision: "r4.12"
-            path: ""
         scanner:
           name: "ScanCode"
           version: "3.2.1-rc2"
@@ -399,11 +389,6 @@ scanner:
             revision: "36d525e1e425006939a77aec5183aecd7c775b05"
             resolved_revision: "36d525e1e425006939a77aec5183aecd7c775b05"
             path: ""
-          original_vcs_info:
-            type: "Git"
-            url: "ssh://git@github.com/hamcrest/JavaHamcrest.git"
-            revision: ""
-            path: ""
         scanner:
           name: "ScanCode"
           version: "3.2.1-rc2"

model/src/test/kotlin/ProvenanceTest.kt

@@ -89,12 +89,6 @@ class ProvenanceTest : WordSpec({
                 revision = "revision",
                 resolvedRevision = "resolvedRevision",
                 path = "path"
-            ),
-            originalVcsInfo = VcsInfo(
-                type = VcsType.UNKNOWN,
-                url = "originalUrl",
-                revision = "originalRevision",
-                path = "originalPath"
             )
         )
 
@@ -109,12 +103,6 @@ class ProvenanceTest : WordSpec({
                     "revision" : "revision",
                     "resolved_revision" : "resolvedRevision",
                     "path" : "path"
-                  },
-                  "original_vcs_info" : {
-                    "type" : "",
-                    "url" : "originalUrl",
-                    "revision" : "originalRevision",
-                    "path" : "originalPath"
                   }
                 }
             """.trimIndent()