refactor(model)!: Replace PluginConfiguration with PluginConfig

Remove the old `PluginConfiguration` class and replace all usages with
the new `PluginConfig` class [1].

Also add an `orEmpty()` convenience function to simplify some code that
is changed as part of this commit.

[1]: #9403 (comment)

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

Author: mnonnenmacher

advisor/src/main/kotlin/Advisor.kt

@@ -37,7 +37,7 @@ import org.ossreviewtoolkit.model.Package
 import org.ossreviewtoolkit.model.config.AdvisorConfiguration
 import org.ossreviewtoolkit.model.vulnerabilities.Vulnerability
 import org.ossreviewtoolkit.model.vulnerabilities.VulnerabilityReference
-import org.ossreviewtoolkit.plugins.api.PluginConfig
+import org.ossreviewtoolkit.plugins.api.orEmpty
 import org.ossreviewtoolkit.utils.ort.Environment
 
 /**
@@ -81,7 +81,7 @@ class Advisor(
             } else {
                 val providers = providerFactories.map {
                     val providerConfig = config.config?.get(it.descriptor.id)
-                    it.create(PluginConfig(providerConfig?.options.orEmpty(), providerConfig?.secrets.orEmpty()))
+                    it.create(providerConfig.orEmpty())
                 }
 
                 providers.map { provider ->

model/build.gradle.kts

@@ -27,6 +27,7 @@ plugins {
 
 dependencies {
     api(projects.clients.clearlyDefinedClient)
+    api(projects.plugins.api)
     api(projects.utils.ortUtils)
     api(projects.utils.spdxUtils)
 

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

@@ -21,6 +21,7 @@ package org.ossreviewtoolkit.model.config
 
 import com.fasterxml.jackson.annotation.JsonInclude
 
+import org.ossreviewtoolkit.plugins.api.PluginConfig
 import org.ossreviewtoolkit.utils.common.Plugin
 
 /**
@@ -34,8 +35,7 @@ data class AdvisorConfiguration(
     val skipExcluded: Boolean = false,
 
     /**
-     * A map with [configuration][PluginConfiguration] for advice providers using the [provider type][Plugin.type] as
-     * key.
+     * A map with [configuration][PluginConfig] for advice providers using the [provider type][Plugin.type] as key.
      */
-    val config: Map<String, PluginConfiguration>? = null
+    val config: Map<String, PluginConfig>? = null
 )

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

@@ -21,6 +21,8 @@ package org.ossreviewtoolkit.model.config
 
 import com.fasterxml.jackson.annotation.JsonInclude
 
+import org.ossreviewtoolkit.plugins.api.PluginConfig
+
 /**
  * The base configuration model of the reporter.
  */
@@ -30,5 +32,5 @@ data class ReporterConfiguration(
      * Reporter specific configuration options. The key needs to match the name of the reporter class, e.g. "FossId"
      * for the FossId reporter. See the documentation of the reporter for available options.
      */
-    val config: Map<String, PluginConfiguration>? = null
+    val config: Map<String, PluginConfig>? = null
 )

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

@@ -24,6 +24,7 @@ import com.fasterxml.jackson.annotation.JsonInclude
 import com.fasterxml.jackson.annotation.JsonPropertyOrder
 
 import org.ossreviewtoolkit.model.utils.FileArchiver
+import org.ossreviewtoolkit.plugins.api.PluginConfig
 import org.ossreviewtoolkit.utils.ort.ORT_REPO_CONFIG_FILENAME
 import org.ossreviewtoolkit.utils.ort.storage.FileStorage
 import org.ossreviewtoolkit.utils.spdx.SpdxConstants
@@ -92,7 +93,7 @@ data class ScannerConfiguration(
      * for the ScanCode wrapper. See the documentation of the scanner for available options.
      */
     @JsonAlias("options")
-    val config: Map<String, PluginConfiguration>? = null,
+    val config: Map<String, PluginConfig>? = null,
 
     /**
      * A map with the configurations of the scan result storages available. Based on this information the actual

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

@@ -52,3 +52,8 @@ data class PluginConfig(
      */
     override fun toString() = "${this::class.simpleName}(options=$options, secrets=[***])"
 }
+
+/**
+ * Returns this [PluginConfig] if it is not `null`, or the [empty][PluginConfig.EMPTY] [PluginConfig] otherwise.
+ */
+fun PluginConfig?.orEmpty() = this ?: PluginConfig.EMPTY

plugins/api/src/main/kotlin/PluginConfig.kt

@@ -43,7 +43,6 @@ import org.apache.logging.log4j.kotlin.logger
 
 import org.ossreviewtoolkit.model.config.CopyrightGarbage
 import org.ossreviewtoolkit.model.config.LicenseFilePatterns
-import org.ossreviewtoolkit.model.config.PluginConfiguration
 import org.ossreviewtoolkit.model.config.RepositoryConfiguration
 import org.ossreviewtoolkit.model.config.createFileArchiver
 import org.ossreviewtoolkit.model.config.orEmpty
