Skip to content

Convert Groovy views to Jelly | use Jenkins.get() #33

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

Merged
jglick merged 5 commits into from
Aug 27, 2019
Merged

Convert Groovy views to Jelly | use Jenkins.get() #33

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a3bb68f
Rebase of the PR
Wadeck Oct 30, 2018
31f0491
Remove all the formatting
Wadeck Oct 31, 2018
59ae71b
Remove all the formatting
Wadeck Oct 31, 2018
8f30525
Revert the rest of the formatting
Wadeck Oct 31, 2018
182b2b3
Merge branch 'master' into REVAMP_UPGRADE_POM
jglick Aug 27, 2019
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
3 changes: 3 additions & 0 deletions Jenkinsfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
#!/usr/bin/env groovy

/* `buildPlugin` step provided by: https://github.com/jenkins-infra/pipeline-library */
buildPlugin()
18 changes: 9 additions & 9 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,15 @@
<name>Ant Plugin</name>
<description>Adds Apache Ant support to Jenkins</description>
<url>https://wiki.jenkins-ci.org/display/JENKINS/Ant+Plugin</url>


<licenses>
<license>
<name>The MIT license</name>
<url>https://opensource.org/licenses/MIT</url>
<distribution>repo</distribution>
</license>
</licenses>

<developers>
<developer>
<id>armfergom</id>
Expand Down Expand Up @@ -97,14 +105,6 @@
</repository>
</repositories>

<licenses>
<license>
<name>The MIT license</name>
<url>https://opensource.org/licenses/MIT</url>
<distribution>repo</distribution>
</license>
</licenses>

