Properly deploy OS-specific jars
[cc0/argeo-build.git] / src / org / argeo / build / Make.java
index b83404da7f63928b2069aefe26bfe400bb49a88e..71976c00188d70cdff9125efb6912865fcf610f2 100644 (file)
@@ -20,6 +20,7 @@ import java.nio.file.Path;
 import java.nio.file.PathMatcher;
 import java.nio.file.Paths;
 import java.nio.file.SimpleFileVisitor;
+import java.nio.file.StandardCopyOption;
 import java.nio.file.attribute.BasicFileAttributes;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -77,6 +78,18 @@ public class Make {
         */
        private final static String ENV_ARGEO_BUILD_CONFIG = "ARGEO_BUILD_CONFIG";
 
+       /** Make file variable (in {@link #SDK_MK}) with a path to the sources base. */
+       private final static String VAR_SDK_SRC_BASE = "SDK_SRC_BASE";
+
+       /**
+        * Make file variable (in {@link #SDK_MK}) with a path to the build output base.
+        */
+       private final static String VAR_SDK_BUILD_BASE = "SDK_BUILD_BASE";
+       /**
+        * Make file variable (in {@link #BRANCH_MK}) with the branch.
+        */
+       private final static String VAR_BRANCH = "BRANCH";
+
        /** Name of the local-specific Makefile (sdk.mk). */
        final static String SDK_MK = "sdk.mk";
        /** Name of the branch definition Makefile (branch.mk). */
@@ -97,7 +110,7 @@ public class Make {
        final Path buildBase;
        /** The base of the a2 output for all layers. */
        final Path a2Output;
-       /** The base of the a2 sources when packages separately. */
+       /** The base of the a2 sources when packaged separately. */
        final Path a2srcOutput;
 
        /** Whether sources should be packaged separately. */
@@ -118,8 +131,8 @@ public class Make {
                Path sdkMkP = findSdkMk(execDirectory);
                Objects.requireNonNull(sdkMkP, "No " + SDK_MK + " found under " + execDirectory);
 
-               Map<String, String> context = readeMakefileVariables(sdkMkP);
-               sdkSrcBase = Paths.get(context.computeIfAbsent("SDK_SRC_BASE", (key) -> {
+               Map<String, String> context = readMakefileVariables(sdkMkP);
+               sdkSrcBase = Paths.get(context.computeIfAbsent(VAR_SDK_SRC_BASE, (key) -> {
                        throw new IllegalStateException(key + " not found");
                })).toAbsolutePath();
 
@@ -136,7 +149,7 @@ public class Make {
                }
                argeoBuildBase = argeoBuildBaseT;
 
-               sdkBuildBase = Paths.get(context.computeIfAbsent("SDK_BUILD_BASE", (key) -> {
+               sdkBuildBase = Paths.get(context.computeIfAbsent(VAR_SDK_BUILD_BASE, (key) -> {
                        throw new IllegalStateException(key + " not found");
                })).toAbsolutePath();
                buildBase = sdkBuildBase.resolve(sdkSrcBase.getFileName());
@@ -213,7 +226,8 @@ public class Make {
                }
 
                // sources
-               for (String bundle : bundles) {
+               boolean atLeastOneBundleToCompile = false;
+               bundles: for (String bundle : bundles) {
                        StringBuilder sb = new StringBuilder();
                        Path bundlePath = execDirectory.resolve(bundle);
                        if (!Files.exists(bundlePath)) {
@@ -224,15 +238,24 @@ public class Make {
                                } else
                                        throw new IllegalArgumentException("Bundle " + bundle + " not found in " + execDirectory);
                        }
-                       sb.append(bundlePath.resolve("src"));
+                       Path bundleSrc = bundlePath.resolve("src");
+                       if (!Files.exists(bundleSrc)) {
+                               logger.log(WARNING, bundleSrc + " does not exist, skipping it, as this is not a Java bundle");
+                               continue bundles;
+                       }
+                       sb.append(bundleSrc);
                        sb.append("[-d");
                        compilerArgs.add(sb.toString());
                        sb = new StringBuilder();
                        sb.append(buildBase.resolve(bundle).resolve("bin"));
                        sb.append("]");
                        compilerArgs.add(sb.toString());
+                       atLeastOneBundleToCompile = true;
                }
 
+               if (!atLeastOneBundleToCompile)
+                       return;
+
                if (logger.isLoggable(INFO))
                        compilerArgs.add("-time");
 
@@ -258,7 +281,7 @@ public class Make {
                        return;
 
                List<String> categories = options.get("--category");
-               Objects.requireNonNull(bundles, "--category argument must be set");
+               Objects.requireNonNull(categories, "--category argument must be set");
                if (categories.size() != 1)
                        throw new IllegalArgumentException("One and only one --category must be specified");
                String category = categories.get(0);
@@ -266,8 +289,8 @@ public class Make {
                final String branch;
                Path branchMk = sdkSrcBase.resolve(BRANCH_MK);
                if (Files.exists(branchMk)) {
-                       Map<String, String> branchVariables = readeMakefileVariables(branchMk);
-                       branch = branchVariables.get("BRANCH");
+                       Map<String, String> branchVariables = readMakefileVariables(branchMk);
+                       branch = branchVariables.get(VAR_BRANCH);
                } else {
                        branch = null;
                }
@@ -286,22 +309,135 @@ public class Make {
                }
                CompletableFuture.allOf(toDos.toArray(new CompletableFuture[toDos.size()])).join();
                long duration = System.currentTimeMillis() - begin;
-               logger.log(INFO, "Packaging took " + duration + " ms");
+               logger.log(DEBUG, "Packaging took " + duration + " ms");
+       }
+
+       /** Install or uninstall bundles and native output. */
+       void install(Map<String, List<String>> options, boolean uninstall) throws IOException {
+               final String LIB_ = "lib/";
+               final String NATIVE_ = "native/";
+
+               // check arguments
+               List<String> bundles = multiArg(options, "--bundles", true);
+               if (bundles.isEmpty())
+                       return;
+               String category = singleArg(options, "--category", true);
+               Path targetA2 = Paths.get(singleArg(options, "--target", true));
+               String nativeTargetArg = singleArg(options, "--target-native", false);
+               Path nativeTargetA2 = nativeTargetArg != null ? Paths.get(nativeTargetArg) : null;
+               String targetOs = singleArg(options, "--os", nativeTargetArg != null);
+               logger.log(INFO, (uninstall ? "Uninstalling bundles from " : "Installing bundles to ") + targetA2);
+
+               final String branch;
+               Path branchMk = sdkSrcBase.resolve(BRANCH_MK);
+               if (Files.exists(branchMk)) {
+                       Map<String, String> branchVariables = readMakefileVariables(branchMk);
+                       branch = branchVariables.get(VAR_BRANCH);
+               } else {
+                       throw new IllegalArgumentException(VAR_BRANCH + " variable must be set.");
+               }
+
+               Properties properties = new Properties();
+               Path branchBnd = sdkSrcBase.resolve("sdk/branches/" + branch + ".bnd");
+               if (Files.exists(branchBnd))
+                       try (InputStream in = Files.newInputStream(branchBnd)) {
+                               properties.load(in);
+                       }
+               String major = properties.getProperty("major");
+               Objects.requireNonNull(major, "'major' must be set");
+               String minor = properties.getProperty("minor");
+               Objects.requireNonNull(minor, "'minor' must be set");
+
+               int count = 0;
+               bundles: for (String bundle : bundles) {
+                       Path bundlePath = Paths.get(bundle);
+                       Path bundleParent = bundlePath.getParent();
+                       Path a2JarDirectory = bundleParent != null ? a2Output.resolve(bundleParent).resolve(category)
+                                       : a2Output.resolve(category);
+                       Path jarP = a2JarDirectory.resolve(bundlePath.getFileName() + "." + major + "." + minor + ".jar");
+
+                       Path targetJarP;
+                       if (bundle.startsWith(LIB_)) {// OS-specific
+                               Objects.requireNonNull(nativeTargetA2);
+                               if (bundle.startsWith(LIB_ + NATIVE_) // portable native
+                                               || bundle.startsWith(LIB_ + targetOs + "/" + NATIVE_)) {// OS-specific native
+                                       targetJarP = nativeTargetA2.resolve(category).resolve(jarP.getFileName());
+                               } else if (bundle.startsWith(LIB_ + targetOs)) {// OS-specific portable
+                                       targetJarP = targetA2.resolve(category).resolve(jarP.getFileName());
+                               } else { // ignore other OS
+                                       continue bundles;
+                               }
+                       } else {
+                               targetJarP = targetA2.resolve(a2Output.relativize(jarP));
+                       }
+
+                       if (uninstall) { // uninstall
+                               if (Files.exists(targetJarP)) {
+                                       Files.delete(targetJarP);
+                                       logger.log(DEBUG, "Removed " + targetJarP);
+                                       count++;
+                               }
+                               Path targetParent = targetJarP.getParent();
+                               deleteEmptyParents(targetA2, targetParent);
+                       } else { // install
+                               Files.createDirectories(targetJarP.getParent());
+                               boolean update = Files.exists(targetJarP);
+                               Files.copy(jarP, targetJarP, StandardCopyOption.REPLACE_EXISTING);
+                               logger.log(DEBUG, (update ? "Updated " : "Installed ") + targetJarP);
+                               count++;
+                       }
+               }
+               logger.log(INFO, uninstall ? count + " bundles removed" : count + " bundles installed or updated");
+       }
+
+       /** Extracts an argument which must be unique. */
+       String singleArg(Map<String, List<String>> options, String arg, boolean mandatory) {
+               List<String> values = options.get(arg);
+               if (values == null || values.size() == 0)
+                       if (mandatory)
+                               throw new IllegalArgumentException(arg + " argument must be set");
+                       else
+                               return null;
+               if (values.size() != 1)
+                       throw new IllegalArgumentException("One and only one " + arg + " arguments must be specified");
+               return values.get(0);
+       }
+
+       /** Extracts an argument which can have multiple values. */
+       List<String> multiArg(Map<String, List<String>> options, String arg, boolean mandatory) {
+               List<String> values = options.get(arg);
+               if (mandatory && values == null)
+                       throw new IllegalArgumentException(arg + " argument must be set");
+               return values != null ? values : new ArrayList<>();
+       }
+
+       /** Delete empty parent directory up to the A2 target (included). */
+       void deleteEmptyParents(Path targetA2, Path targetParent) throws IOException {
+               if (!Files.isDirectory(targetParent))
+                       throw new IllegalArgumentException(targetParent + " must be a directory");
+               boolean isA2target = Files.isSameFile(targetA2, targetParent);
+               if (!Files.list(targetParent).iterator().hasNext()) {
+                       Files.delete(targetParent);
+                       if (isA2target)
+                               return;// stop after deleting A2 base
+                       deleteEmptyParents(targetA2, targetParent.getParent());
+               }
        }
 
        /** Package a single bundle. */
        void createBundle(String branch, String bundle, String category) throws IOException {
-               final Path source;
+               final Path bundleSourceBase;
                if (!Files.exists(execDirectory.resolve(bundle))) {
                        logger.log(WARNING,
                                        "Bundle " + bundle + " not found in " + execDirectory + ", assuming this is this directory.");
-                       source = execDirectory;
+                       bundleSourceBase = execDirectory;
                } else {
-                       source = execDirectory.resolve(bundle);
+                       bundleSourceBase = execDirectory.resolve(bundle);
                }
+               Path srcP = bundleSourceBase.resolve("src");
 
                Path compiled = buildBase.resolve(bundle);
-               String bundleSymbolicName = source.getFileName().toString();
+               String bundleSymbolicName = bundleSourceBase.getFileName().toString();
 
                // Metadata
                Properties properties = new Properties();
@@ -318,7 +454,7 @@ public class Make {
                                }
                }
 
-               Path bndBnd = source.resolve("bnd.bnd");
+               Path bndBnd = bundleSourceBase.resolve("bnd.bnd");
                if (Files.exists(bndBnd))
                        try (InputStream in = Files.newInputStream(bndBnd)) {
                                properties.load(in);
@@ -381,10 +517,15 @@ public class Make {
                        });
 
                        // add resources
-                       Files.walkFileTree(source, new SimpleFileVisitor<Path>() {
+                       Files.walkFileTree(bundleSourceBase, new SimpleFileVisitor<Path>() {
                                @Override
                                public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
-                                       Path relativeP = source.relativize(dir);
+                                       // skip output directory if it happens to be within the sources
+                                       if (Files.isSameFile(sdkBuildBase, dir))
+                                               return FileVisitResult.SKIP_SUBTREE;
+
+                                       // skip excluded patterns
+                                       Path relativeP = bundleSourceBase.relativize(dir);
                                        for (PathMatcher exclude : excludes)
                                                if (exclude.matches(relativeP))
                                                        return FileVisitResult.SKIP_SUBTREE;
@@ -394,10 +535,14 @@ public class Make {
 
                                @Override
                                public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
-                                       Path relativeP = source.relativize(file);
+                                       Path relativeP = bundleSourceBase.relativize(file);
                                        for (PathMatcher exclude : excludes)
                                                if (exclude.matches(relativeP))
                                                        return FileVisitResult.CONTINUE;
+                                       // skip JavaScript source maps
+                                       if (sourceBundles && file.getFileName().toString().endsWith(".map"))
+                                               return FileVisitResult.CONTINUE;
+
                                        JarEntry entry = new JarEntry(relativeP.toString());
                                        jarOut.putNextEntry(entry);
                                        Files.copy(file, jarOut);
@@ -405,54 +550,92 @@ public class Make {
                                }
                        });
 
-                       Path srcP = source.resolve("src");
-                       // Add all resources from src/
-                       Files.walkFileTree(srcP, new SimpleFileVisitor<Path>() {
-                               @Override
-                               public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
-                                       if (file.getFileName().toString().endsWith(".java")
-                                                       || file.getFileName().toString().endsWith(".class"))
+                       if (Files.exists(srcP)) {
+                               // Add all resources from src/
+                               Files.walkFileTree(srcP, new SimpleFileVisitor<Path>() {
+                                       @Override
+                                       public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
+                                               // skip directories ending with .js
+                                               // TODO find something more robust?
+                                               if (dir.getFileName().toString().endsWith(".js"))
+                                                       return FileVisitResult.SKIP_SUBTREE;
+                                               return super.preVisitDirectory(dir, attrs);
+                                       }
+
+                                       @Override
+                                       public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
+                                               if (file.getFileName().toString().endsWith(".java")
+                                                               || file.getFileName().toString().endsWith(".class"))
+                                                       return FileVisitResult.CONTINUE;
+                                               jarOut.putNextEntry(new JarEntry(srcP.relativize(file).toString()));
+                                               if (!Files.isDirectory(file))
+                                                       Files.copy(file, jarOut);
                                                return FileVisitResult.CONTINUE;
-                                       jarOut.putNextEntry(new JarEntry(srcP.relativize(file).toString()));
-                                       if (!Files.isDirectory(file))
-                                               Files.copy(file, jarOut);
-                                       return FileVisitResult.CONTINUE;
+                                       }
+                               });
+
+                               // add sources
+                               // TODO add effective BND, Eclipse project file, etc., in order to be able to
+                               // repackage
+                               if (!sourceBundles) {
+                                       copySourcesToJar(srcP, jarOut, "OSGI-OPT/src/");
                                }
-                       });
+                       }
 
                        // add legal notices and licenses
-                       for (Path p : listLegalFilesToInclude(source).values()) {
+                       for (Path p : listLegalFilesToInclude(bundleSourceBase).values()) {
                                jarOut.putNextEntry(new JarEntry(p.getFileName().toString()));
                                Files.copy(p, jarOut);
                        }
+               }
 
-                       // add sources
-                       // TODO add effective BND, Eclipse project file, etc., in order to be able to
-                       // repackage
-                       if (sourceBundles) {
-                               Path a2srcJarDirectory = bundleParent != null ? a2srcOutput.resolve(bundleParent).resolve(category)
-                                               : a2srcOutput.resolve(category);
-                               Files.createDirectories(a2srcJarDirectory);
-                               Path srcJarP = a2srcJarDirectory
-                                               .resolve(compiled.getFileName() + "." + major + "." + minor + ".src.jar");
-                               Manifest srcManifest = new Manifest();
-                               srcManifest.getMainAttributes().put(Attributes.Name.MANIFEST_VERSION, "1.0");
-                               srcManifest.getMainAttributes().putValue("Bundle-SymbolicName", bundleSymbolicName + ".src");
-                               srcManifest.getMainAttributes().putValue("Bundle-Version",
-                                               manifest.getMainAttributes().getValue("Bundle-Version").toString());
-                               srcManifest.getMainAttributes().putValue("Eclipse-SourceBundle",
-                                               bundleSymbolicName + ";version=\"" + manifest.getMainAttributes().getValue("Bundle-Version"));
-
-                               try (JarOutputStream srcJarOut = new JarOutputStream(Files.newOutputStream(srcJarP), srcManifest)) {
-                                       copySourcesToJar(srcP, srcJarOut, "");
-                                       // add legal notices and licenses
-                                       for (Path p : listLegalFilesToInclude(source).values()) {
-                                               jarOut.putNextEntry(new JarEntry(p.getFileName().toString()));
-                                               Files.copy(p, jarOut);
-                                       }
+               if (sourceBundles) {// create separate sources jar
+                       Path a2srcJarDirectory = bundleParent != null ? a2srcOutput.resolve(bundleParent).resolve(category)
+                                       : a2srcOutput.resolve(category);
+                       Files.createDirectories(a2srcJarDirectory);
+                       Path srcJarP = a2srcJarDirectory.resolve(compiled.getFileName() + "." + major + "." + minor + ".src.jar");
+                       createSourceBundle(bundleSymbolicName, manifest, bundleSourceBase, srcP, srcJarP);
+               }
+       }
+
+       /** Create a separate bundle containing the sources. */
+       void createSourceBundle(String bundleSymbolicName, Manifest manifest, Path bundleSourceBase, Path srcP,
+                       Path srcJarP) throws IOException {
+               Manifest srcManifest = new Manifest();
+               srcManifest.getMainAttributes().put(Attributes.Name.MANIFEST_VERSION, "1.0");
+               srcManifest.getMainAttributes().putValue("Bundle-SymbolicName", bundleSymbolicName + ".src");
+               srcManifest.getMainAttributes().putValue("Bundle-Version",
+                               manifest.getMainAttributes().getValue("Bundle-Version").toString());
+
+               boolean isJsBundle = bundleSymbolicName.endsWith(".js");
+               if (!isJsBundle) {
+                       srcManifest.getMainAttributes().putValue("Eclipse-SourceBundle",
+                                       bundleSymbolicName + ";version=\"" + manifest.getMainAttributes().getValue("Bundle-Version"));
+
+                       try (JarOutputStream srcJarOut = new JarOutputStream(Files.newOutputStream(srcJarP), srcManifest)) {
+                               copySourcesToJar(srcP, srcJarOut, "");
+                               // add legal notices and licenses
+                               for (Path p : listLegalFilesToInclude(bundleSourceBase).values()) {
+                                       srcJarOut.putNextEntry(new JarEntry(p.getFileName().toString()));
+                                       Files.copy(p, srcJarOut);
                                }
-                       } else {
-                               copySourcesToJar(srcP, jarOut, "OSGI-OPT/src/");
+                       }
+               } else {// JavaScript source maps
+                       srcManifest.getMainAttributes().putValue("Fragment-Host", bundleSymbolicName + ";bundle-version=\""
+                                       + manifest.getMainAttributes().getValue("Bundle-Version"));
+                       try (JarOutputStream srcJarOut = new JarOutputStream(Files.newOutputStream(srcJarP), srcManifest)) {
+                               Files.walkFileTree(bundleSourceBase, new SimpleFileVisitor<Path>() {
+                                       @Override
+                                       public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
+                                               Path relativeP = bundleSourceBase.relativize(file);
+                                               if (!file.getFileName().toString().endsWith(".map"))
+                                                       return FileVisitResult.CONTINUE;
+                                               JarEntry entry = new JarEntry(relativeP.toString());
+                                               srcJarOut.putNextEntry(entry);
+                                               Files.copy(file, srcJarOut);
+                                               return FileVisitResult.CONTINUE;
+                                       }
+                               });
                        }
                }
        }
@@ -522,7 +705,7 @@ public class Make {
         * Reads Makefile variable assignments of the form =, :=, or ?=, ignoring white
         * spaces. To be used with very simple included Makefiles only.
         */
-       Map<String, String> readeMakefileVariables(Path path) throws IOException {
+       Map<String, String> readMakefileVariables(Path path) throws IOException {
                Map<String, String> context = new HashMap<>();
                List<String> sdkMkLines = Files.readAllLines(path);
                lines: for (String line : sdkMkLines) {
@@ -569,13 +752,15 @@ public class Make {
                        case "compile" -> argeoMake.compile(options);
                        case "bundle" -> argeoMake.bundle(options);
                        case "all" -> argeoMake.all(options);
+                       case "install" -> argeoMake.install(options, false);
+                       case "uninstall" -> argeoMake.install(options, true);
 
                        default -> throw new IllegalArgumentException("Unkown action: " + action);
                        }
 
                        long jvmUptime = ManagementFactory.getRuntimeMXBean().getUptime();
-                       logger.log(INFO, "Make.java action '" + action + "' succesfully completed after " + (jvmUptime / 1000) + "."
-                                       + (jvmUptime % 1000) + " s");
+                       logger.log(INFO, "Make.java action '" + action + "' successfully completed after " + (jvmUptime / 1000)
+                                       + "." + (jvmUptime % 1000) + " s");
                } catch (Exception e) {
                        long jvmUptime = ManagementFactory.getRuntimeMXBean().getUptime();
                        logger.log(ERROR, "Make.java action '" + action + "' failed after " + (jvmUptime / 1000) + "."