Automatic discovery of JDK Toolchains #1129

gnodet · 2023-05-25T18:14:25Z

Currently, the need to support JDK 8 as a target kinda implies that maven itself needs to run with JDK 8. Toolchains are not easy to use and require a few manual steps.
This commit aims at reducing the burden of using toolchains so that maven get use JDK 11 as a requirement for running, but making it easy for users to target a different JDK.

The code currently adds automatic discovery of JDK on various platforms (though no WSL which looks quite complicated to support). The idea is also to see if the configuration of the toolchain plugin in the pom can also be simplified somehow.

This borrows code from IntelliJ Idea (which is ASL2).

kwin · 2023-05-25T18:26:47Z

implies that maven itself needs to run with JDK 8

Why not using cross compilation with newest javac still supporting Java 8 bytecode?

gnodet · 2023-05-25T18:30:03Z

implies that maven itself needs to run with JDK 8

Why not using cross compilation with newest javac still supporting Java 8 bytecode?

What do you mean exactly ? I may have missed something...

kwin · 2023-05-25T18:34:41Z

implies that maven itself needs to run with JDK 8

Why not using cross compilation with newest javac still supporting Java 8 bytecode?

What do you mean exactly ? I may have missed something...

Usually using maven.compiler.release set to 8 is enough. No need to run the build with JDK 8 or toolchains (except for running ITs)

gnodet · 2023-05-25T18:48:45Z

implies that maven itself needs to run with JDK 8

Why not using cross compilation with newest javac still supporting Java 8 bytecode?

What do you mean exactly ? I may have missed something...

Usually using maven.compiler.release set to 8 is enough. No need to run the build with JDK 8 or toolchains.

Yes, if they are people are happy building with this option, they definitely don't need to use toolchains. My understanding is that when running tests, people quite like the tests to be run in the target environment.
For those that want to use the target JDK, I think simplifying the usage of toolchains would be a win.

olamy · 2023-05-25T22:25:30Z

very interesting/nice feature!
sdkman can be used with osx as well. I haven’t reviewed the code enough but not sure if the current draft takes care of this? IntelliJ does ;)

gnodet · 2023-05-25T22:42:36Z

very interesting/nice feature!
sdkman can be used with osx as well. I haven’t reviewed the code enough but not sure if the current draft takes care of this? IntelliJ does ;)

yes, that's taken care of !

gnodet · 2023-05-26T19:13:36Z

The PR apache/maven-toolchains-plugin#14 provides a new mojo that displays the list of discovered toolchains.

