import static java.lang.System.Logger.Level.TRACE;
import static java.lang.System.Logger.Level.WARNING;
import static java.nio.file.FileVisitResult.CONTINUE;
+import static org.argeo.build.Repackage.ManifestConstants.ARGEO_ORIGIN_M2;
+import static org.argeo.build.Repackage.ManifestConstants.ARGEO_ORIGIN_M2_REPO;
import static org.argeo.build.Repackage.ManifestConstants.BUNDLE_SYMBOLICNAME;
import static org.argeo.build.Repackage.ManifestConstants.BUNDLE_VERSION;
import static org.argeo.build.Repackage.ManifestConstants.EXPORT_PACKAGE;
-import static org.argeo.build.Repackage.ManifestConstants.SLC_ORIGIN_M2;
-import static org.argeo.build.Repackage.ManifestConstants.SLC_ORIGIN_M2_REPO;
import java.io.File;
import java.io.FileNotFoundException;
import aQute.bnd.osgi.Analyzer;
import aQute.bnd.osgi.Jar;
-/** The central class for A2 packaging. */
+/**
+ * Simple tool repackaging existing jar files into OSGi bundles in an A2
+ * repository.
+ */
public class Repackage {
private final static Logger logger = System.getLogger(Repackage.class.getName());
- private final static String ENV_BUILD_SOURCE_BUNDLES = "BUILD_SOURCE_BUNDLES";
+ /**
+ * Environment variable on whether sources should be packaged separately or
+ * integrated in the bundles.
+ */
+ private final static String ENV_SOURCE_BUNDLES = "SOURCE_BUNDLES";
+ /** Whethere repackaging should run in parallel or sequentially. */
private final static boolean parallel = true;
/** Main entry point. */
private final static String COMMON_BND = "common.bnd";
private final static String MERGE_BND = "merge.bnd";
+ /** Directory where to download archives */
private Path originBase;
+ /** Directory where to download Maven artifacts */
private Path mavenBase;
+ /** A2 repository base for binary bundles */
private Path a2Base;
+ /** A2 repository base for source bundles */
private Path a2SrcBase;
+ /** A2 base for native components */
private Path a2LibBase;
+ /** Location of the descriptors driving the packaging */
private Path descriptorsBase;
-
+ /** URIs of archives to download */
private Properties uris = new Properties();
-
- /** key is URI prefix, value list of base URLs */
+ /** Mirrors for archive download. Key is URI prefix, value list of base URLs */
private Map<String, List<String>> mirrors = new HashMap<String, List<String>>();
+ /** Whether sources should be packaged separately */
private final boolean sourceBundles;
+ /** Constructor initialises the various variables */
public Repackage(Path a2Base, Path descriptorsBase) {
- sourceBundles = Boolean.parseBoolean(System.getenv(ENV_BUILD_SOURCE_BUNDLES));
+ sourceBundles = Boolean.parseBoolean(System.getenv(ENV_SOURCE_BUNDLES));
if (sourceBundles)
logger.log(INFO, "Sources will be packaged separately");
try (InputStream in = Files.newInputStream(bndFile)) {
fileProps.load(in);
}
- String repoStr = fileProps.containsKey(SLC_ORIGIN_M2_REPO.toString())
- ? fileProps.getProperty(SLC_ORIGIN_M2_REPO.toString())
+ String repoStr = fileProps.containsKey(ARGEO_ORIGIN_M2_REPO.toString())
+ ? fileProps.getProperty(ARGEO_ORIGIN_M2_REPO.toString())
: null;
if (!fileProps.containsKey(BUNDLE_SYMBOLICNAME.toString())) {
fileProps.put(BUNDLE_SYMBOLICNAME.toString(), symbolicName);
}
- String m2Coordinates = fileProps.getProperty(SLC_ORIGIN_M2.toString());
+ String m2Coordinates = fileProps.getProperty(ARGEO_ORIGIN_M2.toString());
if (m2Coordinates == null)
throw new IllegalArgumentException("No M2 coordinates available for " + bndFile);
M2Artifact artifact = new M2Artifact(m2Coordinates);
commonProps.load(in);
}
- String m2Version = commonProps.getProperty(SLC_ORIGIN_M2.toString());
+ String m2Version = commonProps.getProperty(ARGEO_ORIGIN_M2.toString());
if (m2Version == null) {
logger.log(WARNING, "Ignoring " + duDir + " as it is not an M2-based distribution unit");
return;// ignore, this is probably an Eclipse archive
try (InputStream in = Files.newInputStream(p)) {
fileProps.load(in);
}
- String m2Coordinates = fileProps.getProperty(SLC_ORIGIN_M2.toString());
+ String m2Coordinates = fileProps.getProperty(ARGEO_ORIGIN_M2.toString());
M2Artifact artifact = new M2Artifact(m2Coordinates);
artifact.setVersion(m2Version);
mergeProps.putAll(commonProps);
fileEntries: for (Object key : fileProps.keySet()) {
- if (ManifestConstants.SLC_ORIGIN_M2.toString().equals(key))
+ if (ManifestConstants.ARGEO_ORIGIN_M2.toString().equals(key))
continue fileEntries;
String value = fileProps.getProperty(key.toString());
Object previousValue = mergeProps.put(key.toString(), value);
commonBnd + ": " + key + " was " + previousValue + ", overridden with " + value);
}
}
- mergeProps.put(ManifestConstants.SLC_ORIGIN_M2.toString(), artifact.toM2Coordinates());
+ mergeProps.put(ManifestConstants.ARGEO_ORIGIN_M2.toString(), artifact.toM2Coordinates());
if (!mergeProps.containsKey(BUNDLE_SYMBOLICNAME.toString())) {
// use file name as symbolic name
String symbolicName = p.getFileName().toString();
mergeProps.put(BUNDLE_SYMBOLICNAME.toString(), symbolicName);
}
- String repoStr = mergeProps.containsKey(SLC_ORIGIN_M2_REPO.toString())
- ? mergeProps.getProperty(SLC_ORIGIN_M2_REPO.toString())
+ String repoStr = mergeProps.containsKey(ARGEO_ORIGIN_M2_REPO.toString())
+ ? mergeProps.getProperty(ARGEO_ORIGIN_M2_REPO.toString())
: null;
// download
mergeProps.load(in);
}
- String m2Version = mergeProps.getProperty(SLC_ORIGIN_M2.toString());
+ 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");
return;// ignore, this is probably an Eclipse archive
m2Version = m2Version.substring(1);
mergeProps.put(ManifestConstants.BUNDLE_VERSION.toString(), m2Version);
- String artifactsStr = mergeProps.getProperty(ManifestConstants.SLC_ORIGIN_M2_MERGE.toString());
+ String artifactsStr = mergeProps.getProperty(ManifestConstants.ARGEO_ORIGIN_M2_MERGE.toString());
if (artifactsStr == null)
throw new IllegalArgumentException(
- mergeBnd + ": " + ManifestConstants.SLC_ORIGIN_M2_MERGE + " must be set");
+ mergeBnd + ": " + ManifestConstants.ARGEO_ORIGIN_M2_MERGE + " must be set");
- String repoStr = mergeProps.containsKey(SLC_ORIGIN_M2_REPO.toString())
- ? mergeProps.getProperty(SLC_ORIGIN_M2_REPO.toString())
+ String repoStr = mergeProps.containsKey(ARGEO_ORIGIN_M2_REPO.toString())
+ ? mergeProps.getProperty(ARGEO_ORIGIN_M2_REPO.toString())
: null;
String bundleSymbolicName = mergeProps.getProperty(ManifestConstants.BUNDLE_SYMBOLICNAME.toString());
CategoryNameVersion nameVersion = new M2Artifact(category + ":" + bundleSymbolicName + ":" + m2Version);
Path targetBundleDir = targetCategoryBase.resolve(bundleSymbolicName + "." + nameVersion.getBranch());
- if (Files.exists(targetBundleDir)) {
- logger.log(WARNING, targetBundleDir + " exists, deleting it...");
- deleteDirectory(targetBundleDir);
- } else {
- Files.createDirectories(targetBundleDir);
- }
String[] artifacts = artifactsStr.split(",");
artifacts: for (String str : artifacts) {
try {
Map<String, String> additionalEntries = new TreeMap<>();
boolean doNotModify = Boolean.parseBoolean(fileProps
- .getOrDefault(ManifestConstants.SLC_ORIGIN_MANIFEST_NOT_MODIFIED.toString(), "false").toString());
+ .getOrDefault(ManifestConstants.ARGEO_ORIGIN_MANIFEST_NOT_MODIFIED.toString(), "false").toString());
// we always force the symbolic name
if (doNotModify) {
fileEntries: for (Object key : fileProps.keySet()) {
- if (ManifestConstants.SLC_ORIGIN_M2.toString().equals(key))
+ if (ManifestConstants.ARGEO_ORIGIN_M2.toString().equals(key))
continue fileEntries;
String value = fileProps.getProperty(key.toString());
additionalEntries.put(key.toString(), value);
? targetBundleDir.getParent().resolve(targetBundleDir.toString() + ".src")
: targetBundleDir.resolve("OSGI-OPT/src");
- if (Files.exists(targetSourceDir) && sourceBundles) {
- logger.log(WARNING, targetSourceDir + " exists, deleting it...");
- deleteDirectory(targetSourceDir);
- } else {
- Files.createDirectories(targetSourceDir);
- }
-
- // copy entries
+ Files.createDirectories(targetSourceDir);
JarEntry entry;
entries: while ((entry = jarIn.getNextJarEntry()) != null) {
if (entry.isDirectory())
try (InputStream in = Files.newInputStream(commonBnd)) {
commonProps.load(in);
}
- String url = commonProps.getProperty(ManifestConstants.SLC_ORIGIN_URI.toString());
+ String url = commonProps.getProperty(ManifestConstants.ARGEO_ORIGIN_URI.toString());
if (url == null) {
url = uris.getProperty(duDir.getFileName().toString());
if (url == null)
throw new IllegalStateException("No url available for " + duDir);
- commonProps.put(ManifestConstants.SLC_ORIGIN_URI.toString(), url);
+ commonProps.put(ManifestConstants.ARGEO_ORIGIN_URI.toString(), url);
}
Path downloaded = tryDownloadArchive(url, originBase);
? targetBundleDir.getParent().resolve(targetBundleDir.toString() + ".src")
: targetBundleDir.resolve("OSGI-OPT/src");
- if (Files.exists(targetSourceDir) && sourceBundles) {
- logger.log(WARNING, targetSourceDir + " exists, deleting it...");
- deleteDirectory(targetSourceDir);
- } else {
- Files.createDirectories(targetSourceDir);
- }
-
- // copy entries
+ Files.createDirectories(targetSourceDir);
JarEntry entry;
entries: while ((entry = jarIn.getNextJarEntry()) != null) {
if (entry.isDirectory())
}
}
targetBundleDir = targetBase.resolve(nameVersion.getName() + "." + nameVersion.getBranch());
- if (Files.exists(targetBundleDir)) {
- logger.log(WARNING, targetBundleDir + " exists, deleting it...");
- deleteDirectory(targetBundleDir);
- } else {
- Files.createDirectories(targetBundleDir);
- }
// force Java 9 module name
entries.put(ManifestConstants.AUTOMATIC_MODULE_NAME.toString(), nameVersion.getName());
Object previousValue = manifest.getMainAttributes().putValue(key, value);
if (previousValue != null && !previousValue.equals(value)) {
if (ManifestConstants.IMPORT_PACKAGE.toString().equals(key)
- || ManifestConstants.EXPORT_PACKAGE.toString().equals(key)
- || ManifestConstants.BUNDLE_LICENSE.toString().equals(key))
+ || ManifestConstants.EXPORT_PACKAGE.toString().equals(key))
logger.log(TRACE, file.getFileName() + ": " + key + " was modified");
else
logger.log(WARNING, file.getFileName() + ": " + key + " was " + previousValue
+ ", overridden with " + value);
}
- // hack to remove unresolvable
+ // !! hack to remove unresolvable
if (key.equals("Provide-Capability") || key.equals("Require-Capability"))
if (nameVersion.getName().equals("osgi.core") || nameVersion.getName().equals("osgi.cmpn")) {
manifest.getMainAttributes().remove(key);
/** MANIFEST headers. */
enum ManifestConstants {
// OSGi
+ /** OSGi bundle symbolic name. */
BUNDLE_SYMBOLICNAME("Bundle-SymbolicName"), //
+ /** OSGi bundle version. */
BUNDLE_VERSION("Bundle-Version"), //
- BUNDLE_LICENSE("Bundle-License"), //
+// BUNDLE_LICENSE("Bundle-License"), //
+ /** OSGi exported packages list. */
EXPORT_PACKAGE("Export-Package"), //
+ /** OSGi imported packages list. */
IMPORT_PACKAGE("Import-Package"), //
- // JAVA
+ // Java
+ /** Java module name. */
AUTOMATIC_MODULE_NAME("Automatic-Module-Name"), //
- // SLC
- SLC_CATEGORY("SLC-Category"), //
- SLC_ORIGIN_M2("SLC-Origin-M2"), //
- SLC_ORIGIN_M2_MERGE("SLC-Origin-M2-Merge"), //
- SLC_ORIGIN_M2_REPO("SLC-Origin-M2-Repo"), //
- SLC_ORIGIN_MANIFEST_NOT_MODIFIED("SLC-Origin-ManifestNotModified"), //
- SLC_ORIGIN_URI("SLC-Origin-URI"), //
+ // Argeo Origin
+ /**
+ * Maven coordinates of the origin, possibly partial when using common.bnd or
+ * merge.bnd.
+ */
+ ARGEO_ORIGIN_M2("Argeo-Origin-M2"), //
+ /** List of Maven coordinates to merge. */
+ ARGEO_ORIGIN_M2_MERGE("Argeo-Origin-M2-Merge"), //
+ /** Maven repository if not the default one. */
+ ARGEO_ORIGIN_M2_REPO("Argeo-Origin-M2-Repo"), //
+ /**
+ * Do not perform BND analysis of the origin component. Typically IMport_package
+ * and Export-Package will be kept untouched.
+ */
+ ARGEO_ORIGIN_MANIFEST_NOT_MODIFIED("Argeo-Origin-ManifestNotModified"), //
+ /**
+ * Origin (non-Maven) URI of the component. It may be anything (jar, archive,
+ * etc.).
+ */
+ ARGEO_ORIGIN_URI("Argeo-Origin-URI"), //
;
final String value;
projects / cc0 / argeo-build.git / blobdiff