Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Maven codegen Mojo #5319

Closed
wants to merge 3 commits into from
Closed

Maven codegen Mojo #5319

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8c3552
Moved bnd Configuration load to reusable Helper Class
juergen-albert Sep 5, 2022
3b4c6e3
Improved error Message for Bnd Code Generator
juergen-albert Sep 5, 2022
969f2ad
Adds generator maven plugin
juergen-albert Sep 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Moved bnd Configuration load to reusable Helper Class 
Signed-off-by: Juergen Albert <j.albert@data-in-motion.biz>
  • Loading branch information
@juergen-albert
juergen-albert committed Sep 5, 2022
commit a8c3552ca68a5221a833b11489620e065deec352
134 changes: 134 additions & 0 deletions biz.aQute.bnd.maven/src/aQute/bnd/maven/lib/configuration/Configurations.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
package aQute.bnd.maven.lib.configuration;

import java.io.File;
import java.util.List;
import java.util.Objects;
import java.util.Optional;

import org.apache.maven.model.Plugin;
import org.apache.maven.model.PluginExecution;
import org.apache.maven.model.PluginManagement;
import org.apache.maven.plugin.MojoExecution;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.util.xml.Xpp3Dom;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import aQute.bnd.build.Project;
import aQute.bnd.osgi.Processor;
import aQute.lib.io.IO;
import aQute.lib.utf8properties.UTF8Properties;

/**
* A helper to read configurations for maven plugins consistently over the
* various Mojos.
*
* @author Juergen Albert
*/
public class Configurations {

protected final static Logger logger = LoggerFactory.getLogger(Configurations.class);

public static File loadProperties(Processor processor, MavenProject project, MojoExecution mojoExecution)
throws Exception {
// Load parent project properties first
loadParentProjectProperties(processor, project, mojoExecution);

// Load current project properties
Xpp3Dom configuration = Optional.ofNullable(project.getBuildPlugins())
.flatMap(new FlatMapHelper(mojoExecution)::getConfiguration)
.orElseGet(Configurations::defaultConfiguration);
return loadProjectProperties(processor, project, project, configuration);
}

private static void loadParentProjectProperties(Processor builder, MavenProject currentProject,
MojoExecution mojoExecution) throws Exception {
MavenProject parentProject = currentProject.getParent();
if (parentProject == null) {
return;
}
loadParentProjectProperties(builder, parentProject, mojoExecution);

// Get configuration from parent project
Xpp3Dom configuration = Optional.ofNullable(parentProject.getBuildPlugins())
.flatMap(new FlatMapHelper(mojoExecution)::getConfiguration)
.orElse(null);
if (configuration != null) {
// Load parent project's properties
loadProjectProperties(builder, parentProject, parentProject, configuration);
return;
}

// Get configuration in project's pluginManagement
configuration = Optional.ofNullable(currentProject.getPluginManagement())
.map(PluginManagement::getPlugins)
.flatMap(new FlatMapHelper(mojoExecution)::getConfiguration)
.orElseGet(Configurations::defaultConfiguration);
// Load properties from parent project's bnd file or configuration in
// project's pluginManagement
loadProjectProperties(builder, parentProject, currentProject, configuration);
}

private static File loadProjectProperties(Processor processor, MavenProject bndProject, MavenProject pomProject,
Xpp3Dom configuration) throws Exception {
// check for bnd file configuration
File baseDir = bndProject.getBasedir();
if (baseDir != null) { // file system based pom
File pomFile = bndProject.getFile();
processor.updateModified(pomFile.lastModified(), "POM: " + pomFile);
// check for bnd file
Xpp3Dom bndfileElement = configuration.getChild("bndfile");
String bndFileName = (bndfileElement != null) ? bndfileElement.getValue() : Project.BNDFILE;
File bndFile = IO.getFile(baseDir, bndFileName);
if (bndFile.isFile()) {
logger.debug("loading bnd properties from file: {}", bndFile);
// we use setProperties to handle -include
processor.setProperties(bndFile.getParentFile(), processor.loadProperties(bndFile));
return bndFile;
}
// no bnd file found, so we fall through
}

// check for bnd-in-pom configuration
baseDir = pomProject.getBasedir();
File pomFile = pomProject.getFile();
if (baseDir != null) {
processor.updateModified(pomFile.lastModified(), "POM: " + pomFile);
}
Xpp3Dom bndElement = configuration.getChild("bnd");
if (bndElement != null) {
logger.debug("loading bnd properties from bnd element in pom: {}", pomProject);
UTF8Properties properties = new UTF8Properties();
properties.load(bndElement.getValue(), pomFile, processor);
// we use setProperties to handle -include
processor.setProperties(baseDir, properties.replaceHere(baseDir));
}
return pomFile;
}

private static class FlatMapHelper {

private MojoExecution mojoExecution;

public FlatMapHelper(MojoExecution mojoExecution) {
this.mojoExecution = mojoExecution;
}

public Optional<Xpp3Dom> getConfiguration(List<Plugin> plugins) {
return plugins.stream()
.filter(p -> Objects.equals(p, mojoExecution.getPlugin()))
.map(Plugin::getExecutions)
.flatMap(List::stream)
.filter(e -> Objects.equals(e.getId(), mojoExecution.getExecutionId()))
.findFirst()
.map(PluginExecution::getConfiguration)
.map(Xpp3Dom.class::cast)
.map(Xpp3Dom::new);
}
}

private static Xpp3Dom defaultConfiguration() {
return new Xpp3Dom("configuration");
}

}
2 changes: 1 addition & 1 deletion biz.aQute.bnd.maven/src/aQute/bnd/maven/lib/configuration/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@Version("1.1.0")
@Version("1.2.0")
@Export
package aQute.bnd.maven.lib.configuration;

