]> git.argeo.org Git - cc0/argeo-build.git/blobdiff - src/org/argeo/build/Repackage.java
Make output less verbose
[cc0/argeo-build.git] / src / org / argeo / build / Repackage.java
index 335222114583f0f8c065552a679b3d22735942bc..1ea7d536531ea298a0783463f471a4cd0ac4ac09 100644 (file)
@@ -15,6 +15,7 @@ import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_M2_MERGE;
 import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_M2_REPO;
 import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_NO_METADATA_GENERATION;
 import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_URI;
+import static org.argeo.build.Repackage.ManifestHeader.AUTOMATIC_MODULE_NAME;
 import static org.argeo.build.Repackage.ManifestHeader.BUNDLE_LICENSE;
 import static org.argeo.build.Repackage.ManifestHeader.BUNDLE_SYMBOLICNAME;
 import static org.argeo.build.Repackage.ManifestHeader.BUNDLE_VERSION;
@@ -193,9 +194,9 @@ public class Repackage {
         * Subdirectory of the jar file where origin informations (changes, legal
         * notices etc. are stored)
         */
-       final static String A2_ORIGIN = "A2-ORIGIN";
+       final static String ARGEO_ORIGIN = "ARGEO-ORIGIN";
        /** File detailing modifications to the original component. */
-       final static String CHANGES = A2_ORIGIN + "/changes";
+       final static String CHANGES = ARGEO_ORIGIN + "/changes";
        /**
         * Name of the file at the root of the repackaged jar, which prominently
         * notifies that the component has be repackaged.
@@ -404,7 +405,12 @@ public class Repackage {
                                }
                                String m2Coordinates = fileProps.getProperty(ARGEO_ORIGIN_M2.toString());
                                M2Artifact artifact = new M2Artifact(m2Coordinates);
-                               artifact.setVersion(m2Version);
+                               if (artifact.getVersion() == null) {
+                                       artifact.setVersion(m2Version);
+                               } else {
+                                       logger.log(WARNING, p.getFileName() + " : Using version " + artifact.getVersion()
+                                                       + " specified in descriptor rather than " + m2Version + " specified in " + COMMON_BND);
+                               }
 
                                // prepare manifest entries
                                Properties mergeProps = new Properties();
@@ -453,13 +459,20 @@ public class Repackage {
                Path targetCategoryBase = a2Base.resolve(category);
 
                Properties mergeProps = new Properties();
+               // first, load common properties
+               Path commonBnd = duDir.resolve(COMMON_BND);
+               if (Files.exists(commonBnd))
+                       try (InputStream in = Files.newInputStream(commonBnd)) {
+                               mergeProps.load(in);
+                       }
+               // then, the merge properties themselves
                try (InputStream in = Files.newInputStream(mergeBnd)) {
                        mergeProps.load(in);
                }
 
                String m2Version = mergeProps.getProperty(ARGEO_ORIGIN_M2.toString());
                if (m2Version == null) {
-                       logger.log(WARNING, "Ignoring " + duDir + " as it is not an M2-based distribution unit");
+                       logger.log(WARNING, "Ignoring merging in " + duDir + " as it is not an M2-based distribution unit");
                        return;// ignore, this is probably an Eclipse archive
                }
                if (!m2Version.startsWith(":")) {
@@ -527,7 +540,7 @@ public class Repackage {
                                                continue entries;
                                        }
                                        if (entry.getName().equals("META-INF/MANIFEST.MF")) {
-                                               Path originalManifest = bundleDir.resolve(A2_ORIGIN).resolve(artifact.getGroupId())
+                                               Path originalManifest = bundleDir.resolve(ARGEO_ORIGIN).resolve(artifact.getGroupId())
                                                                .resolve(artifact.getArtifactId()).resolve("MANIFEST.MF");
                                                Files.createDirectories(originalManifest.getParent());
                                                try (OutputStream out = Files.newOutputStream(originalManifest)) {
@@ -542,7 +555,7 @@ public class Repackage {
                                                        || 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(A2_ORIGIN).resolve(artifact.getGroupId())
+                                               Path artifactOriginDir = bundleDir.resolve(ARGEO_ORIGIN).resolve(artifact.getGroupId())
                                                                .resolve(artifact.getArtifactId());
                                                Path target = artifactOriginDir.resolve(entry.getName());
                                                Files.createDirectories(target.getParent());
@@ -977,7 +990,7 @@ public class Repackage {
 
                        // copy original MANIFEST
                        if (sourceManifest != null) {
-                               Path originalManifest = bundleDir.resolve(A2_ORIGIN).resolve("MANIFEST.MF");
+                               Path originalManifest = bundleDir.resolve(ARGEO_ORIGIN).resolve("MANIFEST.MF");
                                Files.createDirectories(originalManifest.getParent());
                                try (OutputStream out = Files.newOutputStream(originalManifest)) {
                                        sourceManifest.write(out);
@@ -1107,6 +1120,9 @@ public class Repackage {
                        if (wasDifferent && !keepPrevious) {
                                if (IMPORT_PACKAGE.toString().equals(key) || EXPORT_PACKAGE.toString().equals(key))
                                        logger.log(TRACE, () -> file.getFileName() + ": " + key + " was modified");
+                               else if (BUNDLE_SYMBOLICNAME.toString().equals(key) || AUTOMATIC_MODULE_NAME.toString().equals(key))
+                                       logger.log(DEBUG,
+                                                       file.getFileName() + ": " + key + " was " + previousValue + ", overridden with " + value);
                                else
                                        logger.log(WARNING,
                                                        file.getFileName() + ": " + key + " was " + previousValue + ", overridden with " + value);
@@ -1164,17 +1180,20 @@ public class Repackage {
                        if (orIndex >= 0)
                                spdxLicenceId = spdxLicenceId.substring(0, orIndex).trim();
 
-                       // set licenses of some well-known components
-                       // even if we say otherwise (typically because coming from an Eclipse archive)
-                       if (bundleDir.getFileName().startsWith("org.apache."))
+                       String bundleDirName = bundleDir.getFileName().toString();
+                       // force licenses of some well-known components
+                       // even if we say otherwise (typically because from an Eclipse archive)
+                       if (bundleDirName.startsWith("org.apache."))
                                spdxLicenceId = "Apache-2.0";
-                       if (bundleDir.getFileName().startsWith("com.sun.jna."))
+                       if (bundleDirName.startsWith("com.sun.jna."))
                                spdxLicenceId = "Apache-2.0";
-                       if (bundleDir.getFileName().startsWith("com.ibm.icu."))
+                       if (bundleDirName.startsWith("com.ibm.icu."))
                                spdxLicenceId = "ICU";
-                       if (bundleDir.getFileName().startsWith("javax.annotation."))
+                       if (bundleDirName.startsWith("javax.annotation."))
                                spdxLicenceId = "GPL-2.0-only WITH Classpath-exception-2.0";
-                       if (bundleDir.getFileName().startsWith("javax.inject."))
+                       if (bundleDirName.startsWith("javax.inject."))
+                               spdxLicenceId = "Apache-2.0";
+                       if (bundleDirName.startsWith("org.osgi."))
                                spdxLicenceId = "Apache-2.0";
 
                        manifest.getMainAttributes().putValue(SPDX_LICENSE_IDENTIFIER.toString(), spdxLicenceId);
@@ -1374,6 +1393,10 @@ public class Repackage {
                deleteDirectory(sourceDir);
        }
 
+       /**
+        * Generate a readme clarifying and prominently notifying of the repackaging and
+        * modifications.
+        */
        void createReadMe(Path jarDir, Manifest manifest) throws IOException {
                // write repackaged README
                try (BufferedWriter writer = Files.newBufferedWriter(jarDir.resolve(README_REPACKAGED))) {
@@ -1386,7 +1409,9 @@ public class Repackage {
                                                + " in order to comply with A2 packaging standards.\n");
 
                        // license
-                       String spdxLicenseId = manifest.getMainAttributes().getValue(ARGEO_ORIGIN_M2_REPO.toString());
+                       String spdxLicenseId = manifest.getMainAttributes().getValue(SPDX_LICENSE_IDENTIFIER.toString());
+                       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");
                        writer.append("SPDX-Identifier: " + spdxLicenseId + "\n\n");
 
@@ -1403,26 +1428,28 @@ public class Repackage {
                        } else {
                                String url = manifest.getMainAttributes().getValue(BUNDLE_LICENSE.toString());
                                if (url != null) {
-                                       writer.write("which is avaliabel here: " + url + "\n");
+                                       writer.write("which is available here: " + url + "\n");
                                } else {
                                        logger.log(ERROR, "No licne 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());
                        if (originDesc != null)
-                               writer.append("The original component has Maven coordinates " + originDesc
-                                               + (m2Repo != null ? " in M2 repository" + m2Repo : "") + ".\n");
-                       else
+                               writer.append("The original component has M2 coordinates:\n" + originDesc.replace(',', '\n') + "\n"
+                                               + (m2Repo != null ? "\nin M2 repository " + m2Repo + "\n" : ""));
+                       else {
                                originDesc = manifest.getMainAttributes().getValue(ARGEO_ORIGIN_URI.toString());
-                       if (originDesc != null)
-                               writer.append("The original component comes from " + originDesc + ".\n");
-                       else
-                               logger.log(ERROR, "Cannot find origin information in " + jarDir);
+                               if (originDesc != null)
+                                       writer.append("The original component comes from " + originDesc + ".\n");
+                               else
+                                       logger.log(ERROR, "Cannot find origin information in " + jarDir);
+                       }
 
-                       writer.append("A 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)
                                        writer.append("Corresponding sources are available in the related archive named "