Fail a Jenkins build from groovy script

Question

I have a groovy script that goes and promotes code. Long story short, I know at a point of time within that script if it was successful or not. I would like to fail the build if not successful. Is there a way in groovy to fail the build?

Example:

in the "execute Groovy script" plugin. you can write code.

(insert API call to promote code) if(checkPromote()){ //fail build here }

where 'checkPromote' returns a true or false value depending on the status of the promote.

return non-zero exitcode from your script. Should fail your build — Rik, Apr 13 '17 at 19:55
That was the first thing I tried. `return -1` that did not work. — Eddie, Apr 13 '17 at 19:58
Than it might help if you provide a snippet of the buildfile and a description of the setup — Rik, Apr 13 '17 at 20:04
Let us [continue this discussion in chat](http://chat.stackoverflow.com/rooms/141676/discussion-between-eddie-and-rik). — Eddie, Apr 13 '17 at 20:44

herm · Accepted Answer · 2017-09-20T14:58:29.497

30

The most elegant way to abort a programm in my opinion is an assertion.

assert condition : "Build fails because..."

edited Sep 20 '17 at 14:58

answered Apr 14 '17 at 09:00

herm

14,613
7
41
62

score 24 · Answer 2 · answered Apr 13 '17 at 20:07

24

The declarative pipeline dsl has an error step:

error('Failing build because...')

See https://jenkins.io/doc/pipeline/steps/workflow-basic-steps and search the page for "Error signal".

this would also do it:

sh "exit 1"

answered Apr 13 '17 at 20:07

burnettk

13,557
4
51
52

This isn't a pipeline job. This is a freestyle project – Eddie Apr 13 '17 at 20:10
@Eddie are you sure? I don't think freestyle projects have groovy scripts. – SINGULARITY Jan 16 '18 at 20:28
2

@SINGULARITY they do, yes – Jim Andrakakis Feb 15 '18 at 10:52

score 8 · Answer 3 · answered Apr 14 '17 at 06:49

8

From this page, https://wiki.jenkins-ci.org/display/JENKINS/Groovy+plugin

import hudson.AbortException
//other code
throw new AbortException("Error message .")

answered Apr 14 '17 at 06:49

Jon S

15,846
4
44
45

Have you tried this? You'd seen the following error `org.jenkinsci.plugins.scriptsecurity.sandbox.RejectedAccessException: Scripts not permitted to use new hudson.AbortException`. – acm Sep 06 '17 at 07:20
@acm Yes it works, although you have to approve the constructor for AbortException first, see https://stackoverflow.com/a/39412951/7509826 – Jon S Sep 06 '17 at 14:33
Nicely this doesn't include an unnecessary stack trace. – Jeremy Gosling Jun 23 '18 at 21:07

Alexander Samoylov · Answer 4 · 2021-11-25T11:48:40.570

There are different "groovy script"s in the Jenkins world. For every of them the solution is different.

"Execute Groovy script" plugin (a plain Groovy script which runs on a node)

 System.exit(1)
 // NOTE: Don't use it in System Groovy Script, Groovy Postbuild, Scriptler or Pipeline
 // because it runs on master and terminates the Jenkins server process!

System Groovy Script / Groovy Postbuild / Scriptler (runs on master):

 import hudson.model.*;
 def currentBuild = Thread.currentThread().executable
 currentBuild.result = Result.FAILURE

This works only for "System Groovy Script"

 return 1

Pipeline:

 currentBuild.result = 'FAILURE'// one way
 error("Error Message") // another way

There are of course more artificial methods like throwing an exception, execution of a faulty command, calling of unexisting function or a function with wrong arguments etc etc.

score 2 · Answer 5 · answered Apr 13 '17 at 23:44

2

I usually use something as simple as throw new Exception("Error Message") so maybe you can have try with:

    if(checkPromote()){
         throw new Exception("Error Message")
     }

Hope this also works for you

answered Apr 13 '17 at 23:44

Chong

335
2
9

score 0 · Answer 6 · answered Aug 31 '21 at 11:05

0

You should be using

currentBuild.result = 'FAILURE'

answered Aug 31 '21 at 11:05

user666

1,104
12
20

Fail a Jenkins build from groovy script

6 Answers6

Linked