Jenkins高级篇之Pipeline方法篇-Pipeline Basic Steps-5-方法timeout,waitUntil,withEnv

版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/u011541946/article/details/84574088

继续来学习basic pipeline这个插件的提供的方法，本篇主要学习timeout和waitUntil两个关于时间监控的方法。有时候，我们需要对一个stage执行时间进行精确监控。例如执行这个stage大概20分钟一定可以完成，那么我们就可以使用timeout 设置20分钟，如果操作20分钟还没有执行结束，那么当前这个pipeline stage就会被自动取消，状态显示为aborted。而waitUntil是一个等待一个条件出现就会终止执行等待的方法。下面我分别用一个简单例子来代码演示。withEnv是设置环境变量的，有时候我们还会设置一些普通变量放这个位置。

1.方法timeout

叫方法或者指令都可以，timeout的基本格式如下，例如我有一个代码块执行监控执行时间，那么放在timeout(){...}就好，

time(时间设置，默认是分钟为单位) {
    // 需要监控的代码执行
}

我写一个一分钟超时的简单代码。

import hudson.model.*;

println env.JOB_NAME
println env.BUILD_NUMBER

pipeline{
	
	agent any
	stages{
		stage("init") {
			steps{
				script {
					timeout(1) {
					    sh('java -version')
					    //sleep 61
					}
				}
			}
		}
	}
}

上面我没有执行sleep语句，那么这个打印java -version的代码肯定能在一分钟之内完成，这个job执行的状态是成功。那么，如果我取消sleep这个前面注释，也就是这个代码要执行61秒以上的时间，但是我给了timeout是1分钟，那么这个job跑起来就会自动cancel,状态是aborted。

日志如下：

[Pipeline] {
[Pipeline] timeout
Timeout set to expire in 1 min 0 sec
[Pipeline] {
[Pipeline] sh
[pipeline_basic_steps] Running shell script
+ java -version
openjdk version "1.8.0_181"
OpenJDK Runtime Environment (build 1.8.0_181-b13)
OpenJDK Server VM (build 25.181-b13, mixed mode)
[Pipeline] sleep
Sleeping for 1 min 1 sec
Cancelling nested steps due to timeout
[Pipeline] }
[Pipeline] // timeout
[Pipeline] }
[Pipeline] // script
[Pipeline] }
[Pipeline] // stage
[Pipeline] }
[Pipeline] // withEnv
[Pipeline] }
[Pipeline] // node
[Pipeline] End of Pipeline
Timeout has been exceeded
Finished: ABORTED

2.方法waitUntil

在waitUntil{...}里面的代码会无限制循环执行下去，直到返回true，如果返回是false,会在很短时间内再次尝试，没有尝试次数限制，如果有异常，会退出。这个我没有实际用过，不好举例。

import hudson.model.*;

println env.JOB_NAME
println env.BUILD_NUMBER

pipeline{
	
	agent any
	stages{
		stage("init") {
			steps{
				script {
					timeout(5) {
					     waitUntil {
                                                 script {
                                                      // 监控某一个服务是否启动完成代码
                                                 }
                                             }
					}
				}
			}
		}
	}
}

我没有想出一个实际例子，这里写一个伪代码。场景就是，在5分钟之内，我使用waitUntil去一直轮询检查某一个服务是否启动完成。

3.withEnv

import hudson.model.*;

println env.JOB_NAME
println env.BUILD_NUMBER

pipeline{
	
	agent any

	stages{
		stage("init") {
			steps{
			    withEnv(['java_home=/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.181-3.b13.el6_10.i386/jre']) {
	                sh("$java_home/bin/java -version")
        	    }
				script {
					println "test with withEnv feature"
				}
			}
		}
	}
}

这个用withEnv添加多个环境变量，我没有使用过，下次如果遇到再补上。