X-Git-Url: https://git.argeo.org/?a=blobdiff_plain;f=src%2Forg%2Fargeo%2Fbuild%2FRepackage.java;h=4561de763890974722ff1ae867ba570c8d9858c0;hb=6c790c4f1e27a15b62967f323a00d3f4dd5100a1;hp=0eec4fad7d7b57d5b6d30838e711771cadc3397c;hpb=e959e966b5c98d0bed74a98142a4df4392b61e62;p=cc0%2Fargeo-build.git diff --git a/src/org/argeo/build/Repackage.java b/src/org/argeo/build/Repackage.java index 0eec4fa..4561de7 100644 --- a/src/org/argeo/build/Repackage.java +++ b/src/org/argeo/build/Repackage.java @@ -98,13 +98,14 @@ public class Repackage { List> toDos = new ArrayList<>(); for (int i = 1; i < args.length; i++) { - Path p = Paths.get(args[i]); - if (sequential) - factory.processCategory(p); + Path categoryPath = Paths.get(args[i]); + factory.cleanPreviousFailedBuild(categoryPath); + if (sequential) // sequential processing happens here + factory.processCategory(categoryPath); else - toDos.add(CompletableFuture.runAsync(() -> factory.processCategory(p))); + toDos.add(CompletableFuture.runAsync(() -> factory.processCategory(categoryPath))); } - if (!sequential) + if (!sequential)// parallel processing CompletableFuture.allOf(toDos.toArray(new CompletableFuture[toDos.size()])).join(); // Summary @@ -115,6 +116,25 @@ public class Repackage { logger.log(INFO, "# License summary:\n" + sb); } + /** Deletes remaining sub directories. */ + void cleanPreviousFailedBuild(Path categoryPath) { + Path outputCategoryPath = a2Base.resolve(categoryPath); + if (!Files.exists(outputCategoryPath)) + return; + // clean previous failed build + try { + for (Path subDir : Files.newDirectoryStream(outputCategoryPath, (d) -> Files.isDirectory(d))) { + if (Files.exists(subDir)) { + logger.log(WARNING, "Bundle dir " + subDir + + " already exists, probably from a previous failed build, deleting it..."); + deleteDirectory(subDir); + } + } + } catch (IOException e) { + logger.log(ERROR, "Cannot clean previous build", e); + } + } + /** MANIFEST headers. */ enum ManifestHeader { // OSGi @@ -180,15 +200,35 @@ public class Repackage { ARGEO_ORIGIN_SOURCES_URI("Argeo-Origin-Sources-URI"), // ; - final String value; + final String headerName; - private ManifestHeader(String value) { - this.value = value; + private ManifestHeader(String headerName) { + this.headerName = headerName; } @Override public String toString() { - return value; + return headerName; + } + + /** Get the value from either a {@link Manifest} or a {@link Properties}. */ + String get(Object map) { + if (map instanceof Manifest manifest) + return manifest.getMainAttributes().getValue(headerName); + else if (map instanceof Properties props) + return props.getProperty(headerName); + else + throw new IllegalArgumentException("Unsupported mapping " + map.getClass()); + } + + /** Put the value into either a {@link Manifest} or a {@link Properties}. */ + void put(Object map, String value) { + if (map instanceof Manifest manifest) + manifest.getMainAttributes().putValue(headerName, value); + else if (map instanceof Properties props) + props.setProperty(headerName, value); + else + throw new IllegalArgumentException("Unsupported mapping " + map.getClass()); } } @@ -342,7 +382,7 @@ public class Repackage { // regular processing A2Origin origin = new A2Origin(); Path bundleDir = processBndJar(downloaded, targetCategoryBase, fileProps, artifact, origin); - downloadAndProcessM2Sources(fileProps, artifact, bundleDir, false); + downloadAndProcessM2Sources(fileProps, artifact, bundleDir, false, false); createJar(bundleDir, origin); } catch (Exception e) { throw new RuntimeException("Cannot process " + bndFile, e); @@ -434,7 +474,7 @@ public class Repackage { } else { A2Origin origin = new A2Origin(); Path targetBundleDir = processBndJar(downloaded, targetCategoryBase, mergedProps, artifact, origin); - downloadAndProcessM2Sources(mergedProps, artifact, targetBundleDir, false); + downloadAndProcessM2Sources(mergedProps, artifact, targetBundleDir, false, false); createJar(targetBundleDir, origin); } } @@ -538,9 +578,9 @@ public class Repackage { } if (entry.getName().endsWith("NOTICE") || entry.getName().endsWith("NOTICE.txt") - || entry.getName().endsWith("LICENSE") || entry.getName().endsWith("LICENSE.md") - || entry.getName().endsWith("LICENSE-notice.md") || entry.getName().endsWith("COPYING") - || entry.getName().endsWith("COPYING.LESSER")) { + || entry.getName().endsWith("NOTICE.md") || entry.getName().endsWith("LICENSE") + || entry.getName().endsWith("LICENSE.md") || entry.getName().endsWith("LICENSE-notice.md") + || entry.getName().endsWith("COPYING") || entry.getName().endsWith("COPYING.LESSER")) { Path artifactOriginDir = bundleDir.resolve(ARGEO_ORIGIN).resolve(artifact.getGroupId()) .resolve(artifact.getArtifactId()); Path target = artifactOriginDir.resolve(entry.getName()); @@ -564,6 +604,10 @@ public class Repackage { } else if (entry.getName().startsWith("org/apache/batik/")) { logger.log(TRACE, "Skip " + entry.getName()); continue entries; + } else if (entry.getName().startsWith("META-INF/NOTICE")) { + logger.log(WARNING, "Skip " + entry.getName() + " from " + artifact); + // TODO merge them? + continue entries; } else { throw new IllegalStateException("File " + target + " from " + artifact + " already exists"); } @@ -574,7 +618,7 @@ public class Repackage { origin.added.add("binary content of " + artifact); // process sources - downloadAndProcessM2Sources(mergeProps, artifact, bundleDir, true); + downloadAndProcessM2Sources(mergeProps, artifact, bundleDir, true, false); } // additional service files @@ -708,20 +752,21 @@ public class Repackage { // When releasing (with separate sources), we just copy it Path unmodifiedTarget = targetCategoryBase .resolve(fileProps.getProperty(BUNDLE_SYMBOLICNAME.toString()) + "." + artifact.getBranch() + ".jar"); + Files.createDirectories(unmodifiedTarget.getParent()); Files.copy(downloaded, unmodifiedTarget, StandardCopyOption.REPLACE_EXISTING); Path bundleDir = targetCategoryBase .resolve(fileProps.getProperty(BUNDLE_SYMBOLICNAME.toString()) + "." + artifact.getBranch()); - downloadAndProcessM2Sources(fileProps, artifact, bundleDir, false); + downloadAndProcessM2Sources(fileProps, artifact, bundleDir, false, true); Manifest manifest; try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(unmodifiedTarget))) { manifest = jarIn.getManifest(); } - createSourceJar(bundleDir, manifest, true); + createSourceJar(bundleDir, manifest, fileProps); } /** Download and integrates sources for a single Maven artifact. */ - void downloadAndProcessM2Sources(Properties props, M2Artifact artifact, Path targetBundleDir, boolean merging) - throws IOException { + void downloadAndProcessM2Sources(Properties props, M2Artifact artifact, Path targetBundleDir, boolean merging, + boolean unmodified) throws IOException { try { String repoStr = props.containsKey(ARGEO_ORIGIN_M2_REPO.toString()) ? props.getProperty(ARGEO_ORIGIN_M2_REPO.toString()) @@ -731,7 +776,7 @@ public class Repackage { URL sourcesUrl = alternateUri != null ? new URL(alternateUri) : M2ConventionsUtils.mavenRepoUrl(repoStr, sourcesArtifact); Path sourcesDownloaded = downloadMaven(sourcesUrl, sourcesArtifact); - processM2SourceJar(sourcesDownloaded, targetBundleDir, merging ? artifact : null); + processM2SourceJar(sourcesDownloaded, targetBundleDir, merging ? artifact : null, unmodified); logger.log(TRACE, () -> "Processed source " + sourcesDownloaded); } catch (Exception e) { logger.log(ERROR, () -> "Cannot download source for " + artifact); @@ -740,9 +785,9 @@ public class Repackage { } /** Integrate sources from a downloaded jar file. */ - void processM2SourceJar(Path file, Path bundleDir, M2Artifact mergingFrom) throws IOException { + void processM2SourceJar(Path file, Path bundleDir, M2Artifact mergingFrom, boolean unmodified) throws IOException { A2Origin origin = new A2Origin(); - Path sourceDir = separateSources ? bundleDir.getParent().resolve(bundleDir.toString() + ".src") + Path sourceDir = separateSources || unmodified ? bundleDir.getParent().resolve(bundleDir.toString() + ".src") : bundleDir.resolve("OSGI-OPT/src"); try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(file), false)) { @@ -756,24 +801,26 @@ public class Repackage { String relPath = entry.getName(); if (entry.isDirectory()) continue entries; - if (entry.getName().startsWith("META-INF")) {// skip META-INF entries - origin.deleted.add("META-INF directory from the sources" + mergingMsg); - continue entries; - } - if (entry.getName().startsWith("module-info.java")) {// skip Java module information - origin.deleted.add("Java module information from the sources (module-info.java)" + mergingMsg); + if (entry.getName().equals("META-INF/MANIFEST.MF")) {// skip META-INF entries + origin.deleted.add("MANIFEST.MF from the sources" + mergingMsg); continue entries; } - if (entry.getName().startsWith("/")) { // absolute paths - int metaInfIndex = entry.getName().indexOf("META-INF"); - if (metaInfIndex >= 0) { - relPath = entry.getName().substring(metaInfIndex); - origin.moved.add(" to " + relPath + " entry with absolute path " + entry.getName()); - } else { - logger.log(WARNING, entry.getName() + " has an absolute path"); - origin.deleted.add(entry.getName() + " from the sources" + mergingMsg); + if (!unmodified) { + if (entry.getName().startsWith("module-info.java")) {// skip Java module information + origin.deleted.add("Java module information from the sources (module-info.java)" + mergingMsg); + continue entries; + } + if (entry.getName().startsWith("/")) { // absolute paths + int metaInfIndex = entry.getName().indexOf("META-INF"); + if (metaInfIndex >= 0) { + relPath = entry.getName().substring(metaInfIndex); + origin.moved.add(" to " + relPath + " entry with absolute path " + entry.getName()); + } else { + logger.log(WARNING, entry.getName() + " has an absolute path"); + origin.deleted.add(entry.getName() + " from the sources" + mergingMsg); + } + continue entries; } - continue entries; } Path target = sourceDir.resolve(relPath); Files.createDirectories(target.getParent()); @@ -786,7 +833,7 @@ public class Repackage { } } // write the changes - if (separateSources) { + if (separateSources || unmodified) { origin.appendChanges(sourceDir); } else { origin.added.add("source code under OSGI-OPT/src"); @@ -887,6 +934,10 @@ public class Repackage { map.put(key.toString(), commonProps.getProperty(key.toString())); A2Origin origin = new A2Origin(); Path bundleDir = processBundleJar(file, targetCategoryBase, map, origin); + if (bundleDir == null) { + logger.log(WARNING, "No bundle dir created for " + file + ", skipping..."); + return FileVisitResult.CONTINUE; + } origins.put(bundleDir, origin); logger.log(DEBUG, () -> "Processed " + file); } @@ -970,6 +1021,8 @@ public class Repackage { Manifest sourceManifest; try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(file), false)) { sourceManifest = jarIn.getManifest(); + if (sourceManifest == null) + logger.log(WARNING, file + " has no manifest"); manifest = sourceManifest != null ? new Manifest(sourceManifest) : new Manifest(); String rawSourceSymbolicName = manifest.getMainAttributes().getValue(BUNDLE_SYMBOLICNAME.toString()); @@ -992,6 +1045,8 @@ public class Repackage { nameVersion = new NameVersion(ourSymbolicName, ourVersion); } else { nameVersion = nameVersionFromManifest(manifest); + if (nameVersion == null) + throw new IllegalStateException("Could not compute name/version from Manifest"); if (ourVersion != null && !nameVersion.getVersion().equals(ourVersion)) { logger.log(WARNING, "Original version is " + nameVersion.getVersion() + " while new version is " + ourVersion); @@ -1002,6 +1057,7 @@ public class Repackage { nameVersion.setName(ourSymbolicName); } } + bundleDir = targetBase.resolve(nameVersion.getName() + "." + nameVersion.getBranch()); // copy original MANIFEST @@ -1027,7 +1083,6 @@ public class Repackage { arch = libRelativePath.getName(1).toString(); } -// if (!embed) { // copy entries JarEntry entry; entries: while ((entry = jarIn.getNextJarEntry()) != null) { @@ -1094,7 +1149,6 @@ public class Repackage { origin.deleted.add(bundleDir.relativize(target).toString()); } logger.log(TRACE, () -> "Copied " + target); -// } } } @@ -1107,11 +1161,6 @@ public class Repackage { entries.get(BUNDLE_SYMBOLICNAME.toString()) + ";singleton:=true"); } -// if (embed) {// copy embedded jar -// Files.copy(file, bundleDir.resolve(file.getFileName())); -// entries.put(ManifestHeader.BUNDLE_CLASSPATH.toString(), file.getFileName().toString()); -// } - // Final MANIFEST decisions // We also check the original OSGi metadata and compare with our changes for (String key : entries.keySet()) { @@ -1294,15 +1343,17 @@ public class Repackage { } /** - * Effectively download. Synchronised in order to avoid downloading twice in - * parallel. + * Effectively download an archive. */ - synchronized Path downloadArchive(URL url, Path dir) throws IOException { + Path downloadArchive(URL url, Path dir) throws IOException { return download(url, dir, (String) null); } - /** Effectively download. */ - Path download(URL url, Path dir, String name) throws IOException { + /** + * Effectively download. Synchronised in order to avoid downloading twice in + * parallel. + */ + synchronized Path download(URL url, Path dir, String name) throws IOException { Path dest; if (name == null) { @@ -1360,13 +1411,14 @@ public class Repackage { deleteDirectory(bundleDir); if (separateSources) - createSourceJar(bundleDir, manifest, false); + createSourceJar(bundleDir, manifest, null); return jarPath; } /** Package sources separately, in the Eclipse-SourceBundle format. */ - void createSourceJar(Path bundleDir, Manifest manifest, boolean notModified) throws IOException { + void createSourceJar(Path bundleDir, Manifest manifest, Properties props) throws IOException { + boolean unmodified = props != null; Path bundleCategoryDir = bundleDir.getParent(); Path sourceDir = bundleCategoryDir.resolve(bundleDir.toString() + ".src"); if (!Files.exists(sourceDir)) { @@ -1374,9 +1426,6 @@ public class Repackage { return; } - if (!notModified) - createReadMe(sourceDir, manifest); - Path relPath = a2Base.relativize(bundleCategoryDir); Path srcCategoryDir = a2SrcBase.resolve(relPath); Path srcJarP = srcCategoryDir.resolve(sourceDir.getFileName() + ".jar"); @@ -1387,14 +1436,16 @@ public class Repackage { bundleSymbolicName = bundleSymbolicName.split(";")[0]; Manifest srcManifest = new Manifest(); srcManifest.getMainAttributes().put(MANIFEST_VERSION, "1.0"); - srcManifest.getMainAttributes().putValue(BUNDLE_SYMBOLICNAME.toString(), bundleSymbolicName + ".src"); - srcManifest.getMainAttributes().putValue(BUNDLE_VERSION.toString(), - manifest.getMainAttributes().getValue(BUNDLE_VERSION.toString()).toString()); - srcManifest.getMainAttributes().putValue(ECLIPSE_SOURCE_BUNDLE.toString(), bundleSymbolicName + ";version=\"" - + manifest.getMainAttributes().getValue(BUNDLE_VERSION.toString()) + "\""); - + BUNDLE_SYMBOLICNAME.put(srcManifest, bundleSymbolicName + ".src"); + BUNDLE_VERSION.put(srcManifest, BUNDLE_VERSION.get(manifest)); + ECLIPSE_SOURCE_BUNDLE.put(srcManifest, + bundleSymbolicName + ";version=\"" + BUNDLE_VERSION.get(manifest) + "\""); + + // metadata + createReadMe(sourceDir, unmodified ? props : manifest); + // create jar try (JarOutputStream srcJarOut = new JarOutputStream(Files.newOutputStream(srcJarP), srcManifest)) { - srcJarOut.setLevel(Deflater.BEST_COMPRESSION); + // srcJarOut.setLevel(Deflater.BEST_COMPRESSION); Files.walkFileTree(sourceDir, new SimpleFileVisitor() { @Override @@ -1417,10 +1468,10 @@ public class Repackage { * Generate a readme clarifying and prominently notifying of the repackaging and * modifications. */ - void createReadMe(Path jarDir, Manifest manifest) throws IOException { + void createReadMe(Path jarDir, Object mapping) throws IOException { // write repackaged README try (BufferedWriter writer = Files.newBufferedWriter(jarDir.resolve(README_REPACKAGED))) { - boolean merged = manifest.getMainAttributes().getValue(ARGEO_ORIGIN_M2_MERGE.toString()) != null; + boolean merged = ARGEO_ORIGIN_M2_MERGE.get(mapping) != null; if (merged) writer.append("This component is a merging of third party components" + " in order to comply with A2 packaging standards.\n"); @@ -1429,7 +1480,7 @@ public class Repackage { + " in order to comply with A2 packaging standards.\n"); // license - String spdxLicenseId = manifest.getMainAttributes().getValue(SPDX_LICENSE_IDENTIFIER.toString()); + String spdxLicenseId = SPDX_LICENSE_IDENTIFIER.get(mapping); if (spdxLicenseId == null) throw new IllegalStateException("An SPDX license id must have beend defined at this stage."); writer.append("\nIt is redistributed under the following license:\n\n"); @@ -1446,31 +1497,35 @@ public class Repackage { writer.append("which is available here: https://spdx.org/licenses/" + spdxLicenseId + "\n"); } } else { - String url = manifest.getMainAttributes().getValue(BUNDLE_LICENSE.toString()); + String url = BUNDLE_LICENSE.get(mapping); if (url != null) { writer.write("which is available here: " + url + "\n"); } else { - logger.log(ERROR, "No licne URL for " + jarDir); + logger.log(ERROR, "No licence URL for " + jarDir); } } - writer.write("\n"); // origin - String m2Repo = manifest.getMainAttributes().getValue(ARGEO_ORIGIN_M2_REPO.toString()); - String originDesc = manifest.getMainAttributes().getValue(ARGEO_ORIGIN_M2.toString()); + String originDesc = ARGEO_ORIGIN_URI.get(mapping); if (originDesc != null) - writer.append("The original component has M2 coordinates:\n" + originDesc.replace(',', '\n') + "\n" - + (m2Repo != null ? "\nin M2 repository " + m2Repo + "\n" : "")); + writer.append("\nThe original component comes from " + originDesc + ".\n"); else { - originDesc = manifest.getMainAttributes().getValue(ARGEO_ORIGIN_URI.toString()); + String m2Repo = ARGEO_ORIGIN_M2_REPO.get(mapping); + originDesc = ARGEO_ORIGIN_M2.get(mapping); if (originDesc != null) - writer.append("The original component comes from " + originDesc + ".\n"); + writer.append("\nThe original component has M2 coordinates:\n" + originDesc.replace(',', '\n') + + "\n" + (m2Repo != null ? "\nin M2 repository " + m2Repo + "\n" : "")); else logger.log(ERROR, "Cannot find origin information in " + jarDir); } + String originSources = ARGEO_ORIGIN_SOURCES_URI.get(mapping); + if (originSources != null) + writer.append("\nThe original sources come from " + originSources + ".\n"); - writer.append("\nA detailed list of changes is available under " + CHANGES + ".\n"); - if (!jarDir.getFileName().endsWith(".src")) {// binary archive + if (Files.exists(jarDir.resolve(CHANGES))) + writer.append("\nA detailed list of changes is available under " + CHANGES + ".\n"); + + if (!jarDir.getFileName().toString().endsWith(".src")) {// binary archive if (separateSources) writer.append("Corresponding sources are available in the related archive named " + jarDir.toString() + ".src.jar.\n"); @@ -1478,7 +1533,6 @@ public class Repackage { writer.append("Corresponding sources are available under OSGI-OPT/src.\n"); } } - } /** @@ -1497,6 +1551,8 @@ public class Repackage { /** Append changes to the A2-ORIGIN/changes file. */ void appendChanges(Path baseDirectory) throws IOException { + if (modified.isEmpty() && deleted.isEmpty() && added.isEmpty() && moved.isEmpty()) + return; // no changes Path changesFile = baseDirectory.resolve(CHANGES); Files.createDirectories(changesFile.getParent()); try (BufferedWriter writer = Files.newBufferedWriter(changesFile, APPEND, CREATE)) {