@@ -57,6 +56,7 @@ import org.ossreviewtoolkit.model.utils.DefaultResolutionProvider
 import org.ossreviewtoolkit.plugins.api.OrtPlugin
 import org.ossreviewtoolkit.plugins.api.PluginConfig
 import org.ossreviewtoolkit.plugins.api.PluginDescriptor
+import org.ossreviewtoolkit.plugins.api.orEmpty
 import org.ossreviewtoolkit.plugins.commands.api.OrtCommand
 import org.ossreviewtoolkit.plugins.commands.api.OrtCommandFactory
 import org.ossreviewtoolkit.plugins.commands.api.utils.configurationGroup
@@ -277,7 +277,7 @@ class ReporterCommand(descriptor: PluginDescriptor = ReporterCommandFactory.desc
             howToFixTextProvider
         )
 
-        val reportConfigMap = sortedMapOf<String, PluginConfiguration>(String.CASE_INSENSITIVE_ORDER)
+        val reportConfigMap = sortedMapOf<String, PluginConfig>(String.CASE_INSENSITIVE_ORDER)
 
         // Obtain reporter-specific options defined in ORT's configuration.
         ortConfig.reporter.config?.forEach { (reporterName, config) ->
@@ -286,7 +286,7 @@ class ReporterCommand(descriptor: PluginDescriptor = ReporterCommandFactory.desc
 
         // Allow overwriting reporter-specific options via the command line.
         reportOptions.forEach { (reporterName, option) ->
-            val reportSpecificConfig = reportConfigMap.getOrPut(reporterName) { PluginConfiguration.EMPTY }
+            val reportSpecificConfig = reportConfigMap.getOrPut(reporterName) { PluginConfig.EMPTY }
             val updatedConfig = reportSpecificConfig.copy(options = reportSpecificConfig.options + option)
             reportConfigMap[reporterName] = updatedConfig
         }
@@ -300,9 +300,8 @@ class ReporterCommand(descriptor: PluginDescriptor = ReporterCommandFactory.desc
                         echo("Generating '${reporter.descriptor.id}' report(s) in thread '$threadName'...")
 
                         reporter to measureTimedValue {
-                            val options = reportConfigMap[reporter.descriptor.id] ?: PluginConfiguration.EMPTY
-                            reporter.create(PluginConfig(options.options, options.secrets))
-                                .generateReport(input, outputDir)
+                            val pluginConfig = reportConfigMap[reporter.descriptor.id].orEmpty()
+                            reporter.create(pluginConfig).generateReport(input, outputDir)
                         }
                     }
                 }.awaitAll()

plugins/commands/reporter/src/main/kotlin/ReporterCommand.kt

@@ -53,6 +53,7 @@ import org.ossreviewtoolkit.model.utils.mergeLabels
 import org.ossreviewtoolkit.plugins.api.OrtPlugin
 import org.ossreviewtoolkit.plugins.api.PluginConfig
 import org.ossreviewtoolkit.plugins.api.PluginDescriptor
+import org.ossreviewtoolkit.plugins.api.orEmpty
 import org.ossreviewtoolkit.plugins.commands.api.OrtCommand
 import org.ossreviewtoolkit.plugins.commands.api.OrtCommandFactory
 import org.ossreviewtoolkit.plugins.commands.api.utils.SeverityStatsPrinter
@@ -176,7 +177,7 @@ class ScannerCommand(descriptor: PluginDescriptor = ScannerCommandFactory.descri
             .takeIf { PackageType.PACKAGE in packageTypes }.orEmpty()
             .map {
                 val config = ortConfig.scanner.config?.get(it.descriptor.id)
-                it.create(PluginConfig(config?.options.orEmpty(), config?.secrets.orEmpty()))
+                it.create(config.orEmpty())
             }
 
         val projectScannerWrappers = projectScannerWrapperFactories

plugins/commands/scanner/src/main/kotlin/ScannerCommand.kt

@@ -27,9 +27,9 @@ import org.ossreviewtoolkit.model.Provenance
 import org.ossreviewtoolkit.model.ScanResult
 import org.ossreviewtoolkit.model.ScanSummary
 import org.ossreviewtoolkit.model.ScannerDetails
-import org.ossreviewtoolkit.model.config.PluginConfiguration
 import org.ossreviewtoolkit.model.config.ScannerConfiguration
 import org.ossreviewtoolkit.plugins.api.Plugin
+import org.ossreviewtoolkit.plugins.api.PluginConfig
 import org.ossreviewtoolkit.scanner.provenance.NestedProvenance
 
 /**
@@ -55,7 +55,7 @@ sealed interface ScannerWrapper : Plugin {
     /**
      * The [ScannerMatcher] object to be used when looking up existing scan results from a scan storage. By default,
      * the properties of this object are initialized by the scanner implementation. These defaults can be overridden
-     * with the scanner-specific [options][PluginConfiguration.options] in [ScannerConfiguration.config]: Use properties
+     * with the scanner-specific [options][PluginConfig.options] in [ScannerConfiguration.config]: Use properties
      * of the form `scannerName.options.property`, where `scannerName` is the name of the scanner and `property` is the
      * name of a property of the [ScannerMatcher] class. For instance, to specify that a specific minimum version of
      * ScanCode is allowed, set this property: `config.ScanCode.options.minVersion=3.0.2`.