refactor(Scanner): Remove RemoteProvenance cast

In order to avoid casting `KnownProvenance` to `RemoteProvenance`,
a lot of parameters need to be changed to `RemoteProvenance`.

Signed-off-by: Jens Keim <[email protected]>

Author: pepper-jk

scanner/src/funTest/kotlin/provenance/AbstractNestedProvenanceStorageFunTest.kt

@@ -23,7 +23,7 @@ import io.kotest.core.listeners.TestListener
 import io.kotest.core.spec.style.WordSpec
 import io.kotest.matchers.shouldBe
 
-import org.ossreviewtoolkit.model.KnownProvenance
+import org.ossreviewtoolkit.model.RemoteProvenance
 import org.ossreviewtoolkit.model.RepositoryProvenance
 import org.ossreviewtoolkit.model.VcsInfo
 import org.ossreviewtoolkit.model.VcsType
@@ -78,6 +78,6 @@ private fun createRepositoryProvenance(
 ) = RepositoryProvenance(vcsInfo, resolvedRevision)
 
 private fun createNestedProvenance(
-    root: KnownProvenance,
+    root: RemoteProvenance,
     subRepositories: Map<String, RepositoryProvenance> = emptyMap()
 ) = NestedProvenance(root, subRepositories)

scanner/src/main/kotlin/ScanController.kt

