想设计复杂的pipeline脚本在devops中成功应用,我们需要从如下几个方面进行考虑:
1.脚本的稳定性:使用异常处理机制保证在发生异常的情况下脚本能够捕获异常并持续运行;
2.脚本执行的超时处理:构建时需要考虑超时机制避免花费大量时间等待而浪费执行时间;
3.构建结果处理:通过异常处理机制,jenkins build的结果都是SUCCESS,如果想对build的结果或者是stage的结果进行控制分析,我们需要进一步对构建结果进行处理;
4.对于groovy脚本的调用:引入其他groovy脚本来实现某些更为复杂的功能
代码的设计基础样式
写一个脚本的通常形式是
- node {
- stage('Build') {
- // git 下载代码
- // mvn clean install 构建代码
- }
- stage('unit Test') {
- // 执行单元测试
- }
- stage('Test') {
- // 执行自动化测试脚本,进行核心功能覆盖
- }
- stage('Deploy') {
- //执行运维脚本,部署程序上线
- }
- }
对脚本进行稳定性处理
- stage('Test'){
- try {
- //需要处理的代码
- }catch(err) {
- //处理error的代码
- }
- catch(exp) {
- //处理exception的代码
- }
脚本执行超时的处理
某些场景我们需要对脚本进行超时处理,例如maven构建超时、测试代码执行超时等等,那么我们可以这样设计代码。
- try {
- timeout(timeout) {
- //超时处理的代码
- }
- }
- catch (exp) {
- //捕获超时异常,便于大家做进一步的处理
- def error_msg = exp.getCauses()[0].toString()
- if (error_msg.find("TimeoutStepExecution") =="TimeoutStepExecution") {
- //处理逻辑
- }
- }
构建结果的处理
通过使用try… catch…的处理,jenkins build的结果都是SUCCESS,如果想对build的结果或者是stage的结果进行控制,可以按照下面的方法进行处理:
build结果包括:SUCCESS, UNSTABLE,或者FAILURE (返回null ,build正在进行中)
使用变量currentBuild.result可以设置build的最终结果
currentBuild.result =‘FAILURE’//设置build结果为失败
对各个stage的结果处理,需要使用catchError
catchError(buildResult: 'SUCCESS', stageResult: 'FAILURE') {}//设置build结果为成功,而改stage结果为失败
引入其他groovy脚本
调用groovy类中的api
- ClassDemo.groovy
- class MyClass {
- void test1() {
- println("test1")
- }
- static void test2() {
- println("test2")
- }
- }
- return new MyClass()
注意一定要给调用者一个返回值,即return new MyClass()返回一个实例
调用groovy脚本中的函数
- Demo.groovy
- def fun1(){
- println("func1")
- }
- def fun2(){
- fun1()
- println("func2")
- }
- def fun3(){
- fun1()
- println("func3")
- }
- return this
同样注意一定要给调用者一个返回值,即return this
在pipeline中调用groovy脚本
使用load引入脚本即可,代码如下
- node {
- def f=load ("/opt/scripts/test/Demo.groovy")
- f.fun1()
- def f2=load ("/opt/scripts/test/ClassDemo.groovy")
- f2.test1()
- }
jenkins share libary方式
可以使用share的方法,请参考官方文档:
https://www.jenkins.io/doc/book/pipeline/shared-libraries/