feat(scanoss)!: Use secret options map

Read the API key from the secrets map instead of the options map in
`ScanOssConfig`.

This also fixes the issue that the API key was serialized to the ORT
result as the `filterSecretOptions` function was not implemented by
`ScanOss`.

Signed-off-by: Martin Nonnenmacher <[email protected]>

Author: mnonnenmacher

plugins/scanners/scanoss/src/main/kotlin/ScanOss.kt

@@ -60,7 +60,7 @@ class ScanOss internal constructor(
             ScanOss(type, config, matcherConfig)
 
         override fun parseConfig(options: Options, secrets: Options) =
-            ScanOssConfig.create(options).also { logger.info { "The $type API URL is ${it.apiUrl}." } }
+            ScanOssConfig.create(options, secrets).also { logger.info { "The $type API URL is ${it.apiUrl}." } }
     }
 
     private val service = ScanOssService.create(config.apiUrl)

plugins/scanners/scanoss/src/main/kotlin/ScanOssConfig.kt

@@ -25,8 +25,11 @@ import org.ossreviewtoolkit.utils.common.Options
 
 /**
  * A data class that holds the configuration options supported by the [ScanOss] scanner. An instance of this class is
- * created from the options contained in a [ScannerConfiguration] object under the key _ScanOss_. It offers the
+ * created from the [scanner config][ScannerConfiguration.config] object under the key _ScanOss_. It offers the
  * following configuration options:
+ *
+ * **"options.apiUrl":** The URL of the ScanOSS server.
+ * **"secrets.apiKey":** The API key to authenticate with the ScanOSS server.
  */
 data class ScanOssConfig(
     /** URL of the ScanOSS server. */
@@ -42,9 +45,9 @@ data class ScanOssConfig(
         /** Name of the configuration property for the API key. */
         const val API_KEY_PROPERTY = "apiKey"
 
-        fun create(options: Options): ScanOssConfig {
+        fun create(options: Options, secrets: Options): ScanOssConfig {
             val apiUrl = options[API_URL_PROPERTY] ?: ScanOssService.DEFAULT_API_URL
-            val apiKey = options[API_KEY_PROPERTY].orEmpty()
+            val apiKey = secrets[API_KEY_PROPERTY].orEmpty()
 
             return ScanOssConfig(apiUrl, apiKey)
         }

plugins/scanners/scanoss/src/test/kotlin/ScanOssConfigTest.kt

@@ -28,19 +28,17 @@ import org.ossreviewtoolkit.clients.scanoss.ScanOssService
 
 class ScanOssConfigTest : StringSpec({
     "Default values are used" {
-        with(ScanOssConfig.create(emptyMap())) {
+        with(ScanOssConfig.create(emptyMap(), emptyMap())) {
             apiUrl shouldBe ScanOssService.DEFAULT_API_URL
             apiKey should beEmpty()
         }
     }
 
     "Default values can be overridden" {
-        val options = mapOf(
-            ScanOssConfig.API_URL_PROPERTY to "url",
-            ScanOssConfig.API_KEY_PROPERTY to "key"
-        )
+        val options = mapOf(ScanOssConfig.API_URL_PROPERTY to "url")
+        val secrets = mapOf(ScanOssConfig.API_KEY_PROPERTY to "key")
 
-        with(ScanOssConfig.create(options)) {
+        with(ScanOssConfig.create(options, secrets)) {
             apiUrl shouldBe "url"
             apiKey shouldBe "key"
         }