Jenkins 2 如何建立 Pipeline job

Pipeline 是 Jenkins 2 的一大特色，其概念就是將建置流程步驟透過 DSL(Domain-Specific Languages) 來定義與描述，使用的語法是 groovy，但如果只為了 build job 而刻意學 goovy 個人擔心學完不常用很快就忘，實際上我只用基本語法來完成 Pipeline 的工作，因此本文關於 groovy 語法的部份只會帶過而已。

本文的另個重點，將會使用 Jenkins 2 搭配 PowerShell 與 robocopy 來完成持續性部署 (Continuous Deployment) 的自動化作業。

使用情境

checkout source code and build
停止網站 or windows service
程式部署
啟動網站 or windows service

實際做法

checkout source code and build
- 可以參考如何使用 Jenkins 2 建置 .NET 專案來建立 build job, 這邊就不重複贅述
- 需要注意的是 build 參數要加上 publish 設定後面才可以進行部署
```
/p:DeployOnBuild=True /p:DeployDefaultTarget=WebPublish /p:WebPublishMethod=FileSystem /p:DeleteExistingFiles=True /p:publishUrl={filepath}
```

停止網站 or windows service

建立 StopWebSite 的 freestyle project
使用參數化建置
- 加入 string 參數來表示目標 server
- 加入 string 參數來表示欲停止的 IIS 網站名稱

使用 PowerShell 來停止 website

5ps

記得安裝 PowerShell plugin (沒裝過的可以參考 Jenkins 2 如何使用 PowerShell 以及自定 build fail (指定 exit code))

加入一個 build step 使用 Windows PowerShell

if ( Invoke-Command -ComputerName  $env:serverIP -ScriptBlock { (Get-WebAppPoolState -Name $args[0]).Value -eq "Started" } -argumentlist $env:siteName)
{
    Invoke-Command -ComputerName $env:serverIP -ScriptBlock { Stop-WebAppPool -Name $args[0] } -argumentlist $env:siteName
}
            
do
{
    Invoke-Command -ComputerName $env:serverIP -ScriptBlock { Stop-WebAppPool -Name $args[0] } -argumentlist $env:siteName
    Start-Sleep -Seconds 1
}
until ( Invoke-Command -ComputerName  $env:serverIP -ScriptBlock { (Get-WebAppPoolState -Name $args[0]).Value -eq "Stopped" } -argumentlist $env:siteName  )

在 Windows PowerShell 要取用定義在 Jenkins 的變數，記得在變數前面加上 $env:

程式部署

建立 DeployWebSite 的 freestyle project
使用參數化建置
- 加入 string 參數來表示部署來源位置
- 加入 string 參數來表示部署目標位置

使用 PowerShell 與 robocopy 來複製檔案

Try
{
    $lasterror=robocopy $env:SourceFolder $env:DestinationFolder *.* /E /MT /purge
}
Catch
{
    write-output "get data fail!"
    exit 1
}
if($lasterror -le 7)
{
 exit 0
}

需要注意的是 robocopy 的 exit code

exit code	說明
0	沒有錯誤，也沒有複製任何檔案，來源與目標已同步
1	檔案已成功複製
2	偵測到目標有額外檔案(檔案比來源目錄還多)
4	檔案或是資料夾不一致
8	檔案或是資料夾無法被複製(複製出錯且重試次數過多)
16	錯誤，無法複製任何檔案(使用方法錯誤或是權限不足)

啟動網站 or windows service

建立 StartWebSite 的 freestyle project
使用參數化建置
- 加入 string 參數來表示目標 server
- 加入 string 參數來表示欲停止的 IIS 網站名稱
使用 PowerShell 來啟動 website

步驟跟 停止網站 or windows service 一樣，只是換成啟動

if ( Invoke-Command -ComputerName  $env:serverIP -ScriptBlock { (Get-WebAppPoolState -Name $args[0]).Value -eq "Stopped" } -argumentlist $env:siteName)
{
    Invoke-Command -ComputerName $env:serverIP -ScriptBlock { Start-WebAppPool -Name $args[0] } -argumentlist $env:siteName
}
            
do
{
    Invoke-Command -ComputerName $env:serverIP -ScriptBlock { Start-WebAppPool -Name $args[0] } -argumentlist $env:siteName
    Start-Sleep -Seconds 1
}
until ( Invoke-Command -ComputerName  $env:serverIP -ScriptBlock { (Get-WebAppPoolState -Name $args[0]).Value -eq "Started" } -argumentlist $env:siteName  )

建立 Pipeline job

建立 TestPipeline 的 Pipeline 專案
建立使用其他 build job 時需要的參數

撰寫 pipeline script

逐步定義步驟
1. BuildProject
2. StopWebSite
3. Deploy
4. StartWebSite

給定參數

8para

需要指定參數型態
指定參數名稱

指定參數值

node {
stage ('BuildProject') {
    build job: 'TestDotNetProject'
}
stage ('StopWebSite') {
    build job: 'StopWebSite', parameters: [[$class: 'StringParameterValue', name: 'serverIP', value: params.serverIP],[$class: 'StringParameterValue', name: 'siteName', value: params.siteName]]   
}    
stage ('Deploy') {
    build job: 'DeployWebSite', parameters: [[$class: 'StringParameterValue', name: 'SourceFolder', value: params.SourceFolder],[$class: 'StringParameterValue', name: 'DestinationFolder', value: params.DestinationFolder]]   
}
stage ('StartWebSite') {
    build job: 'StartWebSite', parameters: [[$class: 'StringParameterValue', name: 'serverIP', value: params.serverIP],[$class: 'StringParameterValue', name: 'siteName', value: params.siteName]]   
}
}

Build

執行 build (給定參數)
逐步執行

文章目錄