feat(cli): Print the JDK version ORT was built with

Signed-off-by: Sebastian Schuberth <[email protected]>
oss-review-toolkit · Mar 14, 2024 · fad4d5e · fad4d5e
1 parent 3112df6
commit fad4d5e
Show file tree

Hide file tree

Showing 18 changed files with 45 additions and 3 deletions.
diff --git a/buildSrc/src/main/kotlin/ort-kotlin-conventions.gradle.kts b/buildSrc/src/main/kotlin/ort-kotlin-conventions.gradle.kts
@@ -113,6 +113,12 @@ java {
     }
 }
 
+tasks.withType<Jar>().configureEach {
+    manifest {
+        attributes["Build-Jdk"] = javaToolchains.compilerFor(java.toolchain).map { it.metadata.jvmVersion }
+    }
+}
+
 val maxKotlinJvmTarget = runCatching { JvmTarget.fromTarget(javaLanguageVersion) }
     .getOrDefault(enumValues<JvmTarget>().max())
 

diff --git a/cli/src/funTest/assets/git-repo-expected-output.yml b/cli/src/funTest/assets/git-repo-expected-output.yml
@@ -47,6 +47,7 @@ analyzer:
   end_time: "1970-01-01T00:00:00Z"
   environment:
     ort_version: "HEAD"
+    build_jdk: "<REPLACE_JDK>"
     java_version: "<REPLACE_JAVA>"
     os: "<REPLACE_OS>"
     processors: "<REPLACE_PROCESSORS>"

diff --git a/cli/src/funTest/assets/gradle-all-dependencies-expected-result-with-curations.yml b/cli/src/funTest/assets/gradle-all-dependencies-expected-result-with-curations.yml
@@ -40,6 +40,7 @@ analyzer:
   end_time: "1970-01-01T00:00:00Z"
   environment:
     ort_version: "HEAD"
+    build_jdk: "<REPLACE_JDK>"
     java_version: "<REPLACE_JAVA>"
     os: "<REPLACE_OS>"
     processors: "<REPLACE_PROCESSORS>"

