refactor(Repository): Add RepositoryProvenance attribute

pepper-jk · pepper-jk · commit 79b079358210 · 2025-09-23T12:06:08.000+02:00
In order to support non-VCS input for ORT, `KnownProvenance`s need to
be supported as input for `anaylzer` and `scanner`. The `Repository`
data structure appears to be the best place to facilitate this change.

This change focusses on adding a `RepositoryProvenance` attribute to
`Repository`, which allows to keep previous behavior.
For now it also exposes the raw `VcsInfo` of the `provenance` as its
`vcs` attribute.

Signed-off-by: Jens Keim &lt;jens.keim@forvia.com&gt;
diff --git a/analyzer/src/main/kotlin/Analyzer.kt b/analyzer/src/main/kotlin/Analyzer.kt
@@ -42,6 +42,8 @@ import org.ossreviewtoolkit.model.AnalyzerResult
 import org.ossreviewtoolkit.model.AnalyzerRun
 import org.ossreviewtoolkit.model.OrtResult
 import org.ossreviewtoolkit.model.Repository
+import org.ossreviewtoolkit.model.RepositoryProvenance
+import org.ossreviewtoolkit.model.VcsInfo
 import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
 import org.ossreviewtoolkit.model.config.Excludes
 import org.ossreviewtoolkit.model.config.RepositoryConfiguration
@@ -147,7 +149,19 @@ class Analyzer(private val config: AnalyzerConfiguration, private val labels: Ma
             // Only include nested VCS if they are part of the analyzed directory.
             workingTree.getRootPath().resolve(path).startsWith(info.absoluteProjectPath)
         }.orEmpty()
-        val repository = Repository(vcs = vcs, nestedRepositories = nestedVcs, config = info.repositoryConfiguration)
+
+        val repository = if (vcs == VcsInfo.EMPTY) {
+            Repository.EMPTY
+        } else {
+            Repository(
+                provenance = RepositoryProvenance(
+                    vcsInfo = vcs,
+                    resolvedRevision = vcs.revision
+                ),
+                nestedRepositories = nestedVcs,
+                config = info.repositoryConfiguration
+            )
+        }
 
         val endTime = Instant.now()
 
diff --git a/cli-helper/src/main/kotlin/commands/CreateAnalyzerResultFromPackageListCommand.kt b/cli-helper/src/main/kotlin/commands/CreateAnalyzerResultFromPackageListCommand.kt
@@ -41,6 +41,7 @@ import org.ossreviewtoolkit.model.PackageReference
 import org.ossreviewtoolkit.model.Project
 import org.ossreviewtoolkit.model.RemoteArtifact
 import org.ossreviewtoolkit.model.Repository
+import org.ossreviewtoolkit.model.RepositoryProvenance
 import org.ossreviewtoolkit.model.Scope
 import org.ossreviewtoolkit.model.VcsInfo
 import org.ossreviewtoolkit.model.VcsType
