[JENKINS-27039] Option for stage step to cancel older executions

[kreinloo]

JENKINS-27039

Added eager flag to stage step. When a new build enters this stage, it will cancel any running build so that it could proceed on its own. Inspired by @jglick's comment.

Example:

stage name: 'build', eager: true
input message: 'Proceed?'

[jglick]

This definitely needs coverage in StageStepTest.

[jglick]

boolean suffices (especially as the default remains false).

[jglick]

Looks good so far. Marking WiP pending test coverage (whether written by you or me or someone else).

[kreinloo]

As of now, it still cancels jobs with the ABORTED message.

Running: End of Workflow
Rejected by SYSTEM
Finished: ABORTED

I tried using the FlowExecution.interrupt as well, but the results were the same. Probably did something wrong. I'll try to improve it and write tests as well.

[jglick]

StageTest IIRC.

Logic for handling aborts is a little subtle. Might need to check with a debugger why it is getting ABORTED. I suspect stop is called on the Execution and this overrides the cancellation cause you tried to set.

[witokondoria]

Wouldnt it be nice to merge this feature and handle the exit status on a different issue (IMHO ABORTED fits well)

[jglick]

Exit status is a minor issue (mainly consistency with the current behavior), but tests are vital.

[jglick]

support/src/test/java/org/jenkinsci/plugins/workflow/support/steps/StageStepTest.java only tests configuration. This tests runtime behavior, the interesting stuff.

[witokondoria]

What about another parameter to flag a stage as uncancellable? It could serve to define complex-one level semaphores

[amuniz]

Tested locally, it works as advertised.
@kreinloo I'm going to add some tests and will file a new PR based on this one (keeping your commits).

[amuniz]

Changed my mind. I'm working on a new step (milestone) that supersedes this PR. See JENKINS-27039 comments for more context.

[amuniz]

See #355

[jenkinsadmin]

Thank you for this pull request! Please check this document for how the Jenkins project handles pull requests.

[jglick]

I think this has become obsolete; please try out jenkinsci/pipeline-milestone-step-plugin#1 and let us know if it works for you.