Skip to content

Commit

Permalink
refactor(reporter)!: Remove ReporterInput.resolutionProvider
Browse files Browse the repository at this point in the history
The reporter command ensures that all resolutions are contained in the
ORT result. So, the resolution provider is not necessary anymore.

Signed-off-by: Frank Viernau <frank_viernau@epam.com>
  • Loading branch information
fviernau committed Dec 13, 2023
1 parent 07b5473 commit 967a269
Show file tree
Hide file tree
Showing 5 changed files with 1 addition and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,6 @@ class ReporterCommand : OrtCommand(
ortResult,
ortConfig,
packageConfigurationProvider,
DefaultResolutionProvider(ortResult.getResolutions()),
DefaultLicenseTextProvider(licenseTextDirectories),
copyrightGarbage,
licenseInfoResolver,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ import io.kotest.matchers.shouldBe
import org.ossreviewtoolkit.model.FileFormat
import org.ossreviewtoolkit.model.OrtResult
import org.ossreviewtoolkit.model.config.PluginConfiguration
import org.ossreviewtoolkit.model.utils.DefaultResolutionProvider
import org.ossreviewtoolkit.reporter.ReporterInput
import org.ossreviewtoolkit.utils.common.normalizeLineBreaks
import org.ossreviewtoolkit.utils.test.getAssetAsString
Expand Down Expand Up @@ -66,7 +65,6 @@ class EvaluatedModelReporterFunTest : WordSpec({
private fun TestConfiguration.generateReport(ortResult: OrtResult, options: Map<String, String> = emptyMap()): String {
val input = ReporterInput(
ortResult = ortResult,
resolutionProvider = DefaultResolutionProvider.create(ortResult),
howToFixTextProvider = { "Some how to fix text." }
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ import io.kotest.matchers.shouldBe
import io.kotest.matchers.string.shouldContain

import org.ossreviewtoolkit.model.OrtResult
import org.ossreviewtoolkit.model.utils.DefaultResolutionProvider
import org.ossreviewtoolkit.reporter.ReporterInput
import org.ossreviewtoolkit.utils.common.normalizeLineBreaks
import org.ossreviewtoolkit.utils.common.unpackZip
Expand Down Expand Up @@ -59,10 +58,7 @@ class OpossumReporterFunTest : WordSpec({
})

private fun TestConfiguration.generateReport(ortResult: OrtResult): String {
val input = ReporterInput(
ortResult = ortResult,
resolutionProvider = DefaultResolutionProvider(ortResult.getRepositoryConfigResolutions())
)
val input = ReporterInput(ortResult = ortResult)

val outputDir = tempdir()
OpossumReporter().generateReport(input, outputDir).single().unpackZip(outputDir)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ import io.kotest.matchers.shouldBe
import javax.xml.transform.TransformerFactory

import org.ossreviewtoolkit.model.OrtResult
import org.ossreviewtoolkit.model.utils.DefaultResolutionProvider
import org.ossreviewtoolkit.reporter.HowToFixTextProvider
import org.ossreviewtoolkit.reporter.ReporterInput
import org.ossreviewtoolkit.utils.ort.Environment
Expand Down Expand Up @@ -70,7 +69,6 @@ class StaticHtmlReporterFunTest : WordSpec({
private fun TestConfiguration.generateReport(ortResult: OrtResult): String {
val input = ReporterInput(
ortResult = ortResult,
resolutionProvider = DefaultResolutionProvider.create(ortResult),
howToFixTextProvider = HOW_TO_FIX_TEXT_PROVIDER
)

Expand Down
8 changes: 0 additions & 8 deletions reporter/src/main/kotlin/ReporterInput.kt
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,14 @@ package org.ossreviewtoolkit.reporter

import org.ossreviewtoolkit.model.Issue
import org.ossreviewtoolkit.model.OrtResult
import org.ossreviewtoolkit.model.RuleViolation
import org.ossreviewtoolkit.model.config.CopyrightGarbage
import org.ossreviewtoolkit.model.config.OrtConfiguration
import org.ossreviewtoolkit.model.config.PackageConfiguration
import org.ossreviewtoolkit.model.config.createFileArchiver
import org.ossreviewtoolkit.model.licenses.DefaultLicenseInfoProvider
import org.ossreviewtoolkit.model.licenses.LicenseClassifications
import org.ossreviewtoolkit.model.licenses.LicenseInfoResolver
import org.ossreviewtoolkit.model.utils.DefaultResolutionProvider
import org.ossreviewtoolkit.model.utils.PackageConfigurationProvider
import org.ossreviewtoolkit.model.utils.ResolutionProvider
import org.ossreviewtoolkit.reporter.StatisticsCalculator.getStatistics

/**
Expand All @@ -53,11 +50,6 @@ data class ReporterInput(
*/
val packageConfigurationProvider: PackageConfigurationProvider = PackageConfigurationProvider.EMPTY,

/**
* A [ResolutionProvider], can be used to check which [Issue]s and [RuleViolation]s are resolved.
*/
val resolutionProvider: ResolutionProvider = DefaultResolutionProvider(),

/**
* A [LicenseTextProvider], can be used to integrate licenses texts into reports.
*/
Expand Down

0 comments on commit 967a269

Please sign in to comment.