X-Git-Url: https://git.argeo.org/?a=blobdiff_plain;f=src%2Forg%2Fargeo%2Fbuild%2FMake.java;h=88036dae82e471eee78f7f71938bc598467ddbb8;hb=177b83d97d5f533ed7b3f1a2b1670789d467c3dc;hp=56230ea5fb9444634b5b0c9ab843b002b65983c4;hpb=3714839e09d67535491b15ef560b2cb3fdf482db;p=cc0%2Fargeo-build.git diff --git a/src/org/argeo/build/Make.java b/src/org/argeo/build/Make.java index 56230ea..88036da 100644 --- a/src/org/argeo/build/Make.java +++ b/src/org/argeo/build/Make.java @@ -1,7 +1,9 @@ package org.argeo.build; +import static java.lang.System.Logger.Level.DEBUG; import static java.lang.System.Logger.Level.ERROR; import static java.lang.System.Logger.Level.INFO; +import static java.lang.System.Logger.Level.WARNING; import java.io.File; import java.io.IOException; @@ -11,22 +13,26 @@ import java.io.PrintWriter; import java.lang.System.Logger; import java.lang.System.Logger.Level; import java.lang.management.ManagementFactory; +import java.nio.file.DirectoryStream; import java.nio.file.FileVisitResult; import java.nio.file.Files; 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; import java.util.HashMap; +import java.util.Iterator; import java.util.List; import java.util.Map; import java.util.Objects; import java.util.Properties; import java.util.StringJoiner; import java.util.StringTokenizer; +import java.util.TreeMap; import java.util.concurrent.CompletableFuture; import java.util.jar.Attributes; import java.util.jar.JarEntry; @@ -52,10 +58,37 @@ public class Make { private final static Logger logger = System.getLogger(Make.class.getName()); /** - * Environment properties on whether sources should be packaged separately or + * Environment variable on whether sources should be packaged separately or * integrated in the bundles. */ - private final static String ENV_BUILD_SOURCE_BUNDLES = "BUILD_SOURCE_BUNDLES"; + private final static String ENV_SOURCE_BUNDLES = "SOURCE_BUNDLES"; + + /** + * Environment variable on whether legal files at the root of the sources should + * be included in the generated bundles. Should be set to true when building + * third-party software in order no to include the build harness license into + * the generated bundles. + */ + private final static String ENV_NO_SDK_LEGAL = "NO_SDK_LEGAL"; + + /** + * Environment variable to override the default location for the Argeo Build + * configuration files. Typically used if Argeo Build has been compiled and + * packaged separately. + */ + 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"; @@ -67,7 +100,7 @@ public class Make { /** Base of the source code, typically the cloned git repository. */ final Path sdkSrcBase; /** - * The base of the builder, typically a submodule pointing to the public + * The base of the builder, typically a submodule pointing to the INCLUDEpublic * argeo-build directory. */ final Path argeoBuildBase; @@ -77,31 +110,51 @@ 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 packaged separately. */ + final Path a2srcOutput; - /** Whether sources should be packaged separately */ + /** Whether sources should be packaged separately. */ final boolean sourceBundles; + /** Whether common legal files should be included. */ + final boolean noSdkLegal; /** Constructor initialises the base directories. */ public Make() throws IOException { - sourceBundles = Boolean.parseBoolean(System.getenv(ENV_BUILD_SOURCE_BUNDLES)); + sourceBundles = Boolean.parseBoolean(System.getenv(ENV_SOURCE_BUNDLES)); if (sourceBundles) logger.log(Level.INFO, "Sources will be packaged separately"); + noSdkLegal = Boolean.parseBoolean(System.getenv(ENV_NO_SDK_LEGAL)); + if (noSdkLegal) + logger.log(Level.INFO, "SDK legal files will NOT be included"); execDirectory = Paths.get(System.getProperty("user.dir")); Path sdkMkP = findSdkMk(execDirectory); Objects.requireNonNull(sdkMkP, "No " + SDK_MK + " found under " + execDirectory); - Map context = readeMakefileVariables(sdkMkP); - sdkSrcBase = Paths.get(context.computeIfAbsent("SDK_SRC_BASE", (key) -> { + Map context = readMakefileVariables(sdkMkP); + sdkSrcBase = Paths.get(context.computeIfAbsent(VAR_SDK_SRC_BASE, (key) -> { throw new IllegalStateException(key + " not found"); })).toAbsolutePath(); - argeoBuildBase = sdkSrcBase.resolve("sdk/argeo-build"); - sdkBuildBase = Paths.get(context.computeIfAbsent("SDK_BUILD_BASE", (key) -> { + Path argeoBuildBaseT = sdkSrcBase.resolve("sdk/argeo-build"); + if (!Files.exists(argeoBuildBaseT)) { + String fromEnv = System.getenv(ENV_ARGEO_BUILD_CONFIG); + if (fromEnv != null) + argeoBuildBaseT = Paths.get(fromEnv); + if (fromEnv == null || !Files.exists(argeoBuildBaseT)) { + throw new IllegalStateException( + "Argeo Build not found. Did you initialise the git submodules or set the " + + ENV_ARGEO_BUILD_CONFIG + " environment variable?"); + } + } + argeoBuildBase = argeoBuildBaseT; + + sdkBuildBase = Paths.get(context.computeIfAbsent(VAR_SDK_BUILD_BASE, (key) -> { throw new IllegalStateException(key + " not found"); })).toAbsolutePath(); buildBase = sdkBuildBase.resolve(sdkSrcBase.getFileName()); a2Output = sdkBuildBase.resolve("a2"); + a2srcOutput = sdkBuildBase.resolve("a2.src"); } /* @@ -114,7 +167,6 @@ public class Make { } /** Compile all the bundles which have been passed via the --bundle argument. */ - @SuppressWarnings("restriction") void compile(Map> options) throws IOException { List bundles = options.get("--bundles"); Objects.requireNonNull(bundles, "--bundles argument must be set"); @@ -123,7 +175,7 @@ public class Make { List a2Categories = options.getOrDefault("--dep-categories", new ArrayList<>()); List a2Bases = options.getOrDefault("--a2-bases", new ArrayList<>()); - if (a2Bases.isEmpty()) { + if (a2Bases.isEmpty() || !a2Bases.contains(a2Output.toString())) { a2Bases.add(a2Output.toString()); } @@ -134,20 +186,39 @@ public class Make { // classpath if (!a2Categories.isEmpty()) { - StringJoiner classPath = new StringJoiner(File.pathSeparator); - StringJoiner modulePath = new StringJoiner(File.pathSeparator); + // We will keep only the highest major.minor + // and order by bundle name, for predictability + Map a2Jars = new TreeMap<>(); + +// StringJoiner modulePath = new StringJoiner(File.pathSeparator); for (String a2Base : a2Bases) { - for (String a2Category : a2Categories) { + categories: for (String a2Category : a2Categories) { Path a2Dir = Paths.get(a2Base).resolve(a2Category); if (!Files.exists(a2Dir)) - Files.createDirectories(a2Dir); - modulePath.add(a2Dir.toString()); - for (Path jarP : Files.newDirectoryStream(a2Dir, - (p) -> p.getFileName().toString().endsWith(".jar"))) { - classPath.add(jarP.toString()); + continue categories; +// modulePath.add(a2Dir.toString()); + for (Path jarP : Files.newDirectoryStream(a2Dir, (p) -> p.getFileName().toString().endsWith(".jar") + && !p.getFileName().toString().endsWith(".src.jar"))) { + A2Jar a2Jar = new A2Jar(jarP); + if (a2Jars.containsKey(a2Jar.name)) { + A2Jar current = a2Jars.get(a2Jar.name); + if (a2Jar.major > current.major) + a2Jars.put(a2Jar.name, a2Jar); + else if (a2Jar.major == current.major // + // if minor equals, we take the last one + && a2Jar.minor >= current.minor) + a2Jars.put(a2Jar.name, a2Jar); + } else { + a2Jars.put(a2Jar.name, a2Jar); + } } } } + + StringJoiner classPath = new StringJoiner(File.pathSeparator); + for (Iterator it = a2Jars.values().iterator(); it.hasNext();) + classPath.add(it.next().path.toString()); + compilerArgs.add("-cp"); compilerArgs.add(classPath.toString()); // compilerArgs.add("--module-path"); @@ -155,25 +226,44 @@ 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)) - throw new IllegalArgumentException("Bundle " + bundle + " not found in " + execDirectory); - sb.append(bundlePath.resolve("src")); + if (!Files.exists(bundlePath)) { + if (bundles.size() == 1) { + logger.log(WARNING, "Bundle " + bundle + " not found in " + execDirectory + + ", assuming this is this directory, as only one bundle was requested."); + bundlePath = execDirectory; + } else + throw new IllegalArgumentException("Bundle " + bundle + " not found in " + execDirectory); + } + 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"); -// for (String arg : compilerArgs) -// System.out.println(arg); + if (logger.isLoggable(DEBUG)) { + logger.log(DEBUG, "Compiler arguments:"); + for (String arg : compilerArgs) + logger.log(DEBUG, arg); + } boolean success = org.eclipse.jdt.core.compiler.batch.BatchCompiler.compile( compilerArgs.toArray(new String[compilerArgs.size()]), new PrintWriter(System.out), @@ -191,7 +281,7 @@ public class Make { return; List 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); @@ -199,8 +289,8 @@ public class Make { final String branch; Path branchMk = sdkSrcBase.resolve(BRANCH_MK); if (Files.exists(branchMk)) { - Map branchVariables = readeMakefileVariables(branchMk); - branch = branchVariables.get("BRANCH"); + Map branchVariables = readMakefileVariables(branchMk); + branch = branchVariables.get(VAR_BRANCH); } else { branch = null; } @@ -222,12 +312,100 @@ public class Make { logger.log(INFO, "Packaging took " + duration + " ms"); } - /* - * UTILITIES - */ + /** Install the bundles. */ + void install(Map> options, boolean uninstall) throws IOException { + // check arguments + List bundles = options.get("--bundles"); + Objects.requireNonNull(bundles, "--bundles argument must be set"); + if (bundles.isEmpty()) + return; + + List categories = options.get("--category"); + 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); + + List targetDirs = options.get("--target"); + Objects.requireNonNull(targetDirs, "--target argument must be set"); + if (targetDirs.size() != 1) + throw new IllegalArgumentException("One and only one --target must be specified"); + Path targetA2 = Paths.get(targetDirs.get(0)); + logger.log(INFO, (uninstall ? "Uninstalling from " : "Installing to ") + targetA2); + + final String branch; + Path branchMk = sdkSrcBase.resolve(BRANCH_MK); + if (Files.exists(branchMk)) { + Map 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; + 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 = 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"); + } + + /** 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 { - Path source = execDirectory.resolve(bundle); + final Path source; + if (!Files.exists(execDirectory.resolve(bundle))) { + logger.log(WARNING, + "Bundle " + bundle + " not found in " + execDirectory + ", assuming this is this directory."); + source = execDirectory; + } else { + source = execDirectory.resolve(bundle); + } + Path srcP = source.resolve("src"); + Path compiled = buildBase.resolve(bundle); String bundleSymbolicName = source.getFileName().toString(); @@ -312,6 +490,11 @@ public class Make { Files.walkFileTree(source, new SimpleFileVisitor() { @Override public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException { + // 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 = source.relativize(dir); for (PathMatcher exclude : excludes) if (exclude.matches(relativeP)) @@ -326,6 +509,10 @@ public class Make { for (PathMatcher exclude : excludes) if (exclude.matches(relativeP)) return FileVisitResult.CONTINUE; + // skip JavaScript source maps + if (file.getFileName().toString().endsWith(".map")) + return FileVisitResult.CONTINUE; + JarEntry entry = new JarEntry(relativeP.toString()); jarOut.putNextEntry(entry); Files.copy(file, jarOut); @@ -333,43 +520,104 @@ public class Make { } }); - Path srcP = source.resolve("src"); - // Add all resources from src/ - Files.walkFileTree(srcP, new SimpleFileVisitor() { - @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() { + @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()) { + 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 srcJarP = a2JarDirectory.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, ""); + 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"); + 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()) { + srcJarOut.putNextEntry(new JarEntry(p.getFileName().toString())); + Files.copy(p, srcJarOut); } - } else { - copySourcesToJar(srcP, jarOut, "OSGI-OPT/src/"); } } } + /** List the relevant legal files to include, from the SDK source base. */ + Map listLegalFilesToInclude(Path bundleBase) throws IOException { + Map toInclude = new HashMap<>(); + if (!noSdkLegal) { + DirectoryStream sdkSrcLegal = Files.newDirectoryStream(sdkSrcBase, (p) -> { + String fileName = p.getFileName().toString(); + return switch (fileName) { + case "NOTICE": + case "LICENSE": + case "COPYING": + case "COPYING.LESSER": + yield true; + default: + yield false; + }; + }); + for (Path p : sdkSrcLegal) + toInclude.put(p.getFileName().toString(), p); + } + for (Iterator> entries = toInclude.entrySet().iterator(); entries.hasNext();) { + Map.Entry entry = entries.next(); + Path inBundle = bundleBase.resolve(entry.getValue().getFileName()); + // remove file if it is also defined at bundle level + // since it has already been copied + // and has priority + if (Files.exists(inBundle)) + entries.remove(); + } + return toInclude; + } + + /* + * UTILITIES + */ + /** Add sources to a jar file */ void copySourcesToJar(Path srcP, JarOutputStream srcJarOut, String prefix) throws IOException { Files.walkFileTree(srcP, new SimpleFileVisitor() { @Override @@ -400,7 +648,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 readeMakefileVariables(Path path) throws IOException { + Map readMakefileVariables(Path path) throws IOException { Map context = new HashMap<>(); List sdkMkLines = Files.readAllLines(path); lines: for (String line : sdkMkLines) { @@ -447,6 +695,8 @@ 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); } @@ -462,6 +712,28 @@ public class Make { } } + /** A jar file in A2 format */ + static class A2Jar { + final Path path; + final String name; + final int major; + final int minor; + + A2Jar(Path path) { + try { + this.path = path; + String fileName = path.getFileName().toString(); + fileName = fileName.substring(0, fileName.lastIndexOf('.')); + minor = Integer.parseInt(fileName.substring(fileName.lastIndexOf('.') + 1)); + fileName = fileName.substring(0, fileName.lastIndexOf('.')); + major = Integer.parseInt(fileName.substring(fileName.lastIndexOf('.') + 1)); + name = fileName.substring(0, fileName.lastIndexOf('.')); + } catch (Exception e) { + throw new IllegalArgumentException("Badly formatted A2 jar " + path, e); + } + } + } + /** * An ECJ {@link CompilationProgress} printing a progress bar while compiling. */