feat(reporter)!: Use the configured license fact providers

Change the `ReporterInput` to use a `LicenseFactProvider` instead of a
`LicenseTextProvider`.

The `ReporterCommand` now creates the license fact providers based on
the ORT configuration and support for the `--custom-license-texts-dir`
option is dropped. Instead, a custom license text directory now has to
be configured in the `config.yml`.

Templates for the Freemarker or AsciiDoc reporters must also be updated
to use `licenseFactProvider` instead of `licenseTextProvider`.

Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>

Author: mnonnenmacher

cli/build.gradle.kts

@@ -49,6 +49,7 @@ dependencies {
     } else {
         "pluginClasspath"(platform(projects.plugins.advisors))
         "pluginClasspath"(platform(projects.plugins.commands))
+        "pluginClasspath"(platform(projects.plugins.licenseFactProviders))
         "pluginClasspath"(platform(projects.plugins.packageConfigurationProviders))
         "pluginClasspath"(platform(projects.plugins.packageCurationProviders))
         "pluginClasspath"(platform(projects.plugins.packageManagers))

integrations/completions/ort-completion.bash

@@ -1152,12 +1152,6 @@ _ort_report() {
           [[ ${i} -gt COMP_CWORD ]] && in_param='--copyright-garbage-file' || in_param=''
           continue
           ;;
-        --custom-license-texts-dir)
-          __skip_opt_eq
-          (( i = i + 1 ))
-          [[ ${i} -gt COMP_CWORD ]] && in_param='--custom-license-texts-dir' || in_param=''
-          continue
-          ;;
         --how-to-fix-text-provider-script)
           __skip_opt_eq
           (( i = i + 1 ))
@@ -1216,7 +1210,7 @@ _ort_report() {
   done
   local word="${COMP_WORDS[$COMP_CWORD]}"
   if [[ "${word}" =~ ^[-] ]]; then
-    COMPREPLY=($(compgen -W '--ort-file -i --output-dir -o --report-formats -f --copyright-garbage-file --custom-license-texts-dir --how-to-fix-text-provider-script --license-classifications-file --package-configurations-dir --refresh-resolutions --repository-configuration-file --resolutions-file --report-option -O -h --help' -- "${word}"))
+    COMPREPLY=($(compgen -W '--ort-file -i --output-dir -o --report-formats -f --copyright-garbage-file --how-to-fix-text-provider-script --license-classifications-file --package-configurations-dir --refresh-resolutions --repository-configuration-file --resolutions-file --report-option -O -h --help' -- "${word}"))
     return
   fi
 
@@ -1237,9 +1231,6 @@ _ort_report() {
     "--copyright-garbage-file")
        __complete_files "${word}"
       ;;
-    "--custom-license-texts-dir")
-       __complete_files "${word}"
-      ;;
     "--how-to-fix-text-provider-script")
        __complete_files "${word}"
       ;;

integrations/completions/ort-completion.fish

@@ -151,7 +151,6 @@ complete -c ort -n "__fish_seen_subcommand_from report" -l ort-file -s i -r -F -
 complete -c ort -n "__fish_seen_subcommand_from report" -l output-dir -s o -r -F -d 'The output directory to store the generated reports in.'
 complete -c ort -n "__fish_seen_subcommand_from report" -l report-formats -s f -r -d 'A comma-separated list of report formats to generate, any of [AOSD2.0, AOSD2.1, CtrlXAutomation, CycloneDX, DocBookTemplate, EvaluatedModel, FossID, FossIdSnippet, HtmlTemplate, ManPageTemplate, Opossum, PdfTemplate, PlainTextTemplate, SpdxDocument, StaticHTML, TrustSource, WebApp].'
 complete -c ort -n "__fish_seen_subcommand_from report" -l copyright-garbage-file -r -F -d 'A file containing copyright statements which are marked as garbage. This can make the output inconsistent with the evaluator output but is useful when testing copyright garbage.'
