@Test
public void parameters() throws Exception {
WorkflowJob us = j.jenkins.createProject(WorkflowJob.class, "us");
FreeStyleProject ds = j.jenkins.createProject(FreeStyleProject.class, "ds");
ds.addProperty(
new ParametersDefinitionProperty(
new StringParameterDefinition("branch", "master"),
new BooleanParameterDefinition("extra", false, null)));
ds.getBuildersList().add(new Shell("echo branch=$branch extra=$extra"));
us.setDefinition(new CpsFlowDefinition("build 'ds'"));
WorkflowRun us1 = j.assertBuildStatusSuccess(us.scheduleBuild2(0));
FreeStyleBuild ds1 = ds.getBuildByNumber(1);
j.assertLogContains("branch=master extra=false", ds1);
Cause.UpstreamCause cause = ds1.getCause(Cause.UpstreamCause.class);
assertNotNull(cause);
assertEquals(us1, cause.getUpstreamRun());
us.setDefinition(
new CpsFlowDefinition(
"build job: 'ds', parameters: [[$class: 'StringParameterValue', name: 'branch', value: 'release']]",
true));
j.assertBuildStatusSuccess(us.scheduleBuild2(0));
// TODO JENKINS-13768 proposes automatic filling in of default parameter values; should that be
// used, or is BuildTriggerStepExecution responsible, or ParameterizedJobMixIn.scheduleBuild2?
j.assertLogContains("branch=release extra=", ds.getBuildByNumber(2));
us.setDefinition(
new CpsFlowDefinition(
"build job: 'ds', parameters: [[$class: 'StringParameterValue', name: 'branch', value: 'release'], [$class: 'BooleanParameterValue', name: 'extra', value: true]]",
true));
j.assertBuildStatusSuccess(us.scheduleBuild2(0));
j.assertLogContains("branch=release extra=true", ds.getBuildByNumber(3));
}
@Issue("JENKINS-25851")
@Test
public void failingBuild() throws Exception {
j.createFreeStyleProject("ds").getBuildersList().add(new FailureBuilder());
WorkflowJob us = j.jenkins.createProject(WorkflowJob.class, "us");
us.setDefinition(new CpsFlowDefinition("build 'ds'", true));
j.assertBuildStatus(Result.FAILURE, us.scheduleBuild2(0).get());
us.setDefinition(
new CpsFlowDefinition(
"echo \"ds.result=${build(job: 'ds', propagate: false).result}\"", true));
j.assertLogContains("ds.result=FAILURE", j.assertBuildStatusSuccess(us.scheduleBuild2(0)));
}
@Test
public void abortBuild() throws Exception {
FreeStyleProject p = j.createFreeStyleProject("test1");
p.getBuildersList().add(new Shell("sleep 6000"));
WorkflowJob foo = j.jenkins.createProject(WorkflowJob.class, "foo");
foo.setDefinition(
new CpsFlowDefinition(StringUtils.join(Arrays.asList("build('test1');"), "\n")));
QueueTaskFuture<WorkflowRun> q = foo.scheduleBuild2(0);
WorkflowRun b = q.getStartCondition().get();
CpsFlowExecution e = (CpsFlowExecution) b.getExecutionPromise().get();
e.waitForSuspension();
FreeStyleBuild fb = null;
while (fb == null) {
fb = p.getBuildByNumber(1);
Thread.sleep(10);
}
fb.getExecutor().interrupt();
j.assertBuildStatus(Result.ABORTED, j.waitForCompletion(fb));
j.assertBuildStatus(Result.FAILURE, q.get());
}
@Issue("JENKINS-30941")
@Test
public void cleanUpSucceeds() throws Exception {
/** Issue was just present on Linux not windows - but the test will run on both */
final String credentialsId = "zipfile";
/* do the dance to get a simple zip file into jenkins */
InputStream zipStream = this.getClass().getResourceAsStream("a.zip");
try {
assertThat(zipStream, is(not(nullValue())));
File zip = tmp.newFile("a.zip");
FileUtils.copyInputStreamToFile(zipStream, zip);
FileItem fi = new FileItemImpl(zip);
FileCredentialsImpl fc =
new FileCredentialsImpl(
CredentialsScope.GLOBAL, credentialsId, "Just a zip file", fi, fi.getName(), null);
CredentialsProvider.lookupStores(j.jenkins)
.iterator()
.next()
.addCredentials(Domain.global(), fc);
} finally {
IOUtils.closeQuietly(zipStream);
zipStream = null;
}
final String unixFile = "/dir/testfile.txt";
final String winFile =
unixFile.replace(
"/", "\\\\"); /* two \\ as we escape the code and then escape for the script */
// if this file does not have a line ending then the text is not echoed to the log.
// fixed in workflow 1.11+ (which is not released at the time of writing)
final String contents = "Test of ZipFileBinding\n";
WorkflowJob p = j.jenkins.createProject(WorkflowJob.class, "p");
p.setDefinition(
new CpsFlowDefinition(
""
+ "node {\n"
+ " withCredentials([[$class: 'ZipFileBinding', credentialsId: '"
+ credentialsId
+ "', variable: 'ziploc']]) {\n"
+ (Functions.isWindows()
? " bat 'type %ziploc%" + winFile + "'\n"
: " sh 'cat ${ziploc}" + unixFile + "'\n")
+ " def text = readFile encoding: 'UTF-8', file: \"${env.ziploc}"
+ unixFile
+ "\"\n"
+ " if (!text.equals('''"
+ contents
+ "''')) {\n"
+ " error ('incorrect details from zip file')\n"
+ " }\n"
+ " }\n"
+ "}\n",
true));
WorkflowRun run = p.scheduleBuild2(0).get();
j.assertBuildStatusSuccess(run);
j.assertLogContains(contents, run);
}
@Issue("JENKINS-26123")
@Test
public void noWait() throws Exception {
j.createFreeStyleProject("ds").setAssignedLabel(Label.get("nonexistent"));
WorkflowJob us = j.jenkins.createProject(WorkflowJob.class, "us");
us.setDefinition(new CpsFlowDefinition("build job: 'ds', wait: false"));
j.assertBuildStatusSuccess(us.scheduleBuild2(0));
}
@Test
public void rejectedStart() throws Exception {
j.createFreeStyleProject("ds");
WorkflowJob us = j.jenkins.createProject(WorkflowJob.class, "us");
// wait: true also fails as expected w/o fix, just more slowly (test timeout):
us.setDefinition(new CpsFlowDefinition("build job: 'ds', wait: false"));
j.assertLogContains(
"Failed to trigger build of ds",
j.assertBuildStatus(Result.FAILURE, us.scheduleBuild2(0).get()));
}
@SuppressWarnings("deprecation")
@Test
public void triggerWorkflow() throws Exception {
WorkflowJob us = j.jenkins.createProject(WorkflowJob.class, "us");
us.setDefinition(new CpsFlowDefinition("build 'ds'"));
WorkflowJob ds = j.jenkins.createProject(WorkflowJob.class, "ds");
ds.setDefinition(new CpsFlowDefinition("echo 'OK'"));
j.assertBuildStatusSuccess(us.scheduleBuild2(0));
assertEquals(1, ds.getBuilds().size());
}
@Issue("JENKINS-25851")
@Test
public void buildTopLevelProject() throws Exception {
j.createFreeStyleProject("ds");
WorkflowJob us = j.jenkins.createProject(WorkflowJob.class, "us");
us.setDefinition(
new CpsFlowDefinition(
"def ds = build 'ds'\n" + "echo \"ds.result=${ds.result} ds.number=${ds.number}\"",
true));
j.assertLogContains(
"ds.result=SUCCESS ds.number=1", j.assertBuildStatusSuccess(us.scheduleBuild2(0)));
}
@Issue("JENKINS-28063")
@Test
public void coalescedQueue() throws Exception {
FreeStyleProject ds = j.createFreeStyleProject("ds");
ds.setConcurrentBuild(true);
ds.getBuildersList().add(new SleepBuilder(3000));
WorkflowJob us = j.jenkins.createProject(WorkflowJob.class, "us");
us.setDefinition(new CpsFlowDefinition("echo \"triggered #${build('ds').number}\"", true));
QueueTaskFuture<WorkflowRun> us1F = us.scheduleBuild2(0);
us1F.waitForStart(); // make sure we do not coalesce the us `Queue.Item`s
QueueTaskFuture<WorkflowRun> us2F = us.scheduleBuild2(0);
WorkflowRun us1 = us1F.get();
assertEquals(1, us1.getNumber());
j.assertLogContains("triggered #1", us1);
WorkflowRun us2 = us2F.get();
assertEquals(2, us2.getNumber());
j.assertLogContains("triggered #1", us2);
FreeStyleBuild ds1 = ds.getLastBuild();
assertEquals(1, ds1.getNumber());
assertEquals(2, ds1.getCauses().size()); // 2× UpstreamCause
}
private void assertSnippet(@NonNull String snippetName, boolean useSandbox) throws Exception {
WorkflowJob job = j.jenkins.createProject(WorkflowJob.class, snippetName);
job.setDefinition(
new CpsFlowDefinition(FileLoaderDSL.getSampleSnippet(snippetName), useSandbox));
// Run job
QueueTaskFuture<WorkflowRun> runFuture = job.scheduleBuild2(0, new Action[0]);
assertThat("build was actually scheduled", runFuture, Matchers.notNullValue());
WorkflowRun run = runFuture.get();
j.assertBuildStatus(Result.SUCCESS, run);
}
@SuppressWarnings("deprecation")
@Test
public void buildFolderProject() throws Exception {
MockFolder dir1 = j.createFolder("dir1");
FreeStyleProject downstream = dir1.createProject(FreeStyleProject.class, "downstream");
downstream.getBuildersList().add(new Shell("echo 'Hello World'"));
MockFolder dir2 = j.createFolder("dir2");
WorkflowJob upstream = dir2.createProject(WorkflowJob.class, "upstream");
upstream.setDefinition(new CpsFlowDefinition("build '../dir1/downstream'"));
QueueTaskFuture<WorkflowRun> q = upstream.scheduleBuild2(0);
j.assertBuildStatusSuccess(q);
assertEquals(1, downstream.getBuilds().size());
}
@Issue("JENKINS-25851")
@Test
public void buildVariables() throws Exception {
j.createFreeStyleProject("ds")
.addProperty(
new ParametersDefinitionProperty(new StringParameterDefinition("param", "default")));
WorkflowJob us = j.jenkins.createProject(WorkflowJob.class, "us");
// TODO apparent sandbox bug using buildVariables.param: unclassified field java.util.HashMap
// param
ScriptApproval.get()
.approveSignature(
"method java.util.Map get java.lang.Object"); // TODO should be prewhitelisted
us.setDefinition(
new CpsFlowDefinition(
"echo \"build var: ${build(job: 'ds', parameters: [[$class: 'StringParameterValue', name: 'param', value: 'override']]).buildVariables.get('param')}\"",
true));
j.assertLogContains("build var: override", j.assertBuildStatusSuccess(us.scheduleBuild2(0)));
}
/**
* Interrupting the flow ought to interrupt its downstream builds too, even across nested parallel
* branches.
*/
@Test
public void interruptFlow() throws Exception {
FreeStyleProject ds1 = j.createFreeStyleProject("ds1");
ds1.getBuildersList().add(new SleepBuilder(Long.MAX_VALUE));
FreeStyleProject ds2 = j.createFreeStyleProject("ds2");
ds2.getBuildersList().add(new SleepBuilder(Long.MAX_VALUE));
FreeStyleProject ds3 = j.createFreeStyleProject("ds3");
ds3.getBuildersList().add(new SleepBuilder(Long.MAX_VALUE));
WorkflowJob us = j.jenkins.createProject(WorkflowJob.class, "us");
us.setDefinition(
new CpsFlowDefinition(
"parallel ds1: {build 'ds1'}, ds23: {parallel ds2: {build 'ds2'}, ds3: {build 'ds3'}}",
true));
j.jenkins.setNumExecutors(3);
j.jenkins.setNodes(
j.jenkins.getNodes()); // TODO https://github.com/jenkinsci/jenkins/pull/1596 renders this
// workaround unnecessary
WorkflowRun usb = us.scheduleBuild2(0).getStartCondition().get();
assertEquals(1, usb.getNumber());
FreeStyleBuild ds1b, ds2b, ds3b;
while ((ds1b = ds1.getLastBuild()) == null
|| (ds2b = ds2.getLastBuild()) == null
|| (ds3b = ds3.getLastBuild()) == null) {
Thread.sleep(100);
}
assertEquals(1, ds1b.getNumber());
assertEquals(1, ds2b.getNumber());
assertEquals(1, ds3b.getNumber());
// Same as X button in UI.
// Should be the same as, e.g., GerritTrigger.RunningJobs.cancelJob, which calls
// Executor.interrupt directly.
// (Not if the Executor.currentExecutable is an AfterRestartTask.Body, though in that case
// probably the FreeStyleBuild would have been killed by restart anyway!)
usb.doStop();
j.assertBuildStatus(Result.ABORTED, j.waitForCompletion(usb));
j.assertBuildStatus(Result.ABORTED, j.waitForCompletion(ds1b));
j.assertBuildStatus(Result.ABORTED, j.waitForCompletion(ds2b));
j.assertBuildStatus(Result.ABORTED, j.waitForCompletion(ds3b));
}
@Test
public void cancelBuildQueue() throws Exception {
FreeStyleProject p = j.createFreeStyleProject("test1");
p.getBuildersList().add(new Shell("sleep 6000"));
WorkflowJob foo = j.jenkins.createProject(WorkflowJob.class, "foo");
foo.setDefinition(
new CpsFlowDefinition(StringUtils.join(Arrays.asList("build('test1');"), "\n")));
j.jenkins.setNumExecutors(0); // should force freestyle build to remain in the queue?
QueueTaskFuture<WorkflowRun> q = foo.scheduleBuild2(0);
WorkflowRun b = q.getStartCondition().get();
CpsFlowExecution e = (CpsFlowExecution) b.getExecutionPromise().get();
e.waitForSuspension();
Queue.Item[] items = j.jenkins.getQueue().getItems();
assertEquals(1, items.length);
j.jenkins.getQueue().cancel(items[0]);
j.assertBuildStatus(Result.FAILURE, q.get());
}
/**
* Also applicable for workflow jobs.
*
* @throws Exception
*/
@Issue("JENKINS-30357")
@Test
public void testWorkflow() throws Exception {
// Prepare an artifact to be copied.
FreeStyleProject copiee = j.createFreeStyleProject();
copiee.getBuildersList().add(new FileWriteBuilder("artifact.txt", "foobar"));
copiee.getPublishersList().add(new ArtifactArchiver("artifact.txt"));
j.assertBuildStatusSuccess(copiee.scheduleBuild2(0));
WorkflowJob copier = createWorkflowJob();
copier.setDefinition(
new CpsFlowDefinition(
String.format(
"node {"
+ "step([$class: 'CopyArtifact',"
+ "projectName: '%1$s',"
+ "filter: '**/*',"
+ "selector: [$class: 'ParameterizedBuildSelector', parameterName: 'SELECTOR'],"
+ "]);"
+ "step([$class: 'ArtifactArchiver', artifacts: '**/*']);"
+ "}",
copiee.getFullName()),
true));
WorkflowRun b =
j.assertBuildStatusSuccess(
copier.scheduleBuild2(
0,
null,
new ParametersAction(
new StringParameterValue(
"SELECTOR",
"<StatusBuildSelector><stable>true</stable></StatusBuildSelector>"))));
VirtualFile vf = b.getArtifactManager().root().child("artifact.txt");
assertEquals("foobar", IOUtils.toString(vf.open()));
}
@Test
public void buildParallelTests() throws Exception {
FreeStyleProject p1 = j.createFreeStyleProject("test1");
p1.getBuildersList().add(new Shell("echo 'Hello World'"));
FreeStyleProject p2 = j.createFreeStyleProject("test2");
p2.getBuildersList().add(new Shell("echo 'Hello World'"));
WorkflowJob foo = j.jenkins.createProject(WorkflowJob.class, "foo");
foo.setDefinition(
new CpsFlowDefinition(
StringUtils.join(
Arrays.asList(
"parallel(test1: {\n"
+ " build('test1');\n"
+ " }, test2: {\n"
+ " build('test2');\n"
+ " })"),
"\n"),
true));
QueueTaskFuture<WorkflowRun> q = foo.scheduleBuild2(0);
j.assertBuildStatusSuccess(q);
}