feat(utils): Add sourceCodeOrigin to the package configuration

The source code origin defines whether the package configuration applies to
any source artifact or VCS location.

See [1].

[1]: #9918 (comment)

Signed-off-by: Nicolas Nobelis <[email protected]>

Author: nnobelis

model/src/main/kotlin/config/PackageConfiguration.kt

@@ -27,6 +27,7 @@ import org.ossreviewtoolkit.model.Package
 import org.ossreviewtoolkit.model.Project
 import org.ossreviewtoolkit.model.Provenance
 import org.ossreviewtoolkit.model.RepositoryProvenance
+import org.ossreviewtoolkit.model.SourceCodeOrigin
 import org.ossreviewtoolkit.model.UnknownProvenance
 import org.ossreviewtoolkit.model.VcsInfo
 import org.ossreviewtoolkit.model.VcsType
@@ -66,11 +67,19 @@ data class PackageConfiguration(
      * License finding curations.
      */
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
-    val licenseFindingCurations: List<LicenseFindingCuration> = emptyList()
+    val licenseFindingCurations: List<LicenseFindingCuration> = emptyList(),
+
+    /**
+     * The source code origin this configuration applies to.
+     */
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    val sourceCodeOrigin: SourceCodeOrigin? = null
 ) {
     init {
-        require((sourceArtifactUrl == null) xor (vcs == null)) {
-            "A package configuration must either set the 'sourceArtifactUrl' or the 'vcs' property."
+        require(
+            listOfNotNull(sourceArtifactUrl, vcs, sourceCodeOrigin).size == 1
+        ) {
+            "A package configuration must set exactly one of 'sourceArtifactUrl', 'vcs' or 'sourceCodeOrigin'."
         }
     }
 
@@ -84,6 +93,13 @@ data class PackageConfiguration(
             return false
         }
 
+        if (sourceCodeOrigin != null) {
+            return when (sourceCodeOrigin) {
+                SourceCodeOrigin.VCS -> provenance is RepositoryProvenance
+                SourceCodeOrigin.ARTIFACT -> provenance is ArtifactProvenance
+            }
+        }
+
         return when (provenance) {
             is UnknownProvenance -> false
             is ArtifactProvenance -> sourceArtifactUrl != null && sourceArtifactUrl == provenance.sourceArtifact.url

model/src/test/kotlin/config/PackageConfigurationTest.kt

@@ -19,13 +19,15 @@
 
 package org.ossreviewtoolkit.model.config
 
+import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.core.spec.style.WordSpec
 import io.kotest.matchers.shouldBe
 
 import org.ossreviewtoolkit.model.ArtifactProvenance
 import org.ossreviewtoolkit.model.Identifier
 import org.ossreviewtoolkit.model.RemoteArtifact
 import org.ossreviewtoolkit.model.RepositoryProvenance
+import org.ossreviewtoolkit.model.SourceCodeOrigin
 import org.ossreviewtoolkit.model.VcsInfo
 import org.ossreviewtoolkit.model.VcsType
 
@@ -155,5 +157,68 @@ class PackageConfigurationTest : WordSpec({
                 )
             ) shouldBe true
         }
+
+        "return true if vcs source code origin and identifier are equal" {
+            val config =
+                PackageConfiguration(
+                    id = Identifier.EMPTY.copy(name = "some-name"),
+                    sourceCodeOrigin = SourceCodeOrigin.VCS
+                )
+
+            config.matches(
+                config.id,
+                RepositoryProvenance(
+                    vcsInfo = VcsInfo(
+                        type = VcsType.GIT,
+                        url = "ssh://git@host/repo.git",
+                        revision = ""
+                    ),
+                    resolvedRevision = "12345678"
+                )
+            ) shouldBe true
+        }
+
+        "return true if artifact source code origin and identifier are equal" {
+            val config =
+                PackageConfiguration(
+                    id = Identifier.EMPTY.copy(name = "some-name"),
+                    sourceCodeOrigin = SourceCodeOrigin.ARTIFACT
+                )
+
+            config.matches(
+                config.id,
+                ArtifactProvenance(
+                    sourceArtifact = RemoteArtifact.EMPTY.copy(
+                        url = "https://host/path/some-other-file.zip"
+                    )
+                )
+            ) shouldBe true
+        }
+
+        "return false if only source code origin is not equal" {
+            val config =
+                PackageConfiguration(
+                    id = Identifier.EMPTY.copy(name = "some-name"),
+                    sourceCodeOrigin = SourceCodeOrigin.ARTIFACT
+                )
+
+            config.matches(
+                config.id,
+                RepositoryProvenance(
+                    vcsInfo = VcsInfo(
+                        type = VcsType.GIT,
+                        url = "ssh://git@host/repo.git",
+                        revision = ""
+                    ),
+                    resolvedRevision = "12345678"
+                )
+            ) shouldBe false
+        }
+
+        "fail if the package configuration has only an identifier" {
+            shouldThrow<IllegalArgumentException> {
+                PackageConfiguration(id = Identifier.EMPTY.copy(name = "some-name"))
+            }
+        }
     }
 })