-complete -c ort -n "__fish_seen_subcommand_from report" -l custom-license-texts-dir -r -F -d 'A directory which maps custom license IDs to license texts. It should contain one text file per license with the license ID as the filename. A custom license text is used only if its ID has a \'LicenseRef-\' prefix and if the respective license text is not known by ORT.'
 complete -c ort -n "__fish_seen_subcommand_from report" -l how-to-fix-text-provider-script -r -F -d 'The path to a Kotlin script which returns an instance of a \'HowToFixTextProvider\'. That provider injects how-to-fix texts in Markdown format for ORT issues.'
 complete -c ort -n "__fish_seen_subcommand_from report" -l license-classifications-file -r -F -d 'A file containing the license classifications. This can make the output inconsistent with the evaluator output but is useful when testing license classifications.'
 complete -c ort -n "__fish_seen_subcommand_from report" -l package-configurations-dir -r -F -d 'A directory that is searched recursively for package configuration files. Each file must only contain a single package configuration. This can make the output inconsistent with the evaluator output but is useful when testing package configurations.'

integrations/completions/ort-completion.zsh

@@ -1157,12 +1157,6 @@ _ort_report() {
           [[ ${i} -gt COMP_CWORD ]] && in_param='--copyright-garbage-file' || in_param=''
           continue
           ;;
-        --custom-license-texts-dir)
-          __skip_opt_eq
-          (( i = i + 1 ))
-          [[ ${i} -gt COMP_CWORD ]] && in_param='--custom-license-texts-dir' || in_param=''
-          continue
-          ;;
         --how-to-fix-text-provider-script)
           __skip_opt_eq
           (( i = i + 1 ))
@@ -1221,7 +1215,7 @@ _ort_report() {
   done
   local word="${COMP_WORDS[$COMP_CWORD]}"
   if [[ "${word}" =~ ^[-] ]]; then
-    COMPREPLY=($(compgen -W '--ort-file -i --output-dir -o --report-formats -f --copyright-garbage-file --custom-license-texts-dir --how-to-fix-text-provider-script --license-classifications-file --package-configurations-dir --refresh-resolutions --repository-configuration-file --resolutions-file --report-option -O -h --help' -- "${word}"))
+    COMPREPLY=($(compgen -W '--ort-file -i --output-dir -o --report-formats -f --copyright-garbage-file --how-to-fix-text-provider-script --license-classifications-file --package-configurations-dir --refresh-resolutions --repository-configuration-file --resolutions-file --report-option -O -h --help' -- "${word}"))
     return
   fi
 
@@ -1242,9 +1236,6 @@ _ort_report() {
     "--copyright-garbage-file")
        __complete_files "${word}"
       ;;
-    "--custom-license-texts-dir")
-       __complete_files "${word}"
-      ;;
     "--how-to-fix-text-provider-script")
        __complete_files "${word}"
       ;;

plugins/commands/reporter/src/main/kotlin/ReportCommand.kt

@@ -63,10 +63,11 @@ import org.ossreviewtoolkit.plugins.commands.api.utils.configurationGroup
 import org.ossreviewtoolkit.plugins.commands.api.utils.inputGroup
 import org.ossreviewtoolkit.plugins.commands.api.utils.outputGroup
 import org.ossreviewtoolkit.plugins.commands.api.utils.readOrtResult
+import org.ossreviewtoolkit.plugins.licensefactproviders.api.CompositeLicenseFactProvider
+import org.ossreviewtoolkit.plugins.licensefactproviders.api.LicenseFactProviderFactory
 import org.ossreviewtoolkit.plugins.packageconfigurationproviders.api.CompositePackageConfigurationProvider
 import org.ossreviewtoolkit.plugins.packageconfigurationproviders.api.SimplePackageConfigurationProvider
 import org.ossreviewtoolkit.plugins.packageconfigurationproviders.dir.DirPackageConfigurationProvider
