Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #22 from jglick/pipeline-JENKINS-26056
[JENKINS-26056] Pipeline-compatible Ant build wrapper
- Loading branch information
Showing
10 changed files
with
374 additions
and
13 deletions.
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
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,140 @@ | ||
| /* | ||
| * The MIT License | ||
| * | ||
| * Copyright 2017 CloudBees, Inc. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in | ||
| * all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| * THE SOFTWARE. | ||
| */ | ||
|
|
||
| package hudson.tasks; | ||
|
|
||
| import hudson.AbortException; | ||
| import hudson.EnvVars; | ||
| import hudson.Extension; | ||
| import hudson.FilePath; | ||
| import hudson.Launcher; | ||
| import hudson.Util; | ||
| import hudson.console.ConsoleLogFilter; | ||
| import hudson.model.AbstractProject; | ||
| import hudson.model.Computer; | ||
| import hudson.model.EnvironmentSpecific; | ||
| import hudson.model.JDK; | ||
| import hudson.model.Node; | ||
| import hudson.model.Run; | ||
| import hudson.model.TaskListener; | ||
| import hudson.slaves.NodeSpecific; | ||
| import hudson.tasks._ant.AntConsoleAnnotator; | ||
| import hudson.tools.ToolInstallation; | ||
| import java.io.IOException; | ||
| import java.util.Map; | ||
| import javax.annotation.Nonnull; | ||
| import jenkins.model.Jenkins; | ||
| import jenkins.tasks.SimpleBuildWrapper; | ||
| import org.jenkinsci.Symbol; | ||
| import org.kohsuke.stapler.DataBoundConstructor; | ||
| import org.kohsuke.stapler.DataBoundSetter; | ||
|
|
||
| public class AntWrapper extends SimpleBuildWrapper { | ||
|
|
||
| private String installation; | ||
| private String jdk; | ||
|
|
||
| @DataBoundConstructor | ||
| public AntWrapper() {} | ||
|
|
||
| public String getInstallation() { | ||
| return installation; | ||
| } | ||
|
|
||
| @DataBoundSetter | ||
| public void setInstallation(String installation) { | ||
| this.installation = Util.fixEmpty(installation); | ||
| } | ||
|
|
||
| public String getJdk() { | ||
| return jdk; | ||
| } | ||
|
|
||
| @DataBoundSetter | ||
| public void setJdk(String jdk) { | ||
| this.jdk = Util.fixEmpty(jdk); | ||
| } | ||
|
|
||
| @Override | ||
| public void setUp(Context context, Run<?, ?> build, FilePath workspace, Launcher launcher, TaskListener listener, EnvVars initialEnvironment) throws IOException, InterruptedException { | ||
| if (installation != null) { | ||
| toolEnv(context, installation, Jenkins.getActiveInstance().getDescriptorByType(Ant.DescriptorImpl.class).getInstallations(), workspace, listener, initialEnvironment); | ||
| } | ||
| if (jdk != null) { | ||
| toolEnv(context, jdk, Jenkins.getActiveInstance().getDescriptorByType(JDK.DescriptorImpl.class).getInstallations(), workspace, listener, initialEnvironment); | ||
| } | ||
| } | ||
|
|
||
| // TODO this is pretty generic and could perhaps be added to SimpleBuildWrapper? | ||
| private static void toolEnv(Context context, @Nonnull String tool, ToolInstallation[] tools, FilePath workspace, TaskListener listener, EnvVars initialEnvironment) throws IOException, InterruptedException { | ||
| ToolInstallation inst = null; | ||
| for (ToolInstallation _inst : tools) { | ||
| if (_inst.getName().equals(tool)) { | ||
| inst = _inst; | ||
| break; | ||
| } | ||
| } | ||
| if (inst == null) { | ||
| throw new AbortException("no such tool ‘" + tool + "’"); | ||
| } | ||
| if (inst instanceof NodeSpecific) { | ||
| Computer computer = workspace.toComputer(); | ||
| if (computer != null) { | ||
| Node node = computer.getNode(); | ||
| if (node != null) { | ||
| inst = (ToolInstallation) ((NodeSpecific) inst).forNode(node, listener); | ||
| } | ||
| } | ||
| } | ||
| if (inst instanceof EnvironmentSpecific) { | ||
| inst = (ToolInstallation) ((EnvironmentSpecific) inst).forEnvironment(initialEnvironment); | ||
| } | ||
| EnvVars modified = new EnvVars(); | ||
| inst.buildEnvVars(modified); | ||
| for (Map.Entry<String, String> entry : modified.entrySet()) { | ||
| context.env(entry.getKey(), entry.getValue()); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public ConsoleLogFilter createLoggerDecorator(Run<?, ?> build) { | ||
| return AntConsoleAnnotator.asConsoleLogFilter(); | ||
| } | ||
|
|
||
| @Extension @Symbol("withAnt") | ||
| public static class DescriptorImpl extends BuildWrapperDescriptor { | ||
|
|
||
| @Override | ||
| public String getDisplayName() { | ||
| return "With Ant"; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean isApplicable(AbstractProject<?, ?> item) { | ||
| return true; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } |
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
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,49 @@ | ||
| /* | ||
| * The MIT License | ||
| * | ||
| * Copyright (c) 2016, CloudBees, Inc. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in | ||
| * all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| * THE SOFTWARE. | ||
| */ | ||
| package hudson.tasks.AntWrapper; | ||
| f=namespace(lib.FormTagLib) | ||
|
|
||
| def installations = app.getDescriptorByType(hudson.tasks.Ant.DescriptorImpl).installations | ||
| if (installations.length != 0) { | ||
| f.entry(title: _('Ant Version')) { | ||
| select(class: 'setting-input', name: 'ant.installation') { | ||
| option(value: '', _('Default')) | ||
| installations.each { | ||
| f.option(selected: it.name == instance?.installation, value: it.name, it.name) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| def jdks = app.getDescriptorByType(hudson.model.JDK.DescriptorImpl).installations | ||
| if (jdks.length != 0) { | ||
| f.entry(title: _('JDK')) { | ||
| select(class: 'setting-input', name: 'ant.jdk') { | ||
| option(value: '', _('Default')) | ||
| jdks.each { | ||
| f.option(selected: it.name == instance?.jdk, value: it.name, it.name) | ||
| } | ||
| } | ||
| } | ||
| } |
3 changes: 3 additions & 0 deletions
3
src/main/resources/hudson/tasks/AntWrapper/help-installation.html
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,3 @@ | ||
| <p> | ||
| Name of an Ant installation to use so that <code>ant</code> will be in the path. | ||
| </p> |
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,3 @@ | ||
| <p> | ||
| Name of an Java installation to use when running Ant. | ||
| </p> |
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,5 @@ | ||
| <div> | ||
| Prepares an environment for Jenkins to run builds using Apache Ant. | ||
| Annotates Ant-specific output to display executed targets. | ||
| Optionally sets up an Ant and/or JDK installation. | ||
| </div> |
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
Oops, something went wrong.