StepCounterプラグインの紹介

このエントリは Jenkins Advent Calendar jp 2011 : ATND の最終日、25日目の分です。

今日は、私が作ったStepCounterプラグインを紹介します。

はじめに

このプラグインは、その名の通り、ステップ数を集計するプラグインです。
世の中にはステップ数を集計するツールはたくさんありますが、このプラグインの特徴は二点あります。

  1. Mavenなどのビルドツールが不要
  2. ソースの種別ごとに集計し、エンコードが指定できる

要するに、SVNとJenkinsがあれば使えて、Javaソース、Groovyソース、プロパティファイル等、種類ごとにステップ数が集計できる、というものです。

ちなみに、ステップ数の計測処理はhttp://amateras.sourceforge.jp/cgi-bin/fswiki/wiki.cgi?page=StepCounter:Project AmaterasのStepCounterを使わせていただいています。そのため、対応しているファイル形式もStepCounterと同じです。

使ってみる

では、Jenkins coreのソースをステップ数を集計してみます。

1. ジョブを作ります。

2. ソースを取得するGitやSVNの設定を行います。

3. StepCounterを有効にして、集計したいソース種別ごとに設定を行います。ソースの指定はAntと同じ形式で行うことができます。

4. ジョブの設定を保存し、実行します。実行ログは以下のように出力されます。

5. 集計結果はプロジェクトのトップに推移グラフとして表示されます。

6. また、詳細を「ステップ数」というリンクで見ることができます。

7. 詳細画面はこんな感じです。

ここではこのジョブを定期的に動かしていないため、推移が分かりませんが、毎日、あるいは毎週定期的にジョブを起動すれば、どのソースがどの程度増減したかが分かるようになります。

さいごに

今後は、以下の機能を追加していきたいと思っています。
-差分詳細の表示
-メール通知
-新しいファイル形式への柔軟な対応(今現在groovyは未対応でした)
-テキスト以外のファイル形式への対応(ExcelやWord)
-Excelへの出力
-メール通知の際の、Excel表添付
下の三つは年上の方への対策機能ですね・・・

Jenkinsのgithubにも公開しているので、使っていただければ幸いです