<pluginRepositories>
<pluginRepository>
<id>repo.jenkins-ci.org</id>
Expand Down
110 changes: 63 additions & 47 deletions src/main/java/hudson/tasks/Ant.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ public class Ant extends Builder {
private final String properties;

@DataBoundConstructor
public Ant(String targets,String antName, String antOpts, String buildFile, String properties) {
public Ant(String targets, String antName, String antOpts, String buildFile, String properties) {
Copy link
Member

@jglick jglick Oct 30, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately https://github.com/jenkinsci/ant-plugin/pull/33/files?w still does not ignore this, making this diff too long to be read.

this.targets = targets;
this.antName = antName;
this.antOpts = Util.fixEmptyAndTrim(antOpts);
Expand All @@ -129,9 +129,10 @@ public String getTargets() {
* or null to invoke the default one.
*/
public AntInstallation getAnt() {
for( AntInstallation i : getDescriptor().getInstallations() ) {
if(antName!=null && antName.equals(i.getName()))
for (AntInstallation i : getDescriptor().getInstallations()) {
if (antName != null && antName.equals(i.getName())) {
return i;
}
}
return null;
}
Expand All @@ -144,7 +145,7 @@ public String getAntOpts() {
}

@Override
public boolean perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener) throws InterruptedException, IOException {
public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListener listener) throws InterruptedException, IOException {
ArgumentListBuilder args = new ArgumentListBuilder();

EnvVars env = build.getEnvironment(listener);
Expand All @@ -160,7 +161,7 @@ public boolean perform(AbstractBuild<?,?> build, Launcher launcher, BuildListene
}

AntInstallation ai = getAnt();
if(ai==null) {
if (ai == null) {
args.add(launcher.isUnix() ? "ant" : "ant.bat");
} else {
Node node = Computer.currentComputer().getNode();
Expand All @@ -170,7 +171,7 @@ public boolean perform(AbstractBuild<?,?> build, Launcher launcher, BuildListene
ai = ai.forNode(node, listener);
ai = ai.forEnvironment(env);
String exe = ai.getExecutable(launcher);
if (exe==null) {
if (exe == null) {
throw new AbortException(Messages.Ant_ExecutableNotFound(ai.getName()));
}
args.add(exe);
Expand All @@ -182,7 +183,7 @@ public boolean perform(AbstractBuild<?,?> build, Launcher launcher, BuildListene

FilePath buildFilePath = buildFilePath(build.getModuleRoot(), buildFile, targets);

if(!buildFilePath.exists()) {
if (!buildFilePath.exists()) {
// because of the poor choice of getModuleRoot() with CVS/Subversion, people often get confused
// with where the build file path is relative to. Now it's too late to change this behavior
// due to compatibility issue, but at least we can make this less painful by looking for errors
Expand All @@ -192,60 +193,62 @@ public boolean perform(AbstractBuild<?,?> build, Launcher launcher, BuildListene
FilePath workspaceFilePath = build.getWorkspace();
if (workspaceFilePath != null) {
FilePath buildFilePath2 = buildFilePath(workspaceFilePath, buildFile, targets);
if(buildFilePath2.exists()) {
if (buildFilePath2.exists()) {
// This must be what the user meant. Let it continue.
buildFilePath = buildFilePath2;
} else {
// neither file exists. So this now really does look like an error.
throw new AbortException("Unable to find build script at "+ buildFilePath);
throw new AbortException("Unable to find build script at " + buildFilePath);
}
} else {
throw new AbortException("Workspace is not available. Agent may be disconnected.");
}
}

if(buildFile!=null) {
if (buildFile != null) {
args.add("-file", buildFilePath.getName());
}

Set<String> sensitiveVars = build.getSensitiveBuildVariables();

args.addKeyValuePairs("-D",build.getBuildVariables(),sensitiveVars);
args.addKeyValuePairs("-D", build.getBuildVariables(), sensitiveVars);

args.addKeyValuePairsFromPropertyString("-D",properties,vr,sensitiveVars);
args.addKeyValuePairsFromPropertyString("-D", properties, vr, sensitiveVars);

args.addTokenized(targets.replaceAll("[\t\r\n]+"," "));
args.addTokenized(targets.replaceAll("[\t\r\n]+", " "));

if(ai!=null)
if (ai != null) {
ai.buildEnvVars(env);
if(antOpts!=null)
env.put("ANT_OPTS",env.expand(antOpts));

if(!launcher.isUnix()) {
}
if (antOpts != null) {
env.put("ANT_OPTS", env.expand(antOpts));
}
if (!launcher.isUnix()) {
args = toWindowsCommand(args.toWindowsCommand());
}

long startTime = System.currentTimeMillis();
try {
AntConsoleAnnotator aca = new AntConsoleAnnotator(listener.getLogger(),build.getCharset());
AntConsoleAnnotator aca = new AntConsoleAnnotator(listener.getLogger(), build.getCharset());
int r;
try {
r = launcher.launch().cmds(args).envs(env).stdout(aca).pwd(buildFilePath.getParent()).join();
} finally {
aca.forceEol();
}
return r==0;
return r == 0;
} catch (IOException e) {
Util.displayIOException(e,listener);
Util.displayIOException(e, listener);

String errorMessage = Messages.Ant_ExecFailed();
if(ai==null && (System.currentTimeMillis()-startTime)<1000) {
if(getDescriptor().getInstallations()==null)
if (ai == null && (System.currentTimeMillis() - startTime) < 1000) {
if (getDescriptor().getInstallations() == null) {
// looks like the user didn't configure any Ant installation
errorMessage += Messages.Ant_GlobalConfigNeeded();
else
} else {
// There are Ant installations configured but the project didn't pick it
errorMessage += Messages.Ant_ProjectConfigNeeded();
}
}
throw new AbortException(errorMessage);
}
Expand Down Expand Up @@ -290,21 +293,24 @@ protected static ArgumentListBuilder toWindowsCommand(ArgumentListBuilder args)
}

private static FilePath buildFilePath(FilePath base, String buildFile, String targets) {
if(buildFile!=null) return base.child(buildFile);
if (buildFile != null) {
return base.child(buildFile);
}
// some users specify the -f option in the targets field, so take that into account as well.
// see
String[] tokens = Util.tokenize(targets);
for (int i = 0; i<tokens.length-1; i++) {
for (int i = 0; i < tokens.length - 1; i++) {
String a = tokens[i];
if(a.equals("-f") || a.equals("-file") || a.equals("-buildfile"))
return base.child(tokens[i+1]);
if (a.equals("-f") || a.equals("-file") || a.equals("-buildfile")) {
return base.child(tokens[i + 1]);
}
}
return base.child("build.xml");
}

@Override
public DescriptorImpl getDescriptor() {
return (DescriptorImpl)super.getDescriptor();
return (DescriptorImpl) super.getDescriptor();
}

@Extension @Symbol("ant")
Expand Down Expand Up @@ -363,15 +369,16 @@ public AntInstallation(String name, String home, List<? extends ToolProperty<?>>
* @deprecated as of 1.308
* Use {@link #AntInstallation(String, String, List)}
*/
@Deprecated
public AntInstallation(String name, String home) {
this(name,home,Collections.<ToolProperty<?>>emptyList());
this(name, home, Collections.emptyList());
}

private static String launderHome(String home) {
if(home.endsWith("/") || home.endsWith("\\")) {
if (home.endsWith("/") || home.endsWith("\\")) {
// see https://issues.apache.org/bugzilla/show_bug.cgi?id=26947
// Ant doesn't like the trailing slash, especially on Windows
return home.substring(0,home.length()-1);
return home.substring(0, home.length() - 1);
} else {
return home;
}
Expand All @@ -388,7 +395,7 @@ public String getAntHome() {

@Override
public void buildEnvVars(EnvVars env) {
env.put("ANT_HOME",getHome());
env.put("ANT_HOME", getHome());
env.put("PATH+ANT", getHome() + "/bin");
}

Expand Down Expand Up @@ -423,7 +430,7 @@ private static class GetExecutable extends MasterToSlaveCallable<String, IOExcep
* Returns true if the executable exists.
*/
public boolean getExists() throws IOException, InterruptedException {
return getExecutable(new Launcher.LocalLauncher(TaskListener.NULL))!=null;
return getExecutable(new Launcher.LocalLauncher(TaskListener.NULL)) != null;
}

private static final long serialVersionUID = 1L;
Expand All @@ -436,8 +443,9 @@ public AntInstallation forNode(Node node, TaskListener log) throws IOException,
return new AntInstallation(getName(), translateFor(node, log), getProperties().toList());
}

@Extension @Symbol("ant")
@SuppressFBWarnings(value="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE", justification="https://github.com/jenkinsci/jenkins/pull/2094")
@Extension
@Symbol("ant")
@SuppressFBWarnings(value = "NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE", justification = "https://github.com/jenkinsci/jenkins/pull/2094")
public static class DescriptorImpl extends ToolDescriptor<AntInstallation> {

@Override
Expand All @@ -448,12 +456,12 @@ public String getDisplayName() {
// for compatibility reasons, the persistence is done by Ant.DescriptorImpl
@Override
public AntInstallation[] getInstallations() {
return Jenkins.getInstance().getDescriptorByType(Ant.DescriptorImpl.class).getInstallations();
return Jenkins.get().getDescriptorByType(Ant.DescriptorImpl.class).getInstallations();
}

@Override
public void setInstallations(AntInstallation... installations) {
Jenkins.getInstance().getDescriptorByType(Ant.DescriptorImpl.class).setInstallations(installations);
Jenkins.get().getDescriptorByType(Ant.DescriptorImpl.class).setInstallations(installations);
}

@Override
Expand All @@ -466,18 +474,22 @@ public List<? extends ToolInstaller> getDefaultInstallers() {
*/
public FormValidation doCheckHome(@QueryParameter File value) {
// this can be used to check the existence of a file on the server, so needs to be protected
if(!Jenkins.getInstance().hasPermission(Jenkins.ADMINISTER))
if (!Jenkins.get().hasPermission(Jenkins.ADMINISTER)) {
return FormValidation.ok();
}

if(value.getPath().equals(""))
if (value.getPath().equals("")) {
return FormValidation.ok();
}

if(!value.isDirectory())
if (!value.isDirectory()) {
return FormValidation.error(Messages.Ant_NotADirectory(value));
}

File antJar = new File(value,"lib/ant.jar");
if(!antJar.exists())
File antJar = new File(value, "lib/ant.jar");
if (!antJar.exists()) {
return FormValidation.error(Messages.Ant_NotAntDirectory(value));
}

return FormValidation.ok();
}
Expand All @@ -488,9 +500,13 @@ public FormValidation doCheckName(@QueryParameter String value) {
}

public static class ConverterImpl extends ToolConverter {
public ConverterImpl(XStream2 xstream) { super(xstream); }
@Override protected String oldHomeField(ToolInstallation obj) {
return ((AntInstallation)obj).antHome;
public ConverterImpl(XStream2 xstream) {
super(xstream);
}

@Override
protected String oldHomeField(ToolInstallation obj) {
return ((AntInstallation) obj).antHome;
}
}
}
Expand All @@ -512,7 +528,7 @@ public String getDisplayName() {

@Override
public boolean isApplicable(Class<? extends ToolInstallation> toolType) {
return toolType==AntInstallation.class;
return toolType == AntInstallation.class;
}
}
}
Expand Down
11 changes: 6 additions & 5 deletions src/main/java/hudson/tasks/AntWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,16 @@
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;

import javax.annotation.Nonnull;
import java.io.IOException;
import java.util.Map;

public class AntWrapper extends SimpleBuildWrapper {

private String installation;
Expand Down Expand Up @@ -79,10 +80,10 @@ public void setJdk(String 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);
toolEnv(context, installation, Jenkins.get().getDescriptorByType(Ant.DescriptorImpl.class).getInstallations(), workspace, listener, initialEnvironment);
Copy link
Member

@batmat batmat Oct 29, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

\o/

}
if (jdk != null) {
toolEnv(context, jdk, Jenkins.getActiveInstance().getDescriptorByType(JDK.DescriptorImpl.class).getInstallations(), workspace, listener, initialEnvironment);
toolEnv(context, jdk, Jenkins.get().getDescriptorByType(JDK.DescriptorImpl.class).getInstallations(), workspace, listener, initialEnvironment);
}
}

Expand Down
14 changes: 7 additions & 7 deletions src/main/resources/hudson/tasks/Ant/AntInstallation/config.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ THE SOFTWARE.
Config page
-->
<?jelly escape-by-default='true'?>
<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
<f:entry title="${%Name}" field="name">
<f:textbox />
</f:entry>
<f:entry title="ANT_HOME" field="home">
<f:textbox />
</f:entry>
<j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form">
<f:entry title="${%Name}" field="name">
<f:textbox/>
</f:entry>
<f:entry title="ANT_HOME" field="home">
<f:textbox/>
</f:entry>
</j:jelly>
Loading