Jenkins DSL

一、什么是 Jenkins DSL？

DSL（领域特定语言），指专用于某一特定应用领域的计算机语言，Jenkins Pipeline 其实就是一门专门用于 Jenkins 的 DSL，除此外 SQL、HTML、CSS、RE 正则表达式也都是 DSL

Jenkins DSL 是基于 Groovy 语言实现的一种 DSL（领域特定语言），它主要用于描述整条流水线是如何运行的，常见的流水线内容包括编译、打包、测试、输出测试报告等阶段（步骤）

OK，通过之前的学习，我们知道了 pipeline 真正 “做事” 的是步骤（Steps），例如：echo、sh 这两个步骤是 Jenkins Pipeline 内置步骤的两个，除此外还有非常多其他的步骤，除此外，我们还可以通过安装插件，来让 Pipeline 支持更多更丰富的步骤

已适配 Pipeline 的插件列表：https://github.com/jenkinsci/pipeline-plugin/blob/master/COMPATIBILITY.md

二、常用的 “步骤”

我们来看下实际工作常用的一些插件，在开始之前，贴两个地方可以辅助学习各种 “Steps” 的地址

步骤参考文档：https://jenkins.io/doc/pipeline/steps/，可以通过 “步骤” 关键字反向查到 “插件”
流水线语法：http://ip/job/pipeline-deemo/pipeline-syntax/

2.1 readJSON

依赖 Pipeline Utility Steps 插件，插件提供数十个 “步骤”，其中仅 read* 就包括：

readCSV：从文件或字符串中中读取 CSV 数据
readJSON：从文件或字符串中中读取 JSON 数据
readManifest：读取 Jar 文件的 Manifest 信息
readMavenPom：读取 POM 文件
readProperties：从文件或字符串中中读取 Properties 数据
readYaml：从文件或字符串中中读取 Yam l数据

更多示例：https://www.jenkins.io/doc/pipeline/steps/pipeline-utility-steps/#pipeline-utility-steps

用于从读取 JSON 文件或 JSON 字符串，使用示例：

// 解析 JSON
def props = readJSON file: 'dir/input.json'
def props = readJSON text: '{ "key": "value" }'

// 获取使用
assert props['key'] == 'value'
assert props.key == 'value'

2.2 withCredentials

withCredentials 用于获取使用 Jenkins 服务器中的凭证，如下所示：

使用 Username/Password 类型的凭证

node {
    withCredentials([usernamePassword(credentialsId: 'gitee-account', passwordVariable: 'PASSWORD', usernameVariable: 'USERNAME')]) {
        // 在 withCredentials 内定义使用 用户名/密码 的执行逻辑
        println("Username: ${USERNAME}")
        // println 不会回显明文密码
        println("Password: ${PASSWORD}")
    }
}

2.3 checkout

checkout 依赖插件 Pipeline: SCM Step，它主要用来从 Git、SVN 等版本管理服务拉取仓库数据，示例如下：

node {
  // branches 为参与构建的分支
  checkout([$class: 'GitSCM', branches: [
    [name: '*/master'],
    [name: '*/develop'],
    [name: '*/stage']
  ], extensions: [], userRemoteConfigs: [
    [credentialsId: 'gitee', url: 'git@gitee.com:l0tusch1ng/jenkins-demo1.git']
  ]])
}

执行效果