-import org.ossreviewtoolkit.reporter.DefaultLicenseTextProvider
 import org.ossreviewtoolkit.reporter.HowToFixTextProvider
 import org.ossreviewtoolkit.reporter.ReporterFactory
 import org.ossreviewtoolkit.reporter.ReporterInput
@@ -77,13 +78,11 @@ import org.ossreviewtoolkit.utils.common.safeMkdirs
 import org.ossreviewtoolkit.utils.config.setPackageConfigurations
 import org.ossreviewtoolkit.utils.config.setResolutions
 import org.ossreviewtoolkit.utils.ort.ORT_COPYRIGHT_GARBAGE_FILENAME
-import org.ossreviewtoolkit.utils.ort.ORT_CUSTOM_LICENSE_TEXTS_DIRNAME
 import org.ossreviewtoolkit.utils.ort.ORT_HOW_TO_FIX_TEXT_PROVIDER_FILENAME
 import org.ossreviewtoolkit.utils.ort.ORT_LICENSE_CLASSIFICATIONS_FILENAME
 import org.ossreviewtoolkit.utils.ort.ORT_RESOLUTIONS_FILENAME
 import org.ossreviewtoolkit.utils.ort.ortConfigDirectory
 import org.ossreviewtoolkit.utils.ort.showStackTrace
