refactor!: Move PackageCurationProvider from model to plugin API

Move the `PackageCurationProvider` interface from the `model` module to `:plugins:package-curation-providers:api`. This is a requirement for migration package curation providers to the new plugin API, as the `model` module cannot depend on `:plugins:api`. Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>
oss-review-toolkit · Sep 2, 2024 · 90accbb · 90accbb
1 parent 3c8b32a
commit 90accbb
Show file tree

Hide file tree

Showing 11 changed files with 8 additions and 10 deletions.
diff --git a/analyzer/src/main/kotlin/Analyzer.kt b/analyzer/src/main/kotlin/Analyzer.kt
@@ -46,7 +46,7 @@ import org.ossreviewtoolkit.model.config.Excludes
 import org.ossreviewtoolkit.model.config.RepositoryConfiguration
 import org.ossreviewtoolkit.model.orEmpty
 import org.ossreviewtoolkit.model.toYaml
-import org.ossreviewtoolkit.model.utils.PackageCurationProvider
+import org.ossreviewtoolkit.plugins.packagecurationproviders.api.PackageCurationProvider
 import org.ossreviewtoolkit.utils.common.CommandLineTool
 import org.ossreviewtoolkit.utils.common.VCS_DIRECTORIES
 import org.ossreviewtoolkit.utils.config.setPackageCurations

diff --git a/...n/kotlin/utils/PackageCurationProvider.kt → ...rc/main/kotlin/PackageCurationProvider.kt b/...n/kotlin/utils/PackageCurationProvider.kt → ...rc/main/kotlin/PackageCurationProvider.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.model.utils
+package org.ossreviewtoolkit.plugins.packagecurationproviders.api
 
 import org.ossreviewtoolkit.model.Package
 import org.ossreviewtoolkit.model.PackageCuration

diff --git a/plugins/package-curation-providers/api/src/main/kotlin/PackageCurationProviderFactory.kt b/plugins/package-curation-providers/api/src/main/kotlin/PackageCurationProviderFactory.kt
@@ -23,7 +23,6 @@ import org.apache.logging.log4j.kotlin.logger
 
 import org.ossreviewtoolkit.model.ResolvedPackageCurations.Companion.REPOSITORY_CONFIGURATION_PROVIDER_ID
 import org.ossreviewtoolkit.model.config.ProviderPluginConfiguration
-import org.ossreviewtoolkit.model.utils.PackageCurationProvider
 import org.ossreviewtoolkit.utils.common.Plugin
 import org.ossreviewtoolkit.utils.common.TypedConfigurablePluginFactory
 import org.ossreviewtoolkit.utils.common.getDuplicates

diff --git a/plugins/package-curation-providers/api/src/main/kotlin/SimplePackageCurationProvider.kt b/plugins/package-curation-providers/api/src/main/kotlin/SimplePackageCurationProvider.kt
@@ -21,7 +21,6 @@ package org.ossreviewtoolkit.plugins.packagecurationproviders.api
 
 import org.ossreviewtoolkit.model.Package
 import org.ossreviewtoolkit.model.PackageCuration