Expand Down
146 changes: 27 additions & 119 deletions maven/bnd-maven-plugin/src/main/java/aQute/bnd/maven/plugin/AbstractBndMavenPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Properties;
import java.util.Set;
Expand All @@ -39,32 +38,12 @@
import java.util.zip.ZipException;
import java.util.zip.ZipFile;

import aQute.bnd.build.Project;
import aQute.bnd.exceptions.Exceptions;
import aQute.bnd.header.OSGiHeader;
import aQute.bnd.maven.PomPropertiesResource;
import aQute.bnd.maven.lib.configuration.BeanProperties;
import aQute.bnd.osgi.Builder;
import aQute.bnd.osgi.Constants;
import aQute.bnd.osgi.FileResource;
import aQute.bnd.osgi.Jar;
import aQute.bnd.osgi.Processor;
import aQute.bnd.osgi.Resource;
import aQute.bnd.version.MavenVersion;
import aQute.bnd.version.Version;
import aQute.lib.io.IO;
import aQute.lib.strings.Strings;
import aQute.lib.utf8properties.UTF8Properties;
import aQute.service.reporter.Report.Location;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.handler.ArtifactHandler;
import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
import org.apache.maven.artifact.resolver.filter.ScopeArtifactFilter;
import org.apache.maven.model.Developer;
import org.apache.maven.model.License;
import org.apache.maven.model.Plugin;
import org.apache.maven.model.PluginExecution;
import org.apache.maven.model.PluginManagement;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecution;
import org.apache.maven.plugin.MojoExecutionException;
Expand All @@ -76,11 +55,28 @@
import org.apache.maven.settings.Settings;
import org.apache.maven.shared.mapping.MappingUtils;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.xml.Xpp3Dom;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonatype.plexus.build.incremental.BuildContext;

