-
介紹
本文介紹如何在Jenkins中使用pipeline插件。
本文的Jenkins是基于docker安裝的串纺，如果您對(duì)這部分感興趣，請(qǐng)參考《Docker安裝應(yīng)用》。
Domain Specific Language（DSL）
- 什么是Pipeline
Jenkins Pipeline是一套插件涧黄，支持實(shí)現(xiàn)和持續(xù)集成作為流水線應(yīng)用到Jenkins篮昧。Pipeline提供了一套可擴(kuò)展的工具。
- 為什么要用Pipeline
根本上來說笋妥，Jenkins是一個(gè)支持很多自動(dòng)化模式的引擎懊昨。Pipeline增加了一套強(qiáng)大的工具到Jenkins中，支持用戶從見的持續(xù)集成到全面的持續(xù)集成春宣。通過模塊化一些列相關(guān)的任務(wù)酵颁，用戶可以利用很多Pipeline的特性。
代碼：Pipelines通過代碼來實(shí)現(xiàn)信认，并通巢囊澹可以由版本控制系統(tǒng)（svn、git等）來管理嫁赏。
可暫停：Pipelines可以暫停（停止）其掂，并且可以在運(yùn)行之前接收人工輸入或者等待同意。
- Pipeline表達(dá)式
Step
是一個(gè)單一任務(wù)潦蝇，告訴Jenkins該做什么款熬。例如，在step中執(zhí)行shell命令make攘乒。當(dāng)一個(gè)插件擴(kuò)展了Pipeline DSl贤牛，就意味著可以使用新的step。
Node
大多數(shù)工作是在一個(gè)或者多個(gè)節(jié)點(diǎn)（node）中完成的则酝。
- 語法
Jenkins的流水線（pipeline）采用groovy語法來編寫殉簸。邏輯判斷、循環(huán)沽讹、異常等功能都是具備的般卑，另外，熟悉groovy的人就明白這和Java的寫法有一定的相似爽雄。
下面我介紹一些流水線的步驟（或者函數(shù)）蝠检，首先介紹的是在插件workflow-basic-steps-plugin中的。我們從插件的名稱上也能看到挚瘟，這些流水線步驟大多是基礎(chǔ)叹谁、簡單的。首先乘盖，給出我研究時(shí)的版本信息：
<pre class="lang:default decode:true "><groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-basic-steps</artifactId>
<version>2.7-SNAPSHOT</version></pre>
以便各位依據(jù)本文可以進(jìn)一步學(xué)習(xí)Jenkins流水線插件的源碼焰檩。
- 環(huán)境變量
<pre class="lang:default decode:true ">node {
echo env.JENKINS_HOME
sh 'echo $JENKINS_HOME'
echo env.JOB_NAME
echo env.NODE_NAME
echo env.NODE_LABELS
echo env.WORKSPACE
echo env.JENKINS_URL
echo env.BUILD_URL
env.SUREN_VER = '12'
echo env.SUREN_VER
}</pre>
上面的示例中，給出了如何使用內(nèi)置的環(huán)境變量和自定義環(huán)境變量的做法
- 工具
<pre class="lang:default decode:true">node() {
tool name: 'JDK8_Linux', type: 'jdk'
tool name: 'maven339_linux_dir', type: 'maven'
echo 'hello'
}</pre>
上面的pipeline指定要工具jdk和maven的名稱（在Global Tool Configuration中配置）侧漓。
對(duì)應(yīng)的實(shí)現(xiàn)類為ToolStep锅尘，該類被final關(guān)鍵字所修飾，因此是不能做擴(kuò)展的了。
- 屬性
<pre class="lang:default decode:true ">node {
echo 'hello'
}
properties([
buildDiscarder(
logRotator(
artifactDaysToKeepStr: '',
artifactNumToKeepStr: '',
daysToKeepStr: '5',
numToKeepStr: '10'
)
),
pipelineTriggers([
cron('H 3,12,17 * * *')
])
])</pre>
- 環(huán)境變量
<pre class="lang:default decode:true crayon-selected">node() {
env.JDK_HOME = "${tool '8u131'}"
env.PATH="${env.JDK_HOME}/bin:${env.PATH}"
echo env.JDK_HOME
echo env.PATH
sh 'java -version'
}
node('bimpm_deploytodev') {
def pass_bin = '/opt/pass/bin'
env.PASS_BIN = pass_bin
stage('Clean') {
sh 'rm -rfv $PASS_BIN'
}
}</pre>
- 拷貝成品
<pre class="lang:default decode:true">node {
stage('Copy') {
step([$class: 'CopyArtifact', fingerprintArtifacts: true, flatten: true, projectName: 'BIM_PMJF/BIM-PMJF-BUILD/BIM_PMJF_DISCOVERY', selector: [$class: 'StatusBuildSelector', stable: false], target: '/opt/pass/bin'])
}
}</pre>
實(shí)現(xiàn)類為ArtifactArchiverStep
- 循環(huán)
<pre class="lang:default decode:true ">node('suren') {
def dev_path = '/opt/suren/bin'
def services = [
[
'name': 'admin',
'project': 'admin',
'port': '7002',
'jarName': 'admin'
]
];
stage('Copy Artifact') {
for(service in services){
step([$class: 'CopyArtifact', fingerprintArtifacts: true, flatten: true,
projectName: service.project,
selector: [$class: 'StatusBuildSelector', stable: false],
target: dev_path + '/' + service.name
])
}
}
stage('Stop Service') {
for(service in services){
sh 'fuser -n tcp -k ' + service.port + ' > redirection &'
}
}
stage('Start Service') {
for(service in services){
sh 'cd ' + pass_bin + '/' + service.name + ' && nohup nice java -server -Xms128m -Xmx384m \
-jar ' + service.jarName + '.jar \
--server.port=' + service.port + ' $> initServer.log 2>&1 &'
}
}
}</pre>
上面的例子藤违，展示了如何在jenkins pipeline中調(diào)用循環(huán)語句浪腐，實(shí)現(xiàn)批量操作。
- 參數(shù)化構(gòu)建
<pre class="lang:default decode:true ">properties([[$class: 'JobRestrictionProperty'],
parameters([run(description: '',
filter: 'ALL',
name: 'Name',
projectName: 'Project')]),
pipelineTriggers([])]
)</pre>
- 并行
<pre class="lang:default decode:true">node {
stage('Start Service') {
parallel 'test': {
echo 'test'
}, 'deply': {
echo 'deply'
}
}
parallel 'one' : {
stage('one') {
echo 'one'
}
}, 'two' : {
stage('two') {
echo 'two'
}
}
}
parallel 'one': {
node{
stage('one') {
echo 'one'
}
}
}, 'two': {
node {
stage('two') {
echo 'two'
}
}
}</pre>
Jenkins的流水線同時(shí)支持節(jié)點(diǎn)（node）顿乒、階段（stage）和步驟（step）之間的并行執(zhí)行议街。如果多個(gè)節(jié)點(diǎn)并發(fā)執(zhí)行的話，并發(fā)數(shù)量會(huì)少于當(dāng)前可用的執(zhí)行器（exector）數(shù)量璧榄。
- 超時(shí)
<pre class="lang:default decode:true">node {
stage('stage2') {
timeout(time: 600, unit: 'SECONDS') {
sleep 20
echo '2'
}
}
}</pre>
遇到可能執(zhí)行時(shí)間會(huì)比較長的情況特漩，可以通過超時(shí)來約定最長的執(zhí)行時(shí)間。
對(duì)應(yīng)的實(shí)現(xiàn)類為TimeoutStep骨杂。
下面介紹的函數(shù)在插件workflow-durable-task-step-plugin中涂身，版本信息如下：
<pre class="lang:default decode:true "><groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-durable-task-step</artifactId>
<version>2.18-SNAPSHOT</version></pre>
- 工作空間
當(dāng)你希望在一個(gè)流水線中，對(duì)多個(gè)工程（例如git工程）做構(gòu)建以及部署等操作搓蚪，如果不切換工作空間的話就會(huì)發(fā)生代碼錯(cuò)亂的問題蛤售。你可以參考下面的示例代碼來解決這個(gè)問題：
<pre class="lang:default decode:true crayon-selected">node{
stage('suren'){
ws('suren-a-work') {
pwd
}
ws('suren-b-work') {
pwd
}
}
}</pre>
實(shí)現(xiàn)類為WorkspaceStep，使用final修飾妒潭，無法擴(kuò)展悴能。
- 執(zhí)行節(jié)點(diǎn)
Jenkins里可能會(huì)配置很多節(jié)點(diǎn)（node），而不一定所有的節(jié)點(diǎn)都滿足你的構(gòu)建環(huán)境要求雳灾，這時(shí)候就需要來指定節(jié)點(diǎn)了：
<pre class="lang:default decode:true ">node('local') {
echo 'hello'
}
properties([
buildDiscarder(
logRotator(
artifactDaysToKeepStr: '',
artifactNumToKeepStr: '',
daysToKeepStr: '5',
numToKeepStr: '10'
)
),
pipelineTriggers([
cron('H 3,12,17 * * *')
])
])</pre>
上面的pipeline指定了運(yùn)行節(jié)點(diǎn)的label為local漠酿。
實(shí)現(xiàn)類為ExecutorStep，使用final修飾谎亩，無法擴(kuò)展炒嘲。
- 異常捕獲
<pre class="lang:default decode:true">node{
stage('suren'){
try{
trigger
}catch(error){
echo error.getMessage()
}
}
}</pre>
這里調(diào)用了一個(gè)不存在的流水線函數(shù)，然后使用catch來捕獲并打印錯(cuò)誤信息匈庭。
- 遠(yuǎn)程調(diào)試
安裝環(huán)境：
sudo apt-get install -y npm
jenkins-pipeline --file test.groovy --url http://localhost:8080/jenkins/job/MyJob --credentials admin:123456
-
參考
http://cloud.spring.io/spring-cloud-pipelines/
本文為原創(chuàng)摸吠，如果您當(dāng)前訪問的域名不是surenpi.com，請(qǐng)?jiān)L問“素人派”嚎花。
