Skip to content

[JENKINS-52189] Ensure GraphListeners are notified of the FlowStartNode too #232

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
dwnusbaum merged 3 commits into from
Feb 1, 2019
Merged

[JENKINS-52189] Ensure GraphListeners are notified of the FlowStartNode too #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fd637cd
Add testcase to catch JENKNIS-52189 - not triggering GraphListener fo…
svanoort Jul 2, 2018
d19a43a
Add notify for FlowStartNode
svanoort Jul 2, 2018
fb5f723
Fix bogus import
svanoort Jul 2, 2018
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
13 changes: 13 additions & 0 deletions src/main/java/org/jenkinsci/plugins/workflow/cps/FlowHead.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,19 @@ void newStartNode(FlowStartNode n) throws IOException {
this.head = execution.startNodes.push(n);
}
execution.storage.storeNode(head, false);

CpsThreadGroup c = CpsThreadGroup.current();
if (c !=null) {
Copy link
Member Author

@svanoort svanoort Jul 2, 2018

Choose a reason for hiding this comment

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

I'm leaving this in, in case we do get a proper CpsThreadGroup down the road, so it does The Right Thing (tm).

// if the manipulation is from within the program executing thread, then
// defer the notification till we get to a safe point.
c.notifyNewHead(head);
} else {
// in recovering from error and such situation, we sometimes need to grow the graph
// without running the program.
// TODO can CpsThreadGroup.notifyNewHead be used instead to notify both kinds of listeners?
execution.notifyListeners(Collections.singletonList(head), true);
execution.notifyListeners(Collections.singletonList(head), false);
}
}

/** Could be better described as "append to Flow graph" except for parallel cases. */
Expand Down
30 changes: 30 additions & 0 deletions src/test/java/org/jenkinsci/plugins/workflow/WorkflowTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,10 @@
import hudson.slaves.SlaveComputer;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
Expand All @@ -52,7 +54,11 @@
import org.jenkinsci.plugins.scriptsecurity.scripts.ScriptApproval;
import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
import org.jenkinsci.plugins.workflow.flow.FlowExecution;
import org.jenkinsci.plugins.workflow.flow.GraphListener;
import org.jenkinsci.plugins.workflow.graph.FlowNode;
import org.jenkinsci.plugins.workflow.graph.FlowStartNode;
import org.jenkinsci.plugins.workflow.job.WorkflowJob;
import org.jenkinsci.plugins.workflow.job.WorkflowRun;
import org.jenkinsci.plugins.workflow.steps.AbstractStepDescriptorImpl;
import org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl;
import org.jenkinsci.plugins.workflow.steps.AbstractStepImpl;
Expand Down Expand Up @@ -262,6 +268,30 @@ public static final class Execution extends AbstractSynchronousNonBlockingStepEx
}
}

@Issue("JENKINS-52189")
@Test
public void notifyFlowStartNode() {
story.then(s->{
WorkflowJob j = jenkins().createProject(WorkflowJob.class, "bob");
j.setDefinition(new CpsFlowDefinition("echo 'I did a thing'", true));
WorkflowRun r = story.j.buildAndAssertSuccess(j);
FlowStartNodeListener listener = jenkins().getExtensionList(FlowStartNodeListener.class).get(0);
assertTrue(listener.execNames.contains(r.getExecution().toString()));
});
}

@TestExtension("notifyFlowStartNode")
public static class FlowStartNodeListener implements GraphListener {
List<String> execNames = new ArrayList<String>();

@Override
public void onNewHead(FlowNode node) {
if (node instanceof FlowStartNode) {
execNames.add(node.getExecution().toString());
}
}
}

@Issue("JENKINS-29952")
@Test public void env() {
story.addStep(new Statement() {
Expand Down