Move jlink parameters into project.properties (#1062)

* Overhaul JLink
* Add Semeru support
* Add Microsoft JDK support
* Add Amazon support,
* Add Zulu support
* Mac: Fix Java.runtime bundle version
* Update CLI documentation

Author: tresf

ant/project.properties

@@ -32,6 +32,15 @@ javac.source=1.8
 javac.target=1.8
 java.download=https://bell-sw.com/pages/downloads/#/java-11-lts
 
+# Java vendor to bundle into software (e.g. "*BellSoft|Adoptium|Microsoft|Amazon|IBM")
+jlink.java.vendor="BellSoft"
+# Java vendor to bundle into software (e.g. "11.0.17+7")
+jlink.java.version="11.0.17+7"
+# Java garbage collector flavor to use (e.g. "hotspot|openj9")
+jlink.java.gc="hotspot"
+# Java garbage collector version to use (e.g. openj9: "0.35.0", zulu: "11.62.17")
+jlink.java.gc.version="gc-ver-is-empty"
+
 # Skip bundling the java runtime
 # jre.skip=true
 

build.xml

@@ -240,10 +240,12 @@
         <echo level="info">Downloading and bundling the jre for ${target.os}</echo>
         <java jar="${dist.dir}/${project.filename}.jar" fork="true" failonerror="true">
             <arg value="jlink"/>
-            <arg value="--platform"/>
-            <arg value="${target.os}"/>
-            <arg value="--arch"/>
-            <arg value="${target.arch}"/>
+            <arg line="--platform ${target.os}"/>
+            <arg line="--arch ${target.arch}"/>
+            <arg line="--vendor ${jlink.java.vendor}"/>
+            <arg line="--version ${jlink.java.version}"/>
+            <arg line="--gc ${jlink.java.gc}"/>
+            <arg line="--gcversion ${jlink.java.gc.version}"/><!-- openj9 only -->
         </java>
     </target>
 

src/org/dyorgio/jna/platform/mac/NSObject.java

@@ -58,7 +58,7 @@ public void release() {
     }
 
     @Override
-    @SuppressWarnings("FinalizeDeclaration")
+    @SuppressWarnings({"FinalizeDeclaration","deprecation","removal"})
     protected void finalize() throws Throwable {
         release();
         super.finalize();

src/qz/build/JLink.java

@@ -14,6 +14,10 @@
 import org.apache.commons.io.FileUtils;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import qz.build.jlink.Arch;
+import qz.build.jlink.Platform;
+import qz.build.jlink.Vendor;
+import qz.build.jlink.Url;
 import qz.common.Constants;
 import qz.utils.*;
 
@@ -22,44 +26,56 @@
 import java.nio.file.*;
 import java.util.HashMap;
 import java.util.LinkedHashSet;
-import java.util.Locale;
 
 public class JLink {
     private static final Logger log = LogManager.getLogger(JLink.class);
-    private static final String JAVA_VENDOR = "BellSoft";
-    private static final String JAVA_VERSION = "11.0.17+7";
-    private static final String JAVA_MAJOR = JAVA_VERSION.split("\\.")[0];
-    private static final String JAVA_MINOR = JAVA_VERSION.split("\\.")[1];
-    private static final String JAVA_PATCH = JAVA_VERSION.split("\\.|\\+|-")[2];
-    private static final String JAVA_VERSION_FILE = JAVA_VERSION.replaceAll("\\+", "_");
-    private static final String JAVA_DEFAULT_GC_ENGINE = "hotspot";
-    private static final String JAVA_DEFAULT_ARCH = VendorArch.ADOPT_AMD64.use;
+    public static final Vendor JAVA_DEFAULT_VENDOR = Vendor.BELLSOFT;
+    private static final String JAVA_DEFAULT_VERSION = "11.0.17+7";
+    private static final String JAVA_DEFAULT_GC_ENGINE = "hotspot"; // or "openj9"
+    private static final String JAVA_DEFAULT_GC_VERSION = "0.35.0"; // openj9 gc only
 
     private Path jarPath;
     private Path jdepsPath;
     private Path jlinkPath;
     private Path jmodsPath;
     private Path outPath;
     private Version jdepsVersion;
-    private String javaVendor;
-    private String targetPlatform;
+    private Platform hostPlatform;
+    private Platform targetPlatform;
+    private Arch hostArch;
+    private Arch targetArch;
+    private Vendor javaVendor;
+    private String gcEngine;
+    private String javaVersion;
+    private String gcVersion;
+
+    private Version javaSemver;
+
     private LinkedHashSet<String> depList;
 
-    public JLink(String targetPlatform, String arch, String gcEngine) throws IOException {
-        this.javaVendor = JAVA_VENDOR;
-        this.targetPlatform = targetPlatform;
+    public JLink(String targetPlatform, String targetArch, String javaVendor, String javaVersion, String gcEngine, String gcVersion) throws IOException {
+        this.hostPlatform = Platform.getCurrentPlatform();
+        this.hostArch = Arch.getCurrentArch();
+
+        this.targetPlatform = Platform.parse(targetPlatform, this.hostPlatform);
+        this.targetArch = Arch.parse(targetArch, this.hostArch);
+        this.javaVendor =  Vendor.parse(javaVendor, JAVA_DEFAULT_VENDOR);
+        this.gcEngine = getParam("gcEngine", gcEngine, JAVA_DEFAULT_GC_ENGINE);
+        this.javaVersion = getParam("javaVersion", javaVersion, JAVA_DEFAULT_VERSION);
+        this.gcVersion = getParam("gcVersion", gcVersion, JAVA_DEFAULT_GC_VERSION);
+
+        this.javaSemver = SystemUtilities.getJavaVersion(this.javaVersion);
 
-        if(needsDownload(SystemUtilities.getJavaVersion(JAVA_VERSION), Constants.JAVA_VERSION)) {
-            log.warn("Java versions are incompatible, locating a suitable runtime for Java " + JAVA_MAJOR + "...");
-            String hostArch = System.getProperty("os.arch");
-            String hostJdk = downloadJdk(JAVA_VENDOR, null, hostArch, gcEngine);
+        if(needsDownload(javaSemver, Constants.JAVA_VERSION)) {
+            log.warn("Java versions are incompatible, locating a suitable runtime for Java " + javaSemver.getMajorVersion() + "...");
+            String hostJdk = downloadJdk(this.hostArch, this.hostPlatform);
             calculateToolPaths(Paths.get(hostJdk));
         } else {
             calculateToolPaths(null);
         }
 
-        String extractedJdk = downloadJdk(javaVendor, targetPlatform, arch, gcEngine);
-        jmodsPath = Paths.get(extractedJdk, "jmods");
+        String targetJdk = downloadJdk(this.targetArch, this.targetPlatform);
+        jmodsPath = Paths.get(targetJdk, "jmods");
         log.info("Selecting jmods folder: {}", jmodsPath);
 
         calculateJarPath()
@@ -69,16 +85,7 @@ public JLink(String targetPlatform, String arch, String gcEngine) throws IOExcep
     }
 
     public static void main(String ... args) throws IOException {
-        JLink jlink = new JLink(null, null, null).calculateJarPath();
-        System.out.println(jlink.jarPath);
-        if(true) {
-            System.exit(0);
-        }
-
-
-        new JLink(args.length > 0 ? args[0] : null,
-                  args.length > 1 ? args[1] : null,
-                  args.length > 2 ? args[2] : null);
+        new JLink(null, null, null, null, null, null).calculateJarPath();
     }
 
     /**
@@ -103,53 +110,18 @@ private static boolean needsDownload(Version want, Version installed) {
     /**
      * Download the JDK and return the path it was extracted to
      */
-    private static String downloadJdk(String javaVendor, String platform, String arch, String gcEngine) throws IOException {
-        if(platform == null) {
-            // Must match ArgValue.JLINK --platform values
-            switch(SystemUtilities.getOsType()) {
-                case MAC:
-                    platform = "mac";
-                    break;
-                case WINDOWS:
-                    platform = "windows";
-                    break;
-                default:
-                    platform = "linux";
-            }
-
-            log.info("No platform specified, assuming '{}'", platform);
-        }
-
-        arch = VendorArch.match(javaVendor, arch, JAVA_DEFAULT_ARCH);
-        platform = VendorOs.match(javaVendor, platform);
-
-
-        if(gcEngine == null) {
-            gcEngine = JAVA_DEFAULT_GC_ENGINE;
-            log.info("No garbage collector specified, assuming '{}'", gcEngine);
-        }
-
-        String fileExt;
-        switch(VendorUrlPattern.getVendor(javaVendor)) {
-            case BELL:
-                fileExt = platform.equals("linux") ? "tar.gz" : "zip";
-                break;
-            case ADOPT:
-            default:
-                fileExt = platform.equals("windows") ? "zip" : "tar.gz";
-        }
-
-        String url = VendorUrlPattern.format(javaVendor, arch, platform, gcEngine, JAVA_MAJOR, JAVA_VERSION, JAVA_VERSION_FILE, fileExt);
+    private String downloadJdk(Arch arch, Platform platform) throws IOException {
+        String url = new Url(this.javaVendor).format(arch, platform, this.gcEngine, this.javaSemver, this.gcVersion);
 
         // Saves to out e.g. "out/jlink/jdk-AdoptOpenjdk-amd64-platform-11_0_7"
-        String extractedJdk = new Fetcher(String.format("jlink/jdk-%s-%s-%s-%s", javaVendor.toLowerCase(Locale.ENGLISH), arch, platform, JAVA_VERSION_FILE), url)
+        String extractedJdk = new Fetcher(String.format("jlink/jdk-%s-%s-%s-%s", javaVendor.value(), arch.value(), platform.value(), javaSemver.toString().replaceAll("\\+", "_")), url)
                 .fetch()
                 .uncompress();
 
         // Get first subfolder, e.g. jdk-11.0.7+10
         for(File subfolder : new File(extractedJdk).listFiles(pathname -> pathname.isDirectory())) {
             extractedJdk = subfolder.getPath();
-            if(platform.equals("mac") && Paths.get(extractedJdk, "/Contents/Home").toFile().isDirectory()) {
+            if(platform == Platform.MAC && Paths.get(extractedJdk, "/Contents/Home").toFile().isDirectory()) {
                 extractedJdk += "/Contents/Home";
             }
             log.info("Selecting JDK home: {}", extractedJdk);
@@ -165,18 +137,20 @@ private JLink calculateJarPath() {
         } else {
             // Detect out/dist/qz-tray.jar for IDE usage
             jarPath = SystemUtilities.getJarParentPath()
-                    .resolve("../../")
+                    .resolve("dist")
                     .resolve(Constants.PROPS_FILE + ".jar");
         }
         log.info("Assuming jar path: {}", jarPath);
         return this;
     }
 
     private JLink calculateOutPath() {
-        if(targetPlatform.equals("mac")) {
-            outPath = jarPath.resolve("../Java.runtime/Contents/Home").normalize();
-        } else {
-            outPath = jarPath.resolve("../runtime").normalize();
+        switch(targetPlatform) {
+            case MAC:
+                outPath = jarPath.resolve("../Java.runtime/Contents/Home").normalize();
+                break;
+            default:
+                outPath = jarPath.resolve("../runtime").normalize();
         }
         log.info("Assuming output path: {}", outPath);
         return this;
@@ -231,7 +205,7 @@ private JLink calculateDepList() throws IOException {
     }
 
     private JLink deployJre() throws IOException {
-        if(targetPlatform.equals("mac")) {
+        if(targetPlatform == Platform.MAC) {
             // Deploy Contents/MacOS/libjli.dylib
             Path macOS = Files.createDirectories(outPath.resolve("../MacOS").normalize());
             Path jliLib = macOS.resolve("libjli.dylib");
@@ -247,9 +221,10 @@ private JLink deployJre() throws IOException {
             // Deploy Contents/Info.plist
             HashMap<String, String> fieldMap = new HashMap<>();
             fieldMap.put("%BUNDLE_ID%", MacUtilities.getBundleId() + ".jre"); // e.g. io.qz.qz-tray.jre
-            fieldMap.put("%BUNDLE_VERSION%", String.format("%s.%s.%s", JAVA_MAJOR, JAVA_MINOR, JAVA_PATCH));
-            fieldMap.put("%BUNDLE_VERSION_FULL%", JAVA_VERSION);
-            fieldMap.put("%BUNDLE_VENDOR%", javaVendor);
+            fieldMap.put("%BUNDLE_VERSION%", String.format("%s.%s.%s", javaSemver.getMajorVersion(), javaSemver.getMinorVersion(), javaSemver.getPatchVersion()));
+            fieldMap.put("%BUNDLE_VERSION_FULL%", javaSemver.toString());
+            fieldMap.put("%BUNDLE_VENDOR%", javaVendor.getVendorName());
+            fieldMap.put("%BUNDLE_PRODUCT%", javaVendor.getProductName());
             log.info("Deploying {}/Info.plist", macOS.getParent());
             FileUtilities.configureAssetFile("assets/mac-runtime.plist.in", macOS.getParent().resolve("Info.plist"), fieldMap, JLink.class);
         }
@@ -270,13 +245,15 @@ private JLink deployJre() throws IOException {
             // Remove all but java/javaw
             String[] keepFiles;
             String keepExt;
-            if(targetPlatform.equals("windows")) {
-                keepFiles = new String[]{ "java.exe", "javaw.exe" };
-                // Windows stores ".dll" files in bin
-                keepExt = ".dll";
-            } else {
-                keepFiles = new String[]{ "java" };
-                keepExt = null;
+            switch(targetPlatform) {
+                case WINDOWS:
+                    keepFiles = new String[]{ "java.exe", "javaw.exe" };
+                    // Windows stores ".dll" files in bin
+                    keepExt = ".dll";
+                    break;
+                default:
+                    keepFiles = new String[]{ "java" };
+                    keepExt = null;
             }
 
             Files.list(outPath.resolve("bin")).forEach(binFile -> {
@@ -300,4 +277,11 @@ private JLink deployJre() throws IOException {
         throw new IOException("An error occurred deploying the jre.  Please check the logs for details.");
     }
 
+    public static String getParam(String paramName, String value, String fallback) {
+        if(value != null && !value.isEmpty() && !value.trim().isEmpty()) {
+            return value;
+        }
+        log.info("No {} specified, assuming '{}'", paramName, fallback);
+        return fallback;
+    }
 }