Jenkins Pipelineを試す

現在さまざまな方法でDevOps CI/CD環境を実現できます。そういった分野でJenkinsも使われてきました。

以前は私もJenkinsを使っていたものの最近触っていないなと思い触り始めたのですが、Jenkinsのバージョン2以降、Jenkins Pipelineという機能が追加されてJenkinsというとGUIでぽちぽち設定するものと思っていたのが割と最近の流行にのっているなと思い、色々調べてみることにしました。

Jenkins Pipelineの基本

Jenkinsは従来の方法でジョブを作成する「フリースタイルプロジェクト」を使う方法もありますが、「パイプライン」というものが追加されています。

パイプラインは次のような形式で作業を記述していくものです。まずは一番単純な例です。このパイプラインはPython 3.8を使って、Pythonスクリプトを実行するというジョブです。

pipeline {
    agent { label 'linux' }

    stages {
        stage('Tested with python 3.8') {
            steps {
                sh 'python3.8 /home/jenkins/test.py'
            } 
        }
    }
}

Jenkinsのダッシュボードから、「ビルド実行」をクリックすると、書いた処理が指定したマシンで実行されます。今回の例の場合、ノードに「linux」というラベルが含まれるマシンで処理が実行されます。

実行するここのような感じです。成功した、失敗したにかかわらずログを見ることができますので、安心ですね。

例えば一つのジョブで複数の作業をしたい場合、単純に「Stage」を追加するだけでよくなります。複数の「Stage」が含まれる「Stages」が正常に実行されるとジョブ成功、何らかの問題があればジョブ失敗になります。

pipeline {
    agent { label 'linux' }

    stages {
        stage('Tested with python 3.8') {
            steps {
                sh 'python3.8 /home/jenkins/test.py'
            }
        }
        stage('Tested with python 3.9') {
            steps {
                sh 'python3.9 /home/jenkins/test.py'
            } 
        }
    }
}

Slack側の設定も必要ですが、Jenkinsに「Slack Notification」を追加すると、パイプラインの成功可否をSlackで通知できます。設定次第ではメール通知も可能です。

パイプラインは次のように書くことができます。

pipeline {
    agent { label 'linux' }

    stages {
        stage('Tested with python 3.8') {
            steps {
                sh 'python3.8 /home/jenkins/test.py'
            }
            post {
                success {
                    slackSend(
                    message: "py38testは成功 (<${env.BUILD_URL}|Open>)",
                )
                }
                failure {
                    slackSend(
                    color: "#FF0000",
                    message: "py38testは失敗 (<${env.BUILD_URL}|Open>)",
                )
                }
            }
            
        }
        stage('Tested with python 3.9') {
            steps {
                sh 'python3.9 /home/jenkins/test.py'
            } 
            post {
                success {
                    slackSend(
                    message: "py39testは成功 (<${env.BUILD_URL}|Open>)",
                )
                }
                failure {
                    slackSend(
                    color: "#FF0000",
                    message: "py39testは失敗 (<${env.BUILD_URL}|Open>)",
                )
                }
            }
        }
    }
}

このようなパイプラインをスクリプトの入力ボックスに入力すれば、ジョブの設定完了です。