-import org.ossreviewtoolkit.utils.spdx.SpdxConstants.LICENSE_REF_PREFIX
 
 @OrtPlugin(
     displayName = "Report",
@@ -127,17 +126,6 @@ class ReportCommand(descriptor: PluginDescriptor = ReportCommandFactory.descript
         .default(ortConfigDirectory / ORT_COPYRIGHT_GARBAGE_FILENAME)
         .configurationGroup()
 
-    private val customLicenseTextsDir by option(
-        "--custom-license-texts-dir",
-        help = "A directory which maps custom license IDs to license texts. It should contain one text file per " +
-            "license with the license ID as the filename. A custom license text is used only if its ID has a " +
-            "'$LICENSE_REF_PREFIX' prefix and if the respective license text is not known by ORT."
-    ).convert { it.expandTilde() }
-        .file(mustExist = false, canBeFile = false, canBeDir = true, mustBeWritable = false, mustBeReadable = false)
-        .convert { it.absoluteFile.normalize() }
-        .default(ortConfigDirectory / ORT_CUSTOM_LICENSE_TEXTS_DIRNAME)
-        .configurationGroup()
-
     private val howToFixTextProviderScript by option(
         "--how-to-fix-text-provider-script",
         help = "The path to a Kotlin script which returns an instance of a 'HowToFixTextProvider'. That provider " +
@@ -220,8 +208,6 @@ class ReportCommand(descriptor: PluginDescriptor = ReportCommandFactory.descript
             ortResult = ortResult.setResolutions(resolutionProvider)
         }
 
-        val licenseTextDirectories = listOfNotNull(customLicenseTextsDir.takeIf { it.isDirectory })
-
         val resolvedPackageConfigurations = ortResult.resolvedConfiguration.packageConfigurations
         val packageConfigurationProvider = when {
             resolvedPackageConfigurations != null && packageConfigurationsDir == null -> {
@@ -265,12 +251,20 @@ class ReportCommand(descriptor: PluginDescriptor = ReportCommandFactory.descript
             HowToFixTextProvider.fromKotlinScript(it.readText(), ortResult)
         } ?: HowToFixTextProvider.NONE
 
+        val licenseFactProviders = ortConfig.licenseFactProviders.map { (id, config) ->
+            val factory = LicenseFactProviderFactory.ALL[id]
+            requireNotNull(factory) { "License fact provider '$id' is not available in the classpath." }
+            factory.create(config)
+        }
+
+        val licenseFactProvider = CompositeLicenseFactProvider(licenseFactProviders)
+
         outputDir.safeMkdirs()
 
         val input = ReporterInput(
             ortResult,
             ortConfig,
-            DefaultLicenseTextProvider(licenseTextDirectories),
+            licenseFactProvider,
             copyrightGarbage,
             licenseInfoResolver,
             licenseClassifications,

plugins/reporters/aosd/build.gradle.kts

@@ -39,5 +39,7 @@ dependencies {
 
     funTestImplementation(testFixtures(projects.reporter))
 
+    funTestImplementation(projects.plugins.licenseFactProviders.spdxLicenseFactProvider)
+
     funTestImplementation(libs.kotest.assertions.json)
 }

plugins/reporters/aosd/src/funTest/kotlin/Aosd20ReporterFunTest.kt

@@ -28,6 +28,7 @@ import io.kotest.matchers.collections.shouldHaveSize
 import io.kotest.matchers.result.shouldBeSuccess
 import io.kotest.matchers.should
 
+import org.ossreviewtoolkit.plugins.licensefactproviders.spdx.SpdxLicenseFactProviderFactory
 import org.ossreviewtoolkit.reporter.ORT_RESULT
 import org.ossreviewtoolkit.reporter.ReporterInput
 import org.ossreviewtoolkit.utils.test.getResource
@@ -54,7 +55,13 @@ class Aosd20ReporterFunTest : WordSpec({
     }
 
     "The generated report" should {
-        val reportFiles = Aosd20Reporter().generateReport(ReporterInput(ORT_RESULT), tempdir())
+        val reportFiles = Aosd20Reporter().generateReport(
+            ReporterInput(
+                ORT_RESULT,
+                licenseFactProvider = SpdxLicenseFactProviderFactory.create()
+            ),
+            tempdir()
+        )
 
         "be valid according to the schema" {
             val schemaJson = readResource("/aosd20/aosd.schema.json")

plugins/reporters/aosd/src/funTest/kotlin/Aosd21ReporterFunTest.kt

@@ -29,6 +29,7 @@ import io.kotest.matchers.result.shouldBeSuccess
 import io.kotest.matchers.should
 import io.kotest.matchers.shouldBe
 
+import org.ossreviewtoolkit.plugins.licensefactproviders.spdx.SpdxLicenseFactProviderFactory
 import org.ossreviewtoolkit.reporter.ORT_RESULT
 import org.ossreviewtoolkit.reporter.ReporterInput
 import org.ossreviewtoolkit.utils.test.getResource
@@ -58,7 +59,13 @@ class Aosd21ReporterFunTest : WordSpec({
     }
 
     "The generated report" should {
-        val reportFiles = Aosd21Reporter().generateReport(ReporterInput(ORT_RESULT), tempdir())
+        val reportFiles = Aosd21Reporter().generateReport(
+            ReporterInput(
+                ORT_RESULT,
+                licenseFactProvider = SpdxLicenseFactProviderFactory.create()
+            ),
+            tempdir()
+        )
 
         "be valid according to the schema" {
             val schemaJson = readResource("/aosd21/AOSD2.1_Importscheme_V2.1.0.json")

plugins/reporters/aosd/src/main/kotlin/Aosd20Reporter.kt

@@ -106,7 +106,7 @@ private fun Package.toLicenses(input: ReporterInput): List<AOSD20.License> {
 
         return effectiveLicense?.decompose()?.map { licenseExpression ->
             val name = licenseExpression.toString()
-            val text = input.licenseTextProvider.getLicenseText(name)
+            val text = input.licenseFactProvider.getLicenseText(name)
 
             AOSD20.License(
                 name = name,

plugins/reporters/aosd/src/main/kotlin/Aosd21Reporter.kt

@@ -94,7 +94,7 @@ private fun Map<Identifier, IndexedValue<CuratedPackage>>.toComponents(
             ?.takeUnless { it.offersChoice() }
 
         val licenseTexts = licenseExpression?.licenses().orEmpty().mapNotNullTo(mutableSetOf()) { license ->
-            input.licenseTextProvider.getLicenseText(license)
+            input.licenseFactProvider.getLicenseText(license)
         }.joinToString("\n--\n") { it.trimEnd() }
 
         with(pkg.metadata) {