Jenkins pipeline流程控制选项

---

一、概述

在Jenkins 中使用流水线即代码 （与使用传统的 Web 表单相比）的一个好处就是，你拥有更多的选项来控制流水线的流程。
这包括对一些可能造成你的流水线停止或者失败的情况进行处理。这些可用的选项包括等待、 重试等方法。

二、超时(timeout)

语法

timeout(time:10, unit:'SECONDS') {
	//这里面的代码会被设置为超时，默认单位是min，SECONDS代表单位为秒
}
1
2
3

示例

10秒内没有输入，则抛出异常，并给response赋值

stage("Enter Your Name") {
        def response
        try {
            timeout(time:10, unit:'SECONDS') {
                response = input id: "input_test",
                    message: "username",
                    parameters: [string(defaultValue: 'devops', description: 'Enter your username', name: 'username')]
            }
        } catch (err) {
            response = "devops"
            println response
        }
   }
1
2
3
4
5
6
7
8
9
10
11
12
13

效果

三、重试(retry)

语法

当retry里面的代码发生异常时，该步骤可以重试n-1次

retry (<n>) { //代码过程 }
1

示例

retry(3) {
   println "发生异常"
    sh "exit 1"
}
1
2
3
4

只重试了两次，但里面的代码会执行三次

四、睡眠（ sleep)

语法

默认的时间单位是s,如果你想指定一个不同的单位，添加单位名称参数即可，如睡眠5分钟

sleep time: 5, unit: 'MINUTES'
1

示例

sleep time:3
println "等待3秒"
1
2

五、等待直到（waitUntil)

这个步骤会导致整个过程一直等待直到某件事发生。这里的“某件事”指的是可以返回 true 的闭包。
如果代码块中的过程返回 false ，那么这个步骤会在等待更长的时间后进行下一次尝试。


注意：最大等待时间为15秒

如果代码过程永不返回 true 的话（无论出于本意与杏），这个步骤将会无期限地等待下去而不会结束，所以推荐使用 timeout 步骤来封装 waitUntil 步骤，这样的话过程终将会结束。

示例

3秒后，如果不返回true，则脚本退出

stage("test") {
    timeout(time:3, unit:'SECONDS') {
        waitUntil {
            def result = sh(script: "test -e ${WORKSPACE}/test.txt", returnStatus: true)
            return (result == 0)
        }
    }
}
1
2
3
4
5
6
7
8

六、实战

检查k8s Pod是否更新成功

总时长为600秒，shell脚本判断当前Pod的数量是否为1，如果为1，则result为0，返回true，waitUntil正常退出。

try {
    timeout(time:600, unit:'SECONDS') {
        waitUntil {
            try {
                def result = sh(script: """test `rancher kubectl get pod -n ${NAMESPACE} | grep \"^${serviceName}\" | wc -l` == 1""", returnStatus: true)
                sleep time:10	//避免尝试的频率过高
                return (result == 0)
            } catch (exception) {
                return false
            }
        }
        println "Upgrade ${serviceName} Success"
    }
} catch (exception) {
	//超时则抛出异常
    throw new Exception("*******upgradeK8sDeployment Upgrade ${serviceName} Fail")
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

七、参考

书籍：《Jenkins2权威指南》