X-Git-Url: https://git.argeo.org/?a=blobdiff_plain;f=src%2Forg%2Fargeo%2Fbuild%2FRepackage.java;h=a6c84edd81f627e86410707cfbf81b364078dcdf;hb=199fe0d1ffe514f49629b64dd0c7669da752beae;hp=607a9ab1c583528ac529c4dfb8a0fe716463f78e;hpb=4abc28a7202ed37009556efc590b3235500b2bdf;p=cc0%2Fargeo-build.git diff --git a/src/org/argeo/build/Repackage.java b/src/org/argeo/build/Repackage.java index 607a9ab..a6c84ed 100644 --- a/src/org/argeo/build/Repackage.java +++ b/src/org/argeo/build/Repackage.java @@ -9,6 +9,7 @@ import static java.nio.file.FileVisitResult.CONTINUE; import static java.nio.file.StandardOpenOption.APPEND; import static java.nio.file.StandardOpenOption.CREATE; import static java.util.jar.Attributes.Name.MANIFEST_VERSION; +import static org.argeo.build.Repackage.ManifestHeader.ARGEO_DO_NOT_MODIFY; import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_M2; import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_M2_MERGE; import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_M2_REPO; @@ -179,15 +180,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()); } } @@ -231,12 +252,12 @@ public class Repackage { final Map> mirrors = new HashMap>(); /** Whether sources should be packaged separately */ - final boolean sourceBundles; + final boolean separateSources; /** Constructor initialises the various variables */ public Repackage(Path a2Base, Path descriptorsBase) { - sourceBundles = Boolean.parseBoolean(System.getenv(ENV_SOURCE_BUNDLES)); - if (sourceBundles) + separateSources = Boolean.parseBoolean(System.getenv(ENV_SOURCE_BUNDLES)); + if (separateSources) logger.log(INFO, "Sources will be packaged separately"); Objects.requireNonNull(a2Base); @@ -246,7 +267,7 @@ public class Repackage { // TODO define and use a build base this.a2Base = a2Base; - this.a2SrcBase = a2Base.getParent().resolve(a2Base.getFileName() + ".src"); + this.a2SrcBase = separateSources ? a2Base.getParent().resolve(a2Base.getFileName() + ".src") : a2Base; this.a2LibBase = a2Base.resolve("lib"); this.descriptorsBase = descriptorsBase; if (!Files.exists(this.descriptorsBase)) @@ -331,29 +352,17 @@ public class Repackage { Path downloaded = downloadMaven(fileProps, artifact); - // some proprietary artifacts do not allow any modification - // when releasing (with separate sources) we just copy it - boolean doNotModify = Boolean.parseBoolean( - fileProps.getOrDefault(ManifestHeader.ARGEO_DO_NOT_MODIFY.toString(), "false").toString()); - if (doNotModify && sourceBundles) { - Path unmodifiedTarget = targetCategoryBase.resolve( - fileProps.getProperty(BUNDLE_SYMBOLICNAME.toString()) + "." + artifact.getBranch() + ".jar"); - Files.copy(downloaded, unmodifiedTarget, StandardCopyOption.REPLACE_EXISTING); - Path bundleDir = targetCategoryBase - .resolve(fileProps.getProperty(BUNDLE_SYMBOLICNAME.toString()) + "." + artifact.getBranch()); - downloadAndProcessM2Sources(fileProps, artifact, bundleDir, false); - Manifest manifest; - try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(unmodifiedTarget))) { - manifest = jarIn.getManifest(); - } - createSourceJar(bundleDir, manifest); + boolean doNotModify = Boolean + .parseBoolean(fileProps.getOrDefault(ARGEO_DO_NOT_MODIFY.toString(), "false").toString()); + if (doNotModify) { + processNotModified(targetCategoryBase, downloaded, fileProps, artifact); return; } // 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); @@ -438,10 +447,16 @@ public class Repackage { // download Path downloaded = downloadMaven(mergedProps, artifact); - A2Origin origin = new A2Origin(); - Path targetBundleDir = processBndJar(downloaded, targetCategoryBase, mergedProps, artifact, origin); - downloadAndProcessM2Sources(mergedProps, artifact, targetBundleDir, false); - createJar(targetBundleDir, origin); + boolean doNotModify = Boolean + .parseBoolean(mergedProps.getOrDefault(ARGEO_DO_NOT_MODIFY.toString(), "false").toString()); + if (doNotModify) { + processNotModified(targetCategoryBase, downloaded, mergedProps, artifact); + } else { + A2Origin origin = new A2Origin(); + Path targetBundleDir = processBndJar(downloaded, targetCategoryBase, mergedProps, artifact, origin); + downloadAndProcessM2Sources(mergedProps, artifact, targetBundleDir, false, false); + createJar(targetBundleDir, origin); + } } } catch (IOException e) { throw new RuntimeException("Cannot process " + duDir, e); @@ -579,7 +594,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 @@ -706,9 +721,28 @@ public class Repackage { } - /** Download and integrates sources for a single Maven artifact. */ - void downloadAndProcessM2Sources(Properties props, M2Artifact artifact, Path targetBundleDir, boolean merging) + /** Process an artifact that should not be modified. */ + void processNotModified(Path targetCategoryBase, Path downloaded, Properties fileProps, M2Artifact artifact) throws IOException { + // Some proprietary or signed artifacts do not allow any modification + // 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, true); + Manifest manifest; + try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(unmodifiedTarget))) { + manifest = jarIn.getManifest(); + } + createSourceJar(bundleDir, manifest, fileProps); + } + + /** Download and integrates sources for a single Maven artifact. */ + 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()) @@ -718,7 +752,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); @@ -727,9 +761,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 = sourceBundles ? 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)) { @@ -743,24 +777,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()); @@ -773,7 +809,7 @@ public class Repackage { } } // write the changes - if (sourceBundles) { + if (separateSources || unmodified) { origin.appendChanges(sourceDir); } else { origin.added.add("source code under OSGI-OPT/src"); @@ -794,10 +830,6 @@ public class Repackage { /** Download a Maven artifact. */ Path downloadMaven(URL url, M2Artifact artifact) throws IOException { return download(url, mavenBase, M2ConventionsUtils.artifactPath("", artifact)); -// return download(url, mavenBase, artifact.getGroupId().replace(".", "/") // -// + '/' + artifact.getArtifactId() + '/' + artifact.getVersion() // -// + '/' + artifact.getArtifactId() + "-" + artifact.getVersion() -// + (artifact.getClassifier() != null ? "-" + artifact.getClassifier() : "") + ".jar"); } /* @@ -916,7 +948,7 @@ public class Repackage { NameVersion nameVersion = new NameVersion(relatedBundle[0], version); bundleDir = targetBase.resolve(nameVersion.getName() + "." + nameVersion.getBranch()); - Path sourceDir = sourceBundles ? bundleDir.getParent().resolve(bundleDir.toString() + ".src") + Path sourceDir = separateSources ? bundleDir.getParent().resolve(bundleDir.toString() + ".src") : bundleDir.resolve("OSGI-OPT/src"); Files.createDirectories(sourceDir); @@ -933,7 +965,7 @@ public class Repackage { } // write the changes - if (sourceBundles) { + if (separateSources) { origin.appendChanges(sourceDir); } else { origin.added.add("source code under OSGI-OPT/src"); @@ -1350,21 +1382,21 @@ public class Repackage { } deleteDirectory(bundleDir); - if (sourceBundles) - createSourceJar(bundleDir, manifest); + if (separateSources) + createSourceJar(bundleDir, manifest, null); return jarPath; } /** Package sources separately, in the Eclipse-SourceBundle format. */ - void createSourceJar(Path bundleDir, Manifest manifest) 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)) { logger.log(WARNING, sourceDir + " does not exist, skipping..."); return; } - createReadMe(sourceDir, manifest); Path relPath = a2Base.relativize(bundleCategoryDir); Path srcCategoryDir = a2SrcBase.resolve(relPath); @@ -1376,14 +1408,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 @@ -1406,10 +1440,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"); @@ -1418,7 +1452,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"); @@ -1435,39 +1469,42 @@ 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"); + + if (Files.exists(jarDir.resolve(CHANGES))) + writer.append("\nA detailed list of changes is available under " + CHANGES + ".\n"); - writer.append("\nA detailed list of changes is available under " + CHANGES + ".\n"); - if (!jarDir.getFileName().endsWith(".src")) {// binary archive - if (sourceBundles) + 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"); else writer.append("Corresponding sources are available under OSGI-OPT/src.\n"); } } - } /** @@ -1486,6 +1523,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)) { @@ -1578,7 +1617,8 @@ class M2ConventionsUtils { /** Absolute path to the directories where the files will be stored */ static String artifactParentPath(String artifactBasePath, M2Artifact artifact) { - return artifactBasePath + (artifactBasePath.endsWith("/") ? "" : "/") + artifactParentPath(artifact); + return artifactBasePath + (artifactBasePath.endsWith("/") || artifactBasePath.equals("") ? "" : "/") + + artifactParentPath(artifact); } /** Relative path to the directories where the files will be stored */