MalingLists

project.xmlに記述してある<mailingLists>の内容を元に、メーリングリストの一覧を出力します。<mailingLists>は複数の<mailingList>を含むことができます。JUnitの場合はメーリングリストにMailmanを使用しています。MailmanはWebインターフェースでメーリングリストへの登録/解除ができるため、<subscribe>、<unsubscribe>にはメールアドレスは記述せずに、<archive>にMailmanのURLを設定しています。

<mailingLists>の設定例:

<mailingLists>
  <mailingList>
    <name>junit-announce</name>
    <!-- 本来はここに subscribeできるアドレスを指定 -->
    <subscribe/>
    <!-- 本来はここに unsubscribeできるアドレスを指定 -->
    <unsubscribe/>
    <archive>http://lists.sourceforge.net/lists/listinfo/junit-announce</archive>
  </mailingList>
</mailingLists>

Project Team

project.xmlに記述してある<developers>の内容を元に、開発メンバーのレポートを生成します。JUnitの場合は、Sourceforgeのメンバー情報から値を指定しています。 [5]

<developers>の設定例:

<developers>
  <developer>
    <id>egamma</id>
    <name>Eric Gamma</name>
    <organization>The IBM Ottawa Lab</organization>
    <email>egamma@users.sourceforge.net</email>
    <roles>
      <role>developer</role>
    </roles>
  </developer>

  [...]

</devepers>

Dependencies

project.xmlに記述してある<dependencies>の内容を元に、依存するライブラリに関するレポートを生成します。JUnitの場合は依存ライブラリが存在しないため未設定です。

Source Repository

project.xmlに記述してある<repository>の内容を元に、ソースコードの構成管理システムのリポジトリに関するレポートを生成します。現状ではCVS(cvs, pserver, ext)と、Starteam、Subversionに対応しています。JUnit の場合は開発者用のリポジトリアクセスは不明なので、<connection>のみ設定してあります。<url>は ViewCVS のリンクを設定しておきます。

<repository>の設定例:

<repository>
  <connection>scm:cvs:pserver:anonymous@cvs.sourceforge.net:/cvsroot/junit:junit</connection>
  <developerConnection/>
  <url>http://cvs.sourceforge.net/viewcvs.py/junit/junit/</url>
</repository>

<connection>内容は次のようになっています。

scm:[SCMソフトウェア名]:[アクセス方法]:[ユーザID]@[ホスト名]:[リポジトリパス]:[モジュール名]

Issue Tracking

project.xmlに記述してある<issueTrakingUrl>の内容を元に、問題追跡システムに関するレポートを生成します。現在のMavenでは残念ながら & のような実体参照が必要な記号を含むURLをissueTrackingUrlに使用することができません。JUnitのバグ管理システムはSourceForgeのBTSを使用しているため、URLに & を含んでしまいます。今回はURLを設定するのはやめておきます。 [6]

Metrics

JDepend を使用した、パッケージ、クラス間の依存度レポートを表示します。オブジェクト指向の原則として高凝集、低結合や、循環依存の禁止などが挙げられます。JDependのレポートから、パッケージ毎の安定性、抽象度、循環依存の判定を読みとることができます。Summaryの項目の説明を以下に挙げておきます。

Summaryの項目一覧

JUnitの場合だと、junit.awtuiパッケージは距離が0%です。つまり抽象的ではなく、外部からも使われない独立したパッケージであると言えます。一方、junit.frameworkパッケージは距離が40%です。そこそこ抽象的で、外部から使われており、外部への依存度もそれほど高くない比較的安定したパッケージと言えます。

また、循環依存に関しては、 Cycles に一覧されるので、一目でわかるようになっています。

Checkstyle report

非常に有名なコーディングスタイルチェッカーである Checkstyle を使用したスタイルチェックのレポートを生成します。Checkstyleは、単体でもAntやEclipseプラグインを使用してのチェックが可能です。EclipseプラグインとMavenを併用することで、プロジェクト全体としてスタイルの統一化を徹底することができます。デフォルトではCheckstyleのコーディングルールは sun のコーディングスタイルになっています。独自定義のコーディングスタイルを使用したい場合には、project.properties で maven.checkstyle.properties にカスタイマイズしたCheckstyleの設定ファイルを指定します。

