Package curation provider plugins

analyzer/src/main/kotlin/PackageCurationProvider.kt

@@ -21,6 +21,35 @@ package org.ossreviewtoolkit.analyzer
 
 import org.ossreviewtoolkit.model.Identifier
 import org.ossreviewtoolkit.model.PackageCuration
+import org.ossreviewtoolkit.model.config.PackageCurationProviderConfiguration
+import org.ossreviewtoolkit.utils.common.ConfigurablePluginFactory
+import org.ossreviewtoolkit.utils.common.NamedPlugin
+
+/**
+ * The extension point for [PackageCurationProvider]s.
+ */
+interface PackageCurationProviderFactory<CONFIG> : ConfigurablePluginFactory<PackageCurationProvider> {
+    companion object {
+        val ALL = NamedPlugin.getAll<PackageCurationProviderFactory<*>>()
+
+        fun create(configurations: List<PackageCurationProviderConfiguration>) =
+            // Reverse the list so that curations from providers with higher priority are applied later and can
+            // overwrite curations from providers with lower priority.
+            configurations.filter { it.enabled }.map { ALL.getValue(it.name).create(it.config) }.asReversed()
+    }
+
+    override fun create(config: Map<String, String>): PackageCurationProvider = create(parseConfig(config))
+
+    /**
+     * Create a new [PackageCurationProvider] with [config].
+     */
+    fun create(config: CONFIG): PackageCurationProvider
+
+    /**
+     * Parse the [config] map into an object.
+     */
+    fun parseConfig(config: Map<String, String>): CONFIG
+}
 
 /**
  * A provider for [PackageCuration]s.

analyzer/src/main/kotlin/curation/ClearlyDefinedPackageCurationProvider.kt

@@ -28,6 +28,7 @@ import okhttp3.OkHttpClient
 import org.apache.logging.log4j.kotlin.Logging
 
 import org.ossreviewtoolkit.analyzer.PackageCurationProvider
+import org.ossreviewtoolkit.analyzer.PackageCurationProviderFactory
 import org.ossreviewtoolkit.clients.clearlydefined.ClearlyDefinedService
 import org.ossreviewtoolkit.clients.clearlydefined.ClearlyDefinedService.Server
 import org.ossreviewtoolkit.clients.clearlydefined.ComponentType
@@ -50,6 +51,24 @@ import org.ossreviewtoolkit.utils.spdx.toSpdx
 
 import retrofit2.HttpException
 
+class ClearlyDefinedPackageCurationProviderConfig(
+    /**
+     * The URL of the ClearlyDefined server to use. If null, uses the [production server][Server.PRODUCTION.apiUrl].
+     */
+    val serverUrl: String? = null
+)
+
+class ClearlyDefinedPackageCurationProviderFactory :
+    PackageCurationProviderFactory<ClearlyDefinedPackageCurationProviderConfig> {
+    override val name = "ClearlyDefined"
+
+    override fun create(config: ClearlyDefinedPackageCurationProviderConfig) =
+        ClearlyDefinedPackageCurationProvider(serverUrl = config.serverUrl)
+
+    override fun parseConfig(config: Map<String, String>) =
+        ClearlyDefinedPackageCurationProviderConfig(serverUrl = config["serverUrl"])
+}
+
 /**
  * A provider for curated package metadata from the [ClearlyDefined](https://clearlydefined.io/) service.
  */

analyzer/src/main/kotlin/curation/FilePackageCurationProvider.kt

@@ -25,25 +25,74 @@ import java.io.IOException
 import org.apache.logging.log4j.kotlin.Logging
 
 import org.ossreviewtoolkit.analyzer.PackageCurationProvider
+import org.ossreviewtoolkit.analyzer.PackageCurationProviderFactory
 import org.ossreviewtoolkit.model.FileFormat
 import org.ossreviewtoolkit.model.PackageCuration
 import org.ossreviewtoolkit.model.readValue
 import org.ossreviewtoolkit.utils.common.getDuplicates