import aQute.bnd.build.Project;
import aQute.bnd.exceptions.Exceptions;
import aQute.bnd.header.OSGiHeader;
import aQute.bnd.maven.PomPropertiesResource;
import aQute.bnd.maven.lib.configuration.BeanProperties;
import aQute.bnd.maven.lib.configuration.Configurations;
import aQute.bnd.osgi.Builder;
import aQute.bnd.osgi.Constants;
import aQute.bnd.osgi.FileResource;
import aQute.bnd.osgi.Jar;
import aQute.bnd.osgi.Processor;
import aQute.bnd.osgi.Resource;
import aQute.bnd.version.MavenVersion;
import aQute.bnd.version.Version;
import aQute.lib.io.IO;
import aQute.lib.strings.Strings;
import aQute.service.reporter.Report.Location;

/**
* Abstract base class for all bnd-maven-plugin mojos.
*/
Expand Down Expand Up @@ -147,7 +143,8 @@ public abstract class AbstractBndMavenPlugin extends AbstractMojo {
* instructions, if any, for the parent project.
*/
@Parameter(defaultValue = Project.BNDFILE)
// This is not used and is for doc only; see loadProjectProperties
// This is not used and is for doc only; see {@link
// Configurations#loadProperties(Processor, MavenProject, MojoExecution)}
@SuppressWarnings("unused")
String bndfile;

Expand All @@ -161,7 +158,8 @@ public abstract class AbstractBndMavenPlugin extends AbstractMojo {
* instructions, if any, for the parent project.
*/
@Parameter
// This is not used and is for doc only; see loadProjectProperties
// This is not used and is for doc only; See {@link
// Configurations#loadProperties(Processor, MavenProject, MojoExecution)}
@SuppressWarnings("unused")
String bnd;

Expand Down Expand Up @@ -236,7 +234,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
builder.setTrace(logger.isDebugEnabled());

builder.setBase(project.getBasedir());
propertiesFile = loadProperties(builder);
propertiesFile = Configurations.loadProperties(builder, project, mojoExecution);
builder.setProperty("project.output", getClassesDir().getCanonicalPath());

// If no bundle to be built, we have nothing to do
Expand Down Expand Up @@ -302,7 +300,8 @@ public void execute() throws MojoExecutionException, MojoFailureException {
builder.updateModified(cpeJar.lastModified(), cpe.getPath());
buildpath.add(cpeJar);
} else {
if (!cpe.getName().endsWith(".jar")) {
if (!artifact.getType()
.equals("jar")) {
/*
* Check if it is a valid zip file. We don't create a
* Jar object here because we want to avoid the cost of
Expand Down Expand Up @@ -677,101 +676,10 @@ private String getExtension(String type) {
private String createArtifactName(Artifact artifact) {
String classifier = artifact.getClassifier();
if ((classifier == null) || classifier.isEmpty()) {
return String.format("%s-%s.%s", artifact.getArtifactId(), artifact.getVersion(), getExtension(artifact.getType()));
return String.format("%s-%s.%s", artifact.getArtifactId(), artifact.getVersion(), artifact.getType());
}
return String.format("%s-%s-%s.%s", artifact.getArtifactId(), artifact.getVersion(), classifier,
getExtension(artifact.getType()));
}

private File loadProperties(Builder builder) throws Exception {
// Load parent project properties first
loadParentProjectProperties(builder, project);

// Load current project properties
Xpp3Dom configuration = Optional.ofNullable(project.getBuildPlugins())
.flatMap(this::getConfiguration)
.orElseGet(this::defaultConfiguration);
return loadProjectProperties(builder, project, project, configuration);
}

private void loadParentProjectProperties(Builder builder, MavenProject currentProject) throws Exception {
MavenProject parentProject = currentProject.getParent();
if (parentProject == null) {
return;
}
loadParentProjectProperties(builder, parentProject);

// Get configuration from parent project
Xpp3Dom configuration = Optional.ofNullable(parentProject.getBuildPlugins())
.flatMap(this::getConfiguration)
.orElse(null);
if (configuration != null) {
// Load parent project's properties
loadProjectProperties(builder, parentProject, parentProject, configuration);
return;
}

// Get configuration in project's pluginManagement
configuration = Optional.ofNullable(currentProject.getPluginManagement())
.map(PluginManagement::getPlugins)
.flatMap(this::getConfiguration)
.orElseGet(this::defaultConfiguration);
// Load properties from parent project's bnd file or configuration in
// project's pluginManagement
loadProjectProperties(builder, parentProject, currentProject, configuration);
}

private File loadProjectProperties(Builder builder, MavenProject bndProject, MavenProject pomProject,
Xpp3Dom configuration) throws Exception {
// check for bnd file configuration
File baseDir = bndProject.getBasedir();
if (baseDir != null) { // file system based pom
File pomFile = bndProject.getFile();
builder.updateModified(pomFile.lastModified(), "POM: " + pomFile);
// check for bnd file
Xpp3Dom bndfileElement = configuration.getChild("bndfile");
String bndFileName = (bndfileElement != null) ? bndfileElement.getValue() : Project.BNDFILE;
File bndFile = IO.getFile(baseDir, bndFileName);
if (bndFile.isFile()) {
logger.debug("loading bnd properties from file: {}", bndFile);
// we use setProperties to handle -include
builder.setProperties(bndFile.getParentFile(), builder.loadProperties(bndFile));
return bndFile;
}
// no bnd file found, so we fall through
}

// check for bnd-in-pom configuration
baseDir = pomProject.getBasedir();
File pomFile = pomProject.getFile();
if (baseDir != null) {
builder.updateModified(pomFile.lastModified(), "POM: " + pomFile);
}
Xpp3Dom bndElement = configuration.getChild("bnd");
if (bndElement != null) {
logger.debug("loading bnd properties from bnd element in pom: {}", pomProject);
UTF8Properties properties = new UTF8Properties();
properties.load(bndElement.getValue(), pomFile, builder);
// we use setProperties to handle -include
builder.setProperties(baseDir, properties.replaceHere(baseDir));
}
return pomFile;
}

private Optional<Xpp3Dom> getConfiguration(List<Plugin> plugins) {
return plugins.stream()
.filter(p -> Objects.equals(p, mojoExecution.getPlugin()))
.map(Plugin::getExecutions)
.flatMap(List::stream)
.filter(e -> Objects.equals(e.getId(), mojoExecution.getExecutionId()))
.findFirst()
.map(PluginExecution::getConfiguration)
.map(Xpp3Dom.class::cast)
.map(Xpp3Dom::new);
}

private Xpp3Dom defaultConfiguration() {
return new Xpp3Dom("configuration");
artifact.getType());
}

protected void reportErrorsAndWarnings(Builder builder) throws MojoFailureException {
Expand Down
5 changes: 3 additions & 2 deletions maven/bnd-maven-plugin/src/main/java/aQute/bnd/maven/plugin/BndMavenTestsPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,16 @@
import java.io.File;
import java.util.List;

import aQute.bnd.osgi.Builder;
import aQute.bnd.osgi.Constants;
import org.apache.maven.model.Resource;
import org.apache.maven.plugin.MojoFailureException;
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.plugins.annotations.ResolutionScope;

import aQute.bnd.osgi.Builder;
import aQute.bnd.osgi.Constants;

/**
* Processes the test target classes to generate OSGi metadata.
* <p>
Expand Down
3 changes: 2 additions & 1 deletion ...d-maven-plugin/src/main/java/aQute/bnd/maven/plugin/BndPackagingLifecycleParticipant.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
import java.util.Objects;
import java.util.Optional;

import aQute.bnd.maven.lib.executions.PluginExecutions;
import org.apache.maven.AbstractMavenLifecycleParticipant;
import org.apache.maven.MavenExecutionException;
import org.apache.maven.execution.MavenSession;
Expand All @@ -21,6 +20,8 @@
import org.codehaus.plexus.logging.LogEnabled;
import org.codehaus.plexus.logging.Logger;

import aQute.bnd.maven.lib.executions.PluginExecutions;

/**
* This lifecycle participant is meant to simplify the changes required to the
* configuration of the maven packaging plugins when the
Expand Down