Change Log

SCMの変更履歴を取得して、最新更新順でリスト表示します。更新履歴には「日付」、「作者」、「対象ファイル」、「コミットログ」が記載されているので、いつ誰が何をコミットしたかが一目でわかります。また、 project.xmlの中で、<repository>の<url>を指定していれば、ファイルやバージョンからViewCVSのサイトへのリンクが貼られます。デフォルトでは変更履歴の表示期間は30日以内の変更に限られています。この期間を変更する場合には、project.propertiesに maven.changelog.range=日数 を追加します。サンプルでは730日(２年)を指定しています。

Developer Activity

Change LogがSCMの更新履歴をそのままに表示しているのに対して、こちらは開発者に着目した更新情報のレポートです。SCMの更新履歴を元に、開発者毎にコミットしたファイル数、変更したファイル数を集計、ソートして表示します。開発者名から Project Info - Project team へのリンクが貼られています。こちらもデフォルトでは30日以内の変更のみ扱います。変更したい場合には、project.properties に maven.activitylog.range=日数 を追加します。

File Activity

こちらのレポートはファイルに着目した更新情報のレポートです。SCMの更新履歴を元に、変更された回数が多い順にファイルをソートして表示します。ファイル名からViewCVSへのリンクが貼られています。こちらもデフォルトでは30日以内のファイルの変更のみ扱いますので、変更したい場合はDeveloper Activity と同様に mavne.activitylog.range=日数 を追加します。

Project License

こちらはプロジェクトのライセンス情報を表示します。オープンソースプロダクトではライセンスは非常に重要ですが、SIなどの開発では設定する必要はないことが多いでしょう。

JavaDocs

javadocコマンドを使用してJavaDocを生成したものです。他のレポートとは異なり、Mavenで生成したサイトレポートとは別ウィンドウで表示されます。

JavaDoc Report

javadocコマンドの実行中のログを表示します。 これはjavadoc生成中にエラーや警告がなかったかどうかをチェックするのに有効です。 maven.docs.outputencoding を指定しないと日本語版j2sdkを使用している場合に文字化けします。

Source Xref / Test Xref

ソースコードのクロスリファレンスを生成します。Javadocと同じレイアウトで、HTML化、ソースコードの色分け、行番号を付加して、各クラス、インターフェースへのリンクを作成します。クロスリファレンスから、同じMavenで生成したJavadocへもリンクできるため、ソースコードを広く見たい場合には、EclipseなどのIDEよりも便利かもしれません。jxrというプラグインにより生成されます。

Source Xref、Test Xrefは各<sourceDirectory>、<unitTestSourceDirectory>で指定しているディレクトリ配下のソースを対象とします。今回のJUnitの場合は、プロダクトコードとテストコードが同一パッケージツリーに存在しているため、混在しています。

UnitTests

JUnitReportはJUnitによる単体テストの実行結果をレポートとして生成します。AntとJUnitで生成できるJUnitReportとはフレームを使わないで、1枚のHTMLとして生成する点が異なります。対象となるテストは <unitTestSourceDirectory> で指定したディレクトリを起点として、配下ディレクトリ全てを対象とします。デフォルトでは *Test.java ファイルが対象となります。対象のテストファイルを指定したい場合には、project.xmlに <unitTest> を設定してフィルタをかけます。フィルタの設定はAntの指定とほぼ同じです。

テストクラスのフィルタ:

<unitTest>
   <includes>
     <include>**/*Test.java</include>
   </includes>
   <excludes>
     <exclude>**/*Tests.java</exclude>
   </excludes>
 </unitTest>

Link Check Report

Javadocに含まれるハイパーリンクのリンク切れチェックを実施してレポートを生成します。

Task List

ソースコードのJavadocコメント内の特定のタグ(デフォルトでは@todo)を一覧表示します。Eclipseのでタスク・タグで「@todo」を設定しておけば、Eclipseのタスクと同期がとれるようになります。対象のタグを変更したい場合は project.properties で maven.tasklist.taskTag を設定します。