JUnitレポート - テスト方法の説明

Question

javadocsを使用してjunitレポートに「説明文」を含める方法があるかどうかを確認しようとしています。 JUnit 4はTestNGのように@Testアノテーションの 'description'属性をサポートしていないようです。

私が調査したところでは、javadoc-junit（http://javadoc-junit.sourceforge.net/）というツールが1つしかありません。しかし、これはJunit 4と互換性がないと思われるため、これを動作させることができませんでした。

JUnitレポートで、各テストメソッドに文または2つのテキストを入力する方法があります。 JavaDocは、JavaDocとJunit Reportの間でドキュメントやテストの統計情報を参照する必要があるため、JavaDocは役に立ちません。

誰も私が最小限の労力で使用できる何かを知っていますか？

ベスト、 レイ・J

Answer 1

私は、JUnitテストでjavadocを入れないでください。私は通常、メソッドの名前を十分記述的にすることで、私が思いつくことができるコメントと同じくらい、またはそれより優れています。

Answer 2

私は想像することができますが、Framework for Integrated Tests (FIT)は素晴らしく清潔な解決策になります。

FITとは何ですか？
FITは、Word文書、wikiテーブル、またはhtmlテーブルのテーブルを介してテストを記述するためのフレームワークです。
テーブル外のすべての文字はFITによって無視され、ドキュメント、説明、要件などを入力できます。

どのようにこれらの表のように見えるのですか？

入力パラメータを2乗する関数MyMath.square(int)を想像してください。あなたのMyMathと次の表の間のアダプタであること、いわゆるフィクスチャを構築する必要があります。

class.with.Fixture.Square 
x square() 
2 4 
5 25 

最初の列は入力値、第2の期待結果を記述しています。同じでない場合、このフィールドは赤色にマークされます。

フィクスチャーの外観はどうですか？与えられた例
、これは正しいフィクスチャのようになります。

package class.with.Fixture // Must be the same as in the fist row of the table 

public class Square extends Fixture { 
    public int x; // Must be the same as in the second row 
    public int square() { // Must be the same as in the second row 
     return MyMath.square(x); 
    } 
} 

おそらく、あなたはあなたの要件にFITを使用することができます。
詳細については、私の回答にコメントしたり質問を編集してください。

Answer 3

Allureという最近の解決策もあります。これは主にJavaベースのテスト実行レポートで、補足的な注釈をコードに追加することに基づいています。既存の注釈が含まれる：

• カスタム説明：@description機能やストーリーによって（ "クール試験"）
• グルーピング：@Features（{ "特長1"、 "特長2"}）、ステップとしてテストケース内で実行メソッドをマーキング@Stories（{ "story1"、 "story2"}）
• ：@Step（さえプライベートメソッドのために働く）
• 添付：@At tachment（名前= "ページのスクリーンショット"、タイプ= "画像/ PNG"）

が自分wikiとexample project詳細を参照してください。

Answer 4

JUnit 5には、すべてのテストに@DisplayNameという注釈を付ける方法があります。宣言されたテストクラスは、text,special charactersおよびemojisを持つことができます。

各テストで宣言されたテキストは、test runnersとtest reportsで表示されます。

---

Javadocは言う：

public @interface DisplayName

@DisplayNameは注釈付きテストクラスやテストメソッドのためのカスタム表示名を宣言するために使用されています。 表示名は、通常、IDEやビルドツールのテストレポートに使用され、スペース、特殊文字、さらには絵文字を含むことがあります。

そしてUser Guide：

import org.junit.gen5.api.DisplayName; 
import org.junit.gen5.api.Test; 

@DisplayName("A special test case") 
class DisplayNameDemo { 

    @Test 
    @DisplayName("Custom test name containing spaces") 
    void testWithDisplayNameContainingSpaces() { 
    } 

    @Test 
    @DisplayName("╯°□°）╯") 
    void testWithDisplayNameContainingSpecialCharacters() { 
    } 

    @Test 
    @DisplayName("") 
    void testWithDisplayNameContainingEmoji() { 
    } 
}