refactor(analyzer): Add a function to create dependency graph projects

This centralizes project creation which will ease an upcoming change. Signed-off-by: Sebastian Schuberth <[email protected]>
oss-review-toolkit · Nov 14, 2024 · 2f44c7c · 2f44c7c
1 parent 15dcd7b
commit 2f44c7c
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 83 deletions.
diff --git a/analyzer/src/main/kotlin/PackageManager.kt b/analyzer/src/main/kotlin/PackageManager.kt
@@ -41,14 +41,17 @@ import org.ossreviewtoolkit.model.config.Excludes
 import org.ossreviewtoolkit.model.config.PackageManagerConfiguration
 import org.ossreviewtoolkit.model.config.RepositoryConfiguration
 import org.ossreviewtoolkit.model.createAndLogIssue
+import org.ossreviewtoolkit.model.utils.DependencyGraphBuilder
 import org.ossreviewtoolkit.utils.common.Options
 import org.ossreviewtoolkit.utils.common.VCS_DIRECTORIES
 import org.ossreviewtoolkit.utils.common.collapseWhitespace
 import org.ossreviewtoolkit.utils.common.collectMessages
 import org.ossreviewtoolkit.utils.common.isSymbolicLink
+import org.ossreviewtoolkit.utils.ort.DeclaredLicenseProcessor
 import org.ossreviewtoolkit.utils.ort.ORT_CONFIG_FILENAME
 import org.ossreviewtoolkit.utils.ort.normalizeVcsUrl
 import org.ossreviewtoolkit.utils.ort.showStackTrace
+import org.ossreviewtoolkit.utils.spdx.SpdxOperator
 
 typealias ManagedProjectFiles = Map<PackageManagerFactory, List<File>>
 typealias ProjectResults = Map<File, List<ProjectAnalyzerResult>>