➜  maven git:(discover-toolchains) ✗ ~/work/git/maven/apache-maven/target/apache-maven-4.0.0-alpha-6-SNAPSHOT/bin/mvn org.apache.maven.plugins:maven-toolchains-plugin:4.0.0-SNAPSHOT:display-discovered-toolchains -N
[INFO] Scanning for projects...
[INFO] 
[INFO] ------------------------------------------------< org.apache.maven:maven >------------------------------------------------
[INFO] Building Apache Maven 4.0.0-alpha-6-SNAPSHOT
[INFO]   from pom.xml
[INFO] ---------------------------------------------------------[ pom ]----------------------------------------------------------
[INFO] 
[INFO] --- toolchains:4.0.0-SNAPSHOT:display-discovered-toolchains (default-cli) @ maven ---
<?xml version="1.0" encoding="UTF-8"?>
<toolchains xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>1.8.0_372</version>
      <runtime.name>OpenJDK Runtime Environment</runtime.name>
      <runtime.version>1.8.0_372-b07</runtime.version>
      <vendor>Azul Systems, Inc.</vendor>
    </provides>
    <configuration>
      <jdkHome>/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/jre</jdkHome>
    </configuration>
  </toolchain>
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>1.8.0_362</version>
      <runtime.name>OpenJDK Runtime Environment</runtime.name>
      <runtime.version>1.8.0_362-b09</runtime.version>
      <vendor>BellSoft</vendor>
    </provides>
    <configuration>
      <jdkHome>/Users/gnodet/.sdkman/candidates/java/8.0.362-librca/jre</jdkHome>
    </configuration>
  </toolchain>
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>17.0.6</version>
      <runtime.name>OpenJDK Runtime Environment</runtime.name>
      <runtime.version>17.0.6+10</runtime.version>
      <vendor>Eclipse Adoptium</vendor>
      <vendor.version>Temurin-17.0.6+10</vendor.version>
    </provides>
    <configuration>
      <jdkHome>/Users/gnodet/.sdkman/candidates/java/17.0.6-tem</jdkHome>
    </configuration>
  </toolchain>
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>20</version>
      <runtime.name>OpenJDK Runtime Environment</runtime.name>
      <runtime.version>20+36</runtime.version>
      <vendor>Eclipse Adoptium</vendor>
      <vendor.version>Temurin-20+36</vendor.version>
    </provides>
    <configuration>
      <jdkHome>/Users/gnodet/.sdkman/candidates/java/20-tem</jdkHome>
    </configuration>
  </toolchain>
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>11.0.17</version>
      <runtime.name>OpenJDK Runtime Environment</runtime.name>
      <runtime.version>11.0.17+8-jvmci-22.3-b08</runtime.version>
      <vendor>GraalVM Community</vendor>
      <vendor.version>GraalVM CE 22.3.0</vendor.version>
    </provides>
    <configuration>
      <jdkHome>/Users/gnodet/.sdkman/candidates/java/22.3.r11-grl</jdkHome>
    </configuration>
  </toolchain>
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>11.0.18</version>
      <runtime.name>OpenJDK Runtime Environment</runtime.name>
      <runtime.version>11.0.18+10-jvmci-22.3-b13</runtime.version>
      <vendor>GraalVM Community</vendor>
      <vendor.version>GraalVM CE 22.3.1</vendor.version>
    </provides>
    <configuration>
      <jdkHome>/Library/Java/JavaVirtualMachines/graalvm-ce-java11-22.3.1/Contents/Home</jdkHome>
    </configuration>
  </toolchain>
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>17.0.5</version>
      <runtime.name>OpenJDK Runtime Environment</runtime.name>
      <runtime.version>17.0.5+8-jvmci-22.3-b08</runtime.version>
      <vendor>GraalVM Community</vendor>
      <vendor.version>GraalVM CE 22.3.0</vendor.version>
    </provides>
    <configuration>
      <jdkHome>/Users/gnodet/.sdkman/candidates/java/22.3.r17-grl</jdkHome>
    </configuration>
  </toolchain>
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>17.0.5</version>
      <runtime.name>OpenJDK Runtime Environment</runtime.name>
      <runtime.version>17.0.5+8-jvmci-22.3-b08</runtime.version>
      <vendor>GraalVM Community</vendor>
      <vendor.version>GraalVM CE 22.3.0</vendor.version>
    </provides>
    <configuration>
      <jdkHome>/Users/gnodet/.sdkman/candidates/java/22.3.r17-grl</jdkHome>
    </configuration>
  </toolchain>
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>17.0.6</version>
      <runtime.name>OpenJDK Runtime Environment</runtime.name>
      <runtime.version>17.0.6+10-jvmci-22.3-b13</runtime.version>
      <vendor>GraalVM Community</vendor>
      <vendor.version>GraalVM CE 22.3.1</vendor.version>
    </provides>
    <configuration>
      <jdkHome>/Library/Java/JavaVirtualMachines/graalvm-ce-java17-22.3.1/Contents/Home</jdkHome>
    </configuration>
  </toolchain>
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>17.0.6</version>
      <runtime.name>OpenJDK Runtime Environment</runtime.name>
      <runtime.version>17.0.6+10-jvmci-22.3-b13</runtime.version>
      <vendor>GraalVM Community</vendor>
      <vendor.version>GraalVM CE 22.3.1</vendor.version>
    </provides>
    <configuration>
      <jdkHome>/Users/gnodet/.sdkman/candidates/java/22.3.1.r17-grl</jdkHome>
    </configuration>
  </toolchain>
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>20-ea</version>
      <runtime.name>OpenJDK Runtime Environment</runtime.name>
      <runtime.version>20-ea+24-1795</runtime.version>
      <vendor>Oracle Corporation</vendor>
    </provides>
    <configuration>
      <jdkHome>/Library/Java/JavaVirtualMachines/jdk-20.jdk/Contents/Home</jdkHome>
    </configuration>
  </toolchain>
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>21-ea</version>
      <runtime.name>OpenJDK Runtime Environment</runtime.name>
      <runtime.version>21-ea+22-1890</runtime.version>
      <vendor>Oracle Corporation</vendor>
    </provides>
    <configuration>
      <jdkHome>/Users/gnodet/.sdkman/candidates/java/21.ea.22-open</jdkHome>
    </configuration>
  </toolchain>
