Skip to content

Commit 5cfca01

Browse files
committed
refactor(model): Use PluginConfiguration as a class name
Rename `PackageCurationProviderConfiguration` to `PluginConfiguration` as a preparation for using it beyond `PackageCurationProvider`s. Signed-off-by: Sebastian Schuberth <[email protected]>
1 parent 56400c1 commit 5cfca01

File tree

5 files changed

+23
-23
lines changed

5 files changed

+23
-23
lines changed

cli/src/funTest/kotlin/OrtMainFunTest.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ import org.ossreviewtoolkit.downloader.VersionControlSystem
3838
import org.ossreviewtoolkit.model.OrtResult
3939
import org.ossreviewtoolkit.model.config.OrtConfiguration
4040
import org.ossreviewtoolkit.model.config.OrtConfigurationWrapper
41-
import org.ossreviewtoolkit.model.config.PackageCurationProviderConfiguration
41+
import org.ossreviewtoolkit.model.config.PluginConfiguration
4242
import org.ossreviewtoolkit.model.config.REFERENCE_CONFIG_FILENAME
4343
import org.ossreviewtoolkit.model.readValue
4444
import org.ossreviewtoolkit.model.writeValue
@@ -70,7 +70,7 @@ class OrtMainFunTest : StringSpec() {
7070
OrtConfigurationWrapper(
7171
OrtConfiguration(
7272
packageCurationProviders = listOf(
73-
PackageCurationProviderConfiguration(
73+
PluginConfiguration(
7474
type = "File",
7575
config = mapOf("path" to projectDir.resolve("gradle/curations.yml").path)
7676
)

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,9 @@ data class OrtConfiguration(
8585
* the priority of the providers: Providers that appear earlier in the list can overwrite curations for the same
8686
* package from providers that appear later in the list.
8787
*/
88-
val packageCurationProviders: List<PackageCurationProviderConfiguration> = listOf(
89-
PackageCurationProviderConfiguration(type = "DefaultDir"),
90-
PackageCurationProviderConfiguration(type = "DefaultFile")
88+
val packageCurationProviders: List<PluginConfiguration> = listOf(
89+
PluginConfiguration(type = "DefaultDir"),
90+
PluginConfiguration(type = "DefaultFile")
9191
),
9292

9393
/**

model/src/main/kotlin/config/PackageCurationProviderConfiguration.kt renamed to model/src/main/kotlin/config/PluginConfiguration.kt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,26 +23,26 @@ import com.sksamuel.hoplite.ConfigAlias
2323

2424
import org.ossreviewtoolkit.utils.common.Plugin
2525

26-
data class PackageCurationProviderConfiguration(
26+
data class PluginConfiguration(
2727
/**
28-
* The [type][Plugin.type] of the package curation provider.
28+
* The [type][Plugin.type] of the plugin to configure.
2929
*/
3030
@ConfigAlias("name")
3131
val type: String,
3232

3333
/**
34-
* A unique identifier for the package curation provider.
34+
* A unique identifier for the plugin instance to be created, to distinguish plugins of the same type but with
35+
* different configuration.
3536
*/
3637
val id: String = type,
3738

3839
/**
39-
* Whether this curation provider is enabled.
40+
* A flag to indicate whether this plugin should be enabled or not.
4041
*/
4142
val enabled: Boolean = true,
4243

4344
/**
44-
* The configuration of the package curation provider. See the specific implementation for available configuration
45-
* options.
45+
* The configuration of the plugin. See the specific implementations for available configuration options.
4646
*/
4747
val config: Map<String, String> = emptyMap()
4848
)

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,24 +64,24 @@ class OrtConfigurationTest : WordSpec({
6464
}
6565

6666
ortConfig.packageCurationProviders should containExactly(
67-
PackageCurationProviderConfiguration(type = "DefaultFile"),
68-
PackageCurationProviderConfiguration(type = "DefaultDir"),
69-
PackageCurationProviderConfiguration(
67+
PluginConfiguration(type = "DefaultFile"),
68+
PluginConfiguration(type = "DefaultDir"),
69+
PluginConfiguration(
7070
type = "File",
7171
id = "SomeCurationsFile",
7272
config = mapOf("path" to "/some-path/curations.yml", "mustExist" to "true")
7373
),
74-
PackageCurationProviderConfiguration(
74+
PluginConfiguration(
7575
type = "File",
7676
id = "SomeCurationsDir",
7777
config = mapOf("path" to "/some-path/curations-dir", "mustExist" to "false")
7878
),
79-
PackageCurationProviderConfiguration(type = "OrtConfig", enabled = true),
80-
PackageCurationProviderConfiguration(
79+
PluginConfiguration(type = "OrtConfig", enabled = true),
80+
PluginConfiguration(
8181
type = "ClearlyDefined",
8282
config = mapOf("serverUrl" to "https://api.clearlydefined.io", "minTotalLicenseScore" to "80")
8383
),
84-
PackageCurationProviderConfiguration(
84+
PluginConfiguration(
8585
type = "SW360",
8686
config = mapOf(
8787
"restUrl" to "https://your-sw360-rest-url",

plugins/package-curation-providers/api/src/main/kotlin/PackageCurationProviderFactory.kt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
package org.ossreviewtoolkit.plugins.packagecurationproviders.api
2121

2222
import org.ossreviewtoolkit.model.ResolvedPackageCurations.Companion.REPOSITORY_CONFIGURATION_PROVIDER_ID
23-
import org.ossreviewtoolkit.model.config.PackageCurationProviderConfiguration
23+
import org.ossreviewtoolkit.model.config.PluginConfiguration
2424
import org.ossreviewtoolkit.model.utils.PackageCurationProvider
2525
import org.ossreviewtoolkit.utils.common.ConfigurablePluginFactory
2626
import org.ossreviewtoolkit.utils.common.Plugin
@@ -34,12 +34,12 @@ interface PackageCurationProviderFactory<CONFIG> : ConfigurablePluginFactory<Pac
3434
val ALL = Plugin.getAll<PackageCurationProviderFactory<*>>()
3535

3636
/**
37-
* Return a new (identifier, provider instance) tuple for each
38-
* [enabled][PackageCurationProviderConfiguration.enabled] provider configuration in [configurations] ordered
39-
* highest-priority first. The given [configurations] must be ordered highest-priority first as well.
37+
* Return a new (identifier, provider instance) tuple for each [enabled][PluginConfiguration.enabled] provider
38+
* configuration in [configurations] ordered highest-priority first. The given [configurations] must be ordered
39+
* highest-priority first as well.
4040
*/
4141
fun create(
42-
configurations: List<PackageCurationProviderConfiguration>
42+
configurations: List<PluginConfiguration>
4343
): List<Pair<String, PackageCurationProvider>> =
4444
configurations.filter {
4545
it.enabled

0 commit comments

Comments
 (0)