package org.argeo.build;
+import static java.lang.System.Logger.Level.ERROR;
+import static java.lang.System.Logger.Level.INFO;
+
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.PrintWriter;
+import java.lang.System.Logger;
+import java.lang.System.Logger.Level;
import java.lang.management.ManagementFactory;
import java.nio.file.FileVisitResult;
import java.nio.file.Files;
import java.util.Properties;
import java.util.StringJoiner;
import java.util.StringTokenizer;
+import java.util.concurrent.CompletableFuture;
import java.util.jar.JarEntry;
import java.util.jar.JarOutputStream;
import java.util.jar.Manifest;
import aQute.bnd.osgi.Analyzer;
import aQute.bnd.osgi.Jar;
+/**
+ * Minimalistic OSGi compiler and packager, meant to be used as a single file
+ * without being itself compiled first. It depends on the Eclipse batch compiler
+ * (aka. ECJ) and the BND Libs library for OSGi metadata generation (which
+ * itselfs depends on slf4j).<br/>
+ * <br/>
+ * For example, a typical system call would be:<br/>
+ * <code>java -cp "/path/to/ECJ jar:/path/to/bndlib jar:/path/to/SLF4J jar" /path/to/cloned/argeo-build/src/org/argeo/build/Make.java action --option1 argument1 argument2 --option2 argument3 </code>
+ */
public class Make {
- private final static String SDK_MK = "sdk.mk";
+ private final static Logger logger = System.getLogger(Make.class.getName());
+
+ /** Name of the local-specific Makefile (sdk.mk). */
+ final static String SDK_MK = "sdk.mk";
+ /** Name of the branch definition Makefile (branch.mk). */
+ final static String BRANCH_MK = "branch.mk";
+ /** The execution directory (${user.dir}). */
final Path execDirectory;
+ /** 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
+ * argeo-build directory.
+ */
final Path argeoBuildBase;
+ /** The base of the build for all layers. */
final Path sdkBuildBase;
+ /** The base of the build for this layer. */
final Path buildBase;
+ /** The base of the a2 output for all layers. */
final Path a2Output;
+ /** Constructor initialises the base directories. */
public Make() throws IOException {
execDirectory = Paths.get(System.getProperty("user.dir"));
Path sdkMkP = findSdkMk(execDirectory);
Objects.requireNonNull(sdkMkP, "No " + SDK_MK + " found under " + execDirectory);
- Map<String, String> context = new HashMap<>();
- List<String> sdkMkLines = Files.readAllLines(sdkMkP);
- lines: for (String line : sdkMkLines) {
- StringTokenizer st = new StringTokenizer(line, " :=");
- if (!st.hasMoreTokens())
- continue lines;
- String key = st.nextToken();
- if (!st.hasMoreTokens())
- continue lines;
- String value = st.nextToken();
- context.put(key, value);
- }
-
+ Map<String, String> context = readeMakefileVariables(sdkMkP);
sdkSrcBase = Paths.get(context.computeIfAbsent("SDK_SRC_BASE", (key) -> {
throw new IllegalStateException(key + " not found");
})).toAbsolutePath();
/*
* ACTIONS
*/
-
+ /** Compile and create the bundles in one go. */
void all(Map<String, List<String>> options) throws IOException {
-// List<String> a2Bundles = options.get("--a2-bundles");
-// if (a2Bundles == null)
-// throw new IllegalArgumentException("--a2-bundles must be specified");
-// List<String> bundles = new ArrayList<>();
-// for (String a2Bundle : a2Bundles) {
-// Path a2BundleP = Paths.get(a2Bundle);
-// Path bundleP = a2Output.relativize(a2BundleP.getParent().getParent().resolve(a2BundleP.getFileName()));
-// bundles.add(bundleP.toString());
-// }
-// options.put("--bundles", bundles);
compile(options);
bundle(options);
}
+ /** Compile all the bundles which have been passed via the --bundle argument. */
@SuppressWarnings("restriction")
void compile(Map<String, List<String>> options) throws IOException {
List<String> bundles = options.get("--bundles");
// classpath
if (!a2Categories.isEmpty()) {
- compilerArgs.add("-cp");
StringJoiner classPath = new StringJoiner(File.pathSeparator);
+ StringJoiner modulePath = new StringJoiner(File.pathSeparator);
for (String a2Base : a2Bases) {
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());
}
}
}
+ compilerArgs.add("-cp");
compilerArgs.add(classPath.toString());
+// compilerArgs.add("--module-path");
+// compilerArgs.add(modulePath.toString());
}
// sources
for (String bundle : bundles) {
StringBuilder sb = new StringBuilder();
- sb.append(execDirectory.resolve(bundle).resolve("src"));
+ Path bundlePath = execDirectory.resolve(bundle);
+ if (!Files.exists(bundlePath))
+ throw new IllegalArgumentException("Bundle " + bundle + " not found in " + execDirectory);
+ sb.append(bundlePath.resolve("src"));
sb.append("[-d");
compilerArgs.add(sb.toString());
sb = new StringBuilder();
compilerArgs.add(sb.toString());
}
- // System.out.println(compilerArgs);
-
- CompilationProgress compilationProgress = new CompilationProgress() {
- int totalWork;
- long currentChunk = 0;
-
- long chunksCount = 80;
-
- @Override
- public void worked(int workIncrement, int remainingWork) {
- long chunk = ((totalWork - remainingWork) * chunksCount) / totalWork;
- if (chunk != currentChunk) {
- currentChunk = chunk;
- for (long i = 0; i < currentChunk; i++) {
- System.out.print("#");
- }
- for (long i = currentChunk; i < chunksCount; i++) {
- System.out.print("-");
- }
- System.out.print("\r");
- }
- if (remainingWork == 0)
- System.out.print("\n");
- }
-
- @Override
- public void setTaskName(String name) {
- }
+ if (logger.isLoggable(INFO))
+ compilerArgs.add("-time");
- @Override
- public boolean isCanceled() {
- return false;
- }
+// for (String arg : compilerArgs)
+// System.out.println(arg);
- @Override
- public void done() {
- }
-
- @Override
- public void begin(int remainingWork) {
- this.totalWork = remainingWork;
- }
- };
- // Use Main instead of BatchCompiler to workaround the fact that
- // org.eclipse.jdt.core.compiler.batch is not exported
- boolean success = org.eclipse.jdt.internal.compiler.batch.Main.compile(
+ boolean success = org.eclipse.jdt.core.compiler.batch.BatchCompiler.compile(
compilerArgs.toArray(new String[compilerArgs.size()]), new PrintWriter(System.out),
- new PrintWriter(System.err), (CompilationProgress) compilationProgress);
- if (!success) {
- System.exit(1);
- }
+ new PrintWriter(System.err), new MakeCompilationProgress());
+ if (!success) // kill the process if compilation failed
+ throw new IllegalStateException("Compilation failed");
}
+ /** Package the bundles. */
void bundle(Map<String, List<String>> options) throws IOException {
+ // check arguments
List<String> bundles = options.get("--bundles");
Objects.requireNonNull(bundles, "--bundles argument must be set");
if (bundles.isEmpty())
return;
List<String> categories = options.get("--category");
- Objects.requireNonNull(bundles, "--bundles argument must be set");
+ Objects.requireNonNull(bundles, "--category argument must be set");
if (categories.size() != 1)
- throw new IllegalArgumentException("One and only one category must be specified");
+ throw new IllegalArgumentException("One and only one --category must be specified");
String category = categories.get(0);
- // create jars
+ Path branchMk = sdkSrcBase.resolve(BRANCH_MK);
+ if (!Files.exists(branchMk))
+ throw new IllegalStateException("No " + branchMk + " file available");
+ Map<String, String> branchVariables = readeMakefileVariables(branchMk);
+
+ String branch = branchVariables.get("BRANCH");
+
+ long begin = System.currentTimeMillis();
+ // create jars in parallel
+ List<CompletableFuture<Void>> toDos = new ArrayList<>();
for (String bundle : bundles) {
- createBundle(bundle, category);
+ toDos.add(CompletableFuture.runAsync(() -> {
+ try {
+ createBundle(branch, bundle, category);
+ } catch (IOException e) {
+ throw new RuntimeException("Packaging of " + bundle + " failed", e);
+ }
+ }));
}
+ CompletableFuture.allOf(toDos.toArray(new CompletableFuture[toDos.size()])).join();
+ long duration = System.currentTimeMillis() - begin;
+ logger.log(INFO, "Packaging took " + duration + " ms");
}
/*
- * JAR PACKAGING
+ * UTILITIES
*/
- void createBundle(String bundle, String category) throws IOException {
+ /** Package a single bundle. */
+ void createBundle(String branch, String bundle, String category) throws IOException {
Path source = execDirectory.resolve(bundle);
Path compiled = buildBase.resolve(bundle);
String bundleSymbolicName = source.getFileName().toString();
try (InputStream in = Files.newInputStream(argeoBnd)) {
properties.load(in);
}
- // FIXME make it configurable
- Path branchBnd = sdkSrcBase.resolve("cnf/unstable.bnd");
+
+ Path branchBnd = sdkSrcBase.resolve("sdk/branches/" + branch + ".bnd");
try (InputStream in = Files.newInputStream(branchBnd)) {
properties.load(in);
}
Jar jar = new Jar(bundleSymbolicName, binP.toFile());
bndAnalyzer.setJar(jar);
manifest = bndAnalyzer.calcManifest();
-
-// keys: for (Object key : manifest.getMainAttributes().keySet()) {
-// System.out.println(key + ": " + manifest.getMainAttributes().getValue(key.toString()));
-// }
} catch (Exception e) {
throw new RuntimeException("Bnd analysis of " + compiled + " failed", e);
}
- String major = properties.getProperty("MAJOR");
- Objects.requireNonNull(major, "MAJOR must be set");
- String minor = properties.getProperty("MINOR");
- Objects.requireNonNull(minor, "MINOR must be set");
+ String major = properties.getProperty("major");
+ Objects.requireNonNull(major, "'major' must be set");
+ String minor = properties.getProperty("minor");
+ Objects.requireNonNull(minor, "'minor' must be set");
// Write manifest
Path manifestP = compiled.resolve("META-INF/MANIFEST.MF");
try (OutputStream out = Files.newOutputStream(manifestP)) {
manifest.write(out);
}
-//
-// // Load manifest
-// Path manifestP = compiled.resolve("META-INF/MANIFEST.MF");
-// if (!Files.exists(manifestP))
-// throw new IllegalStateException("Manifest " + manifestP + " not found");
-// Manifest manifest;
-// try (InputStream in = Files.newInputStream(manifestP)) {
-// manifest = new Manifest(in);
-// } catch (IOException e) {
-// throw new IllegalStateException("Cannot read manifest " + manifestP, e);
-// }
// Load excludes
List<PathMatcher> excludes = new ArrayList<>();
try (JarOutputStream jarOut = new JarOutputStream(Files.newOutputStream(jarP), manifest)) {
// add all classes first
-// Path binP = compiled.resolve("bin");
Files.walkFileTree(binP, new SimpleFileVisitor<Path>() {
-
@Override
public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
jarOut.putNextEntry(new JarEntry(binP.relativize(file).toString()));
// add resources
Files.walkFileTree(source, new SimpleFileVisitor<Path>() {
-
@Override
public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
Path relativeP = source.relativize(dir);
Files.copy(file, jarOut);
return FileVisitResult.CONTINUE;
}
-
});
// add sources
// repackage
Path srcP = source.resolve("src");
Files.walkFileTree(srcP, new SimpleFileVisitor<Path>() {
-
@Override
public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
jarOut.putNextEntry(new JarEntry("OSGI-OPT/src/" + srcP.relativize(file).toString()));
- Files.copy(file, jarOut);
+ if (!Files.isDirectory(file))
+ Files.copy(file, jarOut);
return FileVisitResult.CONTINUE;
}
});
-
}
-
}
- private Path findSdkMk(Path directory) {
+ /**
+ * Recursively find the base source directory (which contains the
+ * <code>{@value #SDK_MK}</code> file).
+ */
+ Path findSdkMk(Path directory) {
Path sdkMkP = directory.resolve(SDK_MK);
if (Files.exists(sdkMkP)) {
return sdkMkP.toAbsolutePath();
if (directory.getParent() == null)
return null;
return findSdkMk(directory.getParent());
+ }
+ /**
+ * 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> context = new HashMap<>();
+ List<String> sdkMkLines = Files.readAllLines(path);
+ lines: for (String line : sdkMkLines) {
+ StringTokenizer st = new StringTokenizer(line, " :=?");
+ if (!st.hasMoreTokens())
+ continue lines;
+ String key = st.nextToken();
+ if (!st.hasMoreTokens())
+ continue lines;
+ String value = st.nextToken();
+ if (st.hasMoreTokens()) // probably not a simple variable assignment
+ continue lines;
+ context.put(key, value);
+ }
+ return context;
}
+ /** Main entry point, interpreting actions and arguments. */
public static void main(String... args) {
- try {
- if (args.length == 0)
- throw new IllegalArgumentException("At least an action must be provided");
- int actionIndex = 0;
- String action = args[actionIndex];
- if (args.length > actionIndex + 1 && !args[actionIndex + 1].startsWith("-"))
- throw new IllegalArgumentException(
- "Action " + action + " must be followed by an option: " + Arrays.asList(args));
-
- Map<String, List<String>> options = new HashMap<>();
- String currentOption = null;
- for (int i = actionIndex + 1; i < args.length; i++) {
- if (args[i].startsWith("-")) {
- currentOption = args[i];
- if (!options.containsKey(currentOption))
- options.put(currentOption, new ArrayList<>());
-
- } else {
- options.get(currentOption).add(args[i]);
- }
+ if (args.length == 0)
+ throw new IllegalArgumentException("At least an action must be provided");
+ int actionIndex = 0;
+ String action = args[actionIndex];
+ if (args.length > actionIndex + 1 && !args[actionIndex + 1].startsWith("-"))
+ throw new IllegalArgumentException(
+ "Action " + action + " must be followed by an option: " + Arrays.asList(args));
+
+ Map<String, List<String>> options = new HashMap<>();
+ String currentOption = null;
+ for (int i = actionIndex + 1; i < args.length; i++) {
+ if (args[i].startsWith("-")) {
+ currentOption = args[i];
+ if (!options.containsKey(currentOption))
+ options.put(currentOption, new ArrayList<>());
+
+ } else {
+ options.get(currentOption).add(args[i]);
}
+ }
+ try {
Make argeoMake = new Make();
switch (action) {
case "compile" -> argeoMake.compile(options);
}
long jvmUptime = ManagementFactory.getRuntimeMXBean().getUptime();
- System.out.println("Completed after " + jvmUptime + " ms");
+ logger.log(INFO, "Make.java action '" + action + "' succesfully completed after " + (jvmUptime / 1000) + "."
+ + (jvmUptime % 1000) + " s");
} catch (Exception e) {
- e.printStackTrace();
+ long jvmUptime = ManagementFactory.getRuntimeMXBean().getUptime();
+ logger.log(ERROR, "Make.java action '" + action + "' failed after " + (jvmUptime / 1000) + "."
+ + (jvmUptime % 1000) + " s", e);
System.exit(1);
}
}
+
+ /**
+ * An ECJ {@link CompilationProgress} printing a progress bar while compiling.
+ */
+ static class MakeCompilationProgress extends CompilationProgress {
+ private int totalWork;
+ private long currentChunk = 0;
+ private long chunksCount = 80;
+
+ @Override
+ public void worked(int workIncrement, int remainingWork) {
+ if (!logger.isLoggable(Level.INFO)) // progress bar only at INFO level
+ return;
+ long chunk = ((totalWork - remainingWork) * chunksCount) / totalWork;
+ if (chunk != currentChunk) {
+ currentChunk = chunk;
+ for (long i = 0; i < currentChunk; i++) {
+ System.out.print("#");
+ }
+ for (long i = currentChunk; i < chunksCount; i++) {
+ System.out.print("-");
+ }
+ System.out.print("\r");
+ }
+ if (remainingWork == 0)
+ System.out.print("\n");
+ }
+
+ @Override
+ public void setTaskName(String name) {
+ }
+
+ @Override
+ public boolean isCanceled() {
+ return false;
+ }
+
+ @Override
+ public void done() {
+ }
+
+ @Override
+ public void begin(int remainingWork) {
+ this.totalWork = remainingWork;
+ }
+ }
}
projects / cc0 / argeo-build.git / blobdiff