X-Git-Url: https://git.argeo.org/?a=blobdiff_plain;f=src%2Forg%2Fargeo%2Fbuild%2FMake.java;h=4f22815f1d4cd5295c20823f309ebb3d080fc097;hb=db89cbf633f301c206628331ea61548ad739eea9;hp=324cae8ab89725ef22d86d545b67a40a70e2dcf2;hpb=d0a93e4a21a3c71a47f4bd0511d7862093731e2e;p=cc0%2Fargeo-build.git diff --git a/src/org/argeo/build/Make.java b/src/org/argeo/build/Make.java index 324cae8..4f22815 100644 --- a/src/org/argeo/build/Make.java +++ b/src/org/argeo/build/Make.java @@ -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; @@ -62,6 +63,14 @@ public class Make { */ 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 @@ -69,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). */ @@ -79,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; @@ -89,24 +110,29 @@ 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 */ + /** 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_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(); @@ -123,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()); @@ -171,8 +197,8 @@ public class Make { if (!Files.exists(a2Dir)) continue categories; // modulePath.add(a2Dir.toString()); - for (Path jarP : Files.newDirectoryStream(a2Dir, - (p) -> p.getFileName().toString().endsWith(".jar"))) { + 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); @@ -200,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)) { @@ -211,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"); @@ -245,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); @@ -253,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; } @@ -276,6 +312,88 @@ public class Make { logger.log(INFO, "Packaging took " + duration + " ms"); } + /** 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 { final Path source; @@ -286,6 +404,7 @@ public class Make { } else { source = execDirectory.resolve(bundle); } + Path srcP = source.resolve("src"); Path compiled = buildBase.resolve(bundle); String bundleSymbolicName = source.getFileName().toString(); @@ -371,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)) @@ -385,6 +509,10 @@ public class Make { 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); @@ -392,41 +520,58 @@ 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 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()); + 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()); + + boolean isJsBundle = bundleSymbolicName.endsWith(".js"); + if (!isJsBundle) { srcManifest.getMainAttributes().putValue("Eclipse-SourceBundle", bundleSymbolicName + ";version=\"" + manifest.getMainAttributes().getValue("Bundle-Version")); @@ -434,12 +579,27 @@ public class Make { 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); + 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 + ";version=\"" + manifest.getMainAttributes().getValue("Bundle-Version")); + try (JarOutputStream srcJarOut = new JarOutputStream(Files.newOutputStream(srcJarP), srcManifest)) { + Files.walkFileTree(source, new SimpleFileVisitor() { + @Override + public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException { + Path relativeP = source.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; + } + }); + } } } } @@ -447,35 +607,31 @@ 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<>(); - 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); + 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; } @@ -513,7 +669,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) { @@ -560,6 +716,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); } @@ -575,6 +733,7 @@ public class Make { } } + /** A jar file in A2 format */ static class A2Jar { final Path path; final String name; @@ -582,13 +741,17 @@ public class Make { 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('.')); + 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); + } } }