chore(sw360)!: Remove the scan storage implementation

This still uses the "legacy" SW360 client and generally seems to be
unused.

Signed-off-by: Sebastian Schuberth <[email protected]>

Author: sschuberth

integrations/schemas/analyzer-configuration-schema.json

@@ -24,48 +24,8 @@
         "packageManagers": {
             "$ref": "https://raw.githubusercontent.com/oss-review-toolkit/ort/main/integrations/schemas/package-manager-configuration-schema.json"
         },
-        "sw360Configuration": {
-            "$ref": "#/definitions/Sw360Configuration"
-        },
         "skipExcluded": {
             "type": "boolean"
         }
-    },
-    "definitions": {
-        "Sw360Configuration": {
-            "type": "object",
-            "additionalProperties": false,
-            "properties": {
-                "restUrl": {
-                    "type": "string",
-                    "format": "uri"
-                },
-                "authUrl": {
-                    "type": "string",
-                    "format": "uri"
-                },
-                "username": {
-                    "type": "string"
-                },
-                "password": {
-                    "type": "string"
-                },
-                "clientId": {
-                    "type": "string"
-                },
-                "clientPassword": {
-                    "type": "string"
-                },
-                "token": {
-                    "type": "string"
-                }
-            },
-            "required": [
-                "authUrl",
-                "clientId",
-                "restUrl",
-                "username"
-            ]
-        }
     }
 }

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

@@ -19,7 +19,6 @@
 
 package org.ossreviewtoolkit.model.config
 
-import com.fasterxml.jackson.annotation.JsonProperty
 import com.fasterxml.jackson.annotation.JsonSubTypes
 import com.fasterxml.jackson.annotation.JsonSubTypes.Type
 import com.fasterxml.jackson.annotation.JsonTypeInfo
@@ -38,8 +37,7 @@ import org.ossreviewtoolkit.utils.ort.storage.FileStorage
 @JsonSubTypes(
     Type(ClearlyDefinedStorageConfiguration::class),
     Type(FileBasedStorageConfiguration::class),
-    Type(PostgresStorageConfiguration::class),
-    Type(Sw360StorageConfiguration::class)
+    Type(PostgresStorageConfiguration::class)
 )
 sealed interface ScanStorageConfiguration
 
@@ -83,50 +81,6 @@ data class PostgresStorageConfiguration(
     val type: StorageType = StorageType.PROVENANCE_BASED
 ) : ScanStorageConfiguration
 
-/**
- * A class to hold the configuration for SW360.
- */
-data class Sw360StorageConfiguration(
-    /**
-     * The REST API URL of SW360.
-     */
-    val restUrl: String,
-
-    /**
-     * The authentication URL of your SW360 instance.
-     */
-    val authUrl: String,
-
-    /**
-     * The username for the requests to SW360.
-     */
-    val username: String,
-
-    /**
-     * The password of the SW360 user.
-     */
-    @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
-    val password: String = "",
-
-    /**
-     * The client ID of the SW360 instance for the two-step authentication.
-     */
-    val clientId: String,
-
-    /**
-     * The password of the client ID.
-     */
-    @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
-    val clientPassword: String = "",
-
-    /**
-     * Optional access token that can be used instead of the [authUrl], [username], [password], [clientId] and
-     * [clientPassword] if the token is already known.
-     */
-    @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
-    val token: String = ""
-) : ScanStorageConfiguration
-
 /**
  * An enum to describe different types of storages.
  */

model/src/main/resources/reference.yml

@@ -330,15 +330,6 @@ ort:
           minimumIdle: 600000
         type: PROVENANCE_BASED
 
-      sw360Configuration:
-        restUrl: 'https://your-sw360-rest-url'
-        authUrl: 'https://your-authentication-url'
-        username: username
-        password: password
-        clientId: clientId
-        clientPassword: clientPassword
-        token: token
-
     # Storage readers are listed from highest to lower priority, i.e. the first match wins.
     storageReaders: [local, postgres, http, aws, clearlyDefined]
 

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

@@ -264,7 +264,7 @@ class OrtConfigurationTest : WordSpec({
 
                 storages shouldNotBeNull {
                     keys should containExactlyInAnyOrder(
-                        "local", "http", "aws", "clearlyDefined", "postgres", "sw360Configuration"
+                        "local", "http", "aws", "clearlyDefined", "postgres"
                     )
 
                     val localStorage = this["local"]
@@ -310,16 +310,6 @@ class OrtConfigurationTest : WordSpec({
                     }
 
                     postgresStorage.type shouldBe StorageType.PROVENANCE_BASED
-
-                    val sw360Storage = this["sw360Configuration"]
-                    sw360Storage.shouldBeInstanceOf<Sw360StorageConfiguration>()
-                    sw360Storage.restUrl shouldBe "https://your-sw360-rest-url"
-                    sw360Storage.authUrl shouldBe "https://your-authentication-url"
-                    sw360Storage.username shouldBe "username"
-                    sw360Storage.password shouldBe "password"
-                    sw360Storage.clientId shouldBe "clientId"
-                    sw360Storage.clientPassword shouldBe "clientPassword"
-                    sw360Storage.token shouldBe "token"
                 }
 
                 storageReaders should containExactly("local", "postgres", "http", "aws", "clearlyDefined")

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

@@ -37,12 +37,6 @@ dependencies {
     implementation(libs.bundles.exposed)
     implementation(libs.kotlinx.coroutines)
     implementation(libs.postgres)
-    implementation(libs.sw360Client) {
-        constraints {
-            implementation("commons-io:commons-io:2.20.0")
-                .because("commons-io 2.11.0 is vulnerable by CVE-2024-47554")
-        }
-    }
 
     funTestImplementation(platform(projects.plugins.scanners))
     funTestImplementation(platform(projects.plugins.versionControlSystems))

scanner/build.gradle.kts

@@ -27,7 +27,6 @@ import org.ossreviewtoolkit.model.config.PostgresStorageConfiguration
 import org.ossreviewtoolkit.model.config.ScanStorageConfiguration
 import org.ossreviewtoolkit.model.config.ScannerConfiguration
 import org.ossreviewtoolkit.model.config.StorageType
-import org.ossreviewtoolkit.model.config.Sw360StorageConfiguration
 import org.ossreviewtoolkit.model.utils.DatabaseUtils
 import org.ossreviewtoolkit.scanner.provenance.NestedProvenance
 import org.ossreviewtoolkit.scanner.provenance.NestedProvenanceScanResult
@@ -41,7 +40,6 @@ 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
 import org.ossreviewtoolkit.utils.common.div
 import org.ossreviewtoolkit.utils.ort.ortDataDirectory
 import org.ossreviewtoolkit.utils.ort.storage.XZCompressedLocalFileStorage
@@ -128,7 +126,6 @@ private fun createStorage(config: ScanStorageConfiguration): ScanStorage =
         is FileBasedStorageConfiguration -> createFileBasedStorage(config)
         is PostgresStorageConfiguration -> createPostgresStorage(config)
         is ClearlyDefinedStorageConfiguration -> createClearlyDefinedStorage(config)
-        is Sw360StorageConfiguration -> createSw360Storage(config)
     }
 
 private fun createFileBasedStorage(config: FileBasedStorageConfiguration) =
@@ -148,5 +145,3 @@ private fun createPostgresStorage(config: PostgresStorageConfiguration) =
     }
 
 private fun createClearlyDefinedStorage(config: ClearlyDefinedStorageConfiguration) = ClearlyDefinedStorage(config)
-
-private fun createSw360Storage(config: Sw360StorageConfiguration) = Sw360Storage(config)