refactor(model)!: Simplify constructor of DefaultLicenseInfoProvider

All callers have been changed to include the package configuration from the provider into the `OrtResult` before passing it to that constructor. So, the parameter `packageConfigurationProvider` has become redundant and can be removed. Signed-off-by: Frank Viernau <[email protected]>
oss-review-toolkit · Jan 16, 2024 · 4e4c475 · 4e4c475
1 parent 79fcd67
commit 4e4c475
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 20 deletions.
diff --git a/helper-cli/src/main/kotlin/utils/Extensions.kt b/helper-cli/src/main/kotlin/utils/Extensions.kt
@@ -113,7 +113,6 @@ internal fun OrtResult.processAllCopyrightStatements(
     val result = mutableListOf<ProcessedCopyrightStatement>()
 
     val licenseInfoResolver = createLicenseInfoResolver(
-        packageConfigurationProvider = this,
         copyrightGarbage = CopyrightGarbage(copyrightGarbage.toSortedSet()),
         addAuthorsToCopyrights = addAuthorsToCopyrights
     )

diff --git a/model/src/main/kotlin/licenses/DefaultLicenseInfoProvider.kt b/model/src/main/kotlin/licenses/DefaultLicenseInfoProvider.kt
@@ -27,17 +27,13 @@ import org.ossreviewtoolkit.model.OrtResult
 import org.ossreviewtoolkit.model.Provenance
 import org.ossreviewtoolkit.model.config.LicenseFindingCuration
 import org.ossreviewtoolkit.model.config.PathExclude
-import org.ossreviewtoolkit.model.utils.PackageConfigurationProvider
 import org.ossreviewtoolkit.model.utils.filterByVcsPath
 import org.ossreviewtoolkit.utils.ort.ProcessedDeclaredLicense
 
 /**
  * The default [LicenseInfoProvider] that collects license information from an [ortResult].
  */
-class DefaultLicenseInfoProvider(
-    val ortResult: OrtResult,
-    private val packageConfigurationProvider: PackageConfigurationProvider
-) : LicenseInfoProvider {
+class DefaultLicenseInfoProvider(val ortResult: OrtResult) : LicenseInfoProvider {
     private val licenseInfo: ConcurrentMap<Identifier, LicenseInfo> = ConcurrentHashMap()
 
     override fun get(id: Identifier) = licenseInfo.getOrPut(id) { createLicenseInfo(id) }
@@ -112,7 +108,7 @@ class DefaultLicenseInfoProvider(
                 ortResult.repository.config.excludes.paths,
                 ortResult.repository.getRelativePath(project.vcsProcessed).orEmpty()
             )
-        } ?: packageConfigurationProvider.getPackageConfigurations(id, provenance).let { packageConfigurations ->
+        } ?: ortResult.getPackageConfigurations(id, provenance).let { packageConfigurations ->
             Configuration(
                 packageConfigurations.flatMap { it.licenseFindingCurations },
                 packageConfigurations.flatMap { it.pathExcludes },

diff --git a/model/src/main/kotlin/utils/OrtResultExtensions.kt b/model/src/main/kotlin/utils/OrtResultExtensions.kt
@@ -70,12 +70,11 @@ fun OrtResult.setResolutions(resolutionProvider: ResolutionProvider): OrtResult
  * instead of calling this function multiple times for better performance.
  */
 fun OrtResult.createLicenseInfoResolver(
-    packageConfigurationProvider: PackageConfigurationProvider = PackageConfigurationProvider.EMPTY,
     copyrightGarbage: CopyrightGarbage = CopyrightGarbage(),
     addAuthorsToCopyrights: Boolean = false,
     archiver: FileArchiver? = null
 ) = LicenseInfoResolver(
-    DefaultLicenseInfoProvider(this, packageConfigurationProvider),
+    DefaultLicenseInfoProvider(this),
     copyrightGarbage,
     addAuthorsToCopyrights,
     archiver,

diff --git a/model/src/test/kotlin/licenses/DefaultLicenseInfoProviderTest.kt b/model/src/test/kotlin/licenses/DefaultLicenseInfoProviderTest.kt
@@ -22,10 +22,8 @@ package org.ossreviewtoolkit.model.licenses
 import io.kotest.core.spec.style.WordSpec
 import io.kotest.matchers.shouldBe
 
-import org.ossreviewtoolkit.model.utils.PackageConfigurationProvider
-
 class DefaultLicenseInfoProviderTest : WordSpec({
-    val defaultLicenseInfoProvider = DefaultLicenseInfoProvider(ortResult, PackageConfigurationProvider.EMPTY)
+    val defaultLicenseInfoProvider = DefaultLicenseInfoProvider(ortResult)
 
     "declaredLicenseInfo" should {
         "contain author information for package" {

diff --git a/model/src/test/kotlin/licenses/LicenseViewTest.kt b/model/src/test/kotlin/licenses/LicenseViewTest.kt
@@ -29,14 +29,13 @@ import org.ossreviewtoolkit.model.LicenseSource
 import org.ossreviewtoolkit.model.Package
 import org.ossreviewtoolkit.model.config.CopyrightGarbage
 import org.ossreviewtoolkit.model.utils.FileArchiver
-import org.ossreviewtoolkit.model.utils.PackageConfigurationProvider
 import org.ossreviewtoolkit.utils.spdx.SpdxSingleLicenseExpression
 import org.ossreviewtoolkit.utils.test.createDefault
 import org.ossreviewtoolkit.utils.test.transformingCollectionMatcher
 
 class LicenseViewTest : WordSpec() {
     private val licenseInfoResolver = LicenseInfoResolver(
-        provider = DefaultLicenseInfoProvider(ortResult, PackageConfigurationProvider.EMPTY),
+        provider = DefaultLicenseInfoProvider(ortResult),
         copyrightGarbage = CopyrightGarbage(),
         addAuthorsToCopyrights = false,
         archiver = FileArchiver.createDefault()

diff --git a/plugins/commands/evaluator/src/main/kotlin/EvaluatorCommand.kt b/plugins/commands/evaluator/src/main/kotlin/EvaluatorCommand.kt
@@ -302,10 +302,7 @@ class EvaluatorCommand : OrtCommand(
         val copyrightGarbage = copyrightGarbageFile.takeIf { it.isFile }?.readValue<CopyrightGarbage>().orEmpty()
 
         val licenseInfoResolver = LicenseInfoResolver(
-            provider = DefaultLicenseInfoProvider(
-                ortResult = ortResultInput,
-                packageConfigurationProvider = ortResultInput
-            ),
+            provider = DefaultLicenseInfoProvider(ortResultInput),
             copyrightGarbage = copyrightGarbage,
             addAuthorsToCopyrights = ortConfig.addAuthorsToCopyrights,
             archiver = ortConfig.scanner.archive.createFileArchiver(),

diff --git a/plugins/commands/reporter/src/main/kotlin/ReporterCommand.kt b/plugins/commands/reporter/src/main/kotlin/ReporterCommand.kt
@@ -240,7 +240,7 @@ class ReporterCommand : OrtCommand(
         val copyrightGarbage = copyrightGarbageFile.takeIf { it.isFile }?.readValue<CopyrightGarbage>().orEmpty()
 
         val licenseInfoResolver = LicenseInfoResolver(
-            provider = DefaultLicenseInfoProvider(ortResult, packageConfigurationProvider),
+            provider = DefaultLicenseInfoProvider(ortResult),
             copyrightGarbage = copyrightGarbage,
             addAuthorsToCopyrights = ortConfig.addAuthorsToCopyrights,
             archiver = ortConfig.scanner.archive.createFileArchiver(),

diff --git a/reporter/src/main/kotlin/ReporterInput.kt b/reporter/src/main/kotlin/ReporterInput.kt
@@ -64,7 +64,7 @@ data class ReporterInput(
      * A resolver for license information for the projects and packages contained in [ortResult].
      */
     val licenseInfoResolver: LicenseInfoResolver = LicenseInfoResolver(
-        provider = DefaultLicenseInfoProvider(ortResult, packageConfigurationProvider),
+        provider = DefaultLicenseInfoProvider(ortResult),
         copyrightGarbage = copyrightGarbage,
         addAuthorsToCopyrights = ortConfig.addAuthorsToCopyrights,
         archiver = ortConfig.scanner.archive.createFileArchiver(),