-
Notifications
You must be signed in to change notification settings - Fork 72
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.
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
[JENKINS-49073] Propagate the downstream result, not just FAILURE #24
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
57 changes: 57 additions & 0 deletions
57
src/main/java/org/jenkinsci/plugins/workflow/support/steps/build/DownstreamFailureCause.java
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,57 @@ | ||
/* | ||
* The MIT License | ||
* | ||
* Copyright 2019 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 org.jenkinsci.plugins.workflow.support.steps.build; | ||
|
||
import hudson.model.Run; | ||
import javax.annotation.CheckForNull; | ||
import jenkins.model.CauseOfInterruption; | ||
|
||
/** | ||
* Indicates that an upstream build failed because of a downstream build’s status. | ||
*/ | ||
public final class DownstreamFailureCause extends CauseOfInterruption { | ||
|
||
private static final long serialVersionUID = 1; | ||
|
||
private final String id; | ||
|
||
DownstreamFailureCause(Run<?, ?> downstream) { | ||
id = downstream.getExternalizableId(); | ||
} | ||
|
||
public @CheckForNull Run<?, ?> getDownstreamBuild() { | ||
return Run.fromExternalizableId(id); | ||
} | ||
|
||
@Override public String getShortDescription() { | ||
Run<?, ?> downstream = getDownstreamBuild(); | ||
if (downstream != null) { | ||
return downstream.getFullDisplayName() + " completed with status " + downstream.getResult() + " (propagate: false to ignore)"; | ||
} else { | ||
return "Downstream build was not stable (propagate: false to ignore)"; | ||
} | ||
} | ||
|
||
} |
37 changes: 37 additions & 0 deletions
37
...s/org/jenkinsci/plugins/workflow/support/steps/build/DownstreamFailureCause/summary.jelly
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,37 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<!-- | ||
The MIT License | ||
|
||
Copyright 2019 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. | ||
--> | ||
|
||
<?jelly escape-by-default='true'?> | ||
<j:jelly xmlns:j="jelly:core"> | ||
<j:set var="ds" value="${it.downstreamBuild}"/> | ||
<j:choose> | ||
<j:when test="${ds != null}"> | ||
<a class="model-link inside" href="${rootURL}/${ds.url}">${ds.fullDisplayName}</a> was not stable | ||
</j:when> | ||
<j:otherwise> | ||
<j:out value="${it.shortDescription}"/> | ||
</j:otherwise> | ||
</j:choose> | ||
</j:jelly> |
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One side effect of using
FlowInterruptedException
instead ofAbortException
is thatretry
will no longer retry thebuild
step if it fails (it ignoresFlowInterruptedException
because of JENKINS-44379 ). This was reported as a bug in JENKINS-60354.I'm not really sure how to fix this. I think
FlowInterruptedException
is overloaded with too many meanings at this point. One approach would be to factor out aResultCarryingException
interface, haveFlowInterruptedException
and some newFooException
implement that interface, and then go through and switch everything that currently just usesFlowInterruptedException
for a result to useResultCarryingException
when inspecting exception andFooException
when creating them, and only useFlowInterruptedException
when we only want to capture actual Pipeline interruption.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I might rather suggest amending
RetryStep
to check for the presence of aCauseOfInterruption
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea, and much simpler to implement, although I do feel like it would be good to separate the different use cases of
FlowInterruptedException
at some point so that it is easier to reason about changes like this in isolation.I think
catchError
andwarnError
probably have the same issue asretry
and would also need to be updated.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, it looks like
WorkflowRun.doTerm
does not set aCauseOfInterruption
when it aborts the build, so that would need to be tested and maybe changed since it should be rethrown byretry
.WorkflowRun.doKill
does not set aCauseOfInterruption
either, but I don't think it matters in that case because of the way the build is aborted.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps just add a
fatal
flag toFlowInterruptedException
, used by true build interruptions, and have steps likeretry
only ignore it in this mode. I guess that boils down to a similar proposal.