@@ -259,6 +262,36 @@ abstract class PackageManager(
      */
     protected open fun afterResolution(definitionFiles: List<File>) {}
 
+    /**
+     * Conveniently create a [Project] for implementations that use the [DependencyGraphBuilder].
+     */
+    fun DependencyGraphBuilder<*>.createProject(
+        namespace: String,
+        name: String,
+        version: String,
+        definitionFile: File,
+        projectDir: File = definitionFile.parentFile,
+        authors: Set<String> = emptySet(),
+        homepageUrl: String = "",
+        declaredLicenses: Set<String> = emptySet(),
+        licenseOperator: SpdxOperator = SpdxOperator.AND,
+        vcsFromProject: VcsInfo = VcsInfo.EMPTY,
+        vararg vcsFallbackUrls: String
+    ): Project {
+        val id = Identifier(projectType, namespace, name, version)
+        return Project(
+            id = id,
+            definitionFilePath = VersionControlSystem.getPathInfo(definitionFile).path,
+            authors = authors,
+            declaredLicenses = declaredLicenses,
+            declaredLicensesProcessed = DeclaredLicenseProcessor.process(declaredLicenses, operator = licenseOperator),
+            vcs = vcsFromProject,
+            vcsProcessed = processProjectVcs(projectDir, vcsFromProject, *vcsFallbackUrls),
+            homepageUrl = homepageUrl,
+            scopeNames = scopesFor(id)
+        )
+    }
+
     /**
      * Generate the final result to be returned by this package manager. This function is called at the very end of the
      * execution of this package manager (after [afterResolution]) with the [projectResults] created for the single

diff --git a/plugins/package-managers/gradle-inspector/src/main/kotlin/GradleInspector.kt b/plugins/package-managers/gradle-inspector/src/main/kotlin/GradleInspector.kt
@@ -36,13 +36,9 @@ import org.gradle.tooling.model.build.BuildEnvironment
 import org.ossreviewtoolkit.analyzer.AbstractPackageManagerFactory
 import org.ossreviewtoolkit.analyzer.PackageManager
 import org.ossreviewtoolkit.analyzer.PackageManagerResult
-import org.ossreviewtoolkit.downloader.VersionControlSystem
-import org.ossreviewtoolkit.model.Identifier
 import org.ossreviewtoolkit.model.Issue
-import org.ossreviewtoolkit.model.Project
 import org.ossreviewtoolkit.model.ProjectAnalyzerResult
 import org.ossreviewtoolkit.model.Severity
-import org.ossreviewtoolkit.model.VcsInfo
 import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
 import org.ossreviewtoolkit.model.config.PackageManagerConfiguration
 import org.ossreviewtoolkit.model.config.RepositoryConfiguration
@@ -243,30 +239,14 @@ class GradleInspector(
             createAndLogIssue(source = managerName, message = it, severity = Severity.WARNING)
         }
 
-        val projectId = Identifier(
-            type = "Gradle",
-            namespace = dependencyTreeModel.group,
-            name = dependencyTreeModel.name,
-            version = dependencyTreeModel.version
-        )
+        val project = with(dependencyTreeModel) { graphBuilder.createProject(group, name, version, definitionFile) }
 
         dependencyTreeModel.configurations.filterNot {
             excludes.isScopeExcluded(it.name)
         }.forEach { configuration ->
-            graphBuilder.addDependencies(projectId, configuration.name, configuration.dependencies)
+            graphBuilder.addDependencies(project.id, configuration.name, configuration.dependencies)
         }
 
-        val project = Project(
-            id = projectId,
-            definitionFilePath = VersionControlSystem.getPathInfo(definitionFile).path,
-            authors = emptySet(),
-            declaredLicenses = emptySet(),
-            vcs = VcsInfo.EMPTY,
-            vcsProcessed = processProjectVcs(definitionFile.parentFile),
-            homepageUrl = "",
-            scopeNames = graphBuilder.scopesFor(projectId)
-        )
-
         val result = ProjectAnalyzerResult(project, emptySet(), issues)
         return listOf(result)
     }

diff --git a/plugins/package-managers/gradle/src/main/kotlin/Gradle.kt b/plugins/package-managers/gradle/src/main/kotlin/Gradle.kt
@@ -41,13 +41,9 @@ import org.gradle.tooling.model.build.BuildEnvironment
 import org.ossreviewtoolkit.analyzer.AbstractPackageManagerFactory
 import org.ossreviewtoolkit.analyzer.PackageManager
 import org.ossreviewtoolkit.analyzer.PackageManagerResult
-import org.ossreviewtoolkit.downloader.VersionControlSystem
-import org.ossreviewtoolkit.model.Identifier
 import org.ossreviewtoolkit.model.Issue
-import org.ossreviewtoolkit.model.Project
 import org.ossreviewtoolkit.model.ProjectAnalyzerResult
 import org.ossreviewtoolkit.model.Severity
-import org.ossreviewtoolkit.model.VcsInfo
 import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
 import org.ossreviewtoolkit.model.config.PackageManagerConfiguration
 import org.ossreviewtoolkit.model.config.RepositoryConfiguration
@@ -292,30 +288,16 @@ class Gradle(
                     "The Gradle project '$projectName' uses the following Maven repositories: $repositories"
                 }
 
-                val projectId = Identifier(
-                    type = managerName,
-                    namespace = dependencyTreeModel.group,
-                    name = dependencyTreeModel.name,
-                    version = dependencyTreeModel.version
-                )
+                val project = with(dependencyTreeModel) {
+                    graphBuilder.createProject(group, name, version, definitionFile)
+                }
 
                 dependencyTreeModel.configurations.filterNot {
                     excludes.isScopeExcluded(it.name)
                 }.forEach { configuration ->
-                    graphBuilder.addDependencies(projectId, configuration.name, configuration.dependencies)
+                    graphBuilder.addDependencies(project.id, configuration.name, configuration.dependencies)
                 }
 
-                val project = Project(
-                    id = projectId,
-                    definitionFilePath = VersionControlSystem.getPathInfo(definitionFile).path,
-                    authors = emptySet(),
-                    declaredLicenses = emptySet(),
-                    vcs = VcsInfo.EMPTY,
-                    vcsProcessed = processProjectVcs(definitionFile.parentFile),
-                    homepageUrl = "",
-                    scopeNames = graphBuilder.scopesFor(projectId)
-                )
-
                 dependencyTreeModel.errors.mapTo(issues) {
                     createAndLogIssue(source = managerName, message = it, severity = Severity.ERROR)
                 }

diff --git a/plugins/package-managers/maven/src/main/kotlin/Maven.kt b/plugins/package-managers/maven/src/main/kotlin/Maven.kt
@@ -31,10 +31,7 @@ import org.eclipse.aether.repository.WorkspaceRepository
 import org.ossreviewtoolkit.analyzer.AbstractPackageManagerFactory
 import org.ossreviewtoolkit.analyzer.PackageManager
 import org.ossreviewtoolkit.analyzer.PackageManagerResult
-import org.ossreviewtoolkit.downloader.VersionControlSystem
 import org.ossreviewtoolkit.model.DependencyGraph
-import org.ossreviewtoolkit.model.Identifier
-import org.ossreviewtoolkit.model.Project
 import org.ossreviewtoolkit.model.ProjectAnalyzerResult
 import org.ossreviewtoolkit.model.Severity
 import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
@@ -50,6 +47,7 @@ import org.ossreviewtoolkit.plugins.packagemanagers.maven.utils.parseLicenses
 import org.ossreviewtoolkit.plugins.packagemanagers.maven.utils.parseVcsInfo
 import org.ossreviewtoolkit.plugins.packagemanagers.maven.utils.processDeclaredLicenses
 import org.ossreviewtoolkit.utils.common.searchUpwardsForSubdirectory
+import org.ossreviewtoolkit.utils.spdx.SpdxOperator
 
 /**
  * The [Maven](https://maven.apache.org/) package manager for Java.
@@ -112,25 +110,6 @@ class Maven(
 
     override fun resolveDependencies(definitionFile: File, labels: Map<String, String>): List<ProjectAnalyzerResult> {
         val workingDir = definitionFile.parentFile
-        val projectBuildingResult = mvn.buildMavenProject(definitionFile)
-        val mavenProject = projectBuildingResult.project
-        val projectId = Identifier(
-            type = managerName,
-            namespace = mavenProject.groupId,
-            name = mavenProject.artifactId,
-            version = mavenProject.version
-        )
-
-        projectBuildingResult.dependencies.filterNot {
-            excludes.isScopeExcluded(it.dependency.scope)
-        }.forEach { node ->
-            graphBuilder.addDependency(DependencyGraph.qualifyScope(projectId, node.dependency.scope), node)
-        }
-
-        val declaredLicenses = parseLicenses(mavenProject)
-        val declaredLicensesProcessed = processDeclaredLicenses(declaredLicenses)
-
-        val vcsFromPackage = parseVcsInfo(mavenProject)
 
         // If running in SBT mode expect that POM files were generated in a "target" subdirectory and that the correct
         // project directory is the parent directory of this.
@@ -140,21 +119,39 @@ class Maven(
             workingDir
         }
 
+        val projectBuildingResult = mvn.buildMavenProject(definitionFile)
+        val mavenProject = projectBuildingResult.project
+
+        val declaredLicenses = parseLicenses(mavenProject)
+
+        val vcsFromProject = parseVcsInfo(mavenProject)
+
         val browsableScmUrl = getOriginalScm(mavenProject)?.url
         val homepageUrl = mavenProject.url
         val vcsFallbackUrls = listOfNotNull(browsableScmUrl, homepageUrl).toTypedArray()
 
-        val project = Project(
-            id = projectId,
-            definitionFilePath = VersionControlSystem.getPathInfo(definitionFile).path,
-            authors = parseAuthors(mavenProject),
-            declaredLicenses = declaredLicenses,
-            declaredLicensesProcessed = declaredLicensesProcessed,
-            vcs = vcsFromPackage,
-            vcsProcessed = processProjectVcs(projectDir, vcsFromPackage, *vcsFallbackUrls),
-            homepageUrl = homepageUrl.orEmpty(),
-            scopeNames = graphBuilder.scopesFor(projectId)
-        )
+        val project = with(mavenProject) {
+            graphBuilder.createProject(
+                namespace = groupId,
+                name = artifactId,
+                version = version,
+                definitionFile = definitionFile,
+                authors = parseAuthors(mavenProject),
+                homepageUrl = homepageUrl.orEmpty(),
+                vcsFallbackUrls = vcsFallbackUrls,
+                declaredLicenses = declaredLicenses,
+                // See http://maven.apache.org/ref/3.6.3/maven-model/maven.html#project saying: "If multiple licenses
+                // are listed, it is assumed that the user can select any of them, not that they must accept all."
+                licenseOperator = SpdxOperator.OR,
+                vcsFromProject = vcsFromProject
+            )
+        }
+
+        projectBuildingResult.dependencies.filterNot {
+            excludes.isScopeExcluded(it.dependency.scope)
+        }.forEach { node ->
+            graphBuilder.addDependency(DependencyGraph.qualifyScope(project.id, node.dependency.scope), node)
+        }
 
         val issues = graphBuilder.packages().mapNotNull { pkg ->
             if (pkg.description == "POM was created by Sonatype Nexus") {

diff --git a/plugins/package-managers/maven/src/main/kotlin/utils/MavenParsers.kt b/plugins/package-managers/maven/src/main/kotlin/utils/MavenParsers.kt
@@ -199,8 +199,3 @@ internal fun parseVcsInfo(project: MavenProject): VcsInfo {
         }
     }
 }
-
-internal fun processDeclaredLicenses(licenses: Set<String>): ProcessedDeclaredLicense =
-    // See http://maven.apache.org/ref/3.6.3/maven-model/maven.html#project which says: "If multiple licenses
-    // are listed, it is assumed that the user can select any of them, not that they must accept all."
-    DeclaredLicenseProcessor.process(licenses, operator = SpdxOperator.OR)
diff --git a/plugins/package-managers/maven/src/main/kotlin/utils/MavenSupport.kt b/plugins/package-managers/maven/src/main/kotlin/utils/MavenSupport.kt
@@ -85,12 +85,14 @@ import org.ossreviewtoolkit.utils.common.DiskCache
 import org.ossreviewtoolkit.utils.common.collectMessages
 import org.ossreviewtoolkit.utils.common.gibibytes
 import org.ossreviewtoolkit.utils.common.searchUpwardsForSubdirectory
+import org.ossreviewtoolkit.utils.ort.DeclaredLicenseProcessor
 import org.ossreviewtoolkit.utils.ort.OrtAuthenticator
 import org.ossreviewtoolkit.utils.ort.OrtProxySelector
 import org.ossreviewtoolkit.utils.ort.downloadText
 import org.ossreviewtoolkit.utils.ort.okHttpClient
 import org.ossreviewtoolkit.utils.ort.ortDataDirectory
 import org.ossreviewtoolkit.utils.ort.showStackTrace
+import org.ossreviewtoolkit.utils.spdx.SpdxOperator
 
 fun Artifact.identifier() = "$groupId:$artifactId:$version"
 
@@ -490,7 +492,10 @@ class MavenSupport(private val workspaceReader: WorkspaceReader) {
         }
 
         val declaredLicenses = parseLicenses(mavenProject)
-        val declaredLicensesProcessed = processDeclaredLicenses(declaredLicenses)
+
+        // See http://maven.apache.org/ref/3.6.3/maven-model/maven.html#project saying: "If multiple licenses
+        // are listed, it is assumed that the user can select any of them, not that they must accept all."
+        val declaredLicensesProcessed = DeclaredLicenseProcessor.process(declaredLicenses, operator = SpdxOperator.OR)
 
         val binaryRemoteArtifact = localProject?.let {
             RemoteArtifact.EMPTY