From 28408474fc04eb9c80f6393418f904306cde89d2 Mon Sep 17 00:00:00 2001 From: Sebastian Schuberth Date: Tue, 17 Oct 2017 16:34:54 +0200 Subject: [PATCH] Rename ScanResult to AnalyzerResult Because this is actually created by the analyzer, not by the scanner module. Change-Id: Iae73b17241b3af855c8755ade57602f6fd074876 --- analyzer/src/main/kotlin/Main.kt | 4 ++-- analyzer/src/main/kotlin/PackageManager.kt | 4 ++-- analyzer/src/main/kotlin/managers/Bower.kt | 4 ++-- analyzer/src/main/kotlin/managers/Bundler.kt | 4 ++-- analyzer/src/main/kotlin/managers/CocoaPods.kt | 4 ++-- analyzer/src/main/kotlin/managers/Godep.kt | 4 ++-- analyzer/src/main/kotlin/managers/Gradle.kt | 4 ++-- analyzer/src/main/kotlin/managers/Maven.kt | 4 ++-- analyzer/src/main/kotlin/managers/NPM.kt | 10 +++++----- analyzer/src/main/kotlin/managers/PIP.kt | 8 ++++---- analyzer/src/main/kotlin/managers/SBT.kt | 4 ++-- downloader/src/main/kotlin/Main.kt | 9 ++++----- graph/src/main/kotlin/Main.kt | 11 ++++------- .../main/kotlin/{ScanResult.kt => AnalyzerResult.kt} | 6 +++--- scanner/src/main/kotlin/Main.kt | 10 +++++----- 15 files changed, 43 insertions(+), 47 deletions(-) rename model/src/main/kotlin/{ScanResult.kt => AnalyzerResult.kt} (56%) diff --git a/analyzer/src/main/kotlin/Main.kt b/analyzer/src/main/kotlin/Main.kt index 271384546608a..37344aeb54ee8 100644 --- a/analyzer/src/main/kotlin/Main.kt +++ b/analyzer/src/main/kotlin/Main.kt @@ -175,7 +175,7 @@ object Main { // Print the list of dependencies. val results = manager.resolveDependencies(absoluteProjectPath, paths) - results.forEach { definitionFile, scanResult -> + results.forEach { definitionFile, analyzerResult -> // Mirror the directory structure from the project in the output. val outputDir = File(absoluteOutputPath, definitionFile.parentFile.toRelativeString(absoluteProjectPath)) @@ -183,7 +183,7 @@ object Main { val outputFile = File(outputDir, definitionFile.name.replace('.', '-') + "-dependencies." + outputFormat.fileEnding) println("Writing results for\n\t$definitionFile\nto\n\t$outputFile") - mapper.writerWithDefaultPrettyPrinter().writeValue(outputFile, scanResult) + mapper.writerWithDefaultPrettyPrinter().writeValue(outputFile, analyzerResult) println("done.") } else { log.error { "Unable to create output directory '$outputDir'." } diff --git a/analyzer/src/main/kotlin/PackageManager.kt b/analyzer/src/main/kotlin/PackageManager.kt index 4ddedf34220ab..dd1de5f6afb87 100644 --- a/analyzer/src/main/kotlin/PackageManager.kt +++ b/analyzer/src/main/kotlin/PackageManager.kt @@ -1,7 +1,7 @@ package com.here.ort.analyzer import com.here.ort.analyzer.managers.* -import com.here.ort.model.ScanResult +import com.here.ort.model.AnalyzerResult import java.io.File import java.nio.file.FileSystems @@ -64,5 +64,5 @@ abstract class PackageManager( * Return a tree of resolved dependencies (not necessarily declared dependencies, in case conflicts were resolved) * for each provided path. */ - abstract fun resolveDependencies(projectDir: File, definitionFiles: List): Map + abstract fun resolveDependencies(projectDir: File, definitionFiles: List): Map } diff --git a/analyzer/src/main/kotlin/managers/Bower.kt b/analyzer/src/main/kotlin/managers/Bower.kt index 0f4eebf8601c6..289743f6339be 100644 --- a/analyzer/src/main/kotlin/managers/Bower.kt +++ b/analyzer/src/main/kotlin/managers/Bower.kt @@ -1,7 +1,7 @@ package com.here.ort.analyzer.managers import com.here.ort.analyzer.PackageManager -import com.here.ort.model.ScanResult +import com.here.ort.model.AnalyzerResult import java.io.File @@ -14,7 +14,7 @@ object Bower : PackageManager( return "bower" } - override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { + override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { TODO("not implemented") //To change body of created functions use File | Settings | File Templates. } } diff --git a/analyzer/src/main/kotlin/managers/Bundler.kt b/analyzer/src/main/kotlin/managers/Bundler.kt index aa04680f88a6e..ddae4d569b24c 100644 --- a/analyzer/src/main/kotlin/managers/Bundler.kt +++ b/analyzer/src/main/kotlin/managers/Bundler.kt @@ -1,7 +1,7 @@ package com.here.ort.analyzer.managers import com.here.ort.analyzer.PackageManager -import com.here.ort.model.ScanResult +import com.here.ort.model.AnalyzerResult import java.io.File @@ -15,7 +15,7 @@ object Bundler : PackageManager( return "bundle" } - override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { + override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { TODO("not implemented") //To change body of created functions use File | Settings | File Templates. } } diff --git a/analyzer/src/main/kotlin/managers/CocoaPods.kt b/analyzer/src/main/kotlin/managers/CocoaPods.kt index a87f013858d3a..c55dfabe0bfb7 100644 --- a/analyzer/src/main/kotlin/managers/CocoaPods.kt +++ b/analyzer/src/main/kotlin/managers/CocoaPods.kt @@ -1,7 +1,7 @@ package com.here.ort.analyzer.managers import com.here.ort.analyzer.PackageManager -import com.here.ort.model.ScanResult +import com.here.ort.model.AnalyzerResult import java.io.File @@ -14,7 +14,7 @@ object CocoaPods : PackageManager( return "pod" } - override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { + override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { TODO("not implemented") //To change body of created functions use File | Settings | File Templates. } } diff --git a/analyzer/src/main/kotlin/managers/Godep.kt b/analyzer/src/main/kotlin/managers/Godep.kt index 0400ca0eebd8c..f6ace0f82d0c9 100644 --- a/analyzer/src/main/kotlin/managers/Godep.kt +++ b/analyzer/src/main/kotlin/managers/Godep.kt @@ -1,7 +1,7 @@ package com.here.ort.analyzer.managers import com.here.ort.analyzer.PackageManager -import com.here.ort.model.ScanResult +import com.here.ort.model.AnalyzerResult import java.io.File @@ -14,7 +14,7 @@ object Godep : PackageManager( return "godep" } - override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { + override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { TODO("not implemented") //To change body of created functions use File | Settings | File Templates. } } diff --git a/analyzer/src/main/kotlin/managers/Gradle.kt b/analyzer/src/main/kotlin/managers/Gradle.kt index 0691a4d9805cb..24f9136db7a9f 100644 --- a/analyzer/src/main/kotlin/managers/Gradle.kt +++ b/analyzer/src/main/kotlin/managers/Gradle.kt @@ -1,7 +1,7 @@ package com.here.ort.analyzer.managers import com.here.ort.analyzer.PackageManager -import com.here.ort.model.ScanResult +import com.here.ort.model.AnalyzerResult import com.here.ort.util.OS import java.io.File @@ -28,7 +28,7 @@ object Gradle : PackageManager( return if (File(workingDir, wrapper).isFile) wrapper else gradle } - override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { + override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { TODO("not implemented") //To change body of created functions use File | Settings | File Templates. } } diff --git a/analyzer/src/main/kotlin/managers/Maven.kt b/analyzer/src/main/kotlin/managers/Maven.kt index 9d87f48668cbc..bd8064e3482a0 100644 --- a/analyzer/src/main/kotlin/managers/Maven.kt +++ b/analyzer/src/main/kotlin/managers/Maven.kt @@ -1,7 +1,7 @@ package com.here.ort.analyzer.managers import com.here.ort.analyzer.PackageManager -import com.here.ort.model.ScanResult +import com.here.ort.model.AnalyzerResult import java.io.File @@ -14,7 +14,7 @@ object Maven : PackageManager( return "mvn" } - override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { + override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { TODO("not implemented") //To change body of created functions use File | Settings | File Templates. } } diff --git a/analyzer/src/main/kotlin/managers/NPM.kt b/analyzer/src/main/kotlin/managers/NPM.kt index 708dbbf1bbd44..38b443a9a0f4e 100644 --- a/analyzer/src/main/kotlin/managers/NPM.kt +++ b/analyzer/src/main/kotlin/managers/NPM.kt @@ -10,7 +10,7 @@ import com.here.ort.analyzer.PackageManager import com.here.ort.model.Package import com.here.ort.model.PackageReference import com.here.ort.model.Project -import com.here.ort.model.ScanResult +import com.here.ort.model.AnalyzerResult import com.here.ort.model.Scope import com.here.ort.util.OS import com.here.ort.util.ProcessCapture @@ -53,13 +53,13 @@ object NPM : PackageManager( return if (File(workingDir, "yarn.lock").isFile) yarn else npm } - override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { + override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { // We do not actually depend on any features specific to an NPM 5.x or Yarn version, but we still want to // stick to fixed versions to be sure to get consistent results. checkCommandVersion(npm, Semver("5.3.0", SemverType.NPM), ignoreActualVersion = Main.ignoreVersions) checkCommandVersion(yarn, Semver("1.1.0", SemverType.NPM), ignoreActualVersion = Main.ignoreVersions) - val result = mutableMapOf() + val result = mutableMapOf() definitionFiles.forEach { definitionFile -> val workingDir = definitionFile.parentFile @@ -320,7 +320,7 @@ object NPM : PackageManager( } } - private fun parseProject(packageJson: File, scopes: List, packages: SortedSet): ScanResult { + private fun parseProject(packageJson: File, scopes: List, packages: SortedSet): AnalyzerResult { log.debug { "Parsing project info from ${packageJson.absolutePath}." } val json = jsonMapper.readTree(packageJson) @@ -347,7 +347,7 @@ object NPM : PackageManager( scopes = scopes ) - return ScanResult(project, packages) + return AnalyzerResult(project, packages) } /** diff --git a/analyzer/src/main/kotlin/managers/PIP.kt b/analyzer/src/main/kotlin/managers/PIP.kt index 18bc489ac3d24..9b859ca41faa3 100644 --- a/analyzer/src/main/kotlin/managers/PIP.kt +++ b/analyzer/src/main/kotlin/managers/PIP.kt @@ -9,7 +9,7 @@ import com.here.ort.analyzer.PackageManager import com.here.ort.model.Package import com.here.ort.model.PackageReference import com.here.ort.model.Project -import com.here.ort.model.ScanResult +import com.here.ort.model.AnalyzerResult import com.here.ort.model.Scope import com.here.ort.util.OkHttpClientHelper import com.here.ort.util.OS @@ -69,12 +69,12 @@ object PIP : PackageManager( return process } - override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { + override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { // virtualenv bundles pip. In order to get pip 9.0.1 inside a virtualenv, which is a version that supports // installing packages from a Git URL that include a commit SHA1, we need at least virtualenv 15.1.0. checkCommandVersion("virtualenv", Semver("15.1.0"), ignoreActualVersion = Main.ignoreVersions) - val result = mutableMapOf() + val result = mutableMapOf() definitionFiles.forEach { definitionFile -> val (virtualEnvDir, workingDir) = setupVirtualEnv(definitionFile) @@ -174,7 +174,7 @@ object PIP : PackageManager( scopes = scopes ) - result[definitionFile] = ScanResult(project, packages) + result[definitionFile] = AnalyzerResult(project, packages) // Remove the virtualenv by simply deleting the directory. virtualEnvDir.deleteRecursively() diff --git a/analyzer/src/main/kotlin/managers/SBT.kt b/analyzer/src/main/kotlin/managers/SBT.kt index f092436c12f28..3bce411df1f64 100644 --- a/analyzer/src/main/kotlin/managers/SBT.kt +++ b/analyzer/src/main/kotlin/managers/SBT.kt @@ -1,7 +1,7 @@ package com.here.ort.analyzer.managers import com.here.ort.analyzer.PackageManager -import com.here.ort.model.ScanResult +import com.here.ort.model.AnalyzerResult import java.io.File @@ -14,7 +14,7 @@ object SBT : PackageManager( return "sbt" } - override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { + override fun resolveDependencies(projectDir: File, definitionFiles: List): Map { TODO("not implemented") //To change body of created functions use File | Settings | File Templates. } } diff --git a/downloader/src/main/kotlin/Main.kt b/downloader/src/main/kotlin/Main.kt index b33af434048a6..fdf4900bf9feb 100644 --- a/downloader/src/main/kotlin/Main.kt +++ b/downloader/src/main/kotlin/Main.kt @@ -9,7 +9,7 @@ import com.beust.jcommander.ParameterException import com.here.ort.model.OutputFormat import com.here.ort.model.Package -import com.here.ort.model.ScanResult +import com.here.ort.model.AnalyzerResult import com.here.ort.util.jsonMapper import com.here.ort.util.log import com.here.ort.util.safeMkdirs @@ -128,16 +128,15 @@ object Main { outputDir.safeMkdirs() - val scanResult = mapper.readValue(dependenciesFile, ScanResult::class.java) - + val analyzerResult = mapper.readValue(dependenciesFile, AnalyzerResult::class.java) val packages = mutableListOf() if (entities.contains(DataEntity.PROJECT)) { - packages.add(scanResult.project.toPackage()) + packages.add(analyzerResult.project.toPackage()) } if (entities.contains(DataEntity.PACKAGES)) { - packages.addAll(scanResult.packages) + packages.addAll(analyzerResult.packages) } packages.forEach { pkg -> diff --git a/graph/src/main/kotlin/Main.kt b/graph/src/main/kotlin/Main.kt index d04a096b168dd..cbbb8196e0f2c 100644 --- a/graph/src/main/kotlin/Main.kt +++ b/graph/src/main/kotlin/Main.kt @@ -5,7 +5,7 @@ import com.beust.jcommander.Parameter import com.here.ort.model.OutputFormat import com.here.ort.model.PackageReference -import com.here.ort.model.ScanResult +import com.here.ort.model.AnalyzerResult import com.here.ort.util.jsonMapper import com.here.ort.util.log import com.here.ort.util.yamlMapper @@ -87,16 +87,13 @@ object Main { else -> throw IllegalArgumentException("Provided input file is neither JSON or YAML.") } - val scanResult = mapper.readValue(dependenciesFile, ScanResult::class.java) - - showGraph(scanResult) + showGraph(mapper.readValue(dependenciesFile, AnalyzerResult::class.java)) } - private fun showGraph(scanResult: ScanResult) { + private fun showGraph(analyzerResult: AnalyzerResult) { System.setProperty("org.graphstream.ui.renderer", "org.graphstream.ui.j2dviewer.J2DGraphRenderer") - val project = scanResult.project - + val project = analyzerResult.project val graph = SingleGraph(project.name) graph.setStrict(true) diff --git a/model/src/main/kotlin/ScanResult.kt b/model/src/main/kotlin/AnalyzerResult.kt similarity index 56% rename from model/src/main/kotlin/ScanResult.kt rename to model/src/main/kotlin/AnalyzerResult.kt index 295c5f0160eb5..6630a9a04584e 100644 --- a/model/src/main/kotlin/ScanResult.kt +++ b/model/src/main/kotlin/AnalyzerResult.kt @@ -3,11 +3,11 @@ package com.here.ort.model import java.util.SortedSet /** - * A class that bundles all information generated during a scan. + * A class that bundles all information generated during an analysis. */ -data class ScanResult( +data class AnalyzerResult( /** - * The project that was scanned. The tree of dependencies is implicitly contained in the scopes in the form + * The project that was analyzed. The tree of dependencies is implicitly contained in the scopes in the form * of package references. */ val project: Project, diff --git a/scanner/src/main/kotlin/Main.kt b/scanner/src/main/kotlin/Main.kt index 436008cbd4e0c..ab33c06e4e751 100644 --- a/scanner/src/main/kotlin/Main.kt +++ b/scanner/src/main/kotlin/Main.kt @@ -10,7 +10,7 @@ import com.beust.jcommander.ParameterException import com.here.ort.model.OutputFormat import com.here.ort.model.Package import com.here.ort.model.Project -import com.here.ort.model.ScanResult +import com.here.ort.model.AnalyzerResult import com.here.ort.scanner.scanners.ScanCode import com.here.ort.util.jsonMapper import com.here.ort.util.log @@ -148,18 +148,18 @@ object Main { "The output directory '${outputDir.absolutePath}' must not exist yet." } - val scanResult = mapper.readValue(dependenciesFile, ScanResult::class.java) + val analyzerResult = mapper.readValue(dependenciesFile, AnalyzerResult::class.java) println("Using scanner '$scanner'.") - val packages = mutableListOf(scanResult.project.toPackage()) - packages.addAll(scanResult.packages) + val packages = mutableListOf(analyzerResult.project.toPackage()) + packages.addAll(analyzerResult.packages) val summary = mutableMapOf() packages.forEach { pkg -> val entry = summary.getOrPut(pkg.identifier) { SummaryEntry() } - entry.scopes.addAll(findScopesForPackage(pkg, scanResult.project)) + entry.scopes.addAll(findScopesForPackage(pkg, analyzerResult.project)) try { println("Scanning ${pkg.identifier}") entry.licenses.addAll(scanner.scan(pkg, outputDir).sorted())