package org.argeo.build;
import static java.lang.System.Logger.Level.DEBUG;
+import static java.lang.System.Logger.Level.ERROR;
+import static java.lang.System.Logger.Level.INFO;
+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.BUNDLE_SYMBOLICNAME;
import static org.argeo.build.Repackage.ManifestConstants.BUNDLE_VERSION;
import static org.argeo.build.Repackage.ManifestConstants.EXPORT_PACKAGE;
import java.io.InputStream;
import java.io.OutputStream;
import java.lang.System.Logger;
-import java.lang.System.Logger.Level;
import java.net.MalformedURLException;
import java.net.URL;
import java.nio.charset.StandardCharsets;
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(Level.INFO, "Sources will be packaged separately");
+ logger.log(INFO, "Sources will be packaged separately");
Objects.requireNonNull(a2Base);
Objects.requireNonNull(descriptorsBase);
this.originBase = Paths.get(System.getProperty("user.home"), ".cache", "argeo/build/origin");
+ this.mavenBase = Paths.get(System.getProperty("user.home"), ".m2", "repository");
+
// TODO define and use a build base
this.a2Base = a2Base;
+ this.a2SrcBase = a2Base.getParent().resolve(a2Base.getFileName() + ".src");
this.a2LibBase = a2Base.resolve("lib");
this.descriptorsBase = descriptorsBase;
if (!Files.exists(this.descriptorsBase))
it.remove();
}
}
-
mirrors.put("http://www.eclipse.org/downloads", eclipseMirrors);
}
/*
* MAVEN ORIGIN
*/
-
/** Process a whole category/group id. */
public void processCategory(Path categoryRelativePath) {
try {
/** Process a standalone Maven artifact. */
public void processSingleM2ArtifactDistributionUnit(Path bndFile) {
try {
-// String category = bndFile.getParent().getFileName().toString();
Path categoryRelativePath = descriptorsBase.relativize(bndFile.getParent());
Path targetCategoryBase = a2Base.resolve(categoryRelativePath);
throw new IllegalArgumentException("No M2 coordinates available for " + bndFile);
M2Artifact artifact = new M2Artifact(m2Coordinates);
URL url = M2ConventionsUtils.mavenRepoUrl(repoStr, artifact);
- Path downloaded = downloadMaven(url, originBase, artifact);
+ Path downloaded = downloadMaven(url, artifact);
Path targetBundleDir = processBndJar(downloaded, targetCategoryBase, fileProps, artifact);
-
downloadAndProcessM2Sources(repoStr, artifact, targetBundleDir);
createJar(targetBundleDir);
/** Process multiple Maven artifacts. */
public void processM2BasedDistributionUnit(Path duDir) {
try {
- // String category = duDir.getParent().getFileName().toString();
Path categoryRelativePath = descriptorsBase.relativize(duDir.getParent());
Path targetCategoryBase = a2Base.resolve(categoryRelativePath);
- // merge
Path mergeBnd = duDir.resolve(MERGE_BND);
- if (Files.exists(mergeBnd)) {
+ if (Files.exists(mergeBnd)) // merge
mergeM2Artifacts(mergeBnd);
-// return;
- }
Path commonBnd = duDir.resolve(COMMON_BND);
- if (!Files.exists(commonBnd)) {
+ if (!Files.exists(commonBnd))
return;
- }
+
Properties commonProps = new Properties();
try (InputStream in = Files.newInputStream(commonBnd)) {
commonProps.load(in);
String m2Version = commonProps.getProperty(SLC_ORIGIN_M2.toString());
if (m2Version == null) {
- logger.log(Level.WARNING, "Ignoring " + duDir + " as it is not an M2-based distribution unit");
+ logger.log(WARNING, "Ignoring " + duDir + " as it is not an M2-based distribution unit");
return;// ignore, this is probably an Eclipse archive
}
if (!m2Version.startsWith(":")) {
}
String m2Coordinates = fileProps.getProperty(SLC_ORIGIN_M2.toString());
M2Artifact artifact = new M2Artifact(m2Coordinates);
-
artifact.setVersion(m2Version);
// prepare manifest entries
String value = fileProps.getProperty(key.toString());
Object previousValue = mergeProps.put(key.toString(), value);
if (previousValue != null) {
- logger.log(Level.WARNING,
+ logger.log(WARNING,
commonBnd + ": " + key + " was " + previousValue + ", overridden with " + value);
}
}
// download
URL url = M2ConventionsUtils.mavenRepoUrl(repoStr, artifact);
- Path downloaded = downloadMaven(url, originBase, artifact);
+ Path downloaded = downloadMaven(url, artifact);
Path targetBundleDir = processBndJar(downloaded, targetCategoryBase, mergeProps, artifact);
-// logger.log(Level.DEBUG, () -> "Processed " + downloaded);
-
- // sources
downloadAndProcessM2Sources(repoStr, artifact, targetBundleDir);
-
createJar(targetBundleDir);
}
} catch (IOException e) {
throw new RuntimeException("Cannot process " + duDir, e);
}
-
}
/** Merge multiple Maven artifacts. */
mergeProps.load(in);
}
- // Version
String m2Version = mergeProps.getProperty(SLC_ORIGIN_M2.toString());
if (m2Version == null) {
- logger.log(Level.WARNING, "Ignoring " + duDir + " as it is not an M2-based distribution unit");
+ logger.log(WARNING, "Ignoring " + duDir + " as it is not an M2-based distribution unit");
return;// ignore, this is probably an Eclipse archive
}
if (!m2Version.startsWith(":")) {
if (bundleSymbolicName == null)
throw new IllegalArgumentException("Bundle-SymbolicName must be set in " + mergeBnd);
CategoryNameVersion nameVersion = new M2Artifact(category + ":" + bundleSymbolicName + ":" + m2Version);
+
Path targetBundleDir = targetCategoryBase.resolve(bundleSymbolicName + "." + nameVersion.getBranch());
String[] artifacts = artifactsStr.split(",");
if (artifact.getVersion() == null)
artifact.setVersion(m2Version);
URL url = M2ConventionsUtils.mavenRepoUrl(repoStr, artifact);
- Path downloaded = downloadMaven(url, originBase, artifact);
+ Path downloaded = downloadMaven(url, artifact);
JarEntry entry;
try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(downloaded), false)) {
entries: while ((entry = jarIn.getNextJarEntry()) != null) {
try (OutputStream out = Files.newOutputStream(target, StandardOpenOption.APPEND)) {
out.write("\n".getBytes());
jarIn.transferTo(out);
- logger.log(Level.WARNING, artifact.getArtifactId() + " - Appended " + entry.getName());
+ logger.log(DEBUG, artifact.getArtifactId() + " - Appended " + entry.getName());
}
} else if (entry.getName().startsWith("org/apache/batik/")) {
- logger.log(Level.WARNING, "Skip " + entry.getName());
+ logger.log(TRACE, "Skip " + entry.getName());
continue entries;
} else {
throw new IllegalStateException("File " + target + " from " + artifact + " already exists");
}
}
- logger.log(Level.TRACE, () -> "Copied " + target);
+ logger.log(TRACE, () -> "Copied " + target);
}
}
OutputStream out = Files.newOutputStream(target, StandardOpenOption.APPEND);) {
out.write("\n".getBytes());
in.transferTo(out);
- logger.log(Level.WARNING, "Appended " + p);
+ logger.log(DEBUG, "Appended " + p);
}
}
}
&& value.toString().equals("osgi.ee;filter:=\"(&(osgi.ee=JavaSE)(version=1.1))\""))
continue keys;// hack for very old classes
entries.put(key.toString(), value.toString());
- // logger.log(DEBUG, () -> key + "=" + value);
-
}
} catch (Exception e) {
throw new RuntimeException("Cannot process " + mergeBnd, e);
}
}
Path targetBundleDir = processBundleJar(downloaded, targetCategoryBase, additionalEntries);
- logger.log(Level.DEBUG, () -> "Processed " + downloaded);
+ logger.log(DEBUG, () -> "Processed " + downloaded);
return targetBundleDir;
} catch (Exception e) {
throw new RuntimeException("Cannot BND process " + downloaded, e);
/** Download and integrates sources for a single Maven artifact. */
protected void downloadAndProcessM2Sources(String repoStr, M2Artifact artifact, Path targetBundleDir)
throws IOException {
-// if (sourceBundles)
-// return;
try {
M2Artifact sourcesArtifact = new M2Artifact(artifact.toM2Coordinates(), "sources");
URL sourcesUrl = M2ConventionsUtils.mavenRepoUrl(repoStr, sourcesArtifact);
- Path sourcesDownloaded = downloadMaven(sourcesUrl, originBase, artifact, true);
+ Path sourcesDownloaded = downloadMaven(sourcesUrl, artifact, true);
processM2SourceJar(sourcesDownloaded, targetBundleDir);
- logger.log(Level.TRACE, () -> "Processed source " + sourcesDownloaded);
+ logger.log(TRACE, () -> "Processed source " + sourcesDownloaded);
} catch (Exception e) {
- logger.log(Level.ERROR, () -> "Cannot download source for " + artifact);
+ logger.log(ERROR, () -> "Cannot download source for " + artifact);
}
}
? targetBundleDir.getParent().resolve(targetBundleDir.toString() + ".src")
: targetBundleDir.resolve("OSGI-OPT/src");
- // TODO make it less dangerous?
- if (Files.exists(targetSourceDir)) {
-// deleteDirectory(targetSourceDir);
- } else {
- Files.createDirectories(targetSourceDir);
- }
-
- // copy entries
+ Files.createDirectories(targetSourceDir);
JarEntry entry;
entries: while ((entry = jarIn.getNextJarEntry()) != null) {
if (entry.isDirectory())
Files.createDirectories(target.getParent());
if (!Files.exists(target)) {
Files.copy(jarIn, target);
- logger.log(Level.TRACE, () -> "Copied source " + target);
+ logger.log(TRACE, () -> "Copied source " + target);
} else {
- logger.log(Level.WARNING, () -> target + " already exists, skipping...");
+ logger.log(TRACE, () -> target + " already exists, skipping...");
}
}
}
}
/** Download a Maven artifact. */
- protected Path downloadMaven(URL url, Path dir, M2Artifact artifact) throws IOException {
- return downloadMaven(url, dir, artifact, false);
+ protected Path downloadMaven(URL url, M2Artifact artifact) throws IOException {
+ return downloadMaven(url, artifact, false);
}
/** Download a Maven artifact. */
- protected Path downloadMaven(URL url, Path dir, M2Artifact artifact, boolean sources) throws IOException {
- return download(url, dir, artifact.getGroupId() + '/' + artifact.getArtifactId() + "-" + artifact.getVersion()
- + (sources ? "-sources" : "") + ".jar");
+ protected Path downloadMaven(URL url, M2Artifact artifact, boolean sources) throws IOException {
+ return download(url, mavenBase, artifact.getGroupId().replace(".", "/") //
+ + '/' + artifact.getArtifactId() + '/' + artifact.getVersion() //
+ + '/' + artifact.getArtifactId() + "-" + artifact.getVersion() + (sources ? "-sources" : "") + ".jar");
}
/*
* ECLIPSE ORIGIN
*/
-
/** Process an archive in Eclipse format. */
public void processEclipseArchive(Path duDir) {
try {
Path targetCategoryBase = a2Base.resolve(categoryRelativePath);
Files.createDirectories(targetCategoryBase);
// first delete all directories from previous builds
- for (Path dir : Files.newDirectoryStream(targetCategoryBase, (p) -> Files.isDirectory(p))) {
+ for (Path dir : Files.newDirectoryStream(targetCategoryBase, (p) -> Files.isDirectory(p)))
deleteDirectory(dir);
- }
Files.createDirectories(originBase);
if (includeMatcher.matches(file)) {
for (PathMatcher excludeMatcher : excludeMatchers) {
if (excludeMatcher.matches(file)) {
- logger.log(Level.TRACE, "Skipping excluded " + file);
+ logger.log(TRACE, "Skipping excluded " + file);
return FileVisitResult.CONTINUE;
}
}
if (file.getFileName().toString().contains(".source_")) {
-// if (!sourceBundles) {
processEclipseSourceJar(file, targetCategoryBase);
- logger.log(Level.DEBUG, () -> "Processed source " + file);
-// }
-
+ logger.log(DEBUG, () -> "Processed source " + file);
} else {
Map<String, String> map = new HashMap<>();
for (Object key : commonProps.keySet())
map.put(key.toString(), commonProps.getProperty(key.toString()));
processBundleJar(file, targetCategoryBase, map);
- logger.log(Level.DEBUG, () -> "Processed " + file);
+ logger.log(DEBUG, () -> "Processed " + file);
}
break includeMatchers;
}
? targetBundleDir.getParent().resolve(targetBundleDir.toString() + ".src")
: targetBundleDir.resolve("OSGI-OPT/src");
- // TODO make it less dangerous?
- if (Files.exists(targetSourceDir)) {
-// deleteDirectory(targetSourceDir);
- } else {
- Files.createDirectories(targetSourceDir);
- }
-
- // copy entries
+ Files.createDirectories(targetSourceDir);
JarEntry entry;
entries: while ((entry = jarIn.getNextJarEntry()) != null) {
if (entry.isDirectory())
Path target = targetSourceDir.resolve(entry.getName());
Files.createDirectories(target.getParent());
Files.copy(jarIn, target);
- logger.log(Level.TRACE, () -> "Copied source " + target);
+ logger.log(TRACE, () -> "Copied source " + target);
}
-
- // copy MANIFEST
}
} catch (IOException e) {
throw new IllegalStateException("Cannot process " + file, e);
}
-
}
/*
String rawSourceSymbolicName = manifest.getMainAttributes()
.getValue(ManifestConstants.BUNDLE_SYMBOLICNAME.toString());
if (rawSourceSymbolicName != null) {
-
// make sure there is no directive
String[] arr = rawSourceSymbolicName.split(";");
for (int i = 1; i < arr.length; i++) {
logger.log(DEBUG, file.getFileName() + " is a singleton");
}
}
-
// remove problematic entries in MANIFEST
manifest.getEntries().clear();
} else {
nameVersion = nameVersionFromManifest(manifest);
if (ourVersion != null && !nameVersion.getVersion().equals(ourVersion)) {
- logger.log(Level.WARNING,
+ logger.log(WARNING,
"Original version is " + nameVersion.getVersion() + " while new version is " + ourVersion);
entries.put(BUNDLE_VERSION.toString(), ourVersion);
}
if (isNative && (entry.getName().endsWith(".so") || entry.getName().endsWith(".dll")
|| entry.getName().endsWith(".jnilib"))) {
Path categoryDir = targetBundleDir.getParent();
-// String[] segments = categoryDir.getFileName().toString().split("\\.");
-// String arch = segments[segments.length - 1];
-// String os = segments[segments.length - 2];
boolean copyDll = false;
Path targetDll = categoryDir.resolve(targetBundleDir.relativize(target));
if (nameVersion.getName().equals("com.sun.jna")) {
}
Files.delete(target);
}
- logger.log(Level.TRACE, () -> "Copied " + target);
+ logger.log(TRACE, () -> "Copied " + target);
}
// copy MANIFEST
if (ManifestConstants.IMPORT_PACKAGE.toString().equals(key)
|| ManifestConstants.EXPORT_PACKAGE.toString().equals(key)
|| ManifestConstants.BUNDLE_LICENSE.toString().equals(key))
- logger.log(Level.TRACE, file.getFileName() + ": " + key + " was modified");
+ logger.log(TRACE, file.getFileName() + ": " + key + " was modified");
else
- logger.log(Level.WARNING, file.getFileName() + ": " + key + " was " + previousValue
+ logger.log(WARNING, file.getFileName() + ": " + key + " was " + previousValue
+ ", overridden with " + value);
}
/*
* UTILITIES
*/
-
/** Recursively deletes a directory. */
private static void deleteDirectory(Path path) throws IOException {
if (!Files.exists(path))
if (e != null)
throw e;
Files.delete(directory);
- return FileVisitResult.CONTINUE;
+ return CONTINUE;
}
@Override
public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
Files.delete(file);
- return FileVisitResult.CONTINUE;
+ return CONTINUE;
}
});
}
try {
return downloadArchive(url, dir);
} catch (FileNotFoundException e) {
- logger.log(Level.WARNING, "Cannot download " + url + ", trying another mirror");
+ logger.log(WARNING, "Cannot download " + url + ", trying another mirror");
}
}
throw new FileNotFoundException("Cannot find " + uri);
dest = dir.resolve(name);
if (Files.exists(dest)) {
- logger.log(Level.TRACE, () -> "File " + dest + " already exists for " + url + ", not downloading again");
+ logger.log(TRACE, () -> "File " + dest + " already exists for " + url + ", not downloading again");
return dest;
} else {
Files.createDirectories(dest.getParent());
try (InputStream in = url.openStream()) {
Files.copy(in, dest);
- logger.log(Level.DEBUG, () -> "Downloaded " + dest + " from " + url);
+ logger.log(DEBUG, () -> "Downloaded " + dest + " from " + url);
}
return dest;
}
deleteDirectory(bundleDir);
if (sourceBundles) {
- Path sourceDir = bundleDir.getParent().resolve(bundleDir.toString() + ".src");
+ Path bundleCategoryDir = bundleDir.getParent();
+ Path sourceDir = bundleCategoryDir.resolve(bundleDir.toString() + ".src");
if (!Files.exists(sourceDir)) {
logger.log(WARNING, sourceDir + " does not exist, skipping...");
return jarPath;
+
}
- Path srcJarP = sourceDir.getParent().resolve(sourceDir.getFileName() + ".jar");
+
+ Path relPath = a2Base.relativize(bundleCategoryDir);
+ Path srcCategoryDir = a2SrcBase.resolve(relPath);
+ Path srcJarP = srcCategoryDir.resolve(sourceDir.getFileName() + ".jar");
+ Files.createDirectories(srcJarP.getParent());
+
String bundleSymbolicName = manifest.getMainAttributes().getValue("Bundle-SymbolicName").toString();
// in case there are additional directives
bundleSymbolicName = bundleSymbolicName.split(";")[0];
return jarPath;
}
+ /** MANIFEST headers. */
enum ManifestConstants {
// OSGi
BUNDLE_SYMBOLICNAME("Bundle-SymbolicName"), //
// JAVA
AUTOMATIC_MODULE_NAME("Automatic-Module-Name"), //
// SLC
- SLC_CATEGORY("SLC-Category"), //
+// 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"),//
+ SLC_ORIGIN_URI("SLC-Origin-URI"), //
;
final String value;
public String toString() {
return value;
}
-
}
-
}
/** Simple representation of an M2 artifact. */
}
}
+/** Combination of a category, a name and a version. */
class CategoryNameVersion extends NameVersion {
private String category;
}
+/** Combination of a name and a version. */
class NameVersion implements Comparable<NameVersion> {
private String name;
private String version;
projects / cc0 / argeo-build.git / blobdiff