diff --git a/cli/src/funTest/kotlin/OrtMainFunTest.kt b/cli/src/funTest/kotlin/OrtMainFunTest.kt index f2f4897f1007e..e359762be9d90 100644 --- a/cli/src/funTest/kotlin/OrtMainFunTest.kt +++ b/cli/src/funTest/kotlin/OrtMainFunTest.kt @@ -38,7 +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.config.PluginConfiguration import org.ossreviewtoolkit.model.config.REFERENCE_CONFIG_FILENAME import org.ossreviewtoolkit.model.readValue import org.ossreviewtoolkit.model.writeValue @@ -70,7 +70,7 @@ class OrtMainFunTest : StringSpec() { OrtConfigurationWrapper( OrtConfiguration( packageCurationProviders = listOf( - PackageCurationProviderConfiguration( + PluginConfiguration( type = "File", config = mapOf("path" to projectDir.resolve("gradle/curations.yml").path) ) diff --git a/model/src/main/kotlin/config/OrtConfiguration.kt b/model/src/main/kotlin/config/OrtConfiguration.kt index 227fbae423dd5..31ac9422dc54a 100644 --- a/model/src/main/kotlin/config/OrtConfiguration.kt +++ b/model/src/main/kotlin/config/OrtConfiguration.kt @@ -85,9 +85,9 @@ data class OrtConfiguration( * the priority of the providers: Providers that appear earlier in the list can overwrite curations for the same * package from providers that appear later in the list. */ - val packageCurationProviders: List = listOf( - PackageCurationProviderConfiguration(type = "DefaultDir"), - PackageCurationProviderConfiguration(type = "DefaultFile") + val packageCurationProviders: List = listOf( + PluginConfiguration(type = "DefaultDir"), + PluginConfiguration(type = "DefaultFile") ), /** diff --git a/model/src/main/kotlin/config/PackageCurationProviderConfiguration.kt b/model/src/main/kotlin/config/PluginConfiguration.kt similarity index 72% rename from model/src/main/kotlin/config/PackageCurationProviderConfiguration.kt rename to model/src/main/kotlin/config/PluginConfiguration.kt index de838d9493a9b..6bf605bcc504d 100644 --- a/model/src/main/kotlin/config/PackageCurationProviderConfiguration.kt +++ b/model/src/main/kotlin/config/PluginConfiguration.kt @@ -23,26 +23,26 @@ import com.sksamuel.hoplite.ConfigAlias import org.ossreviewtoolkit.utils.common.Plugin -data class PackageCurationProviderConfiguration( +data class PluginConfiguration( /** - * The [type][Plugin.type] of the package curation provider. + * The [type][Plugin.type] of the plugin to configure. */ @ConfigAlias("name") val type: String, /** - * A unique identifier for the package curation provider. + * A unique identifier for the plugin instance to be created, to distinguish plugins of the same type but with + * different configuration. */ val id: String = type, /** - * Whether this curation provider is enabled. + * A flag to indicate whether this plugin should be enabled or not. */ val enabled: Boolean = true, /** - * The configuration of the package curation provider. See the specific implementation for available configuration - * options. + * The configuration of the plugin. See the specific implementations for available configuration options. */ val config: Map = emptyMap() ) diff --git a/model/src/test/kotlin/config/OrtConfigurationTest.kt b/model/src/test/kotlin/config/OrtConfigurationTest.kt index 172f331b0f214..2a8296e76088c 100644 --- a/model/src/test/kotlin/config/OrtConfigurationTest.kt +++ b/model/src/test/kotlin/config/OrtConfigurationTest.kt @@ -64,24 +64,24 @@ class OrtConfigurationTest : WordSpec({ } ortConfig.packageCurationProviders should containExactly( - PackageCurationProviderConfiguration(type = "DefaultFile"), - PackageCurationProviderConfiguration(type = "DefaultDir"), - PackageCurationProviderConfiguration( + PluginConfiguration(type = "DefaultFile"), + PluginConfiguration(type = "DefaultDir"), + PluginConfiguration( type = "File", id = "SomeCurationsFile", config = mapOf("path" to "/some-path/curations.yml", "mustExist" to "true") ), - PackageCurationProviderConfiguration( + PluginConfiguration( type = "File", id = "SomeCurationsDir", config = mapOf("path" to "/some-path/curations-dir", "mustExist" to "false") ), - PackageCurationProviderConfiguration(type = "OrtConfig", enabled = true), - PackageCurationProviderConfiguration( + PluginConfiguration(type = "OrtConfig", enabled = true), + PluginConfiguration( type = "ClearlyDefined", config = mapOf("serverUrl" to "https://api.clearlydefined.io", "minTotalLicenseScore" to "80") ), - PackageCurationProviderConfiguration( + PluginConfiguration( type = "SW360", config = mapOf( "restUrl" to "https://your-sw360-rest-url", diff --git a/plugins/package-curation-providers/api/src/main/kotlin/PackageCurationProviderFactory.kt b/plugins/package-curation-providers/api/src/main/kotlin/PackageCurationProviderFactory.kt index 63e470d747667..043e9f72f7c43 100644 --- a/plugins/package-curation-providers/api/src/main/kotlin/PackageCurationProviderFactory.kt +++ b/plugins/package-curation-providers/api/src/main/kotlin/PackageCurationProviderFactory.kt @@ -20,7 +20,7 @@ package org.ossreviewtoolkit.plugins.packagecurationproviders.api import org.ossreviewtoolkit.model.ResolvedPackageCurations.Companion.REPOSITORY_CONFIGURATION_PROVIDER_ID -import org.ossreviewtoolkit.model.config.PackageCurationProviderConfiguration +import org.ossreviewtoolkit.model.config.PluginConfiguration import org.ossreviewtoolkit.model.utils.PackageCurationProvider import org.ossreviewtoolkit.utils.common.ConfigurablePluginFactory import org.ossreviewtoolkit.utils.common.Plugin @@ -34,12 +34,12 @@ interface PackageCurationProviderFactory : ConfigurablePluginFactory>() /** - * Return a new (identifier, provider instance) tuple for each - * [enabled][PackageCurationProviderConfiguration.enabled] provider configuration in [configurations] ordered - * highest-priority first. The given [configurations] must be ordered highest-priority first as well. + * Return a new (identifier, provider instance) tuple for each [enabled][PluginConfiguration.enabled] provider + * configuration in [configurations] ordered highest-priority first. The given [configurations] must be ordered + * highest-priority first as well. */ fun create( - configurations: List + configurations: List ): List> = configurations.filter { it.enabled