jenkins2 pipeline入门

 

本文经过简单的pipeline的实例和详细的讲解，可以学习基本pipeline的groovy用法，而后开始实现本身的pipeline job。

翻译和修改自：https://github.com/jenkinsci/pipeline-plugin/blob/master/TUTORIAL.md

 

文章来自：http://www.ciandcd.com
文中的代码来自能够从github下载： https://github.com/ciandcd

 

1. 安装java，maven，配置jenkins

安装java和maven：

#install java jdk
sudo apt-get update
sudo apt-get install default-jdk

#install maven in ubuntu
sudo apt-get update
sudo apt-get install maven

#setting for maven
~/.bashrc
export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64

#testing maven
/usr/share/maven/bin/mvn -v
Apache Maven 3.3.9
Maven home: /usr/share/maven
Java version: 1.8.0_91, vendor: Oracle Corporation
Java home: /usr/lib/jvm/java-8-openjdk-amd64/jre
Default locale: en_GB, platform encoding: UTF-8
OS name: "linux", version: "4.4.0-24-generic", arch: "amd64", family: "unix"

在jenkins的global tool configuration里配置环境变量

 

2. 建立简单的pipeline job

groovy代码以下：

node {
git url: 'https://github.com/jglick/simple-maven-project-with-tests.git'
def mvnHome = tool 'M3'
sh "${mvnHome}/bin/mvn -B verify"
}

上面的代码实现了从github checkout源代码，而后经过maven来构建， 代码中包含了测试用例，有可能会随机的失败， 若是有测试用例失败，则整个pipeline job将会标记为失败。

若是是windows系统，须要修改成bat "${mvnHome}\\bin\\mvn -B verify"。

groovy的node用来选择运行的机器，只要node还有可用的executor，node里的step任务将会在选中的机器上运行，且会在选中的机器上建立workspace。

许多的step必须在node里执行，例如git，sh等必须在node环境里执行。

不像用户定义的函数，pipeline step老是接受命名参数，括号能够省略，也可使用标准的groovy语法传入map做为参数，例如等价用法： 

git url: 'https://github.com/jglick/simple-maven-project-with-tests.git'

git url: 'https://github.com/jglick/simple-maven-project-with-tests.git', branch: 'master'

git([url: 'https://github.com/jglick/simple-maven-project-with-tests.git', branch: 'master'])

若是只有一个强制的参数，则能够省略参数名字，以下两种等价效果：

sh 'echo hello'

sh([script: 'echo hello'])

def能够定义groovy变量，tool能够检查指定名字的工具是否存在且能够访问，在双引号里使用变量，变量将会被替换为真实的值：

def mvnHome = tool 'M3'

"${mvnHome}/bin/mvn -B verify"

 3. 环境变量的使用

最简单的使用工具的方式是将工具路径加入到PATH中，经过env能够修改node对应机器的环境变量，后面的steps能够看到环境变量的修改。

node {

git url: 'https://github.com/jglick/simple-maven-project-with-tests.git'
def mvnHome = tool 'M3'
env.PATH = "${mvnHome}/bin:${env.PATH}"
sh 'mvn -B verify'
}

jenkins的job有一些内置的默认的环境变量，能够经过http://jenkins-server/job/javahelloworld/pipeline-syntax/globals来查看job默认的环境变量。 以下：

BRANCH_NAME
CHANGE_ID
CHANGE_URL
CHANGE_TITLE
CHANGE_AUTHOR
CHANGE_AUTHOR_DISPLAY_NAME
CHANGE_AUTHOR_EMAIL
CHANGE_TARGET
BUILD_NUMBER
BUILD_ID
BUILD_DISPLAY_NAME
JOB_NAME
JOB_BASE_NAME
BUILD_TAG
EXECUTOR_NUMBER
NODE_NAME
NODE_LABELS
WORKSPACE
JENKINS_HOME
JENKINS_URL
BUILD_URL
JOB_URL
例如你能够在node中的step中使用env.BUILD_TAG。

一样地，若是你使用参数化build，则同名的参数在groovy里可使用。

 

4. 记录测试结果和构建产物

当有测试用例失败的时候，你可能须要保存失败的用例结果和构建产物用于人工排查错误。

node {
git url: 'https://github.com/jglick/simple-maven-project-with-tests.git'
def mvnHome = tool 'M3'
sh "${mvnHome}/bin/mvn -B -Dmaven.test.failure.ignore verify"
step([$class: 'ArtifactArchiver', artifacts: '**/target/*.jar', fingerprint: true])
step([$class: 'JUnitResultArchiver', testResults: '**/target/surefire-reports/TEST-*.xml'])
}
上面的例子中，-Dmaven.test.failure.ignore将忽略测试用例的失败，jenkins将正常执行后面的step而后退出。
上面的两个step调用至关于调用传统的jenkins的steps将构建产物和测试结构保存。

如下两个是等价做用，第一个是简写：
git url: 'https://github.com/jglick/simple-maven-project-with-tests.git'
checkout scm: [$class: 'GitSCM', branches: [[name: '*/master']], userRemoteConfigs: [[url: 'https://github.com/jglick/simple-maven-project-with-tests']]

5. slave机器的选择、

groovy中经过node的参数labels来选择slave，用法跟jenkins1里的同样，咱们须要先定义jenkins node，且给jenkins node定义label，而后在groovy里使用node加label来选择slave。

例如以下node选择同时定义了unix和64bit的slave。

node('unix && 64bit') {    // as before  }

 

6. 暂停pipeline
新建pipeline job，修改groovy脚本以下：
node {
git url: 'https://github.com/jglick/simple-maven-project-with-tests.git'
def mvnHome = tool 'M3'
sh "${mvnHome}/bin/mvn -B -Dmaven.test.failure.ignore verify"
input 'save artifacts and unit results?'
// rest as before
step([$class: 'ArtifactArchiver', artifacts: '**/target/*.jar', fingerprint: true])
step([$class: 'JUnitResultArchiver', testResults: '**/target/surefire-reports/TEST-*.xml'])
}

在job的运行页面能够看到

而后点击proceed，pipelinejob就继续执行了。貌似job console output中的 proceed/Abort链接点了没有用。必需要要点击pause for input的proceed/abort按钮才能够。

7. 分配workspace
当node执行steps的时候会自动分配workspace，用于checkout代码，运行命令和其余任务。在step执行的时候workspace是被lock的，workspace只能同时被一个build使用。若是多个build须要使用同一个node的workspace，新的workspace将会被自动分配。
例如你同时运行你的同一个job两次，则第二个job log中能够看到使用了不一样的workspace：

并行的job若是在新的workspace，则须要从新checkout代码，能够查看job log来证明。下一节将学习更复杂的groovy用法。Running on <yourslavename> in /<slaveroot>/workspace/<jobname>@2