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

Recover gracefully when a PlaceholderTask is in the queue but the associated build is complete #185

Merged
merged 6 commits into from
Dec 6, 2021
Merged

Recover gracefully when a PlaceholderTask is in the queue but the associated build is complete #185

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8db0ae1
Add ignored test where a PlaceholderTask is in the queue but the asso…
dwnusbaum Dec 1, 2021
d0632af
Update annotation to explain why test is ignored
dwnusbaum Dec 1, 2021
3abef26
Simplify test using JenkinsSessionRule.getHome and TemporaryFolder
dwnusbaum Dec 2, 2021
00cdd69
De-flake test and update to released version of jenkins-test-harness
dwnusbaum Dec 3, 2021
9d8eeca
Check if build is complete in PlaceholderTask.getCauseOfBlockage and …
dwnusbaum Dec 3, 2021
e0b5abf
Simplify lambda in PlaceholderTask.getCauseOfBlockage
dwnusbaum Dec 3, 2021
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
42 changes: 42 additions & 0 deletions src/test/java/org/jenkinsci/plugins/workflow/support/steps/ExecutorStepTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
import hudson.model.FreeStyleProject;
import hudson.model.Item;
import hudson.model.Job;
import hudson.model.Label;
import hudson.model.Node;
import hudson.model.Queue;
import hudson.model.Result;
Expand Down Expand Up @@ -79,7 +80,9 @@

import hudson.util.VersionNumber;
import java.nio.charset.StandardCharsets;
import java.nio.file.StandardCopyOption;
import java.util.Set;
import java.util.concurrent.atomic.AtomicReference;
import jenkins.model.Jenkins;
import jenkins.security.MasterToSlaveCallable;
import jenkins.security.QueueItemAuthenticator;
Expand Down Expand Up @@ -126,6 +129,7 @@
import static org.junit.Assert.fail;
import org.junit.Assume;
import org.junit.ClassRule;
import org.junit.Ignore;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
Expand Down Expand Up @@ -1264,6 +1268,44 @@ public void accessPermittedOnlyFromCurrentBuild() throws Throwable {
r.buildAndAssertSuccess(main);
});
}

@Ignore
dwnusbaum marked this conversation as resolved.
Show resolved Hide resolved
@Test public void placeholderTaskInQueueButAssociatedBuildComplete() throws Throwable {
AtomicReference<File> rootDir = new AtomicReference<>();
jglick marked this conversation as resolved.
Show resolved Hide resolved
Path tempQueueFile = Files.createTempFile("queue", ".xml");
sessions.then(r -> {
rootDir.set(r.jenkins.getRootDir());
System.out.println(rootDir);
WorkflowJob p = r.createProject(WorkflowJob.class, "p");
p.setDefinition(new CpsFlowDefinition("node('custom-label') { }", true));
WorkflowRun b = p.scheduleBuild2(0).waitForStart();
// Get into a state where a PlaceholderTask is in the queue.
while (true) {
Queue.Item[] items = Queue.getInstance().getItems();
if (items.length == 1 && items[0].task instanceof ExecutorStepExecution.PlaceholderTask) {
break;
}
Thread.sleep(500L);
}
// Copy queue.xml to a temp file while the PlaceholderTask is in the queue.
r.jenkins.getQueue().save();
Files.copy(rootDir.get().toPath().resolve("queue.xml"), tempQueueFile, StandardCopyOption.REPLACE_EXISTING);
// Create a node with the correct label and let the build complete.
DumbSlave node = r.createOnlineSlave(Label.get("custom-label"));
r.assertBuildStatusSuccess(r.waitForCompletion(b));
});
// Copy the temp queue.xml over the real one. The associated build has already completed, so the queue now
// has a bogus PlaceholderTask.
Files.copy(tempQueueFile, rootDir.get().toPath().resolve("queue.xml"), StandardCopyOption.REPLACE_EXISTING);
sessions.then(r -> {
WorkflowJob p = r.jenkins.getItemByFullName("p", WorkflowJob.class);
WorkflowRun b = p.getBuildByNumber(1);
assertFalse(b.isLogUpdated());
r.assertBuildStatusSuccess(b);
assertThat(Queue.getInstance().getItems(), emptyArray()); // This assertion fails.
dwnusbaum marked this conversation as resolved.
Show resolved Hide resolved
});
}

Copy link
Member

Choose a reason for hiding this comment

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

BTW the reason there was no newline here before is that this step was a @TestExtension of the test formerly above it, now with the new test intervening.

public static final class WriteBackStep extends Step {
static File controllerFile;
static boolean legal = true;
Expand Down