テストタグを作成する

テストタグでリンクを付けるテストクラスとテストメソッドの命名規則を次のように決めます。

テストクラス名は、テストする対象のクラス名の前に「Test」をつけた名前とします。テストメソッド名はテスト対象のメソッド名の1文字目を大文字にし、直前に「test」をつけた名前とします。

例えば、テストする対象のクラスが「Sample」クラスだとすると、テストクラスは「TestSample」クラスになります。また、テストする 対象のメソッドが「getSomething」メソッドだとすると、テストメソッドは「testGetSomething」メソッドになります。

さらにテストメソッドには、名称の後にさらに文字列を加えてもよいこととします。つまり「GetSomething」メソッドの場合、「testGetSomethingRed」メソッドもテストメソッドになります。

テストタグを使ってリファレンスドキュメントを作成したイメージは、次のようになります。


⁄**
* @test
*/
public class Sample {
    ⁄**
     * カスタムタグを利用するメソッド。
     * @spec test.xls
     * @spec.chapter 2
     * @spec.chapter 3
     * @spec.id 100
     * @spec.id 101
     * @spec.id 102
     * @spec.id 103
     * @spec.id 104
     * @test
     */
    public void getSomething() {}
}

リファレンスドキュメント
図1:リファレンスドキュメント
(画像をクリックすると別ウィンドウに拡大図を表示します)

開発環境

「第2回:『どんなシステムを作るのか』をJavadocで表現する」と同様、カスタムタグを作るための環境を以下のように想定して進めます。異なる場合は適宜読み替えてください。


OSMicrosoft Windows XP SP2
JDKJava SE 6
表2:開発環境

なお、Java SE 6については下記のURLよりダウンロードできます。




JDKはCドライブ直下の"C:\java"にインストールしておきます。

今回のテストタグ作成プロジェクトのルートディレクトリは「C:\projects\LinkTestTagletProject」とします。また、今回のプロジェクトでは、前回作成した仕様書タグのjarパッケージをあわせて利用します。


spec仕様書を置くディレクトリ
srcソースコードを置くディレクトリ
testテストコードを置くディレクトリ
lib利用するjarパッケージを置くディレクトリ
classesソースコードをコンパイルしてできたクラスファイルを置くディレクトリ
javadocソースコードを元に作成したリファレンスドキュメントを置くディレクトリ
表3:ディレクトリ構成

カスタムタグに必要なメソッド

テストタグは「TestTaglet」クラスとして実装します。このクラスは、前回と同様に 「com.sun.tools.doclets.Taglet」インターフェースを実装します。実装のメインとなる「toString(Tag)」メソッ ドがテストタグの書かれた位置を判断し、テストクラスやテストメソッドへのリンク文字列を返します。

Antのビルドプロセスに組み込む

前回作ったAntのビルドファイルを使うことで、Antの削除タスクやコンパイルタスク、jarパッケージングタスク、javadocタスクを連続で実行できます。これを利用するには、ビルドファイルにあるjavadocタスクのTagletエレメントに、今回作成するテストタグの設定を追加しま す。




  
    
    
      
    

  



   さらにコンパイルタスクの対象に、テストコードを含めます。





テストタグの実装ではJavaのリフレクションを使用しています。リフレクションでテストクラスをロードし、テストクラスとテストメソッドの情報を取得しています。

プロパティファイルにはテストコードを置くディレクトリの設定を追加します。

人気記事トップ10

人気記事ランキングをもっと見る

企画広告も役立つ情報バッチリ! Sponsored

サーバやOSの保守期限、VMware環境の見直しといった節目に考える、Oracle AI Databaseの次期基盤。オンプレ継続・AWS・OCIそれぞれの特性と留意点を整理するWebセミナー 11月19日 16:00 AIエージェントの“見えないリスク”に備えてアイデンティティを「関係」で統制する 11月17日 6:25 AI生成コードをどう安全に使うか――決定論的検証とAutoFixで築く品質保証ワークフロー 11月16日 6:30 デジタル主権時代、データとモデルの持ち方は企業が主体的に定める 11月13日 6:25 ClickHouse Cloudが実現した広告運用SaaS「ATOM」のデータ基盤革新、パフォーマンスを向上しながら、運用負荷とコストを削減 11月11日 6:20 AIで開発が加速する時代、品質保証はどう変わる? Tricentisが示すAIエージェント活用の実像 11月9日 6:45 悪用までの猶予が「1分」に迫るフロンティアAI時代に開発と本番を貫く脆弱性管理が必要 10月29日 8:30 欧州CRA対応とSBOM運用。AI生成コードのOSS混入問題の対策とは ――スニペット単位で検出する「FossID」「Insignary Clarity」によるSBOM運用 9月16日 6:40 PostgreSQLからTiDBへ、稼働中SaaSで進める段階的DB移行の実践と再設計への展望 9月7日 6:30 機能安全開発におけるGoogleTestの活用を支援!「Parasoft C/C++test CT」で実現する効率化&AI連携 4月14日 6:30