diff --git a/cli/src/main/kotlin/OrtMain.kt b/cli/src/main/kotlin/OrtMain.kt
@@ -190,9 +190,9 @@ class OrtMain : CliktCommand(
 
                 cell(
                     """
-                        The OSS Review Toolkit, version ${Theme.Default.info(version)}.
-    
-                        Running$command$user under Java ${env.javaVersion} on ${env.os}
+                        The OSS Review Toolkit, version ${Theme.Default.info(version)},
+                        built with JDK ${env.buildJdk}, running under Java ${env.javaVersion}.
+                        Executing$command$user on ${env.os}
                         with ${env.processors} CPUs and a maximum of $maxMemInMib MiB of memory.
                     """.trimIndent()
                 )

diff --git a/model/src/test/assets/result-with-issues-graph-old.yml b/model/src/test/assets/result-with-issues-graph-old.yml
@@ -16,6 +16,7 @@ analyzer:
   end_time: "1970-01-01T00:00:00Z"
   environment:
     ort_version: "HEAD"
+    build_jdk: "<REPLACE_JDK>"
     java_version: "<REPLACE_JAVA>"
     os: "<REPLACE_OS>"
     processors: 4

diff --git a/model/src/test/assets/result-with-issues-graph.yml b/model/src/test/assets/result-with-issues-graph.yml
@@ -16,6 +16,7 @@ analyzer:
   end_time: "1970-01-01T00:00:00Z"
   environment:
     ort_version: "HEAD"
+    build_jdk: "<REPLACE_JDK>"
     java_version: "<REPLACE_JAVA>"
     os: "<REPLACE_OS>"
     processors: 4

diff --git a/model/src/test/assets/result-with-issues-scopes.yml b/model/src/test/assets/result-with-issues-scopes.yml
@@ -16,6 +16,7 @@ analyzer:
   end_time: "1970-01-01T00:00:00Z"
   environment:
     ort_version: "HEAD"
+    build_jdk: "<REPLACE_JDK>"
     java_version: "<REPLACE_JAVA>"
     os: "<REPLACE_OS>"
     processors: 4

diff --git a/model/src/test/assets/sbt-multi-project-example-expected-output.yml b/model/src/test/assets/sbt-multi-project-example-expected-output.yml
@@ -16,6 +16,7 @@ analyzer:
   end_time: "1970-01-01T00:00:00Z"
   environment:
     ort_version: "HEAD"
+    build_jdk: "<REPLACE_JDK>"
     java_version: "<REPLACE_JAVA>"
     os: "<REPLACE_OS>"
     processors: "<REPLACE_PROCESSORS>"

diff --git a/model/src/test/assets/sbt-multi-project-example-graph-old.yml b/model/src/test/assets/sbt-multi-project-example-graph-old.yml
@@ -16,6 +16,7 @@ analyzer:
   end_time: "1970-01-01T00:00:00Z"
   environment:
     ort_version: "HEAD"
+    build_jdk: "<REPLACE_JDK>"
     java_version: "<REPLACE_JAVA>"
     os: "<REPLACE_OS>"
     processors: "<REPLACE_PROCESSORS>"

diff --git a/model/src/test/assets/sbt-multi-project-example-graph.yml b/model/src/test/assets/sbt-multi-project-example-graph.yml
@@ -16,6 +16,7 @@ analyzer:
   end_time: "1970-01-01T00:00:00Z"
   environment:
     ort_version: "HEAD"
+    build_jdk: "<REPLACE_JDK>"
     java_version: "<REPLACE_JAVA>"
     os: "<REPLACE_OS>"
     processors: "<REPLACE_PROCESSORS>"

diff --git a/...e-managers/node/src/funTest/assets/projects/synthetic/pnpm-workspaces-expected-output.yml b/...e-managers/node/src/funTest/assets/projects/synthetic/pnpm-workspaces-expected-output.yml
@@ -16,6 +16,7 @@ analyzer:
   end_time: "1970-01-01T00:00:00Z"
   environment:
     ort_version: "HEAD"
+    build_jdk: "<REPLACE_JDK>"
     java_version: "<REPLACE_JAVA>"
     os: "<REPLACE_OS>"
     processors: "<REPLACE_PROCESSORS>"

diff --git a/...rs/sbt/src/funTest/assets/projects/external/sbt-multi-project-example-expected-output.yml b/...rs/sbt/src/funTest/assets/projects/external/sbt-multi-project-example-expected-output.yml
@@ -16,6 +16,7 @@ analyzer:
   end_time: "1970-01-01T00:00:00Z"
   environment:
     ort_version: "HEAD"
+    build_jdk: "<REPLACE_JDK>"
     java_version: "<REPLACE_JAVA>"
     os: "<REPLACE_OS>"
     processors: "<REPLACE_PROCESSORS>"

diff --git a/...anagers/sbt/src/funTest/assets/projects/synthetic/sbt-http4s-template-expected-output.yml b/...anagers/sbt/src/funTest/assets/projects/synthetic/sbt-http4s-template-expected-output.yml
@@ -16,6 +16,7 @@ analyzer:
   end_time: "1970-01-01T00:00:00Z"
   environment:
     ort_version: "HEAD"
+    build_jdk: "<REPLACE_JDK>"
     java_version: "<REPLACE_JAVA>"
     os: "<REPLACE_OS>"
     processors: "<REPLACE_PROCESSORS>"

diff --git a/plugins/reporters/web-app/src/funTest/assets/scan-result-for-synthetic-gradle-lib.yml b/plugins/reporters/web-app/src/funTest/assets/scan-result-for-synthetic-gradle-lib.yml
@@ -16,6 +16,7 @@ analyzer:
   end_time: "1970-01-01T00:00:00Z"
   environment:
     ort_version: "HEAD"
+    build_jdk: "<REPLACE_JDK>"
     java_version: "<REPLACE_JAVA>"
     os: "<REPLACE_OS>"
     processors: "<REPLACE_PROCESSORS>"
@@ -188,6 +189,7 @@ scanner:
   end_time: "1970-01-01T00:00:00Z"
   environment:
     ort_version: "HEAD"
+    build_jdk: "<REPLACE_JDK>"
     java_version: "<REPLACE_JAVA>"
     os: "<REPLACE_OS>"
     processors: "<REPLACE_PROCESSORS>"

diff --git a/scanner/src/funTest/assets/scanner-integration-all-pkgs-expected-ort-result.yml b/scanner/src/funTest/assets/scanner-integration-all-pkgs-expected-ort-result.yml
@@ -16,6 +16,7 @@ analyzer:
   end_time: "1970-01-01T00:00:00Z"
   environment:
     ort_version: "HEAD"
+    build_jdk: "<REPLACE_JDK>"
     java_version: "<REPLACE_JAVA>"
     os: "<REPLACE_OS>"
     processors: "<REPLACE_PROCESSORS>"
@@ -186,6 +187,7 @@ scanner:
   end_time: "1970-01-01T00:00:00Z"
   environment:
     ort_version: "HEAD"
+    build_jdk: "<REPLACE_JDK>"
     java_version: "<REPLACE_JAVA>"
     os: "<REPLACE_OS>"
     processors: "<REPLACE_PROCESSORS>"

diff --git a/scanner/src/funTest/assets/scanner-integration-subset-pkgs-expected-ort-result.yml b/scanner/src/funTest/assets/scanner-integration-subset-pkgs-expected-ort-result.yml
@@ -16,6 +16,7 @@ analyzer:
   end_time: "1970-01-01T00:00:00Z"
   environment:
     ort_version: "HEAD"
+    build_jdk: "<REPLACE_JDK>"
     java_version: "<REPLACE_JAVA>"
     os: "<REPLACE_OS>"
     processors: "<REPLACE_PROCESSORS>"
@@ -105,6 +106,7 @@ scanner:
   end_time: "1970-01-01T00:00:00Z"
   environment:
     ort_version: "HEAD"
+    build_jdk: "<REPLACE_JDK>"
     java_version: "<REPLACE_JAVA>"
     os: "<REPLACE_OS>"
     processors: "<REPLACE_PROCESSORS>"

diff --git a/utils/ort/src/main/kotlin/Environment.kt b/utils/ort/src/main/kotlin/Environment.kt
@@ -21,6 +21,7 @@ package org.ossreviewtoolkit.utils.ort
 
 import java.io.File
 import java.lang.Runtime
+import java.util.jar.JarFile
 
 import org.ossreviewtoolkit.utils.common.Os
 
@@ -33,6 +34,11 @@ data class Environment(
      */
     val ortVersion: String = ORT_VERSION,
 
+    /**
+     * The JDK version ORT was built with.
+     */
+    val buildJdk: String = BUILD_JDK,
+
     /**
      * The version of Java used.
      */
@@ -71,6 +77,18 @@ data class Environment(
          */
         val ORT_VERSION by lazy { this::class.java.`package`.implementationVersion ?: "IDE-SNAPSHOT" }
 
+        /**
+         * The version of the OSS Review Toolkit as a string.
+         */
+        val BUILD_JDK: String by lazy {
+            runCatching {
+                val codeSource = this::class.java.protectionDomain.codeSource
+                JarFile(codeSource?.location?.file).use {
+                    it.manifest.mainAttributes.getValue("Build-Jdk")
+                }
+            }.getOrDefault(System.getProperty("java.version"))
+        }
+
         /**
          * A string that is supposed to be used as the User Agent when using ORT as an HTTP client.
          */

diff --git a/utils/test/src/main/kotlin/Utils.kt b/utils/test/src/main/kotlin/Utils.kt
@@ -92,6 +92,7 @@ fun patchExpectedResult(
     val env = Environment()
 
     val replacements = buildMap {
+        put("<REPLACE_JDK>", env.buildJdk)
         put("<REPLACE_JAVA>", env.javaVersion)
         put("<REPLACE_OS>", env.os)
         put("\"<REPLACE_PROCESSORS>\"", env.processors.toString())