Jenkins Declarative Pipeline Examples

背景

Jenkins Pipeline 非常强大，其中 Jenkins Declarative Pipeline 声明式的语法又比较友好。下面记录的都是用 Pipeline 实现一些功能。

示例

拉取 Git 仓库代码

pipeline {
  agent {
    label "master"
  }
  stages {
    stage ("checkout code") {
      steps {
        git branch: "master",
          credentialsId: "xxx-xxx-xxx-xxx",
          url: "https://github.com/xxx/xxx.git"
      }
    }
  }
}

执行 shell 命令

pipeline {
  agent {
    label "master"
  }
  stages {
    stage ("run shell commands") {
      steps {
        sh "npm run install"
        sh "./run.sh param"
      }
    }
  }
}

跳转到特定的目录执行命令

1.直接 shell 命令跳转到某个目录

pipeline {
  agent {
    label "master"
  }
  stages {
    stage ("run command in directory") {
      steps {
        sh "cd ./directory"
        sh "npm run start"
      }
    }
  }
}

2.用 Pipeline 的特定语法

pipeline {
  agent {
    label "master"
  }
  stages {
    stage ("run command in directory") {
      steps {
        dir ("./directory") {
          sh "npm run start"
        }
      }
    }
  }
}

设置参数

1.选项

properties([
  parameters([
    choice(
      choices: ["a","b","c"],
      description: "name of project",
      name: "PROJECT"
    )
  ])
])

pipeline {
  agent {
    label "master"
  }
  stages {
    stage ("get project name") {
      steps {
        echo "You choose ${params.PROJECT} project."
      }
    }
  }
}

2.动态选项（动态获取 Git 仓库分支名列表）

properties([
  parameters([
    [
      $class: "CascadeChoiceParameter",
      choiceType: "PT_SINGLE_SELECT",
      description: "branch of git repository",
      filterLength: 1,
      filterable: false,
      name: "BRANCH_NAME",
      randomName: "xxx-xxx-xxx",
      referencedParameters: "PROJECT",
      script: [
        $class: "GroovyScript",
        fallbackScript: [
          classpath: [],
          sandbox: true,
          script: "return ['error']"
        ],
        script: [
          classpath: [],
          sandbox: true,
          script:
            '''
            def gettags = ("git ls-remote -t -h git@gitlab.lrts.me:fed/${PROJECT}.git").execute()
            return gettags.text.readLines().collect { 
              it.split()[1]
                .replaceAll(\"refs/heads/\", \"\")
                .replaceAll(\"refs/tags/\", \"\")
                .replaceAll("\\\\^\\\\{\\\\}", \"\")
            }
            '''
        ]
      ]
    ]
  ])
])

pipeline {
  agent {
    label "master"
  }
  stages {
    stage ("get branch name") {
      steps {
        echo params.BRANCH_NAME
      }
    }
  }
}

3.字符串参数

properties([
  parameters([
    string(
      defaultValue: "Nothing",
      description: "name of environment",
      name: "ENV_NAME",
      trim: true
    )
  ])
])

pipeline {
  agent {
    label "master"
  }
  stages {
    stage ("get environment name") {
      steps {
        echo params.ENV_NAME
      }
    }
  }
}

判断上一次构建到现在有没有代码变化

pipeline {
  agent {
    label "master"
  }
  stages {
    stage ("checkout code") {
      steps {
        script {
          scmVars = git branch: "master",
            credentialsId: "xxx-xxx-xxx-xxx",
            url: "https://github.com/xxx/xxx.git"
          nothingChanged = (scmVars.GIT_COMMIT == scmVars.GIT_PREVIOUS_SUCCESSFUL_COMMIT) ? "true" : "false"
        }
      }
    }
    stage ("check params") {
      steps {
        echo scmVars.GIT_COMMIT
        echo scmVars.GIT_PREVIOUS_SUCCESSFUL_COMMIT
        echo scmVars.GIT_BRANCH
        echo nothingChanged
      }
    }
  }
}

判断某个文件或目录是否存在

1.判断项目目录下是否存在 hello.txt 文件

pipeline {
  agent {
    label "master"
  }
  stages {
    stage ("check file exists") {
      steps {
        script {
          existed = fileExists "hello.txt"
          echo existed
        }
      }
    }
  }
}

发送邮件

1.发送默认邮件内容

pipeline {
  agent {
    label "master"
  }
  stages {
    stage ("send email") {
      steps {
        emailext body:
          '''
          <p>${DEFAULT_CONTENT}</p>
          ''',
        subject: '${DEFAULT_SUBJECT}',
        to: 'somebody@xxx.com'
      }
    }
  }
}

匹配控制台日志内容

1.匹配输出日志中的「ERROR」关键字

pipeline {
  agent {
    label "master"
  }
  stages {
    stage ("find text in console log") {
      steps {
        findText alsoCheckConsoleOutput: true,
          notBuiltIfFound: false,
          regexp: '^\\\\[ERROR\\\\]',
          succeedIfFound: false,
          unstableIfFound: false
      }
    }
  }
}

构建完成后结果处理

1.构建失败则发送邮件，且附上构建日志

pipeline {
  agent {
    label "master"
  }
  stages {
    stage ("build") {
      steps {
        sh "./build.sh"
      }
    }
  }
  post {
    success {
      echo "build success"
    }
    failure {
      echo "build failure"
      emailext body:
        '''
        <p>${DEFAULT_CONTENT}</p>
        <pre>${BUILD_LOG_REGEX, regex="^\\\\[Text Finder\\\\]", linesBefore=0, linesAfter=0, maxMatches=100, showTruncatedLines=true, escapeHtml=false}</pre>
        ''',
      subject: '${DEFAULT_SUBJECT}',
      to: 'somebody@xxx.com',
      attachLog: true
    }
  }
}

构建过程中触发其他 Jenkins 任务

pipeline {
  agent {
    label "master"
  }
  stages {
    stage ("trigger another build") {
      steps {
        build job: 'jobname',
          parameters: [
            string(name: 'PROJECT', value: 'project-name'),
            string(name: 'BRANCH', value: 'master'),
            string(name: 'ENV_NAME', value: 'production')
          ]
      }
    }
  }
}

其他操作

用 curl 从命令行触发 Jenkins 任务

1.使用 POST 请求

curl -X POST \
  https://JENKINS_URL/job/JOB_NAME/build \
  --user USER_ID:API_TOKEN \
  --data-urlencode json='{"parameter": [{"name":"param1", "value":"1"}, {"name":"param2", "value":"2"}, {"name":"param3", "value":"hello"}]}'

2.使用 GET 请求

curl 'https://USER_ID:API_TOKEN@JENKINS_URL/job/JOB_NAME/buildWithParameters?param1=1&param2=2&param3=hello'

用 Node.js 发起请求

const axios = require('axios')

const json = {
  parameter: [
    { name: 'param1', value: '1' },
    { name: 'param2', value: '2' },
    { name: 'param3', value: '3' }
  ]
}
const data = `json=${JSON.stringify(json)}`
const userpass = Buffer.from('<username>:<token>').toString('base64')
const Authorization = `Basic ${userpass}`
axios({
  url: 'https://<jenkins-url>/job/<job-name>/build',
  method: 'POST',
  data,
  headers: {
    Authorization,
    'Content-Type': 'application/x-www-form-urlencoded'
  }
})
  .then(result => {
    const { status, statusText } = result
    // do something here
  })
  .catch(err => {
    console.log(err)
  })

参考资料