X-Git-Url: https://git.argeo.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Forg%2Fargeo%2Fbuild%2FMake.java;h=5a5fd64d424639ae4036b5205a9d895c6e53df1d;hb=dd7d34930a31c4b72a4f397a9bcb6a3468af6c52;hp=97318ab610d5abc44caa4e7df77c9ad7d37d6b31;hpb=af5b640e4fa16c3d5ed59a1fd3b1ffcdc37bf4fb;p=cc0%2Fargeo-build.git diff --git a/src/org/argeo/build/Make.java b/src/org/argeo/build/Make.java index 97318ab..5a5fd64 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,6 +13,7 @@ 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; @@ -21,12 +24,14 @@ 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 +57,25 @@ 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"; /** Name of the local-specific Makefile (sdk.mk). */ final static String SDK_MK = "sdk.mk"; @@ -67,7 +87,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; @@ -80,14 +100,19 @@ public class Make { /** The base of the a2 sources when packages 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); @@ -97,7 +122,19 @@ public class Make { sdkSrcBase = Paths.get(context.computeIfAbsent("SDK_SRC_BASE", (key) -> { throw new IllegalStateException(key + " not found"); })).toAbsolutePath(); - argeoBuildBase = sdkSrcBase.resolve("sdk/argeo-build"); + + 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("SDK_BUILD_BASE", (key) -> { throw new IllegalStateException(key + " not found"); @@ -117,7 +154,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"); @@ -126,7 +162,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()); } @@ -137,20 +173,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()); + continue categories; +// modulePath.add(a2Dir.toString()); for (Path jarP : Files.newDirectoryStream(a2Dir, (p) -> p.getFileName().toString().endsWith(".jar"))) { - classPath.add(jarP.toString()); + 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"); @@ -161,8 +216,14 @@ public class Make { 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); + 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); + } sb.append(bundlePath.resolve("src")); sb.append("[-d"); compilerArgs.add(sb.toString()); @@ -175,8 +236,11 @@ public class Make { 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), @@ -225,12 +289,17 @@ public class Make { logger.log(INFO, "Packaging took " + duration + " ms"); } - /* - * UTILITIES - */ /** 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 compiled = buildBase.resolve(bundle); String bundleSymbolicName = source.getFileName().toString(); @@ -351,6 +420,12 @@ public class Make { } }); + // 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 @@ -370,6 +445,11 @@ public class Make { 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); + } } } else { copySourcesToJar(srcP, jarOut, "OSGI-OPT/src/"); @@ -377,6 +457,47 @@ public class Make { } } + /** 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); + } + DirectoryStream bundleLegal = Files.newDirectoryStream(bundleBase, (p) -> { + String fileName = p.getFileName().toString(); + return switch (fileName) { + case "NOTICE": + case "LICENSE": + case "COPYING": + case "COPYING.LESSER": + yield true; + default: + yield false; + }; + }); + // bundle can override + for (Path p : bundleLegal) + toInclude.put(p.getFileName().toString(), p); + 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 @@ -469,6 +590,23 @@ public class Make { } } + static class A2Jar { + final Path path; + final String name; + final int major; + final int minor; + + A2Jar(Path path) { + 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('.')); + } + } + /** * An ECJ {@link CompilationProgress} printing a progress bar while compiling. */