-import org.ossreviewtoolkit.model.utils.PackageCurationProvider
 
 /**
  * A [PackageCurationProvider] that provides the specified [packageCurations].

diff --git a/...ration-providers/clearly-defined/src/main/kotlin/ClearlyDefinedPackageCurationProvider.kt b/...ration-providers/clearly-defined/src/main/kotlin/ClearlyDefinedPackageCurationProvider.kt
@@ -40,8 +40,8 @@ import org.ossreviewtoolkit.model.PackageCurationData
 import org.ossreviewtoolkit.model.RemoteArtifact
 import org.ossreviewtoolkit.model.VcsInfoCurationData
 import org.ossreviewtoolkit.model.VcsType
-import org.ossreviewtoolkit.model.utils.PackageCurationProvider
 import org.ossreviewtoolkit.model.utils.toClearlyDefinedCoordinates
+import org.ossreviewtoolkit.plugins.packagecurationproviders.api.PackageCurationProvider
 import org.ossreviewtoolkit.plugins.packagecurationproviders.api.PackageCurationProviderFactory
 import org.ossreviewtoolkit.utils.common.Options
 import org.ossreviewtoolkit.utils.common.collectMessages

diff --git a/plugins/package-curation-providers/file/src/main/kotlin/FilePackageCurationProvider.kt b/plugins/package-curation-providers/file/src/main/kotlin/FilePackageCurationProvider.kt
@@ -25,7 +25,6 @@ import java.io.IOException
 import org.ossreviewtoolkit.model.FileFormat
 import org.ossreviewtoolkit.model.PackageCuration
 import org.ossreviewtoolkit.model.readValue
-import org.ossreviewtoolkit.model.utils.PackageCurationProvider
 import org.ossreviewtoolkit.plugins.packagecurationproviders.api.PackageCurationProviderFactory
 import org.ossreviewtoolkit.plugins.packagecurationproviders.api.SimplePackageCurationProvider
 import org.ossreviewtoolkit.utils.common.Options

diff --git a/...package-curation-providers/ort-config/src/main/kotlin/OrtConfigPackageCurationProvider.kt b/...package-curation-providers/ort-config/src/main/kotlin/OrtConfigPackageCurationProvider.kt
@@ -31,7 +31,7 @@ import org.ossreviewtoolkit.model.PackageCuration
 import org.ossreviewtoolkit.model.VcsInfo
 import org.ossreviewtoolkit.model.VcsType
 import org.ossreviewtoolkit.model.readValue
-import org.ossreviewtoolkit.model.utils.PackageCurationProvider
+import org.ossreviewtoolkit.plugins.packagecurationproviders.api.PackageCurationProvider
 import org.ossreviewtoolkit.plugins.packagecurationproviders.api.PackageCurationProviderFactory
 import org.ossreviewtoolkit.utils.common.Options
 import org.ossreviewtoolkit.utils.common.encodeOr

diff --git a/plugins/package-curation-providers/sw360/src/main/kotlin/Sw360PackageCurationProvider.kt b/plugins/package-curation-providers/sw360/src/main/kotlin/Sw360PackageCurationProvider.kt
@@ -42,7 +42,7 @@ import org.ossreviewtoolkit.model.RemoteArtifact
 import org.ossreviewtoolkit.model.config.Sw360StorageConfiguration
 import org.ossreviewtoolkit.model.jsonMapper
 import org.ossreviewtoolkit.model.orEmpty
-import org.ossreviewtoolkit.model.utils.PackageCurationProvider
+import org.ossreviewtoolkit.plugins.packagecurationproviders.api.PackageCurationProvider
 import org.ossreviewtoolkit.plugins.packagecurationproviders.api.PackageCurationProviderFactory
 import org.ossreviewtoolkit.utils.common.Options
 import org.ossreviewtoolkit.utils.ort.DeclaredLicenseProcessor

diff --git a/utils/config/build.gradle.kts b/utils/config/build.gradle.kts
@@ -24,4 +24,5 @@ plugins {
 
 dependencies {
     api(projects.model)
+    api(projects.plugins.packageCurationProviders.packageCurationProviderApi)
 }
diff --git a/utils/config/src/main/kotlin/ConfigurationResolver.kt b/utils/config/src/main/kotlin/ConfigurationResolver.kt
@@ -33,9 +33,9 @@ import org.ossreviewtoolkit.model.ScanResult
 import org.ossreviewtoolkit.model.config.PackageConfiguration
 import org.ossreviewtoolkit.model.config.Resolutions
 import org.ossreviewtoolkit.model.utils.PackageConfigurationProvider
-import org.ossreviewtoolkit.model.utils.PackageCurationProvider
 import org.ossreviewtoolkit.model.utils.ResolutionProvider
 import org.ossreviewtoolkit.model.vulnerabilities.Vulnerability
+import org.ossreviewtoolkit.plugins.packagecurationproviders.api.PackageCurationProvider
 
 object ConfigurationResolver {
     /**

diff --git a/utils/config/src/main/kotlin/OrtResultExtensions.kt b/utils/config/src/main/kotlin/OrtResultExtensions.kt
@@ -21,8 +21,8 @@ package org.ossreviewtoolkit.utils.config
 
 import org.ossreviewtoolkit.model.OrtResult
 import org.ossreviewtoolkit.model.utils.PackageConfigurationProvider
-import org.ossreviewtoolkit.model.utils.PackageCurationProvider
 import org.ossreviewtoolkit.model.utils.ResolutionProvider
+import org.ossreviewtoolkit.plugins.packagecurationproviders.api.PackageCurationProvider
 
 /**
  * Replace the package configurations in [OrtResult.resolvedConfiguration] with the ones obtained from