Developer's Blog

Jenkins がもっともっともっと便利になるプラグイン 8 つ

title

こんにちは、開発担当の松本です。

前々回
前回に引き続いて、
今回も Jenkins の便利プラグインをいくつか紹介します。

リストビューの表示内容を拡張する: Extra Columns

th_extracolumn1

名前や上の画像が示すように、リストビューに表示するカラム項目を拡張してくれるプラグインです。

プラグインインストール後に、ビューの変更のカラムに上記画像のような項目が追加されています。項目によっては設定も付いていたりします。

extracolumn2

プロジェクト説明や設定へのリンクなど小粋で便利なカラムが多いので入れておくと便利です。

リストビューをグループ化できる: Categorized Jobs View

cateview1

正規表現を用いたグループによって、リストビューの項目をまとめることができるプラグインです。

カテゴリビューを作成するには、プラグインをインストールした後に、新規ビュー作成ページで「Categorized Jobs View」を選択します。

cateview2

そして、ビューの設定の「Job group categorization」セクションで「Add new group rule」でルールを追加していくだけです。

cateview3

まとまったプロジェクト群で R50_ のようにサフィックスを付けている場合には、上記のようにすればグループができます。

なお、「Naming Rule」では「Regex for categorization」でのキャプチャの利用できたりしますので、うまく使うと楽にグルーピングできるかもしれません。

Jenkins の状態を監視する: Monitoring

monitoring1x

日々黙々と働く Jenkins さん。その体調を管理することは重要です。

というわけで、このプラグイン。JavaMelody によって、 Jenkins の状況をモニタリングできるようになります。

利用するためには、プラグインをインストールした後に /monitoring にアクセス (例えば、http://jenkins.example.com/monitoring) するだけです。

HTTP エラーやシステムエラーもさっと見ることができるようになります。

monitoring2x

ただモニタするだけでなく、GC を強制させることもできます。

monitoring3

Jenkins さんを酷使させていないか気になっている心優しい人は是非とも導入してください。

テキストファイルやコンソールログから文字列を検索してビルド結果に反映させる: Text-finder

textfinder1

以前に紹介した LogParser の、ログ色付け機能を無くしたかわりに、使いやすくしたようなプラグインです。

利用するにはプラグイン導入後に、プロジェクトの設定の「ビルド後の処理」セクションから「ビルド後の処理の追加」 → 「Jenkins Text Finder」で利用できます。

textfinder2

「Also search the console output」をチェックすれば LogParser 同様にコンソールログから指定した文字列を探して、発見したらビルド成功や失敗にできます。
また、コンソールログ以外にも、指定したファイルを対象にすることもできます。

ただし、複数の正規表現を扱うことができないので、その場合には LogParser のほうが便利かもしれません。

選択パラメータを拡張する: Extended Choice Parameter

choice1

パラメータ付きビルドで利用する「選択パラメータ」の機能拡張版です。

拡張された機能としてはまず、「ジョブ共有で使用できる選択パラメータ」が使えること。

これを設定するには、Jenkins の管理 → システム設定 → ジョブ共通で使用出来る選択パラメータ で選択パラメータを追加していきます。

choice2

上のように設定したものはプロジェクト設定の「ビルドのパラメータ化」から「拡張可能な選択」から指定できるようになります。

choice3

また、システム設定の「編集された値の追加を許可する」と、プロジェクト設定の「編集可能にする」と「編集された値を選択肢に追加する」の 3 つにチェックを入れておくと、編集した内容が自動で追加されて、次回から選択可能にすることもできます。

それ以外の機能としては、ファイルやフォルダを選択できるようになったりします。ディレクトリは $JENKINS_HOME からの相対パスを指定します。

choice4

また、スクリプト言語 Groovy を利用した項目の作成も可能です。

choice1

なお、似た名前のプラグインに Extended Choice Parameter がありますのでお間違えのないよう
(こちらも便利なプラグインです)。

リストビューを階層化できる: Nested View

先ほどの Categorized Jobs View よりもさらに細かく階層化したい方向けのプラグインです。

nestview1

利用するには、プラグインをインストールした後に、先ほどと同様に新規ビュー作成ページで「Nested View」を選択します。

nestview2

すると、作られた Nested View 内からさらにビューを追加することができるようになっています。

nestview3

ここでさらに Nested View を作ることもできますので、これによってビューを階層化することができます。

ただし、階層の把握がしづらいので、個人的には前述の Categorized Jobs View のほうが好みです。

プロジェクトのテストなどに利用できる: Fail The Build

fail1

プロジェクトで「不安定」などをビルドトリガにしているときに、それを確認するときに便利なプラグイン。

利用するには、プラグイン導入後にプラグイン設定のビルドセクションで Set the build result を追加するだけです。

fail2

「Cycle results」を選択した場合には「成功」→「不安定」→「失敗」→「中止」が繰り返し発生するようになります。それ以外にも、毎回失敗だけするビルドなどをつくることもできます。

プラグインを作成しているときなどの挙動を確認したいときにも使うと便利かもしれません。

URL ビルドで確認画面を出せる: Build With Parameters

URL ビルドのように URL 経由でアクセスできて、その際にパラメータの確認ページが表示されるようになるプラグインです。

parambuild

例えば、http://jenkins.example.com/job/R10_compile/parambuild?debug=true&option=foobar にアクセスした場合には上の画像のような確認ページが表示されます。

わざわざひと手間増やしただけのプラグインのようにも一見思えますが、それによってミスが減ったり、普段 Jenkins を利用しないような人でも簡単にアクセスできるようになったりと意外と使い途がありそうに思えました。

ただし、現バージョンでは、入れただけで全てのプロジェクトで使えるようになる上に、デフォルトのリモートビルドのような認証トークンも利用できないようですので、ご注意ください。

おわりに

プラグインは日々、変更や追加されていますのでたまにチェックするとより幸せになれるかもしれません。

Jenkins のプラグイン情報をツイートする bot もありますので必要な方はチェックしてみてください。

そして、お勧めのプラグインがあればぜひ紹介してください。

ソーシャルアカウント

フェンリルのオフィシャル Twitter アカウントでは、フェンリルプロダクトの最新情報などをつぶやいています。よろしければフォローしてください!

Copyright © 2019 Fenrir Inc. All rights reserved.