+import org.ossreviewtoolkit.utils.ort.ORT_PACKAGE_CURATIONS_DIRNAME
+import org.ossreviewtoolkit.utils.ort.ORT_PACKAGE_CURATIONS_FILENAME
+import org.ossreviewtoolkit.utils.ort.ortConfigDirectory
+
+class FilePackageCurationProviderConfig(
+    /**
+     * The path of the package curation file or directory.
+     */
+    val path: String
+)
+
+class FilePackageCurationProviderFactory : PackageCurationProviderFactory<FilePackageCurationProviderConfig> {
+    override val name = "File"
+
+    override fun create(config: FilePackageCurationProviderConfig) = FilePackageCurationProvider(config)
+
+    override fun parseConfig(config: Map<String, String>) =
+        FilePackageCurationProviderConfig(path = config.getValue("path"))
+}
+
+class DefaultFilePackageCurationProviderFactory : PackageCurationProviderFactory<Unit> {
+    override val name = "DefaultFile"
+
+    override fun create(config: Unit) =
+        ortConfigDirectory.resolve(ORT_PACKAGE_CURATIONS_FILENAME).let { curationsFile ->
+            when {
+                curationsFile.isFile -> FilePackageCurationProvider(curationsFile)
+                else -> PackageCurationProvider.EMPTY
+            }
+        }
+
+    override fun parseConfig(config: Map<String, String>) = Unit
+}
+
+class DefaultDirPackageCurationProviderFactory : PackageCurationProviderFactory<Unit> {
+    override val name = "DefaultDir"
+
+    override fun create(config: Unit) =
+        ortConfigDirectory.resolve(ORT_PACKAGE_CURATIONS_DIRNAME).let { curationsDir ->
+            when {
+                curationsDir.isDirectory -> FilePackageCurationProvider(curationsDir)
+                else -> PackageCurationProvider.EMPTY
+            }
+        }
+
+    override fun parseConfig(config: Map<String, String>) = Unit
+}
 
 /**
  * A [PackageCurationProvider] that loads [PackageCuration]s from all given curation files. Supports all file formats
  * specified in [FileFormat].
  */
 class FilePackageCurationProvider(
-    curationFiles: Collection<File>
+    curationFiles: List<File>
 ) : SimplePackageCurationProvider(readCurationFiles(curationFiles)) {
     constructor(curationFile: File) : this(listOf(curationFile))
+    constructor(config: FilePackageCurationProviderConfig) : this(File(config.path))
 
     companion object : Logging {
         fun from(file: File? = null, dir: File? = null): FilePackageCurationProvider {
             val curationFiles = mutableListOf<File>()
             file?.takeIf { it.isFile }?.let { curationFiles += it }
-            dir?.let { curationFiles += FileFormat.findFilesWithKnownExtensions(it) }
+            dir?.takeIf { it.isDirectory }?.let { curationFiles += FileFormat.findFilesWithKnownExtensions(it) }
 
             return FilePackageCurationProvider(curationFiles)
         }

analyzer/src/main/kotlin/curation/OrtConfigPackageCurationProvider.kt

@@ -25,6 +25,7 @@ import java.io.IOException
 import org.apache.logging.log4j.kotlin.Logging
 
 import org.ossreviewtoolkit.analyzer.PackageCurationProvider
+import org.ossreviewtoolkit.analyzer.PackageCurationProviderFactory
 import org.ossreviewtoolkit.downloader.vcs.Git
 import org.ossreviewtoolkit.model.Identifier
 import org.ossreviewtoolkit.model.PackageCuration
@@ -38,6 +39,14 @@ import org.ossreviewtoolkit.utils.ort.ortDataDirectory
 private const val ORT_CONFIG_REPOSITORY_BRANCH = "main"
 private const val ORT_CONFIG_REPOSITORY_URL = "https://github.com/oss-review-toolkit/ort-config.git"
 
+class OrtConfigPackageCurationProviderFactory : PackageCurationProviderFactory<Unit> {
+    override val name = "OrtConfig"
+
+    override fun create(config: Unit) = OrtConfigPackageCurationProvider()
+
+    override fun parseConfig(config: Map<String, String>) = Unit
+}
+
 /**
  * A [PackageCurationProvider] that provides [PackageCuration]s loaded from the
  * [ort-config repository](https://github.com/oss-review-toolkit/ort-config).

analyzer/src/main/kotlin/curation/Sw360PackageCurationProvider.kt

@@ -33,6 +33,7 @@ import org.eclipse.sw360.http.HttpClientFactoryImpl
 import org.eclipse.sw360.http.config.HttpClientConfig
 
 import org.ossreviewtoolkit.analyzer.PackageCurationProvider
+import org.ossreviewtoolkit.analyzer.PackageCurationProviderFactory
 import org.ossreviewtoolkit.model.Hash
 import org.ossreviewtoolkit.model.HashAlgorithm
 import org.ossreviewtoolkit.model.Identifier
@@ -45,6 +46,23 @@ import org.ossreviewtoolkit.model.orEmpty
 import org.ossreviewtoolkit.utils.ort.DeclaredLicenseProcessor
 import org.ossreviewtoolkit.utils.spdx.SpdxExpression
 
+class Sw360PackageCurationProviderFactory : PackageCurationProviderFactory<Sw360StorageConfiguration> {
+    override val name = "SW360"
+
+    override fun create(config: Sw360StorageConfiguration) = Sw360PackageCurationProvider(config)
+
+    override fun parseConfig(config: Map<String, String>) =
+        Sw360StorageConfiguration(
+            restUrl = config.getValue("restUrl"),
+            authUrl = config.getValue("authUrl"),
+            username = config.getValue("username"),
+            password = config["password"].orEmpty(),
+            clientId = config.getValue("clientId"),
+            clientPassword = config["clientPassword"].orEmpty(),
+            token = config["token"].orEmpty()
+        )
+}
+
 /**
  * A [PackageCurationProvider] for curated package metadata from the configured SW360 instance using the REST API.
  */

analyzer/src/main/resources/META-INF/services/org.ossreviewtoolkit.analyzer.PackageCurationProviderFactory

@@ -0,0 +1,6 @@
+org.ossreviewtoolkit.analyzer.curation.ClearlyDefinedPackageCurationProviderFactory
+org.ossreviewtoolkit.analyzer.curation.DefaultDirPackageCurationProviderFactory
+org.ossreviewtoolkit.analyzer.curation.DefaultFilePackageCurationProviderFactory
+org.ossreviewtoolkit.analyzer.curation.FilePackageCurationProviderFactory
+org.ossreviewtoolkit.analyzer.curation.OrtConfigPackageCurationProviderFactory
+org.ossreviewtoolkit.analyzer.curation.Sw360PackageCurationProviderFactory

cli/src/funTest/kotlin/OrtMainFunTest.kt

@@ -38,6 +38,7 @@ import org.ossreviewtoolkit.downloader.VersionControlSystem
 import org.ossreviewtoolkit.model.OrtResult
 import org.ossreviewtoolkit.model.config.OrtConfiguration
 import org.ossreviewtoolkit.model.config.OrtConfigurationWrapper
+import org.ossreviewtoolkit.model.config.PackageCurationProviderConfiguration
 import org.ossreviewtoolkit.model.readValue
 import org.ossreviewtoolkit.model.writeValue
 import org.ossreviewtoolkit.utils.common.EnvironmentVariableFilter
@@ -63,7 +64,18 @@ class OrtMainFunTest : StringSpec() {
 
     override suspend fun beforeSpec(spec: Spec) {
         configFile = createSpecTempFile(suffix = ".yml")
-        configFile.writeValue(OrtConfigurationWrapper(OrtConfiguration()))
+        configFile.writeValue(
+            OrtConfigurationWrapper(
+                OrtConfiguration(
+                    packageCurationProviders = listOf(
+                        PackageCurationProviderConfiguration(
+                            name = "File",
+                            config = mapOf("path" to projectDir.resolve("gradle/curations.yml").path)
+                        )
+                    )
+                )
+            )
+        )
     }
 
     override suspend fun beforeTest(testCase: TestCase) {
@@ -186,29 +198,6 @@ class OrtMainFunTest : StringSpec() {
         }
 
         "Analyzer creates correct output" {
-            val expectedResult = patchExpectedResult(
-                projectDir.resolve("gradle-all-dependencies-expected-result.yml"),
-                url = vcsUrl,
-                revision = vcsRevision,
-                urlProcessed = normalizeVcsUrl(vcsUrl)
-            )
-
-            @Suppress("IgnoredReturnValue")
-            runMain(
-                "-c", configFile.path,
-                "-P", "ort.analyzer.enabledPackageManagers=Gradle",
-                "analyze",
-                "-i", projectDir.resolve("gradle").absolutePath,
-                "-o", outputDir.path
-            )
-
-            val analyzerResult = outputDir.resolve("analyzer-result.yml").readValue<OrtResult>()
-            val resolvedResult = analyzerResult.withResolvedScopes()
-
-            patchActualResult(resolvedResult, patchStartAndEndTime = true) shouldBe expectedResult
-        }
-
-        "Package curation data file is applied correctly" {
             val expectedResult = patchExpectedResult(
                 projectDir.resolve("gradle-all-dependencies-expected-result-with-curations.yml"),
                 url = vcsUrl,
@@ -222,8 +211,7 @@ class OrtMainFunTest : StringSpec() {
                 "-P", "ort.analyzer.enabledPackageManagers=Gradle",
                 "analyze",
                 "-i", projectDir.resolve("gradle").absolutePath,
-                "-o", outputDir.path,
-                "--package-curations-file", projectDir.resolve("gradle/curations.yml").toString()
+                "-o", outputDir.path
             )
 
             val analyzerResult = outputDir.resolve("analyzer-result.yml").readValue<OrtResult>()

cli/src/main/kotlin/commands/AnalyzerCommand.kt

@@ -28,7 +28,6 @@ import com.github.ajalt.clikt.parameters.options.convert
 import com.github.ajalt.clikt.parameters.options.default
 import com.github.ajalt.clikt.parameters.options.defaultLazy
 import com.github.ajalt.clikt.parameters.options.deprecated
-import com.github.ajalt.clikt.parameters.options.flag
 import com.github.ajalt.clikt.parameters.options.option
 import com.github.ajalt.clikt.parameters.options.required
 import com.github.ajalt.clikt.parameters.options.split
@@ -40,14 +39,11 @@ import java.time.Duration
 import kotlin.time.toKotlinDuration
 
 import org.ossreviewtoolkit.analyzer.Analyzer
+import org.ossreviewtoolkit.analyzer.PackageCurationProviderFactory
 import org.ossreviewtoolkit.analyzer.PackageManager
 import org.ossreviewtoolkit.analyzer.PackageManagerFactory
-import org.ossreviewtoolkit.analyzer.curation.ClearlyDefinedPackageCurationProvider
 import org.ossreviewtoolkit.analyzer.curation.CompositePackageCurationProvider
-import org.ossreviewtoolkit.analyzer.curation.FilePackageCurationProvider
-import org.ossreviewtoolkit.analyzer.curation.OrtConfigPackageCurationProvider
 import org.ossreviewtoolkit.analyzer.curation.SimplePackageCurationProvider
-import org.ossreviewtoolkit.analyzer.curation.Sw360PackageCurationProvider
 import org.ossreviewtoolkit.cli.OrtCommand
 import org.ossreviewtoolkit.cli.utils.SeverityStats
 import org.ossreviewtoolkit.cli.utils.configurationGroup
@@ -64,8 +60,6 @@ import org.ossreviewtoolkit.model.utils.DefaultResolutionProvider
 import org.ossreviewtoolkit.model.utils.mergeLabels
 import org.ossreviewtoolkit.utils.common.expandTilde
 import org.ossreviewtoolkit.utils.common.safeMkdirs
-import org.ossreviewtoolkit.utils.ort.ORT_PACKAGE_CURATIONS_DIRNAME
-import org.ossreviewtoolkit.utils.ort.ORT_PACKAGE_CURATIONS_FILENAME
 import org.ossreviewtoolkit.utils.ort.ORT_REPO_CONFIG_FILENAME
 import org.ossreviewtoolkit.utils.ort.ORT_RESOLUTIONS_FILENAME
 import org.ossreviewtoolkit.utils.ort.ortConfigDirectory
@@ -98,24 +92,6 @@ class AnalyzerCommand : OrtCommand(
         help = "The list of output formats to be used for the ORT result file(s)."
     ).enum<FileFormat>().split(",").default(listOf(FileFormat.YAML)).outputGroup()
 
-    private val packageCurationsFile by option(
-        "--package-curations-file",
-        help = "A file containing package curation data."
-    ).convert { it.expandTilde() }
-        .file(mustExist = true, canBeFile = true, canBeDir = false, mustBeWritable = false, mustBeReadable = true)
-        .convert { it.absoluteFile.normalize() }
-        .default(ortConfigDirectory.resolve(ORT_PACKAGE_CURATIONS_FILENAME))
-        .configurationGroup()
-
-    private val packageCurationsDir by option(
-        "--package-curations-dir",
-        help = "A directory containing package curation data."
-    ).convert { it.expandTilde() }
-        .file(mustExist = true, canBeFile = false, canBeDir = true, mustBeWritable = false, mustBeReadable = true)
-        .convert { it.absoluteFile.normalize() }
-        .default(ortConfigDirectory.resolve(ORT_PACKAGE_CURATIONS_DIRNAME))
-        .configurationGroup()
-
     private val repositoryConfigurationFile by option(
         "--repository-configuration-file",
         help = "A file containing the repository configuration. If set, overrides any repository configuration " +
@@ -135,21 +111,6 @@ class AnalyzerCommand : OrtCommand(
         .default(ortConfigDirectory.resolve(ORT_RESOLUTIONS_FILENAME))
         .configurationGroup()
 
-    private val useClearlyDefinedCurations by option(
-        "--clearly-defined-curations",
-        help = "Whether to fall back to package curation data from the ClearlyDefine service or not."
-    ).flag()
-
-    private val useOrtCurations by option(
-        "--ort-curations",
-        help = "Whether to fall back to package curation data from the ort-config repository or not."
-    ).flag()
-
-    private val useSw360Curations by option(
-        "--sw360-curations",
-        help = "Whether to fall back to package curation data from the SW360 service or not."
-    ).flag()
-
     private val labels by option(
         "--label", "-l",
         help = "Set a label in the ORT result, overwriting any existing label of the same name. Can be used multiple " +
@@ -199,8 +160,6 @@ class AnalyzerCommand : OrtCommand(
         }
 
         val configurationFiles = listOf(
-            packageCurationsFile,
-            packageCurationsDir,
             repositoryConfigurationFile,
             resolutionsFile
         )
@@ -232,15 +191,7 @@ class AnalyzerCommand : OrtCommand(
         val analyzer = Analyzer(analyzerConfiguration, labels)
 
         val curationProviders = buildList {
-            if (useClearlyDefinedCurations) add(ClearlyDefinedPackageCurationProvider())
-
-            if (useSw360Curations) {
-                ortConfig.analyzer.sw360Configuration?.let { add(Sw360PackageCurationProvider(it)) }
-            }
-
-            if (useOrtCurations) add(OrtConfigPackageCurationProvider())
-
-            add(FilePackageCurationProvider.from(packageCurationsFile, packageCurationsDir))
+            addAll(PackageCurationProviderFactory.create(ortConfig.packageCurationProviders))
 
             val repositoryPackageCurations = repositoryConfiguration.curations.packages