@@ -120,7 +121,12 @@ internal class CreateAnalyzerResultFromPackageListCommand : OrtHelperCommand(
                 environment = Environment()
             ),
             repository = Repository(
-                vcs = projectVcs.normalize(),
+                provenance = projectVcs.normalize().let {
+                    RepositoryProvenance(
+                        vcsInfo = it,
+                        resolvedRevision = it.revision
+                    )
+                },
                 config = RepositoryConfiguration(
                     excludes = Excludes(
                         scopes = listOf(
diff --git a/evaluator/src/test/kotlin/ProjectSourceRuleTest.kt b/evaluator/src/test/kotlin/ProjectSourceRuleTest.kt
@@ -214,7 +214,12 @@ private fun createOrtResult(
     }
 
     return OrtResult.EMPTY.copy(
-        repository = Repository(vcsInfo),
+        repository = Repository(
+            provenance = RepositoryProvenance(
+                vcsInfo = vcsInfo,
+                resolvedRevision = vcsInfo.revision
+            )
+        ),
         analyzer = AnalyzerRun.EMPTY.copy(
             result = AnalyzerResult.EMPTY.copy(
                 projects = setOf(
diff --git a/evaluator/src/testFixtures/kotlin/TestData.kt b/evaluator/src/testFixtures/kotlin/TestData.kt
@@ -42,7 +42,6 @@ import org.ossreviewtoolkit.model.ScannerDetails
 import org.ossreviewtoolkit.model.Scope
 import org.ossreviewtoolkit.model.TextLocation
 import org.ossreviewtoolkit.model.UnknownProvenance
-import org.ossreviewtoolkit.model.VcsInfo
 import org.ossreviewtoolkit.model.config.AdvisorConfiguration
 import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
 import org.ossreviewtoolkit.model.config.Excludes
@@ -179,7 +178,7 @@ val allProjects = setOf(
 
 val ortResult = OrtResult(
     repository = Repository(
-        vcs = VcsInfo.EMPTY,
+        provenance = Repository.EMPTY.provenance,
         config = RepositoryConfiguration(
             excludes = Excludes(
                 paths = listOf(
diff --git a/model/src/main/kotlin/Repository.kt b/model/src/main/kotlin/Repository.kt
@@ -28,10 +28,15 @@ import org.ossreviewtoolkit.utils.ort.ORT_REPO_CONFIG_FILENAME
  * A description of the source code repository that was used as input for ORT.
  */
 data class Repository(
+    /**
+     * Provenance wrapper for original VCS information, if present.
+     */
+    val provenance: RepositoryProvenance,
+
     /**
      * Original VCS-related information from the working tree containing the analyzer root.
      */
-    val vcs: VcsInfo,
+    val vcs: VcsInfo = provenance.vcsInfo,
 
     /**
      * Processed VCS-related information from the working tree containing the analyzer root that has e.g. common
@@ -57,6 +62,10 @@ data class Repository(
          */
         @JvmField
         val EMPTY = Repository(
+            provenance = RepositoryProvenance(
+                vcsInfo = VcsInfo.EMPTY,
+                resolvedRevision = HashAlgorithm.SHA1.emptyValue
+            ),
             vcs = VcsInfo.EMPTY,
             vcsProcessed = VcsInfo.EMPTY,
             nestedRepositories = emptyMap(),
diff --git a/model/src/test/kotlin/OrtResultTest.kt b/model/src/test/kotlin/OrtResultTest.kt
@@ -163,6 +163,7 @@ class OrtResultTest : WordSpec({
     "getDefinitionFilePathRelativeToAnalyzerRoot()" should {
         "use the correct vcs" {
             val vcs = VcsInfo(type = VcsType.GIT, url = "https://example.com/git", revision = "")
+            val provenance = RepositoryProvenance(vcsInfo = vcs, resolvedRevision = vcs.revision)
             val nestedVcs1 = VcsInfo(type = VcsType.GIT, url = "https://example.com/git1", revision = "")
             val nestedVcs2 = VcsInfo(type = VcsType.GIT, url = "https://example.com/git2", revision = "")
             val project1 = Project.EMPTY.copy(
@@ -185,7 +186,7 @@ class OrtResultTest : WordSpec({
             )
             val ortResult = OrtResult(
                 Repository(
-                    vcs = vcs,
+                    provenance = provenance,
                     nestedRepositories = mapOf(
                         "path/1" to nestedVcs1,
                         "path/2" to nestedVcs2
@@ -203,6 +204,7 @@ class OrtResultTest : WordSpec({
 
         "fail if no vcs matches" {
             val vcs = VcsInfo(type = VcsType.GIT, url = "https://example.com/git", revision = "")
+            val provenance = RepositoryProvenance(vcsInfo = vcs, resolvedRevision = vcs.revision)
             val nestedVcs1 = VcsInfo(type = VcsType.GIT, url = "https://example.com/git1", revision = "")
             val nestedVcs2 = VcsInfo(type = VcsType.GIT, url = "https://example.com/git2", revision = "")
             val project = Project.EMPTY.copy(
@@ -213,7 +215,7 @@ class OrtResultTest : WordSpec({
             )
             val ortResult = OrtResult(
                 Repository(
-                    vcs = vcs,
+                    provenance = provenance,
                     nestedRepositories = mapOf(
                         "path/1" to nestedVcs1
                     )
diff --git a/model/src/testFixtures/kotlin/TestData.kt b/model/src/testFixtures/kotlin/TestData.kt
@@ -136,7 +136,7 @@ val scanResults = listOf(
 
 val ortResult = OrtResult(
     repository = Repository(
-        vcs = VcsInfo.EMPTY,
+        provenance = Repository.EMPTY.provenance,
         config = RepositoryConfiguration(
             excludes = Excludes(
                 paths = listOf(
diff --git a/plugins/reporters/ctrlx/src/funTest/kotlin/CtrlXAutomationReporterFunTest.kt b/plugins/reporters/ctrlx/src/funTest/kotlin/CtrlXAutomationReporterFunTest.kt
@@ -42,6 +42,7 @@ import org.ossreviewtoolkit.model.OrtResult
 import org.ossreviewtoolkit.model.Package
 import org.ossreviewtoolkit.model.Project
 import org.ossreviewtoolkit.model.Repository
+import org.ossreviewtoolkit.model.RepositoryProvenance
 import org.ossreviewtoolkit.model.RootDependencyIndex
 import org.ossreviewtoolkit.model.Scope
 import org.ossreviewtoolkit.model.VcsInfo
@@ -165,8 +166,10 @@ private fun createReporterInput(): ReporterInput {
     return ReporterInput(
         OrtResult(
             repository = Repository(
-                vcs = analyzedVcs,
-                vcsProcessed = analyzedVcs
+                provenance = RepositoryProvenance(
+                    vcsInfo = analyzedVcs,
+                    resolvedRevision = analyzedVcs.revision
+                )
             ),
             analyzer = AnalyzerRun.EMPTY.copy(
                 result = AnalyzerResult(
diff --git a/plugins/reporters/fossid/src/test/kotlin/FossIdReporterTest.kt b/plugins/reporters/fossid/src/test/kotlin/FossIdReporterTest.kt
@@ -42,6 +42,7 @@ import org.ossreviewtoolkit.clients.fossid.model.report.SelectionType
 import org.ossreviewtoolkit.model.Identifier
 import org.ossreviewtoolkit.model.OrtResult
 import org.ossreviewtoolkit.model.Repository
+import org.ossreviewtoolkit.model.RepositoryProvenance
 import org.ossreviewtoolkit.model.ScanResult
 import org.ossreviewtoolkit.model.ScanSummary
 import org.ossreviewtoolkit.model.ScannerDetails
@@ -266,8 +267,10 @@ private fun createReporterInput(vararg scanCodes: String): ReporterInput {
                         )
                     )
                 ),
-                vcs = analyzedVcs,
-                vcsProcessed = analyzedVcs
+                provenance = RepositoryProvenance(
+                    vcsInfo = analyzedVcs,
+                    resolvedRevision = analyzedVcs.revision
+                )
             ),
             scanner = scannerRunOf(*results.toList().toTypedArray())
         )
diff --git a/plugins/reporters/freemarker/src/test/kotlin/FreeMarkerTemplateProcessorTest.kt b/plugins/reporters/freemarker/src/test/kotlin/FreeMarkerTemplateProcessorTest.kt
@@ -97,6 +97,10 @@ private val PROJECT_ROOT_VCS_INFO = VcsInfo(
 private val PROJECT_SUB_VCS_INFO = PROJECT_ROOT_VCS_INFO.copy(
     path = "sub-dir"
 )
+private val PROJECT_PROVENANCE = RepositoryProvenance(
+    vcsInfo = PROJECT_ROOT_VCS_INFO,
+    resolvedRevision = PROJECT_ROOT_VCS_INFO.revision
+)
 private val NESTED_VCS_INFO = VcsInfo(
     type = VcsType.GIT,
     url = "ssh://git@host/project/repo",
@@ -110,7 +114,7 @@ private val idNestedProject = Identifier("SpdxDocumentFile:@ort:project-in-neste
 
 private val ORT_RESULT = OrtResult(
     repository = Repository(
-        vcs = PROJECT_ROOT_VCS_INFO,
+        provenance = PROJECT_PROVENANCE,
         config = RepositoryConfiguration(),
         nestedRepositories = mapOf("nested-vcs-dir" to NESTED_VCS_INFO)
     ),
diff --git a/plugins/reporters/opossum/src/test/kotlin/OpossumReporterTest.kt b/plugins/reporters/opossum/src/test/kotlin/OpossumReporterTest.kt
@@ -244,8 +244,10 @@ private fun createOrtResult(): OrtResult {
 
     return OrtResult(
         repository = Repository(
-            vcs = analyzedVcs,
-            vcsProcessed = analyzedVcs
+            provenance = RepositoryProvenance(
+                vcsInfo = analyzedVcs,
+                resolvedRevision = analyzedVcs.revision
+            )
         ),
         analyzer = AnalyzerRun.EMPTY.copy(
             config = AnalyzerConfiguration(allowDynamicVersions = true),
diff --git a/plugins/reporters/spdx/src/testFixtures/kotlin/TestData.kt b/plugins/reporters/spdx/src/testFixtures/kotlin/TestData.kt
@@ -53,6 +53,11 @@ private val ANALYZED_VCS = VcsInfo(
     url = "https://github.com/path/proj1-repo.git"
 )
 
+private val ANALYZED_PROVENANCE = RepositoryProvenance(
+    vcsInfo = ANALYZED_VCS,
+    resolvedRevision = ANALYZED_VCS.revision
+)
+
 val ORT_RESULT = OrtResult(
     repository = Repository(
         config = RepositoryConfiguration(
@@ -66,7 +71,7 @@ val ORT_RESULT = OrtResult(
                 )
             )
         ),
-        vcs = ANALYZED_VCS,
+        provenance = ANALYZED_PROVENANCE,
         vcsProcessed = ANALYZED_VCS
     ),
     analyzer = AnalyzerRun.EMPTY.copy(
diff --git a/reporter/src/testFixtures/kotlin/TestData.kt b/reporter/src/testFixtures/kotlin/TestData.kt
@@ -41,6 +41,7 @@ import org.ossreviewtoolkit.model.PackageReference
 import org.ossreviewtoolkit.model.Project
 import org.ossreviewtoolkit.model.RemoteArtifact
 import org.ossreviewtoolkit.model.Repository
+import org.ossreviewtoolkit.model.RepositoryProvenance
 import org.ossreviewtoolkit.model.ScanResult
 import org.ossreviewtoolkit.model.ScanSummary
 import org.ossreviewtoolkit.model.ScannerDetails
@@ -66,10 +67,13 @@ import org.ossreviewtoolkit.utils.test.scannerRunOf
 // TODO: Create a way to reduce the code required to prepare an OrtResult for testing.
 val ORT_RESULT = OrtResult(
     repository = Repository(
-        vcs = VcsInfo(
-            type = VcsType.GIT,
-            url = "https://github.com/oss-review-toolkit/ort.git",
-            revision = "main"
+        provenance = RepositoryProvenance(
+            vcsInfo = VcsInfo(
+                type = VcsType.GIT,
+                url = "https://github.com/oss-review-toolkit/ort.git",
+                revision = "main"
+            ),
+            resolvedRevision = "main"
         ),
         config = RepositoryConfiguration(
             excludes = Excludes(
