test(package-managers): Do not use USER_DIR as the analyzer root

sschuberth · sschuberth · commit c9faf3e3c1ec · 2025-09-25T20:10:54.000+02:00
`USER_DIR` is the current user / working directory which does not
necessarily have anything in common with the definition files. Use a
more realistic analyzer root that is a parent of the definition files
instead.

For `CargoSubcrateFunTest` this actually fixes the `PackageLinkage` as
it is determined based in the `analyzerRoot`. This corrects
"Crate::lib:0.1.0" to appear in the list of packages.

For various other tests, this simplifies the project ID / paths of
expected results as the project root now equals the `analyzerRoot`.

Signed-off-by: Sebastian Schuberth &lt;sebastian@doubleopen.org&gt;
diff --git a/analyzer/src/testFixtures/kotlin/TestUtils.kt b/analyzer/src/testFixtures/kotlin/TestUtils.kt
@@ -40,7 +40,7 @@ import org.ossreviewtoolkit.model.config.RepositoryConfiguration
 import org.ossreviewtoolkit.model.config.ScopeExclude
 import org.ossreviewtoolkit.model.config.ScopeExcludeReason
 import org.ossreviewtoolkit.plugins.api.PluginConfig
-import org.ossreviewtoolkit.utils.test.USER_DIR
+import org.ossreviewtoolkit.utils.common.getCommonParentFile
 
 fun PackageManager.resolveSingleProject(
     definitionFile: File,
@@ -49,14 +49,15 @@ fun PackageManager.resolveSingleProject(
     resolveScopes: Boolean = false
 ): ProjectAnalyzerResult {
     val definitionFiles = listOf(definitionFile)
+    val analyzerRoot = getCommonParentFile(definitionFiles)
     val analyzerConfig = AnalyzerConfiguration(allowDynamicVersions = allowDynamicVersions)
 
-    beforeResolution(USER_DIR, definitionFiles, analyzerConfig)
+    beforeResolution(analyzerRoot, definitionFiles, analyzerConfig)
 
     val excludes = Excludes(scopes = excludedScopes.map { ScopeExclude(it, ScopeExcludeReason.TEST_DEPENDENCY_OF) })
-    val managerResult = resolveDependencies(USER_DIR, definitionFiles, excludes, analyzerConfig, emptyMap())
+    val managerResult = resolveDependencies(analyzerRoot, definitionFiles, excludes, analyzerConfig, emptyMap())
 
-    afterResolution(USER_DIR, definitionFiles)
+    afterResolution(analyzerRoot, definitionFiles)
 
     val resultList = managerResult.projectResults[definitionFile]
     resultList.shouldNotBeNull()
diff --git a/plugins/package-managers/bundler/src/funTest/assets/projects/synthetic/bundler-expected-output-lockfile.yml b/plugins/package-managers/bundler/src/funTest/assets/projects/synthetic/bundler-expected-output-lockfile.yml
@@ -1,6 +1,6 @@
 ---
 project:
-  id: "Bundler::src/funTest/assets/projects/synthetic/lockfile/Gemfile:"
+  id: "Bundler::Gemfile:"
   definition_file_path: "plugins/package-managers/bundler/src/funTest/assets/projects/synthetic/lockfile/Gemfile"
   declared_licenses: []
   declared_licenses_processed: {}
diff --git a/plugins/package-managers/bundler/src/funTest/kotlin/BundlerFunTest.kt b/plugins/package-managers/bundler/src/funTest/kotlin/BundlerFunTest.kt
@@ -48,8 +48,7 @@ class BundlerFunTest : WordSpec({
             val actualResult = BundlerFactory.create().resolveSingleProject(definitionFile)
 
             with(actualResult) {
-                project.id shouldBe
-                    Identifier("Bundler::src/funTest/assets/projects/synthetic/no-lockfile/Gemfile:")
+                project.id shouldBe Identifier("Bundler::Gemfile:")
                 project.definitionFilePath shouldBe
                     "plugins/package-managers/bundler/src/funTest/assets/projects/synthetic/no-lockfile/Gemfile"
                 packages should beEmpty()
diff --git a/plugins/package-managers/cargo/src/funTest/assets/projects/synthetic/cargo-subcrate-client-expected-output.yml b/plugins/package-managers/cargo/src/funTest/assets/projects/synthetic/cargo-subcrate-client-expected-output.yml
@@ -21,7 +21,7 @@ project:
   - name: "dependencies"
     dependencies:
     - id: "Crate::lib:0.1.0"
-      linkage: "PROJECT_STATIC"
+      linkage: "STATIC"
       dependencies:
       - id: "Crate::cfg-if:0.1.9"
         linkage: "STATIC"
@@ -59,3 +59,32 @@ packages:
     url: "https://github.com/alexcrichton/cfg-if.git"
     revision: ""
     path: ""
+- id: "Crate::lib:0.1.0"
+  purl: "pkg:cargo/lib@0.1.0"
+  declared_licenses:
+  - "Apache-2.0"
+  - "MIT"
+  declared_licenses_processed:
+    spdx_expression: "Apache-2.0 OR MIT"
+  description: ""
+  homepage_url: "https://example.org"
+  binary_artifact:
+    url: ""
+    hash:
+      value: ""
+      algorithm: ""
+  source_artifact:
+    url: ""
+    hash:
+      value: ""
+      algorithm: ""
+  vcs:
+    type: ""
+    url: ""
+    revision: ""
+    path: ""
+  vcs_processed:
+    type: "Git"
+    url: "<REPLACE_URL_PROCESSED>"
+    revision: "<REPLACE_REVISION>"
+    path: "plugins/package-managers/cargo/src/funTest/assets/projects/synthetic/cargo-subcrate"
diff --git a/plugins/package-managers/carthage/src/test/kotlin/CarthageTest.kt b/plugins/package-managers/carthage/src/test/kotlin/CarthageTest.kt
@@ -35,7 +35,6 @@ import java.net.URI
 import org.ossreviewtoolkit.model.VcsType
 import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
 import org.ossreviewtoolkit.model.config.Excludes
-import org.ossreviewtoolkit.utils.test.USER_DIR
 
 class CarthageTest : WordSpec() {
     private val carthage = CarthageFactory.create()
@@ -128,4 +127,4 @@ class CarthageTest : WordSpec() {
 }
 
 private fun Carthage.resolveDependencies(definitionFile: File) =
-    resolveDependencies(USER_DIR, definitionFile, Excludes.EMPTY, AnalyzerConfiguration(), emptyMap())
+    resolveDependencies(definitionFile.parentFile, definitionFile, Excludes.EMPTY, AnalyzerConfiguration(), emptyMap())
diff --git a/plugins/package-managers/cocoapods/src/funTest/assets/projects/synthetic/dep-tree-expected-output.yml b/plugins/package-managers/cocoapods/src/funTest/assets/projects/synthetic/dep-tree-expected-output.yml
@@ -1,6 +1,6 @@
 ---
 project:
-  id: "CocoaPods::src/funTest/assets/projects/synthetic/dep-tree/Podfile:"
+  id: "CocoaPods::Podfile:"
   definition_file_path: "plugins/package-managers/cocoapods/src/funTest/assets/projects/synthetic/dep-tree/Podfile"
   declared_licenses: []
   declared_licenses_processed: {}
diff --git a/plugins/package-managers/cocoapods/src/funTest/assets/projects/synthetic/external-sources-expected-output.yml b/plugins/package-managers/cocoapods/src/funTest/assets/projects/synthetic/external-sources-expected-output.yml
@@ -1,6 +1,6 @@
 ---
 project:
-  id: "CocoaPods::src/funTest/assets/projects/synthetic/external-sources/Podfile:"
+  id: "CocoaPods::Podfile:"
   definition_file_path: "plugins/package-managers/cocoapods/src/funTest/assets/projects/synthetic/external-sources/Podfile"
   declared_licenses: []
   declared_licenses_processed: {}
diff --git a/plugins/package-managers/cocoapods/src/funTest/assets/projects/synthetic/no-lockfile-expected-output.yml b/plugins/package-managers/cocoapods/src/funTest/assets/projects/synthetic/no-lockfile-expected-output.yml
@@ -1,6 +1,6 @@
 ---
 project:
-  id: "CocoaPods::src/funTest/assets/projects/synthetic/no-lockfile/Podfile:"
+  id: "CocoaPods::Podfile:"
   definition_file_path: "plugins/package-managers/cocoapods/src/funTest/assets/projects/synthetic/no-lockfile/Podfile"
   declared_licenses: []
   declared_licenses_processed: {}
@@ -20,7 +20,6 @@ packages: []
 issues:
 - timestamp: "1970-01-01T00:00:00Z"
   source: "CocoaPods"
-  message: "Missing lockfile 'src/funTest/assets/projects/synthetic/no-lockfile/Podfile.lock'\
-    \ for definition file 'src/funTest/assets/projects/synthetic/no-lockfile/Podfile'.\
-    \ The analysis of a Podfile without a lockfile is not supported."
+  message: "Missing lockfile 'Podfile.lock' for definition file 'Podfile'. The analysis\
+    \ of a Podfile without a lockfile is not supported."
   severity: "ERROR"
diff --git a/plugins/package-managers/cocoapods/src/funTest/assets/projects/synthetic/regular-expected-output.yml b/plugins/package-managers/cocoapods/src/funTest/assets/projects/synthetic/regular-expected-output.yml
@@ -1,6 +1,6 @@
 ---
 project:
-  id: "CocoaPods::src/funTest/assets/projects/synthetic/regular/Podfile:"
+  id: "CocoaPods::Podfile:"
   definition_file_path: "plugins/package-managers/cocoapods/src/funTest/assets/projects/synthetic/regular/Podfile"
   declared_licenses: []
   declared_licenses_processed: {}
diff --git a/plugins/package-managers/cocoapods/src/funTest/assets/projects/synthetic/version-resolution-expected-output.yml b/plugins/package-managers/cocoapods/src/funTest/assets/projects/synthetic/version-resolution-expected-output.yml
@@ -1,6 +1,6 @@
 ---
 project:
-  id: "CocoaPods::src/funTest/assets/projects/synthetic/version-resolution/Podfile:"
+  id: "CocoaPods::Podfile:"
   definition_file_path: "plugins/package-managers/cocoapods/src/funTest/assets/projects/synthetic/version-resolution/Podfile"
   declared_licenses: []
   declared_licenses_processed: {}
diff --git a/plugins/package-managers/composer/src/funTest/kotlin/ComposerFunTest.kt b/plugins/package-managers/composer/src/funTest/kotlin/ComposerFunTest.kt
@@ -72,9 +72,7 @@ class ComposerFunTest : StringSpec({
         val result = ComposerFactory.create().resolveSingleProject(definitionFile)
 
         with(result) {
-            project.id shouldBe Identifier(
-                "Composer::src/funTest/assets/projects/synthetic/no-lockfile/composer.json:"
-            )
+            project.id shouldBe Identifier("Composer::composer.json:")
             project.definitionFilePath shouldBe "plugins/package-managers/composer/src/funTest/assets/projects/" +
                 "synthetic/no-lockfile/composer.json"
             packages should beEmpty()
diff --git a/plugins/package-managers/gradle-inspector/src/funTest/kotlin/GradleAndroidFunTest.kt b/plugins/package-managers/gradle-inspector/src/funTest/kotlin/GradleAndroidFunTest.kt
@@ -26,7 +26,6 @@ import org.ossreviewtoolkit.analyzer.resolveSingleProject
 import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
 import org.ossreviewtoolkit.model.config.Excludes
 import org.ossreviewtoolkit.model.toYaml
-import org.ossreviewtoolkit.utils.test.USER_DIR
 import org.ossreviewtoolkit.utils.test.getAssetFile
 import org.ossreviewtoolkit.utils.test.matchExpectedResult
 
@@ -68,8 +67,13 @@ class GradleAndroidFunTest : StringSpec({
         val definitionFile = getAssetFile("projects/synthetic/gradle-android-cyclic/app/build.gradle").toGradle()
         val expectedResultFile = getAssetFile("projects/synthetic/gradle-android-cyclic-expected-output-app.yml")
 
-        val result = GradleInspectorFactory.create(javaVersion = "17")
-            .resolveDependencies(USER_DIR, listOf(definitionFile), Excludes.EMPTY, AnalyzerConfiguration(), emptyMap())
+        val result = GradleInspectorFactory.create(javaVersion = "17").resolveDependencies(
+            analysisRoot = definitionFile.parentFile,
+            definitionFiles = listOf(definitionFile),
+            excludes = Excludes.EMPTY,
+            analyzerConfig = AnalyzerConfiguration(),
+            labels = emptyMap()
+        )
 
         result.toYaml() should matchExpectedResult(expectedResultFile, definitionFile)
     }
diff --git a/plugins/package-managers/gradle/src/funTest/kotlin/GradleAndroidFunTest.kt b/plugins/package-managers/gradle/src/funTest/kotlin/GradleAndroidFunTest.kt
@@ -26,7 +26,6 @@ import org.ossreviewtoolkit.analyzer.resolveSingleProject
 import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
 import org.ossreviewtoolkit.model.config.Excludes
 import org.ossreviewtoolkit.model.toYaml
-import org.ossreviewtoolkit.utils.test.USER_DIR
 import org.ossreviewtoolkit.utils.test.getAssetFile
 import org.ossreviewtoolkit.utils.test.matchExpectedResult
 
@@ -65,8 +64,13 @@ class GradleAndroidFunTest : StringSpec({
         val definitionFile = getAssetFile("projects/synthetic/gradle-android-cyclic/app/build.gradle")
         val expectedResultFile = getAssetFile("projects/synthetic/gradle-android-cyclic-expected-output-app.yml")
 
-        val result = GradleFactory.create(javaVersion = "17")
-            .resolveDependencies(USER_DIR, listOf(definitionFile), Excludes.EMPTY, AnalyzerConfiguration(), emptyMap())
+        val result = GradleFactory.create(javaVersion = "17").resolveDependencies(
+            analysisRoot = definitionFile.parentFile,
+            definitionFiles = listOf(definitionFile),
+            excludes = Excludes.EMPTY,
+            analyzerConfig = AnalyzerConfiguration(),
+            labels = emptyMap()
+        )
 
         result.toYaml() should matchExpectedResult(expectedResultFile, definitionFile)
     }
diff --git a/plugins/package-managers/maven/src/funTest/kotlin/MavenFunTest.kt b/plugins/package-managers/maven/src/funTest/kotlin/MavenFunTest.kt
@@ -30,8 +30,8 @@ import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
 import org.ossreviewtoolkit.model.config.Excludes
 import org.ossreviewtoolkit.model.toYaml
 import org.ossreviewtoolkit.utils.common.Os
+import org.ossreviewtoolkit.utils.common.getCommonParentFile
 import org.ossreviewtoolkit.utils.common.safeDeleteRecursively
-import org.ossreviewtoolkit.utils.test.USER_DIR
 import org.ossreviewtoolkit.utils.test.getAssetFile
 import org.ossreviewtoolkit.utils.test.matchExpectedResult
 import org.ossreviewtoolkit.utils.test.patchActualResult
@@ -56,10 +56,11 @@ class MavenFunTest : StringSpec({
         // resolution of transitive dependencies would not work.
         val managerResult = with(MavenFactory.create()) {
             val definitionFiles = listOf(definitionFileApp, definitionFileLib)
+            val analysisRoot = getCommonParentFile(definitionFiles)
             val config = AnalyzerConfiguration()
-            beforeResolution(USER_DIR, definitionFiles, config)
-            resolveDependencies(USER_DIR, definitionFiles, Excludes.EMPTY, config, emptyMap()).also {
-                afterResolution(USER_DIR, definitionFiles)
+            beforeResolution(analysisRoot, definitionFiles, config)
+            resolveDependencies(analysisRoot, definitionFiles, Excludes.EMPTY, config, emptyMap()).also {
+                afterResolution(analysisRoot, definitionFiles)
             }
         }
 
diff --git a/plugins/package-managers/python/src/funTest/assets/projects/external/example-python-flask-expected-output.yml b/plugins/package-managers/python/src/funTest/assets/projects/external/example-python-flask-expected-output.yml
@@ -1,6 +1,6 @@
 ---
 project:
-  id: "PIP::example-python-flask:0773991e36a4c69b121cdb05146d6140347d4065"
+  id: "PIP::requirements.txt:0773991e36a4c69b121cdb05146d6140347d4065"
   definition_file_path: "requirements.txt"
   declared_licenses: []
   declared_licenses_processed: {}
diff --git a/plugins/package-managers/python/src/funTest/assets/projects/synthetic/pip-expected-output.yml b/plugins/package-managers/python/src/funTest/assets/projects/synthetic/pip-expected-output.yml
@@ -1,6 +1,6 @@
 ---
 project:
-  id: "PIP::Example-App-with-requirements-pip:2.4.0"
+  id: "PIP::Example-App-with-requirements-requirements.txt:2.4.0"
   definition_file_path: "plugins/package-managers/python/src/funTest/assets/projects/synthetic/pip/requirements.txt"
   declared_licenses:
   - "MIT License"
diff --git a/plugins/package-managers/spdx/src/funTest/kotlin/SpdxDocumentFileFunTest.kt b/plugins/package-managers/spdx/src/funTest/kotlin/SpdxDocumentFileFunTest.kt
@@ -44,8 +44,8 @@ import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
 import org.ossreviewtoolkit.model.config.Excludes
 import org.ossreviewtoolkit.model.toYaml
 import org.ossreviewtoolkit.utils.common.div
+import org.ossreviewtoolkit.utils.common.getCommonParentFile
 import org.ossreviewtoolkit.utils.ort.normalizeVcsUrl
-import org.ossreviewtoolkit.utils.test.USER_DIR
 import org.ossreviewtoolkit.utils.test.getAssetFile
 import org.ossreviewtoolkit.utils.test.matchExpectedResult
 
@@ -80,8 +80,9 @@ class SpdxDocumentFileFunTest : WordSpec({
             val zlibId = Identifier("SpdxDocumentFile::zlib:1.2.11")
 
             val definitionFiles = listOf(curlPackageFile, opensslPackageFile, zlibPackageFile)
+            val analyzerRoot = getCommonParentFile(definitionFiles)
             val actualResult = SpdxDocumentFileFactory.create()
-                .resolveDependencies(USER_DIR, definitionFiles, Excludes.EMPTY, AnalyzerConfiguration(), emptyMap())
+                .resolveDependencies(analyzerRoot, definitionFiles, Excludes.EMPTY, AnalyzerConfiguration(), emptyMap())
                 // Extract only ProjectAnalyzerResults to avoid depending on other analyzer result specific items (e.g.
                 // the dependency graph).
                 .projectResults.values.flatten().associateBy { it.project.id }
@@ -160,9 +161,10 @@ class SpdxDocumentFileFunTest : WordSpec({
 
             val projectFile = projectDir / "transitive-dependencies" / "project-xyz.spdx.yml"
             val definitionFiles = listOf(projectFile)
+            val analysisRoot = getCommonParentFile(definitionFiles)
 
             val result = SpdxDocumentFileFactory.create()
-                .resolveDependencies(USER_DIR, definitionFiles, Excludes.EMPTY, AnalyzerConfiguration(), emptyMap())
+                .resolveDependencies(analysisRoot, definitionFiles, Excludes.EMPTY, AnalyzerConfiguration(), emptyMap())
 
             result.projectResults[projectFile] shouldNotBeNull {
                 with(single()) {
@@ -189,9 +191,10 @@ class SpdxDocumentFileFunTest : WordSpec({
 
             val projectFile = projectDir / "DEPENDS_ON-packages" / "project-xyz.spdx.yml"
             val definitionFiles = listOf(projectFile)
+            val analysisRoot = getCommonParentFile(definitionFiles)
 
             val result = SpdxDocumentFileFactory.create()
-                .resolveDependencies(USER_DIR, definitionFiles, Excludes.EMPTY, AnalyzerConfiguration(), emptyMap())
+                .resolveDependencies(analysisRoot, definitionFiles, Excludes.EMPTY, AnalyzerConfiguration(), emptyMap())
 
             result.projectResults[projectFile] shouldNotBeNull {
                 with(single()) {
@@ -231,9 +234,10 @@ class SpdxDocumentFileFunTest : WordSpec({
             val packageFile = projectDir / "libs" / "curl" / "package.spdx.yml"
 
             val definitionFiles = listOf(projectFile, packageFile)
+            val analysisRoot = getCommonParentFile(definitionFiles)
 
             val result = SpdxDocumentFileFactory.create()
-                .mapDefinitionFiles(USER_DIR, definitionFiles, AnalyzerConfiguration())
+                .mapDefinitionFiles(analysisRoot, definitionFiles, AnalyzerConfiguration())
 
             result should containExactly(projectFile)
         }
@@ -243,9 +247,10 @@ class SpdxDocumentFileFunTest : WordSpec({
             val packageFileZlib = projectDir / "libs" / "zlib" / "package.spdx.yml"
 
             val definitionFiles = listOf(packageFileCurl, packageFileZlib)
+            val analysisRoot = getCommonParentFile(definitionFiles)
 
             val result = SpdxDocumentFileFactory.create()
-                .mapDefinitionFiles(USER_DIR, definitionFiles, AnalyzerConfiguration())
+                .mapDefinitionFiles(analysisRoot, definitionFiles, AnalyzerConfiguration())
 
             result should containExactly(definitionFiles)
         }
@@ -258,9 +263,10 @@ class SpdxDocumentFileFunTest : WordSpec({
             val projectFile = projectDir / "subproject-dependencies" / "project-xyz.spdx.yml"
             val subProjectFile = projectDir / "subproject-dependencies" / "subproject" / "subproject-xyz.spdx.yml"
             val definitionFiles = listOf(projectFile, subProjectFile)
+            val analysisRoot = getCommonParentFile(definitionFiles)
 
             val result = SpdxDocumentFileFactory.create()
-                .resolveDependencies(USER_DIR, definitionFiles, Excludes.EMPTY, AnalyzerConfiguration(), emptyMap())
+                .resolveDependencies(analysisRoot, definitionFiles, Excludes.EMPTY, AnalyzerConfiguration(), emptyMap())
             val projectResults = result.projectResults.values.flatten()
             val projectIds = projectResults.map { it.project.id }
             val packageIds = projectResults.flatMap { projResult -> projResult.packages.map { it.id } }
@@ -280,9 +286,10 @@ class SpdxDocumentFileFunTest : WordSpec({
             val projectFile = projectDir / "illegal-chars-external-refs" / "project-xyz.spdx.yml"
             val subProjectFile = projectDir / "illegal-chars-external-refs" / "illegal_chars" / "package.spdx.yml"
             val definitionFiles = listOf(projectFile, subProjectFile)
+            val analysisRoot = getCommonParentFile(definitionFiles)
 
             val result = SpdxDocumentFileFactory.create()
-                .resolveDependencies(USER_DIR, definitionFiles, Excludes.EMPTY, AnalyzerConfiguration(), emptyMap())
+                .resolveDependencies(analysisRoot, definitionFiles, Excludes.EMPTY, AnalyzerConfiguration(), emptyMap())
 
             val rootProject = result.projectResults[projectFile.absoluteFile]?.first()
 
