Catching a job cancel

[John Westcott IV]

Is it possible for a plugin to get a notification if a Jenkins job is cancelled while the plugin is working?

i.e. is there some kind of "public void on_job_cancel()" method I can implement to take some action if my plugin is actively running when a job is canceled?

I'm not seeing anything in the docs but wanted to double check in case I am missing something.

-John

[Jeff Pearce]

You can probably get the info if you implement the RunListener extension point

 

From: <jenkin...@googlegroups.com> on behalf of John Westcott IV <jowe...@redhat.com>
Reply-To: "jenkin...@googlegroups.com" <jenkin...@googlegroups.com>
Date: Thursday, September 26, 2019 at 1:17 PM
To: Jenkins Developers <jenkin...@googlegroups.com>
Subject: Catching a job cancel

 

Notice: This email is from an external sender.

 

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to jenkinsci-de...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/6296320b-1e84-4caa-9686-475650e8d334%40googlegroups.com.

[Robert Sandell]

When a build is canceled the executor threads will be interrupted. So if your plugin is doing a remote call, waiting on something, or sleeping an InterruptedException will be thrown.

Otherwise you can check the status of the current thread: Thread.currentThread().isInterrupted()

/B

To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/AEC405E5-912A-46E2-9FD2-84836E31A08E%40godaddy.com.

--

Robert Sandell

Software Engineer

CloudBees, Inc.

E: rsan...@cloudbees.com

Twitter: robert_sandell

[John Westcott]

Thanks for the tip on this. Unfortunately, my code does more than just sleep its also gathering log information as well as running status checks. Is there anyway to put a larger try/catch block around all of that code rather than just the sleep method? Or a way to register an action on the builder itself for an on-cancel event? Or would that have to be a request to Jenkins core?

Does anyone have an example of implementing the RunListener extension point?

-John

You received this message because you are subscribed to a topic in the Google Groups "Jenkins Developers" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/jenkinsci-dev/bD22cVOyp60/unsubscribe.
To unsubscribe from this group and all its topics, send an email to jenkinsci-de...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CALzHZS2RPku1jJR39z1_%3DLUkrKgsSvrZkBsgnMtaPZnYCmYPUA%40mail.gmail.com.

[Robert Sandell]

If you are doing a lot of on master calculations you should either consider moving that out to the agent (workspace.act) or, once in a while, check if the current thread is interrupted for example on the top of every loop.

Examples of extensionpoint implementations can be found among the documentation: https://jenkins.io/doc/developer/extensions/jenkins-core/#runlistener

/B

To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/DAD8A4DE-2A7C-4789-8168-18B7C6D3D082%40redhat.com.

[John Westcott]

Thanks for the help with this, I didn’t realize that the thread would continue to run once canceled; I assumed it would have been killed off. 

-John

To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CALzHZS1HvHWwCUUv9eRAzzPW36fvNihfTWK1UPMka8K_4-RNLw%40mail.gmail.com.