refactor(scanner)!: Rename the package based storages

Rename the package based file and Postgres storage to match the names of their provenance based counterparts. Signed-off-by: Martin Nonnenmacher <[email protected]>
oss-review-toolkit · Mar 16, 2024 · 4fb53b4 · 4fb53b4
1 parent 192eda6
commit 4fb53b4
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 14 deletions.
diff --git a/helper-cli/src/main/kotlin/commands/ImportScanResultsCommand.kt b/helper-cli/src/main/kotlin/commands/ImportScanResultsCommand.kt
@@ -26,7 +26,7 @@ import com.github.ajalt.clikt.parameters.options.required
 import com.github.ajalt.clikt.parameters.types.file
 
 import org.ossreviewtoolkit.helper.utils.readOrtResult
-import org.ossreviewtoolkit.scanner.storages.FileBasedStorage
+import org.ossreviewtoolkit.scanner.storages.PackageBasedFileStorage
 import org.ossreviewtoolkit.utils.common.expandTilde
 import org.ossreviewtoolkit.utils.ort.storage.LocalFileStorage
 
@@ -51,7 +51,7 @@ internal class ImportScanResultsCommand : CliktCommand(
 
     override fun run() {
         val ortResult = readOrtResult(ortFile)
-        val scanResultsStorage = FileBasedStorage(LocalFileStorage(scanResultsStorageDir))
+        val scanResultsStorage = PackageBasedFileStorage(LocalFileStorage(scanResultsStorageDir))
         val ids = ortResult.getProjects().map { it.id } + ortResult.getPackages().map { it.metadata.id }
 
         ids.forEach { id ->

diff --git a/helper-cli/src/main/kotlin/commands/packageconfig/CreateCommand.kt b/helper-cli/src/main/kotlin/commands/packageconfig/CreateCommand.kt
@@ -43,7 +43,7 @@ import org.ossreviewtoolkit.model.config.PackageConfiguration
 import org.ossreviewtoolkit.model.config.VcsMatcher
 import org.ossreviewtoolkit.model.licenses.LicenseClassifications
 import org.ossreviewtoolkit.model.readValue
-import org.ossreviewtoolkit.scanner.storages.FileBasedStorage
+import org.ossreviewtoolkit.scanner.storages.PackageBasedFileStorage
 import org.ossreviewtoolkit.utils.common.expandTilde
 import org.ossreviewtoolkit.utils.common.safeMkdirs
 import org.ossreviewtoolkit.utils.ort.storage.LocalFileStorage
@@ -119,7 +119,7 @@ internal class CreateCommand : CliktCommand(
     override fun run() {
         outputDir.safeMkdirs()
 
-        val scanResultsStorage = FileBasedStorage(LocalFileStorage(scanResultsStorageDir))
+        val scanResultsStorage = PackageBasedFileStorage(LocalFileStorage(scanResultsStorageDir))
         val scanResults = scanResultsStorage.read(Package.EMPTY.copy(id = packageId)).getOrThrow().run {
             listOfNotNull(
                 find { it.provenance is RepositoryProvenance },

diff --git a/...otlin/storages/FileBasedStorageFunTest.kt → ...torages/PackageBasedFileStorageFunTest.kt b/...otlin/storages/FileBasedStorageFunTest.kt → ...torages/PackageBasedFileStorageFunTest.kt
@@ -23,6 +23,6 @@ import io.kotest.engine.spec.tempdir
 
 import org.ossreviewtoolkit.utils.ort.storage.LocalFileStorage
 
-class FileBasedStorageFunTest : AbstractPackageBasedScanStorageFunTest() {
-    override fun createStorage() = FileBasedStorage(LocalFileStorage(tempdir()))
+class PackageBasedFileStorageFunTest : AbstractPackageBasedScanStorageFunTest() {
+    override fun createStorage() = PackageBasedFileStorage(LocalFileStorage(tempdir()))
 }
diff --git a/...kotlin/storages/PostgresStorageFunTest.kt → ...ges/PackageBasedPostgresStorageFunTest.kt b/...kotlin/storages/PostgresStorageFunTest.kt → ...ges/PackageBasedPostgresStorageFunTest.kt
@@ -23,6 +23,7 @@ import org.ossreviewtoolkit.utils.test.PostgresListener
 
 private val postgresListener = PostgresListener()
 
-class PostgresStorageFunTest : AbstractPackageBasedScanStorageFunTest(postgresListener) {
-    override fun createStorage() = PostgresStorage(dataSource = postgresListener.dataSource, parallelTransactions = 5)
+class PackageBasedPostgresStorageFunTest : AbstractPackageBasedScanStorageFunTest(postgresListener) {
+    override fun createStorage() =
+        PackageBasedPostgresStorage(dataSource = postgresListener.dataSource, parallelTransactions = 5)
 }
diff --git a/scanner/src/main/kotlin/ScanStorages.kt b/scanner/src/main/kotlin/ScanStorages.kt
@@ -37,8 +37,8 @@ import org.ossreviewtoolkit.scanner.provenance.ResolvedArtifactProvenance
 import org.ossreviewtoolkit.scanner.provenance.ResolvedRepositoryProvenance
 import org.ossreviewtoolkit.scanner.provenance.UnresolvedPackageProvenance
 import org.ossreviewtoolkit.scanner.storages.ClearlyDefinedStorage
-import org.ossreviewtoolkit.scanner.storages.FileBasedStorage
-import org.ossreviewtoolkit.scanner.storages.PostgresStorage
+import org.ossreviewtoolkit.scanner.storages.PackageBasedFileStorage
+import org.ossreviewtoolkit.scanner.storages.PackageBasedPostgresStorage
 import org.ossreviewtoolkit.scanner.storages.ProvenanceBasedFileStorage
 import org.ossreviewtoolkit.scanner.storages.ProvenanceBasedPostgresStorage
 import org.ossreviewtoolkit.scanner.storages.Sw360Storage
@@ -132,13 +132,13 @@ private fun createStorage(config: ScanStorageConfiguration): ScanStorage =
 
 private fun createFileBasedStorage(config: FileBasedStorageConfiguration) =
     when (config.type) {
-        StorageType.PACKAGE_BASED -> FileBasedStorage(config.backend.createFileStorage())
+        StorageType.PACKAGE_BASED -> PackageBasedFileStorage(config.backend.createFileStorage())
         StorageType.PROVENANCE_BASED -> ProvenanceBasedFileStorage(config.backend.createFileStorage())
     }
 
 private fun createPostgresStorage(config: PostgresStorageConfiguration) =
     when (config.type) {
-        StorageType.PACKAGE_BASED -> PostgresStorage(
+        StorageType.PACKAGE_BASED -> PackageBasedPostgresStorage(
             DatabaseUtils.createHikariDataSource(config = config.connection, applicationNameSuffix = TOOL_NAME),
             config.connection.parallelTransactions
         )

diff --git a/.../main/kotlin/storages/FileBasedStorage.kt → ...otlin/storages/PackageBasedFileStorage.kt b/.../main/kotlin/storages/FileBasedStorage.kt → ...otlin/storages/PackageBasedFileStorage.kt
@@ -43,7 +43,7 @@ const val SCAN_RESULTS_FILE_NAME = "scan-results.yml"
 /**
  * A [PackageBasedScanStorage] using a [FileStorage] as backend. Scan results are serialized using [YAML][yamlMapper].
  */
-class FileBasedStorage(
+class PackageBasedFileStorage(
     /**
      * The [FileStorage] to use for storing scan results.
      */

diff --git a/...c/main/kotlin/storages/PostgresStorage.kt → ...n/storages/PackageBasedPostgresStorage.kt b/...c/main/kotlin/storages/PostgresStorage.kt → ...n/storages/PackageBasedPostgresStorage.kt
@@ -61,7 +61,7 @@ private val TABLE_NAME = ScanResults.tableName
 /**
  * The Postgres storage back-end.
  */
-class PostgresStorage(
+class PackageBasedPostgresStorage(
     /**
      * The JDBC data source to obtain database connections.
      */