From 2e98ec953bc132f85962f42940517717dd898b61 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20L=C3=A4ubrich?= Date: Sat, 9 Nov 2024 08:12:01 +0100 Subject: [PATCH] Add a tycho-wrap mojo in maven jars/artifacts can be build in numerous ways, not all include the maven-jar-plugin (e.g. maven-assembly-plugin) and not all are easily combined with maven-bundle or bnd-maven plugin. This adds a new tycho-wrap-plugin that closes this gap by allowing to specify an arbitrary input and output, some bnd instructions and an option to attach the result to the project. This has also the advantage that projects are able to publish two "flavors" of their artifact a plain one and an OSGi-fied one that could help to convince projects to provide such things as it has zero influence to their build and ways how they build artifacts. --- RELEASE_NOTES.md | 47 +++++- pom.xml | 1 + .../.settings/org.eclipse.jdt.core.prefs | 8 + tycho-wrap-plugin/pom.xml | 53 ++++++ .../java/org/eclipse/tycho/wrap/WrapMojo.java | 158 ++++++++++++++++++ 5 files changed, 258 insertions(+), 9 deletions(-) create mode 100644 tycho-wrap-plugin/.settings/org.eclipse.jdt.core.prefs create mode 100644 tycho-wrap-plugin/pom.xml create mode 100644 tycho-wrap-plugin/src/main/java/org/eclipse/tycho/wrap/WrapMojo.java diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 0e0f5a96d8..60ea2abf49 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -13,15 +13,15 @@ Specifying no version is equivalent to `0.0.0` which resolves to the latest vers All of the following variants to specify a version are now possible: ``` - - - - - - - - - + + + + + + + + + ``` @@ -34,6 +34,35 @@ that manually can be a daunting task. There is now a new `tycho-version-bump:update-manifest` mojo that helps in calculate the lower bound and update the manifest accordingly. +## new `wrap` mojo + +With maven, jars (or more general artifacts) can be build in numerous ways, not all include +the maven-jar-plugin (e.g. maven-assembly-plugin) and not all are easily +combined with maven-bundle or bnd-maven plugin. + +Tycho now provides a new `tycho-wrap:wrap mojo` that closes this gap by allowing to +specify an arbitrary input and output, some bnd instructions and (optionally) attach the result to the maven project. + +This has the advantage that projects are able to publish two "flavors" of their artifact a plain one and an OSGi-fied one that could +help to convince projects to provide such things as it has zero influence to their build and ways how they build artifacts. + +In the simplest form it can be used like this: + +```xml + + org.eclipse.tycho + tycho-wrap-plugin + 5.0.0-SNAPSHOT + + + make-bundle + + wrap + + + + +``` ## support bumping maven target locations diff --git a/pom.xml b/pom.xml index 6a50a4ed5e..8039cd08a4 100644 --- a/pom.xml +++ b/pom.xml @@ -594,6 +594,7 @@ tycho-bnd-plugin tycho-repository-plugin tycho-eclipse-plugin + tycho-wrap-plugin diff --git a/tycho-wrap-plugin/.settings/org.eclipse.jdt.core.prefs b/tycho-wrap-plugin/.settings/org.eclipse.jdt.core.prefs new file mode 100644 index 0000000000..eeac0e762f --- /dev/null +++ b/tycho-wrap-plugin/.settings/org.eclipse.jdt.core.prefs @@ -0,0 +1,8 @@ +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.targetPlatform=17 +org.eclipse.jdt.core.compiler.compliance=17 +org.eclipse.jdt.core.compiler.problem.enablePreviewFeatures=disabled +org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning +org.eclipse.jdt.core.compiler.problem.reportPreviewFeatures=ignore +org.eclipse.jdt.core.compiler.release=enabled +org.eclipse.jdt.core.compiler.source=17 diff --git a/tycho-wrap-plugin/pom.xml b/tycho-wrap-plugin/pom.xml new file mode 100644 index 0000000000..5d6bdf0830 --- /dev/null +++ b/tycho-wrap-plugin/pom.xml @@ -0,0 +1,53 @@ + + 4.0.0 + + org.eclipse.tycho + tycho + 5.0.0-SNAPSHOT + + tycho-wrap-plugin + Tycho Wrap Plugin + Support wrapping of plain jars into OSGi bundles + maven-plugin + + ${minimal-maven-version} + + + + org.apache.maven + maven-core + + + org.apache.maven + maven-plugin-api + + + org.apache.maven.plugin-tools + maven-plugin-annotations + + + biz.aQute.bnd + biz.aQute.bndlib + + + biz.aQute.bnd + biz.aQute.bnd.maven + 7.0.0 + + + + + + org.apache.maven.plugins + maven-plugin-plugin + + + tycho-wrap + + + + + \ No newline at end of file diff --git a/tycho-wrap-plugin/src/main/java/org/eclipse/tycho/wrap/WrapMojo.java b/tycho-wrap-plugin/src/main/java/org/eclipse/tycho/wrap/WrapMojo.java new file mode 100644 index 0000000000..bde6c8d374 --- /dev/null +++ b/tycho-wrap-plugin/src/main/java/org/eclipse/tycho/wrap/WrapMojo.java @@ -0,0 +1,158 @@ +/******************************************************************************* + * Copyright (c) 2024 Christoph Läubrich and others. + * This program and the accompanying materials + * are made available under the terms of the Eclipse Public License 2.0 + * which accompanies this distribution, and is available at + * https://www.eclipse.org/legal/epl-2.0/ + * + * SPDX-License-Identifier: EPL-2.0 + * + * Contributors: + * Christoph Läubrich - initial API and implementation + ******************************************************************************/ +package org.eclipse.tycho.wrap; + +import java.io.File; +import java.util.Set; +import java.util.jar.Attributes; +import java.util.jar.JarFile; +import java.util.jar.Manifest; +import java.util.regex.Pattern; + +import org.apache.maven.artifact.Artifact; +import org.apache.maven.plugin.AbstractMojo; +import org.apache.maven.plugin.MojoExecution; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Component; +import org.apache.maven.plugins.annotations.LifecyclePhase; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.apache.maven.project.MavenProject; +import org.apache.maven.project.MavenProjectHelper; +import org.apache.maven.settings.Settings; +import org.osgi.framework.Constants; + +import aQute.bnd.build.Project; +import aQute.bnd.maven.lib.configuration.BndConfiguration; +import aQute.bnd.osgi.Analyzer; +import aQute.bnd.osgi.Jar; +import aQute.bnd.print.JarPrinter; +import aQute.bnd.version.MavenVersion; +import aQute.bnd.version.Version; + +@Mojo(name = "wrap", requiresProject = true, threadSafe = true, defaultPhase = LifecyclePhase.PACKAGE) +public class WrapMojo extends AbstractMojo { + + private static final String[] HEADERS = { Constants.BUNDLE_SYMBOLICNAME, Constants.BUNDLE_VERSION }; + + @Component + private MavenProject project; + + @Parameter(defaultValue = "${settings}", readonly = true) + Settings settings; + + @Component + private MojoExecution mojoExecution; + + @Component + private MavenProjectHelper helper; + + /** + * File path to a bnd file containing bnd instructions for this project. + * Defaults to {@code bnd.bnd}. The file path can be an absolute or relative to + * the project directory. + *

