refactor(web-app)!: Use a plugin config class

Add a config class for the reporter and use it instead of the options passed to the `generateReport` function. Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>
oss-review-toolkit · Nov 9, 2024 · 740436f · 740436f
1 parent ff6ca62
commit 740436f
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 14 deletions.
diff --git a/plugins/reporters/web-app/src/funTest/kotlin/WebAppReporterFunTest.kt b/plugins/reporters/web-app/src/funTest/kotlin/WebAppReporterFunTest.kt
@@ -26,6 +26,7 @@ import io.kotest.matchers.longs.beInRange
 import io.kotest.matchers.result.shouldBeSuccess
 import io.kotest.matchers.should
 
+import org.ossreviewtoolkit.plugins.api.PluginConfig
 import org.ossreviewtoolkit.reporter.ReporterInput
 import org.ossreviewtoolkit.utils.test.getAssetFile
 import org.ossreviewtoolkit.utils.test.readOrtResult
@@ -36,7 +37,8 @@ class WebAppReporterFunTest : WordSpec({
             val ortResult = readOrtResult(getAssetFile("scan-result-for-synthetic-gradle-lib.yml"))
             val outputDir = tempdir()
 
-            val reportFileResults = WebAppReporter().generateReport(ReporterInput(ortResult), outputDir)
+            val reportFileResults = WebAppReporterFactory().create(PluginConfig())
+                .generateReport(ReporterInput(ortResult), outputDir)
 
             reportFileResults.shouldBeSingleton {
                 it shouldBeSuccess { reportFile ->

diff --git a/plugins/reporters/web-app/src/main/kotlin/WebAppReporter.kt b/plugins/reporters/web-app/src/main/kotlin/WebAppReporter.kt
@@ -31,6 +31,7 @@ import org.apache.commons.compress.compressors.gzip.GzipParameters
 
 import org.ossreviewtoolkit.model.config.PluginConfiguration
 import org.ossreviewtoolkit.plugins.api.OrtPlugin
+import org.ossreviewtoolkit.plugins.api.OrtPluginOption
 import org.ossreviewtoolkit.plugins.api.PluginDescriptor
 import org.ossreviewtoolkit.plugins.reporters.evaluatedmodel.EvaluatedModel
 import org.ossreviewtoolkit.reporter.Reporter
@@ -39,23 +40,26 @@ import org.ossreviewtoolkit.reporter.ReporterInput
 
 private const val PLACEHOLDER = "ORT_REPORT_DATA_PLACEHOLDER"
 
+data class WebAppReporterConfig(
+    /**
+     * If true, subtrees occurring multiple times in the dependency tree are stripped.
+     */
+    @OrtPluginOption(defaultValue = "false")
+    val deduplicateDependencyTree: Boolean
+)
+
 /**
  * A [Reporter] that generates a web application that allows browsing an ORT result interactively.
- *
- * This reporter supports the following options:
- * - *deduplicateDependencyTree*: Controls whether subtrees occurring multiple times in the dependency tree are
- *   stripped.
  */
 @OrtPlugin(
     displayName = "WebApp Reporter",
     description = "Generates a web application to browse an ORT result interactively.",
     factory = ReporterFactory::class
 )
-class WebAppReporter(override val descriptor: PluginDescriptor = WebAppReporterFactory.descriptor) : Reporter {
-    companion object {
-        const val OPTION_DEDUPLICATE_DEPENDENCY_TREE = "deduplicateDependencyTree"
-    }
-
+class WebAppReporter(
+    override val descriptor: PluginDescriptor = WebAppReporterFactory.descriptor,
+    private val config: WebAppReporterConfig
+) : Reporter {
     private val reportFilename = "scan-report-web-app.html"
 
     override fun generateReport(
@@ -64,10 +68,7 @@ class WebAppReporter(override val descriptor: PluginDescriptor = WebAppReporterF
         config: PluginConfiguration
     ): List<Result<File>> {
         val template = javaClass.getResource("/scan-report-template.html").readText()
-        val evaluatedModel = EvaluatedModel.create(
-            input,
-            config.options[OPTION_DEDUPLICATE_DEPENDENCY_TREE].toBoolean()
-        )
+        val evaluatedModel = EvaluatedModel.create(input, this.config.deduplicateDependencyTree)
 
         val index = template.indexOf(PLACEHOLDER)
         val prefix = template.substring(0, index)