feat(model): Allow to set sourceCodeOrigins via package curations

Signed-off-by: Frank Viernau <frank_viernau@epam.com>
oss-review-toolkit · Mar 15, 2024 · bf12184 · bf12184
1 parent cadf56a
commit bf12184
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 10 deletions.
diff --git a/model/src/main/kotlin/Package.kt b/model/src/main/kotlin/Package.kt
@@ -182,7 +182,8 @@ data class Package(
             sourceArtifact = sourceArtifact.takeIf { it != other.sourceArtifact },
             vcs = vcsProcessed.takeIf { it != other.vcsProcessed }?.toCuration(),
             isMetadataOnly = isMetadataOnly.takeIf { it != other.isMetadataOnly },
-            isModified = isModified.takeIf { it != other.isModified }
+            isModified = isModified.takeIf { it != other.isModified },
+            sourceCodeOrigins = sourceCodeOrigins.takeIf { it != other.sourceCodeOrigins }
         )
     }
 

diff --git a/model/src/main/kotlin/PackageCurationData.kt b/model/src/main/kotlin/PackageCurationData.kt
@@ -99,7 +99,14 @@ data class PackageCurationData(
      * applied by [DeclaredLicenseProcessor.process].
      */
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
-    val declaredLicenseMapping: Map<String, SpdxExpression> = emptyMap()
+    val declaredLicenseMapping: Map<String, SpdxExpression> = emptyMap(),
+
+    /**
+     * The considered source code origins in order of priority. If not null, this must not be empty and not contain any
+     * duplicates.
+     */
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    val sourceCodeOrigins: List<SourceCodeOrigin>? = null
 ) {
     /**
      * Apply this [PackageCuration] to [targetPackage] by overriding all values of [targetPackage] with non-null values
@@ -139,7 +146,8 @@ data class PackageCurationData(
             vcs = original.vcs,
             vcsProcessed = vcsProcessed,
             isMetadataOnly = isMetadataOnly ?: original.isMetadataOnly,
-            isModified = isModified ?: original.isModified
+            isModified = isModified ?: original.isModified,
+            sourceCodeOrigins = sourceCodeOrigins ?: original.sourceCodeOrigins
         )
 
         val declaredLicenseMappingDiff = buildMap {
@@ -179,6 +187,7 @@ data class PackageCurationData(
             declaredLicenseMapping = declaredLicenseMapping.zip(other.declaredLicenseMapping) { value, otherValue ->
                 @Suppress("UnsafeCallOnNullableType")
                 (value ?: otherValue)!!
-            }
+            },
+            sourceCodeOrigins = sourceCodeOrigins ?: other.sourceCodeOrigins
         )
 }
diff --git a/model/src/test/kotlin/PackageCurationDataTest.kt b/model/src/test/kotlin/PackageCurationDataTest.kt
@@ -49,7 +49,8 @@ class PackageCurationDataTest : WordSpec({
         ),
         isMetadataOnly = true,
         isModified = true,
-        declaredLicenseMapping = mapOf("original" to "original".toSpdx())
+        declaredLicenseMapping = mapOf("original" to "original".toSpdx()),
+        sourceCodeOrigins = listOf(SourceCodeOrigin.ARTIFACT, SourceCodeOrigin.VCS)
     )
 
     val other = PackageCurationData(
@@ -76,7 +77,8 @@ class PackageCurationDataTest : WordSpec({
         ),
         isMetadataOnly = false,
         isModified = false,
-        declaredLicenseMapping = mapOf("other" to "other".toSpdx())
+        declaredLicenseMapping = mapOf("other" to "other".toSpdx()),
+        sourceCodeOrigins = listOf(SourceCodeOrigin.VCS)
     )
 
     "Merging" should {
@@ -92,7 +94,8 @@ class PackageCurationDataTest : WordSpec({
                 binaryArtifact = null,
                 vcs = null,
                 isMetadataOnly = null,
-                declaredLicenseMapping = emptyMap()
+                declaredLicenseMapping = emptyMap(),
+                sourceCodeOrigins = null
             )
 
             originalWithSomeUnsetData.merge(other) shouldBe originalWithSomeUnsetData.copy(
@@ -102,7 +105,8 @@ class PackageCurationDataTest : WordSpec({
                 binaryArtifact = other.binaryArtifact,
                 vcs = other.vcs,
                 isMetadataOnly = other.isMetadataOnly,
-                declaredLicenseMapping = other.declaredLicenseMapping
+                declaredLicenseMapping = other.declaredLicenseMapping,
+                sourceCodeOrigins = other.sourceCodeOrigins
             )
         }
 
@@ -123,7 +127,8 @@ class PackageCurationDataTest : WordSpec({
                 comment = original.comment,
                 authors = original.authors,
                 concludedLicense = original.concludedLicense,
-                declaredLicenseMapping = original.declaredLicenseMapping
+                declaredLicenseMapping = original.declaredLicenseMapping,
+                sourceCodeOrigins = original.sourceCodeOrigins
             )
 
             val mergedData = original.merge(otherWithSomeOriginalData)

diff --git a/model/src/test/kotlin/PackageTest.kt b/model/src/test/kotlin/PackageTest.kt
@@ -51,7 +51,8 @@ class PackageTest : StringSpec({
             sourceArtifact = RemoteArtifact("url", Hash.create("hash")),
             vcs = VcsInfo(VcsType.forName("type"), "url", "revision"),
             isMetadataOnly = false,
-            isModified = false
+            isModified = false,
+            sourceCodeOrigins = null
         )
 
         val other = Package(
@@ -83,6 +84,7 @@ class PackageTest : StringSpec({
         diff.vcs shouldBe pkg.vcsProcessed.toCuration()
         diff.isMetadataOnly shouldBe pkg.isMetadataOnly
         diff.isModified shouldBe pkg.isModified
+        diff.sourceCodeOrigins shouldBe pkg.sourceCodeOrigins
     }
 
     "diff result does not contain unchanged values" {
@@ -112,5 +114,6 @@ class PackageTest : StringSpec({
         diff.sourceArtifact should beNull()
         diff.vcs should beNull()
         diff.isMetadataOnly should beNull()
+        diff.sourceCodeOrigins should beNull()
     }
 })