refactor: Remove RemoteProvenance casts

Casts were removed from `FileListResolver`, `ProvenanceBasedFileStorage`,
`ProvenanceDownloader`, and `Scanner`.

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

With the exception of `ProvenanceBasedFileStorage`, which now uses
`UnknownProvenance` exceptions just like `ProvenanceBasedPostgresStorage`.

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
     }
 
@@ -166,7 +166,7 @@ internal class ScanController(
     /**
      * Return all [KnownProvenance]s contained in [nestedProvenances].
      */
-    fun getAllProvenances(): Set<KnownProvenance> =
+    fun getAllProvenances(): Set<RemoteProvenance> =
         nestedProvenances.values.flatMapTo(mutableSetOf()) { it.allProvenances }
 
     /**
@@ -178,7 +178,7 @@ internal class ScanController(
     /**
      * Return all provenances including sub-repositories associated with the identifiers of the packages they belong to.
      */
-    fun getIdsByProvenance(): Map<KnownProvenance, Set<Identifier>> =
+    fun getIdsByProvenance(): Map<RemoteProvenance, Set<Identifier>> =
         buildMap<_, MutableSet<Identifier>> {
             getNestedProvenancesByPackage().forEach { (pkg, nestedProvenance) ->
                 nestedProvenance.allProvenances.forEach { provenance ->
@@ -278,7 +278,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

@@ -236,7 +236,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,
@@ -257,7 +257,7 @@ class Scanner(
                 controller.getPackageProvenancesWithoutVcsPath().map { provenance ->
                     async {
                         provenance to runCatching {
-                            nestedProvenanceResolver.resolveNestedProvenance(provenance as RemoteProvenance)
+                            nestedProvenanceResolver.resolveNestedProvenance(provenance)
                         }.onFailure {
                             if (it is CancellationException) currentCoroutineContext().ensureActive()
                         }
@@ -586,13 +586,13 @@ class Scanner(
     }
 
     private fun scanPath(
-        provenance: KnownProvenance,
+        provenance: RemoteProvenance,
         scanners: List<PathScannerWrapper>,
         context: ScanContext,
         controller: ScanController
     ): Map<PathScannerWrapper, ScanResult> {
         val downloadDir = try {
-            provenanceDownloader.download(provenance as RemoteProvenance)
+            provenanceDownloader.download(provenance)
         } catch (e: DownloadException) {
             val issue = createAndLogIssue(
                 "Downloader", "Could not download provenance $provenance: ${e.collectMessages()}"

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
 
 /**
@@ -32,7 +33,7 @@ data class NestedProvenance(
     /**
      * The root provenance that contains the [nested provenances][subRepositories].
      */
-    val root: KnownProvenance,
+    val root: RemoteProvenance,
 
     /**
      * If [root] is a [RepositoryProvenance] this map contains all paths which contain nested repositories associated
@@ -45,7 +46,7 @@ data class NestedProvenance(
      * The set of all contained [KnownProvenance]s.
      */
     @JsonIgnore
-    val allProvenances: Set<KnownProvenance> =
+    val allProvenances: Set<RemoteProvenance> =
         buildSet {
             add(root)
             addAll(subRepositories.values)

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
@@ -38,7 +39,7 @@ data class NestedProvenanceScanResult(
     /**
      * A map of [KnownProvenance]s from [nestedProvenance] associated with lists of [ScanResult]s.
      */
-    val scanResults: Map<KnownProvenance, List<ScanResult>>
+    val scanResults: Map<RemoteProvenance, List<ScanResult>>
 ) {
     /**
      * Return true if [scanResults] contains at least one scan result for each of the [KnownProvenance]s contained in
@@ -107,7 +108,7 @@ data class NestedProvenanceScanResult(
             }
         }
 
-        fun KnownProvenance.withVcsPath() =
+        fun RemoteProvenance.withVcsPath() =
             when (this) {
                 is RepositoryProvenance -> {
                     val pathWithinProvenance = pathsWithinProvenances.getValue(this)

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

@@ -33,10 +33,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
@@ -54,7 +54,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
 }
 
 /**
@@ -74,7 +74,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

@@ -64,7 +64,7 @@ fun interface ProvenanceDownloader {
         // Use the provenanceDownloader to download each provenance from nestedProvenance separately, because they are
         // likely already cached if a path scanner wrapper is used.
 
-        val root = download(nestedProvenance.root as RemoteProvenance)
+        val root = download(nestedProvenance.root)
 
         nestedProvenance.subRepositories.forEach { (path, provenance) ->
             val tempDir = download(provenance)

scanner/src/main/kotlin/storages/ProvenanceBasedFileStorage.kt

@@ -46,7 +46,11 @@ class ProvenanceBasedFileStorage(private val backend: FileStorage) : ProvenanceB
     override fun read(provenance: KnownProvenance, scannerMatcher: ScannerMatcher?): List<ScanResult> {
         requireEmptyVcsPath(provenance)
 
-        val path = storagePath(provenance as RemoteProvenance)
+        if (provenance !is RemoteProvenance) {
+            throw ScanStorageException("Scan result must have a known provenance, but it is $provenance.")
+        }
+
+        val path = storagePath(provenance)
 
         return runCatching {
             backend.read(path).use { input ->
@@ -81,7 +85,7 @@ class ProvenanceBasedFileStorage(private val backend: FileStorage) : ProvenanceB
 
         requireEmptyVcsPath(provenance)
 
-        if (provenance !is KnownProvenance) {
+        if (provenance !is RemoteProvenance) {
             throw ScanStorageException("Scan result must have a known provenance, but it is $provenance.")
         }
 
@@ -98,7 +102,7 @@ class ProvenanceBasedFileStorage(private val backend: FileStorage) : ProvenanceB
 
         val scanResults = existingScanResults + scanResult
 
-        val path = storagePath(provenance as RemoteProvenance)
+        val path = storagePath(provenance)
         val yamlBytes = yamlMapper.writeValueAsBytes(scanResults)
         val input = ByteArrayInputStream(yamlBytes)
 

scanner/src/main/kotlin/utils/FileListResolver.kt

@@ -56,10 +56,10 @@ class FileListResolver(
      * Get the [FileList] associated with the provided [provenance]. If it is not available in the [storage], download
      * the provenance and create the [FileList] from it.
      */
-    fun resolve(provenance: KnownProvenance): FileList {
+    fun resolve(provenance: RemoteProvenance): FileList {
         storage.getFileList(provenance)?.let { return it }
 
-        val dir = provenanceDownloader.download(provenance as RemoteProvenance)
+        val dir = provenanceDownloader.download(provenance)
 
         return createFileList(dir).also {
             try {

scanner/src/test/kotlin/ScannerTest.kt

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