Running on build-server-aliyun-ecs-01 in /opt/jenkins/workspace/checkout-demo1
[Pipeline] {
[Pipeline] checkout
Selected Git installation does not exist. Using Default
The recommended git tool is: NONE
# 使用自定义的 SSH Credentials
using credential gitee
# Clone 远程仓库
Cloning the remote Git repository
Cloning repository git@gitee.com:l0tusch1ng/jenkins-demo1.git
 > /usr/bin/git init /opt/jenkins/workspace/checkout-demo1 # timeout=10
Fetching upstream changes from git@gitee.com:l0tusch1ng/jenkins-demo1.git
 > /usr/bin/git --version # timeout=10
 > git --version # 'git version 1.8.3.1'
using GIT_SSH to set credentials 
 > /usr/bin/git fetch --tags --progress git@gitee.com:l0tusch1ng/jenkins-demo1.git +refs/heads/*:refs/remotes/origin/* # timeout=10
Avoid second fetch
 > /usr/bin/git config remote.origin.url git@gitee.com:l0tusch1ng/jenkins-demo1.git # timeout=10
 > /usr/bin/git config --add remote.origin.fetch +refs/heads/*:refs/remotes/origin/* # timeout=10
Seen branch in repository origin/master
Seen 1 remote branch
 > /usr/bin/git show-ref --tags -d # timeout=10
Checking out Revision 604354ab5db5b3c894794068d8c985506cc88f77 (origin/master)
 > /usr/bin/git config core.sparsecheckout # timeout=10
 > /usr/bin/git checkout -f 604354ab5db5b3c894794068d8c985506cc88f77 # timeout=10
Commit message: "update Dockerfile."
First time build. Skipping changelog.
[Pipeline] }
[Pipeline] // node
[Pipeline] End of Pipeline
Finished: SUCCESS

查看工作目录

$ ls /opt/jenkins/workspace/checkout-demo1
Dockerfile  Jenkinsfile  README.en.md  README.md

OK，通过 SSH 协议拉取 Git 仓库实验完成~

2.4 publishHTML

publishHTML 依赖于 HTML Publisher plugin 插件，主要用来展示单元测试、自动化测试等阶段产生的 HTML 报告

示例如下：

node {
  publishHTML([allowMissing: false, alwaysLinkToLastBuild: false, keepAll: false, reportDir: './report', reportFiles: 'index.html', reportName: 'HTML Report', reportTitles: '测试报告'])
}

2.5 input

input 依赖 Pipeline: Input Step 插件，主要用来在流水线的某个阶段让人工介入处理

示例如下：

pipeline {
    agent any
    stages {
        stage('pre-deploy') {
            steps {
                script {
                      def approvalMap = input id: 'Deploy-verify-input', message: '准备发布哪个环境？', ok: '确定', parameters: [choice(choices: ['DEV', 'PROD', 'STAGE', 'TEST'], description: '发布到什么环境？', name: 'DEPLOY_ENV')], submitter: 'admin,release-group', submitterParameter: 'DEPLOY_APPROVER'
                      println(approvalMap)
                      println("发布环境：${approvalMap.DEPLOY_ENV}")
                      println("批准用户：${approvalMap.DEPLOY_APPROVER}")
                }
            }
        }
    }
}

执行效果

2.6 BuildUser

BuildUser 是 wrap 步骤中的一个类，wrap 步骤依赖 Pipeline: Basic Steps 插件及 build user var 插件，主要用来获取执行流水线构建的用户信息，例如：BUILD_USER、BUILD_USER_ID、BUILD_USER_EMAIL等

示例如下：

wrap([$class: 'BuildUser']) {
    echo "构建用户：${BUILD_USER}"
    echo "构建用户 ID：${BUILD_USER_ID}"
    echo "构建用户 Email：${BUILD_USER_EMAIL}"
}

执行效果

2.7 HttpRequest

// 引入之前写的共享库，给输出文本加点颜色
@Library('shareLibraryDemo')
// 基于 utils 实例化一个 util_tools 对象
def util_tools = new org.devops.utils()

pipeline {
    agent any
    stages {
        stage('http-demo') {
            steps {
                script {
                    // 注意：consoleLogResponseBody 为 false 时响应体为 null
                    def response = httpRequest consoleLogResponseBody: true, contentType: 'APPLICATION_JSON_UTF8', acceptType: "APPLICATION_JSON", responseHandle: 'NONE', url: 'https://jsonplaceholder.typicode.com/todos/1', wrapAsMultipart: false
                    def data = readJSON text: "${response.content}"
                    util_tools.PrintColorMsg("标题: ${data.title}", "blue")
                    util_tools.PrintColorMsg("用户ID: ${data.userId}", "blue")
                }
            }
        }
    }
}