feat(analyzer)!: Pass the configuration also to mapDefinitionFiles()

sschuberth · sschuberth · commit bca951028d4b · 2025-05-05T14:45:34.000+02:00
This will be required by an upcoming fix.

Signed-off-by: Sebastian Schuberth &lt;sebastian@doubleopen.org&gt;
diff --git a/analyzer/src/main/kotlin/Analyzer.kt b/analyzer/src/main/kotlin/Analyzer.kt
@@ -99,7 +99,7 @@ class Analyzer(private val config: AnalyzerConfiguration, private val labels: Ma
                 config.excludes(repositoryConfiguration)
             )
         }.mapNotNull { (manager, files) ->
-            val mappedFiles = manager.mapDefinitionFiles(absoluteProjectPath, files)
+            val mappedFiles = manager.mapDefinitionFiles(absoluteProjectPath, files, config)
             Pair(manager, mappedFiles).takeIf { mappedFiles.isNotEmpty() }
         }.toMap(mutableMapOf())
 
diff --git a/analyzer/src/main/kotlin/PackageManager.kt b/analyzer/src/main/kotlin/PackageManager.kt
@@ -230,7 +230,11 @@ abstract class PackageManager(val projectType: String) : Plugin {
     /**
      * Optional mapping of found [definitionFiles] before dependency resolution.
      */
-    open fun mapDefinitionFiles(analysisRoot: File, definitionFiles: List<File>): List<File> = definitionFiles
+    open fun mapDefinitionFiles(
+        analysisRoot: File,
+        definitionFiles: List<File>,
+        analyzerConfig: AnalyzerConfiguration
+    ): List<File> = definitionFiles
 
     /**
      * Return if this package manager must run before or after certain other package managers. This can manually be
diff --git a/plugins/package-managers/bazel/src/main/kotlin/Bazel.kt b/plugins/package-managers/bazel/src/main/kotlin/Bazel.kt
@@ -155,7 +155,11 @@ class Bazel(
      * source.json file and under a directory with a metadata.json file. This simple metric avoids parsing the .bazelrc
      * in the top directory of the project to find out if a MODULE.bazel file is part of a local registry or not.
      */
-    override fun mapDefinitionFiles(analysisRoot: File, definitionFiles: List<File>): List<File> =
+    override fun mapDefinitionFiles(
+        analysisRoot: File,
+        definitionFiles: List<File>,
+        analyzerConfig: AnalyzerConfiguration
+    ): List<File> =
         definitionFiles.mapNotNull { file ->
             file.takeUnless {
                 it.resolveSibling(SOURCE_JSON).isFile && it.parentFile.resolveSibling(METADATA_JSON).isFile
diff --git a/plugins/package-managers/cargo/src/main/kotlin/Cargo.kt b/plugins/package-managers/cargo/src/main/kotlin/Cargo.kt
@@ -123,7 +123,11 @@ class Cargo(override val descriptor: PluginDescriptor = CargoFactory.descriptor)
         }
     }
 
-    override fun mapDefinitionFiles(analysisRoot: File, definitionFiles: List<File>): List<File> {
+    override fun mapDefinitionFiles(
+        analysisRoot: File,
+        definitionFiles: List<File>,
+        analyzerConfig: AnalyzerConfiguration
+    ): List<File> {
         fun File.isVirtualWorkspace(): Boolean {
             var foundWorkspace = false
             var foundPackage = false
diff --git a/plugins/package-managers/composer/src/funTest/kotlin/ComposerFunTest.kt b/plugins/package-managers/composer/src/funTest/kotlin/ComposerFunTest.kt
@@ -31,6 +31,7 @@ import java.io.File
 
 import org.ossreviewtoolkit.analyzer.resolveSingleProject
 import org.ossreviewtoolkit.model.Identifier
+import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
 import org.ossreviewtoolkit.model.toYaml
 import org.ossreviewtoolkit.utils.test.getAssetFile
 import org.ossreviewtoolkit.utils.test.matchExpectedResult
@@ -44,7 +45,8 @@ class ComposerFunTest : StringSpec({
                 "projectA/vendor/dependency1/composer.json",
                 "projectB/composer.json",
                 "projectB/vendor/dependency2/composer.json"
-            ).map { File(it) }
+            ).map { File(it) },
+            AnalyzerConfiguration()
         )
 
         projectFiles.map { it.path } should containExactly(
diff --git a/plugins/package-managers/composer/src/main/kotlin/Composer.kt b/plugins/package-managers/composer/src/main/kotlin/Composer.kt
@@ -107,7 +107,11 @@ class Composer(override val descriptor: PluginDescriptor = ComposerFactory.descr
         ComposerCommand.checkVersion()
     }
 
-    override fun mapDefinitionFiles(analysisRoot: File, definitionFiles: List<File>): List<File> {
+    override fun mapDefinitionFiles(
+        analysisRoot: File,
+        definitionFiles: List<File>,
+        analyzerConfig: AnalyzerConfiguration
+    ): List<File> {
         val projectFiles = definitionFiles.toMutableList()
 
         // Ignore definition files from vendor directories that reside next to other definition files, to avoid the
diff --git a/plugins/package-managers/conan/src/main/kotlin/Conan.kt b/plugins/package-managers/conan/src/main/kotlin/Conan.kt
@@ -154,7 +154,11 @@ class Conan(
      * If a Bazel project uses some Conan packages, the corresponding Conan files should not be picked up by the Conan
      * package manager. Therefore, the Conan file is checked to NOT contain the BazelDeps and BazelToolchain generators.
      */
-    override fun mapDefinitionFiles(analysisRoot: File, definitionFiles: List<File>): List<File> =
+    override fun mapDefinitionFiles(
+        analysisRoot: File,
+        definitionFiles: List<File>,
+        analyzerConfig: AnalyzerConfiguration
+    ): List<File> =
         definitionFiles.mapNotNull { file ->
             file.takeUnless {
                 val content = it.readText()
diff --git a/plugins/package-managers/go/src/main/kotlin/GoMod.kt b/plugins/package-managers/go/src/main/kotlin/GoMod.kt
@@ -95,7 +95,11 @@ internal object GoCommand : CommandLineTool {
 class GoMod(override val descriptor: PluginDescriptor = GoModFactory.descriptor) : PackageManager("GoMod") {
     override val globsForDefinitionFiles = listOf("go.mod")
 
-    override fun mapDefinitionFiles(analysisRoot: File, definitionFiles: List<File>): List<File> =
+    override fun mapDefinitionFiles(
+        analysisRoot: File,
+        definitionFiles: List<File>,
+        analyzerConfig: AnalyzerConfiguration
+    ): List<File> =
         definitionFiles.filterNot { definitionFile ->
             "vendor" in definitionFile
                 .parentFile
diff --git a/plugins/package-managers/maven/src/main/kotlin/Maven.kt b/plugins/package-managers/maven/src/main/kotlin/Maven.kt
@@ -86,7 +86,11 @@ class Maven(override val descriptor: PluginDescriptor = MavenFactory.descriptor,
      * Map the given [definitionFiles] to a list of files that should be processed. This implementation filters out
      * projects that require the Tycho build extension.
      */
-    override fun mapDefinitionFiles(analysisRoot: File, definitionFiles: List<File>): List<File> {
+    override fun mapDefinitionFiles(
+        analysisRoot: File,
+        definitionFiles: List<File>,
+        analyzerConfig: AnalyzerConfiguration
+    ): List<File> {
         val tychoRoots = definitionFiles.filter(::isTychoProject).map { it.parentFile }
 
         // All pom files under a Tycho project will be handled by Tycho and therefore need to be excluded.
diff --git a/plugins/package-managers/maven/src/main/kotlin/tycho/Tycho.kt b/plugins/package-managers/maven/src/main/kotlin/tycho/Tycho.kt
@@ -100,8 +100,11 @@ class Tycho(override val descriptor: PluginDescriptor = TychoFactory.Companion.d
      */
     private lateinit var graphBuilder: DependencyGraphBuilder<DependencyNode>
 
-    override fun mapDefinitionFiles(analysisRoot: File, definitionFiles: List<File>): List<File> =
-        definitionFiles.filter(::isTychoProject)
+    override fun mapDefinitionFiles(
+        analysisRoot: File,
+        definitionFiles: List<File>,
+        analyzerConfig: AnalyzerConfiguration
+    ): List<File> = definitionFiles.filter(::isTychoProject)
 
     override fun resolveDependencies(
         analysisRoot: File,
diff --git a/plugins/package-managers/maven/src/test/kotlin/MavenTest.kt b/plugins/package-managers/maven/src/test/kotlin/MavenTest.kt
@@ -24,6 +24,7 @@ import io.kotest.engine.spec.tempdir
 import io.kotest.matchers.collections.containExactlyInAnyOrder
 import io.kotest.matchers.should
 
+import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
 import org.ossreviewtoolkit.plugins.packagemanagers.maven.tycho.addTychoExtension
 
 class MavenTest : WordSpec({
@@ -52,7 +53,7 @@ class MavenTest : WordSpec({
             )
 
             val maven = Maven()
-            val mappedDefinitionFiles = maven.mapDefinitionFiles(tempdir(), definitionFiles)
+            val mappedDefinitionFiles = maven.mapDefinitionFiles(tempdir(), definitionFiles, AnalyzerConfiguration())
 
             mappedDefinitionFiles should containExactlyInAnyOrder(mavenDefinitionFile, mavenSubModule)
         }
diff --git a/plugins/package-managers/maven/src/test/kotlin/tycho/TychoTest.kt b/plugins/package-managers/maven/src/test/kotlin/tycho/TychoTest.kt
@@ -100,7 +100,7 @@ class TychoTest : WordSpec({
             )
 
             val tycho = Tycho()
-            val mappedDefinitionFiles = tycho.mapDefinitionFiles(tempdir(), definitionFiles)
+            val mappedDefinitionFiles = tycho.mapDefinitionFiles(tempdir(), definitionFiles, AnalyzerConfiguration())
 
             mappedDefinitionFiles should containExactlyInAnyOrder(tychoDefinitionFile1, tychoDefinitionFile2)
         }
diff --git a/plugins/package-managers/node/src/main/kotlin/NodePackageManager.kt b/plugins/package-managers/node/src/main/kotlin/NodePackageManager.kt
@@ -30,6 +30,7 @@ import org.ossreviewtoolkit.downloader.VersionControlSystem
 import org.ossreviewtoolkit.model.Identifier
 import org.ossreviewtoolkit.model.Project
 import org.ossreviewtoolkit.model.ProjectAnalyzerResult
+import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
 import org.ossreviewtoolkit.model.utils.DependencyGraphBuilder
 import org.ossreviewtoolkit.utils.common.realFile
 
@@ -72,8 +73,11 @@ abstract class NodePackageManager(val managerType: NodePackageManagerType) : Pac
         )
     }
 
-    override fun mapDefinitionFiles(analysisRoot: File, definitionFiles: List<File>) =
-        NodePackageManagerDetection(definitionFiles).filterApplicable(managerType)
+    override fun mapDefinitionFiles(
+        analysisRoot: File,
+        definitionFiles: List<File>,
+        analyzerConfig: AnalyzerConfiguration
+    ) = NodePackageManagerDetection(definitionFiles).filterApplicable(managerType)
 
     override fun createPackageManagerResult(projectResults: Map<File, List<ProjectAnalyzerResult>>) =
         PackageManagerResult(projectResults, graphBuilder.build(), graphBuilder.packages())
diff --git a/plugins/package-managers/sbt/src/main/kotlin/Sbt.kt b/plugins/package-managers/sbt/src/main/kotlin/Sbt.kt
@@ -88,7 +88,11 @@ class Sbt(override val descriptor: PluginDescriptor = SbtFactory.descriptor, pri
     PackageManager("SBT") {
     override val globsForDefinitionFiles = listOf("build.sbt", "build.scala")
 
-    override fun mapDefinitionFiles(analysisRoot: File, definitionFiles: List<File>): List<File> {
+    override fun mapDefinitionFiles(
+        analysisRoot: File,
+        definitionFiles: List<File>,
+        analyzerConfig: AnalyzerConfiguration
+    ): List<File> {
         // Some SBT projects do not have a build file in their root, but they still require "sbt" to be run from the
         // project's root directory. In order to determine the root directory, use the common prefix of all
         // definition file paths.
diff --git a/plugins/package-managers/spdx/src/funTest/kotlin/SpdxDocumentFileFunTest.kt b/plugins/package-managers/spdx/src/funTest/kotlin/SpdxDocumentFileFunTest.kt
@@ -231,7 +231,8 @@ class SpdxDocumentFileFunTest : WordSpec({
 
             val definitionFiles = listOf(projectFile, packageFile)
 
-            val result = SpdxDocumentFileFactory.create().mapDefinitionFiles(USER_DIR, definitionFiles)
+            val result = SpdxDocumentFileFactory.create()
+                .mapDefinitionFiles(USER_DIR, definitionFiles, AnalyzerConfiguration())
 
             result should containExactly(projectFile)
         }
@@ -242,7 +243,8 @@ class SpdxDocumentFileFunTest : WordSpec({
 
             val definitionFiles = listOf(packageFileCurl, packageFileZlib)
 
-            val result = SpdxDocumentFileFactory.create().mapDefinitionFiles(USER_DIR, definitionFiles)
+            val result = SpdxDocumentFileFactory.create()
+                .mapDefinitionFiles(USER_DIR, definitionFiles, AnalyzerConfiguration())
 
             result should containExactly(definitionFiles)
         }
diff --git a/plugins/package-managers/spdx/src/main/kotlin/SpdxDocumentFile.kt b/plugins/package-managers/spdx/src/main/kotlin/SpdxDocumentFile.kt
@@ -489,7 +489,11 @@ class SpdxDocumentFile(override val descriptor: PluginDescriptor = SpdxDocumentF
             )
         }
 
-    override fun mapDefinitionFiles(analysisRoot: File, definitionFiles: List<File>): List<File> =
+    override fun mapDefinitionFiles(
+        analysisRoot: File,
+        definitionFiles: List<File>,
+        analyzerConfig: AnalyzerConfiguration
+    ): List<File> =
         definitionFiles.associateWith {
             spdxDocumentCache.load(it).getOrNull()
         }.filter { (_, spdxDocument) ->
diff --git a/plugins/package-managers/swiftpm/src/main/kotlin/SwiftPm.kt b/plugins/package-managers/swiftpm/src/main/kotlin/SwiftPm.kt
@@ -72,7 +72,11 @@ internal object SwiftCommand : CommandLineTool {
 class SwiftPm(override val descriptor: PluginDescriptor = SwiftPmFactory.descriptor) : PackageManager("SwiftPM") {
     override val globsForDefinitionFiles = listOf(PACKAGE_SWIFT_NAME, PACKAGE_RESOLVED_NAME)
 
-    override fun mapDefinitionFiles(analysisRoot: File, definitionFiles: List<File>): List<File> {
+    override fun mapDefinitionFiles(
+        analysisRoot: File,
+        definitionFiles: List<File>,
+        analyzerConfig: AnalyzerConfiguration
+    ): List<File> {
         return definitionFiles.filterNot { file -> file.path.contains(".build/checkouts") }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ class Analyzer(private val config: AnalyzerConfiguration, private val labels: Ma`
`99`	`99`	`config.excludes(repositoryConfiguration)`
`100`	`100`	`)`
`101`	`101`	`}.mapNotNull { (manager, files) ->`
`102`		`- val mappedFiles = manager.mapDefinitionFiles(absoluteProjectPath, files)`
	`102`	`+ val mappedFiles = manager.mapDefinitionFiles(absoluteProjectPath, files, config)`
`103`	`103`	`Pair(manager, mappedFiles).takeIf { mappedFiles.isNotEmpty() }`
`104`	`104`	`}.toMap(mutableMapOf())`
`105`	`105`
Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,11 @@ class Cargo(override val descriptor: PluginDescriptor = CargoFactory.descriptor)`
`123`	`123`	`}`
`124`	`124`	`}`
`125`	`125`
`126`		`- override fun mapDefinitionFiles(analysisRoot: File, definitionFiles: List<File>): List<File> {`
	`126`	`+ override fun mapDefinitionFiles(`
	`127`	`+ analysisRoot: File,`
	`128`	`+ definitionFiles: List<File>,`
	`129`	`+ analyzerConfig: AnalyzerConfiguration`
	`130`	`+ ): List<File> {`
`127`	`131`	`fun File.isVirtualWorkspace(): Boolean {`
`128`	`132`	`var foundWorkspace = false`
`129`	`133`	`var foundPackage = false`