</toolchains>

[INFO] Copying org.apache.maven:maven:pom:4.0.0-alpha-6-SNAPSHOT to project local repository
[INFO] Copying org.apache.maven:maven:pom:consumer:4.0.0-alpha-6-SNAPSHOT to project local repository
[INFO] --------------------------------------------------------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] --------------------------------------------------------------------------------------------------------------------------
[INFO] Total time:  1.051 s
[INFO] Finished at: 2023-05-26T21:07:20+02:00
[INFO] --------------------------------------------------------------------------------------------------------------------------
➜  maven git:(discover-toolchains) ✗

gnodet · 2023-05-26T21:11:34Z

I'm planning to add better support for the current JDK toolchain. The selection of the toolchain by the mojo, in the case of the JDK toolchain, should take into account the current toolchain with several modes:

ignore : always use a toolchain
if-same : if the selection selects the current toolchain, then do not use any toolchain to avoid forking tools
if-match : first match the current toolchain against the set of requirements, and use it (i.e. do not use any toolchain) if they match. This should also avoid discovering all JDK toolchains if the current one matches

Also, the selection may be made slightly easier for the JDK toolchains, as the set of properties is kinda determined by the discovery mechanism, so a dedicated mojo may be needed for the JDK toolchain.

The discovery could be stored to disk, at least the mapping between the jdk home and the properties, so that we don't have to launch all the JVMs to get the information.

I also wonder if the jdk profile activation should use the toolchain.

...hain-builder/src/main/java/org/apache/maven/toolchain/building/DefaultToolchainsBuilder.java

maven-toolchain-builder/src/main/java/org/apache/maven/toolchain/discovery/JavaHomeFinder.java

...oolchain-builder/src/main/java/org/apache/maven/toolchain/discovery/JavaHomeFinderBasic.java

gnodet · 2023-05-30T10:58:01Z

I actually wonder if it would make more sense to move that code into the maven-toolchains-plugin. This plugin is actually required to select the toolchain, as there's no other official way afaik (one can always rewrite a different plugin).
So the discovery could happen at the time the toolchain is selected, which would avoid the need to perform the discovery if not needed.

gnodet · 2023-05-30T22:32:24Z

Given the way toolchains are defined and used in the code, there's no real reason to split the discovery process from the selection process, so I'm closing this PR in favour of apache/maven-toolchains-plugin#14 which adds 3 mojos to discover and display / generate an xml / select the toolchain.

Automatic discovery of JDK Toolchains

b50e2d7

gnodet force-pushed the discover-toolchains branch from 19acf20 to b50e2d7 Compare May 25, 2023 18:29

mthmulders reviewed May 28, 2023

View reviewed changes

gnodet added 10 commits May 29, 2023 20:49

Simplify code

16a4b4b

Add cache and compute in parallel

24420c6

Ensure non null arguments and simplify code

01293cf

Use Path in Toolchain#findTool, allow wrapping JavaToolchain

642c67c

Add javadoc

dd58fc0

Add logging framework for tests

ea97c75

Add constant for JDK type

b5cb1a6

Cleanup

15e85e9

Fix possible NPE

1d3d305

Add a discovery mode config option

1034fb7

gnodet closed this May 30, 2023

Automatic discovery of JDK Toolchains #1129

Automatic discovery of JDK Toolchains #1129

Uh oh!

Conversation

gnodet commented May 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kwin commented May 25, 2023

Uh oh!

gnodet commented May 25, 2023

Uh oh!

kwin commented May 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gnodet commented May 25, 2023

Uh oh!

olamy commented May 25, 2023

Uh oh!

gnodet commented May 25, 2023

Uh oh!

gnodet commented May 26, 2023

Uh oh!

gnodet commented May 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gnodet commented May 30, 2023

Uh oh!

gnodet commented May 30, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

gnodet commented May 25, 2023 •

edited

Loading

kwin commented May 25, 2023 •

edited

Loading

gnodet commented May 26, 2023 •

edited

Loading