[JENKINS-51214] - Allow invoking Custom WAR Packager Maven Plugin in the CLI Mode #26
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| package io.jenkins.tools.warpackager.mavenplugin; | ||
|
|
||
| import io.jenkins.tools.warpackager.lib.config.Config; | ||
| import io.jenkins.tools.warpackager.lib.impl.Builder; | ||
| import org.apache.maven.plugin.AbstractMojo; | ||
| import org.apache.maven.plugin.MojoExecutionException; | ||
| import org.apache.maven.plugin.MojoFailureException; | ||
| import org.apache.maven.plugins.annotations.Mojo; | ||
| import org.apache.maven.plugins.annotations.Parameter; | ||
|
|
||
| import javax.annotation.CheckForNull; | ||
| import javax.annotation.Nonnull; | ||
| import java.io.File; | ||
| import java.io.IOException; | ||
|
|
||
| import static org.apache.maven.plugins.annotations.LifecyclePhase.PACKAGE; | ||
| import static org.apache.maven.plugins.annotations.ResolutionScope.RUNTIME; | ||
|
|
||
| //TODO: There is a serious correlation with Maven HPI's Plugin "custom-war" step. This step is actually used inside via Maven-in-Maven. May be reworked later. | ||
|
|
||
| /** | ||
| * Mojo wrapper for {@link Builder}. | ||
| * @author Oleg Nenashev | ||
| * @since TODO | ||
| */ | ||
| @Mojo(name="build", defaultPhase = PACKAGE, requiresProject = false) | ||
| public class BuildMojo extends AbstractMojo { | ||
|
|
||
| @Parameter(property = "configFile", required = true) | ||
| public @CheckForNull String configFilePath; | ||
|
|
||
| @Parameter(property = "version") | ||
| public @CheckForNull String warVersion; | ||
|
|
||
| @Parameter(property = "tmpDir") | ||
| public @CheckForNull String tmpDir; | ||
|
|
||
| @Parameter(property = "mvnSettingsFile") | ||
| public @CheckForNull String mvnSettingsFile; | ||
|
|
||
| @Parameter(property = "bomFile") | ||
| public @CheckForNull String bom; | ||
|
|
||
| @Parameter(property = "environment") | ||
| public @CheckForNull String environment; | ||
|
|
||
| @Parameter(property = "batchMode") | ||
| public boolean batchMode; | ||
|
|
||
| @Parameter(property = "installArtifacts") | ||
| public boolean installArtifacts; | ||
|
|
||
| @Override | ||
| public void execute() throws MojoExecutionException, MojoFailureException { | ||
| Config cfg = getConfigOrFail(); | ||
| build(cfg, new File("tmp")); | ||
| } | ||
|
|
||
| protected void build(@Nonnull Config cfg, @Nonnull File buildDir) throws MojoExecutionException { | ||
| cfg.buildSettings.setVersion(warVersion); | ||
| cfg.buildSettings.setInstallArtifacts(installArtifacts); | ||
| if (mvnSettingsFile != null) { | ||
| cfg.buildSettings.setMvnSettingsFile(new File(mvnSettingsFile)); | ||
| } | ||
| if (tmpDir != null) { | ||
| cfg.buildSettings.setTmpDir(new File(tmpDir)); | ||
| } else { // Use a Maven temporary dir | ||
| //TODO: use step ID | ||
| cfg.buildSettings.setTmpDir(buildDir); | ||
| } | ||
|
|
||
| if (batchMode) { | ||
| cfg.buildSettings.addMavenOption("--batch-mode"); | ||
| cfg.buildSettings.addMavenOption("-Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn"); | ||
| } | ||
|
There was a problem hiding this comment. This is weird. Delete the option IMO. There was a problem hiding this comment. why is it weird? There was a problem hiding this comment. I think the calling script should be responsible for including |
||
|
|
||
| // BOM | ||
| cfg.buildSettings.setEnvironmentName(environment); | ||
| if (bom != null) { | ||
| cfg.buildSettings.setBOM(new File(bom)); | ||
| } | ||
|
|
||
| final Builder bldr = new Builder(cfg); | ||
| try { | ||
| bldr.build(); | ||
| } catch (Exception ex) { | ||
| throw new MojoExecutionException("Failed to build the custom WAR", ex); | ||
| } | ||
| } | ||
|
|
||
| protected Config getConfigOrFail() throws MojoExecutionException { | ||
| if (configFilePath == null) { | ||
| throw new MojoExecutionException("Config file is not defined"); | ||
| } | ||
|
|
||
| final Config cfg; | ||
| try { | ||
| cfg = Config.loadConfig(new File(configFilePath)); | ||
| } catch (IOException ex) { | ||
| throw new MojoExecutionException("Cannot load configuration from " + configFilePath, ex); | ||
| } | ||
| return cfg; | ||
| } | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
BTW if you add Javadoc for these things, and configure your POM to generate
HelpMojo, you will make it easier for people to invoke this.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For sure. Created https://issues.jenkins-ci.org/browse/JENKINS-51259