+ * The bnd instructions for this project are merged with the bnd instructions, + * if any, for the parent project. + */ + // This is not used and is for doc only; see + // BndConfiguration#loadProperties and + // AbstractBndMavenPlugin for reference + @Parameter(defaultValue = Project.BNDFILE) + String bndfile; + + /** + * Bnd instructions for this project specified directly in the pom file. This is + * generally be done using a {@code } section. If the project has a + * {@link #bndfile}, then this configuration element is ignored. + *

+ * The bnd instructions for this project are merged with the bnd instructions, + * if any, for the parent project. + */ + // This is not used and is for doc only; see + // BndConfiguration#loadProperties and + // AbstractBndMavenPlugin for reference + @Parameter + String bnd; + + @Parameter(required = true, property = "input", defaultValue = "${project.build.directory}/${project.build.finalName}.${project.packaging}") + private File input; + + @Parameter(required = true, property = "output", defaultValue = "${project.build.directory}/${project.build.finalName}-bundle.${project.packaging}") + private File output; + + /** + * If enabled attach the generated file as an artifact to the project + */ + @Parameter(required = false, defaultValue = "true", property = "attach") + private boolean attach; + + /** + * The classifier to use when attach this to the project + */ + @Parameter(defaultValue = "bundle", property = "classifier") + private String classifier; + + @Override + public void execute() throws MojoExecutionException, MojoFailureException { + BndConfiguration configuration = new BndConfiguration(project, mojoExecution); + + try (Jar jar = new Jar(output.getName(), input, Pattern.compile(JarFile.MANIFEST_NAME)); + Analyzer analyzer = new Analyzer(jar)) { + configuration.loadProperties(analyzer); + if (analyzer.getProperty(Constants.BUNDLE_VERSION) == null) { + Version version = new MavenVersion(project.getVersion()).getOSGiVersion(); + analyzer.setProperty(Constants.BUNDLE_VERSION, version.toString()); + } + if (analyzer.getProperty(Constants.BUNDLE_SYMBOLICNAME) == null) { + analyzer.setProperty(Constants.BUNDLE_SYMBOLICNAME, project.getArtifactId()); + } + if (analyzer.getProperty(Constants.BUNDLE_NAME) == null) { + analyzer.setProperty(Constants.BUNDLE_NAME, project.getName()); + } + Set artifacts = project.getArtifacts(); + for (Artifact artifact : artifacts) { + File cpe = artifact.getFile(); + try { + analyzer.addClasspath(cpe); + } catch (Exception e) { + // just go on... it might be not a jar or something else not usable + } + } + Manifest manifest = analyzer.calcManifest(); + jar.setManifest(manifest); + jar.write(output); + analyzer.getWarnings().forEach(getLog()::warn); + analyzer.getErrors().forEach(getLog()::error); + Attributes mainAttributes = manifest.getMainAttributes(); + for (String header : HEADERS) { + getLog().info(header + ": " + mainAttributes.getValue(header)); + } + try (JarPrinter jarPrinter = new JarPrinter()) { + jarPrinter.doPrint(jar, JarPrinter.IMPEXP, false, false); + getLog().info(jarPrinter.toString()); + } + } catch (MojoFailureException e) { + throw e; + } catch (MojoExecutionException e) { + throw e; + } catch (Exception e) { + throw new MojoFailureException("wrapping input " + input + " failed: " + e, e); + } + if (attach) { + helper.attachArtifact(project, output, classifier); + } + } + +}