Jenkinsビルドのパラメータ化

Jenkinsの実行時に変数を指定できる機能として、Parametarized Buildがあります。コマンドの引数など一部の引数が異なるビルドを複数作る際に便利です。

ビルドのパラメータ化の概要は以下のとおりです。

  • 各ジョブの「設定」画面の「ビルドのパラメータ化」をチェックONすると、パラメータを定義できる
    • パラメータには型を指定する。コマンド引数を想定すると、文字列型がオーソドックス
    • 「名前」はPipelineスクリプト(Jenkinsfile)から参照する変数名。flagという名前をつけた場合、pipelineからはenv.flagという変数で参照できる
    • 「デフォルト値」は変数の値。実行時に書き換えて変更も可能
  • パラメータを設定したジョブは、「ビルド」が「パラメータ付きビルド」に変わり、実行前にパラメータ確認画面が増える
  • リモートビルドのURLも変わる

Pipelineのif判定の際の利用

パラメータ化したからにはpipelineで条件判定に活用するケースが出てきます。構造はifブロックで良いのですが、以下のコードは想定した挙動にならないことがあります。

if( env.parameter ) {
  // execute when truthy
}

たとえば、このparameterが文字列型の際、画面上の設定が空欄だった場合にもifブロックは実行されます。以下のように型キャストすると空文字列はfalseと評価され、ブロックの実行はスキップされます。

if( env.parameter as Boolean ) {
  // execute when truthy
}

これはgroovyの言語仕様によりますが、ほかにも数値の0などもBooleanキャストでfalseになるようです。

また、真偽値(boolean)型のパラメータはチェックボックスで指定するのですが、あろうことかfalseの値が文字列’false’です。

よって、trueのみ実行するifブロックの書き方は以下のようになります。

if( env.parameter == 'true' ) {
  // execute when string 'true'
}

パイプラインから別ジョブ呼び出し

Jenkinsのpipelineから、build()ステップを利用すると登録済みの別ジョブを実行できます。パラメータ付きビルドできるジョブを作成しておくと、ライブラリとして再利用可能になります。

build()は以下のような書式で利用します。

build(job: "job_name", parameters: [string(name: "var1", value: "some_value")])

jobは登録済みのジョブ名、parametersは配列形式でstring()を複数指定可能です。string()以外のパラメータ型も存在していますが、動作しない可能性があります。たとえばファイル渡しが動作しないため、想定するジョブ連携をうまく作れないケースもありそうです。

また、パラメータに指定する変数はあらかじめ呼び出されるジョブに登録しておく必要があり、未登録の場合、値がnullになります。

ノード設定にも注意

別ジョブ呼び出しでは、呼び出し元が待機したままジョブを起動するため、少なくとも2つジョブを実行できる必要があります。
ノード上で同時実行可能なジョブ数を1つに制限している場合、デッドロックして完了しなくなるため設定変更が必要です。

⁋ 2020/08/20↻ 2020/08/31