@@ -74,7 +74,7 @@ internal class ScanController(
     /**
      * A map of [KnownProvenance]s to their resolved [NestedProvenance]s.
      */
-    private val nestedProvenances = mutableMapOf<KnownProvenance, NestedProvenance>()
+    private val nestedProvenances = mutableMapOf<RemoteProvenance, NestedProvenance>()
 
     /**
      * A map of package [Identifier]s to their resolved [KnownProvenance]s. These provenances are used to filter the
@@ -86,7 +86,7 @@ internal class ScanController(
      * A map of package [Identifier]s to their resolved [KnownProvenance]s with the VCS path removed. These provenances
      * are used during scanning to make sure that always the full repositories are scanned.
      */
-    private val packageProvenancesWithoutVcsPath = mutableMapOf<Identifier, KnownProvenance>()
+    private val packageProvenancesWithoutVcsPath = mutableMapOf<Identifier, RemoteProvenance>()
 
     /**
      * The [ScanResult]s for each [KnownProvenance] and [ScannerWrapper].
@@ -143,7 +143,7 @@ internal class ScanController(
      * Set the [nestedProvenance] corresponding to the given [package provenance][root], overwriting any existing
      * values.
      */
-    fun putNestedProvenance(root: KnownProvenance, nestedProvenance: NestedProvenance) {
+    fun putNestedProvenance(root: RemoteProvenance, nestedProvenance: NestedProvenance) {
         nestedProvenances[root] = nestedProvenance
     }
 
@@ -273,7 +273,7 @@ internal class ScanController(
     /**
      * Return all [KnownProvenance]s for the [packages] with the VCS path removed.
      */
-    fun getPackageProvenancesWithoutVcsPath(): Set<KnownProvenance> = packageProvenancesWithoutVcsPath.values.toSet()
+    fun getPackageProvenancesWithoutVcsPath(): Set<RemoteProvenance> = packageProvenancesWithoutVcsPath.values.toSet()
 
     /**
      * Return all [PackageScannerWrapper]s.

scanner/src/main/kotlin/Scanner.kt

@@ -259,7 +259,7 @@ class Scanner(
                 }.awaitAll()
             }.forEach { (pkg, result) ->
                 result.onSuccess { provenance ->
-                    controller.putPackageProvenance(pkg.id, provenance as RemoteProvenance)
+                    controller.putPackageProvenance(pkg.id, provenance)
                 }.onFailure {
                     controller.putPackageProvenanceResolutionIssue(
                         pkg.id,
@@ -280,7 +280,7 @@ class Scanner(
                 controller.getPackageProvenancesWithoutVcsPath().map { provenance ->
                     async {
                         provenance to runCatching {
-                            nestedProvenanceResolver.resolveNestedProvenance(provenance as RemoteProvenance)
+                            nestedProvenanceResolver.resolveNestedProvenance(provenance)
                         }
                     }
                 }.awaitAll()

scanner/src/main/kotlin/provenance/NestedProvenance.kt

@@ -23,6 +23,7 @@ import com.fasterxml.jackson.annotation.JsonIgnore
 
 import org.ossreviewtoolkit.model.ArtifactProvenance
 import org.ossreviewtoolkit.model.KnownProvenance
+import org.ossreviewtoolkit.model.RemoteProvenance
 import org.ossreviewtoolkit.model.RepositoryProvenance
 
 /**

scanner/src/main/kotlin/provenance/NestedProvenanceScanResult.kt

@@ -21,6 +21,7 @@ package org.ossreviewtoolkit.scanner.provenance
 
 import org.ossreviewtoolkit.model.KnownProvenance
 import org.ossreviewtoolkit.model.OrtResult
+import org.ossreviewtoolkit.model.RemoteProvenance
 import org.ossreviewtoolkit.model.RepositoryProvenance
 import org.ossreviewtoolkit.model.ScanResult
 import org.ossreviewtoolkit.model.ScanSummary

scanner/src/main/kotlin/provenance/PackageProvenanceResolver.kt

@@ -28,10 +28,10 @@ import org.apache.logging.log4j.kotlin.logger
 
 import org.ossreviewtoolkit.downloader.WorkingTreeCache
 import org.ossreviewtoolkit.model.ArtifactProvenance
-import org.ossreviewtoolkit.model.KnownProvenance
 import org.ossreviewtoolkit.model.Package
 import org.ossreviewtoolkit.model.Provenance
 import org.ossreviewtoolkit.model.RemoteArtifact
+import org.ossreviewtoolkit.model.RemoteProvenance
 import org.ossreviewtoolkit.model.RepositoryProvenance
 import org.ossreviewtoolkit.model.SourceCodeOrigin
 import org.ossreviewtoolkit.model.VcsInfo
@@ -50,7 +50,7 @@ interface PackageProvenanceResolver {
      *
      * Throws an [IOException] if the provenance cannot be resolved.
      */
-    suspend fun resolveProvenance(pkg: Package, defaultSourceCodeOrigins: List<SourceCodeOrigin>): KnownProvenance
+    suspend fun resolveProvenance(pkg: Package, defaultSourceCodeOrigins: List<SourceCodeOrigin>): RemoteProvenance
 }
 
 /**
@@ -70,7 +70,7 @@ class DefaultPackageProvenanceResolver(
     override suspend fun resolveProvenance(
         pkg: Package,
         defaultSourceCodeOrigins: List<SourceCodeOrigin>
-    ): KnownProvenance {
+    ): RemoteProvenance {
         val errors = mutableMapOf<SourceCodeOrigin, Throwable>()
         val sourceCodeOrigins = pkg.sourceCodeOrigins ?: defaultSourceCodeOrigins
 

scanner/src/main/kotlin/provenance/ProvenanceDownloader.kt

@@ -29,6 +29,7 @@ import org.ossreviewtoolkit.downloader.DownloadException
 import org.ossreviewtoolkit.downloader.Downloader
 import org.ossreviewtoolkit.downloader.WorkingTreeCache
 import org.ossreviewtoolkit.model.ArtifactProvenance
+import org.ossreviewtoolkit.model.KnownProvenance
 import org.ossreviewtoolkit.model.Package
 import org.ossreviewtoolkit.model.RemoteProvenance
 import org.ossreviewtoolkit.model.RepositoryProvenance

scanner/src/test/kotlin/ScannerTest.kt

@@ -988,7 +988,7 @@ private class FakePackageProvenanceResolver : PackageProvenanceResolver {
     override suspend fun resolveProvenance(
         pkg: Package,
         defaultSourceCodeOrigins: List<SourceCodeOrigin>
-    ): KnownProvenance {
+    ): RemoteProvenance {
         defaultSourceCodeOrigins.forEach { sourceCodeOrigin ->
             when (sourceCodeOrigin) {
                 SourceCodeOrigin.ARTIFACT -> {
@@ -1103,7 +1103,7 @@ private fun createScanResult(
 )
 
 private fun createNestedScanResult(
-    provenance: KnownProvenance,
+    provenance: RemoteProvenance,
     scannerDetails: ScannerDetails,
     subRepositories: Map<String, RepositoryProvenance> = emptyMap()
 ) = NestedProvenanceScanResult(
@@ -1125,7 +1125,7 @@ private fun createStoredScanResult(provenance: Provenance, scannerDetails: Scann
     )
 
 private fun createStoredNestedScanResult(
-    provenance: KnownProvenance,
+    provenance: RemoteProvenance,
     scannerDetails: ScannerDetails,
     subRepositories: Map<String, RepositoryProvenance> = emptyMap()
 ) = NestedProvenanceScanResult(