TMS リンクアノテーション
アノテーションは、コードに関するメタデータを含むコード内の特別なマーカーです。 TMS リンクアノテーションを使用して、テストに関する追加情報を提供できます。 これにより、IntelliJ IDEA はユニットテストを TMS アイテムにリンクできます。
TMS リンクアノテーションにより、IntelliJ IDEA はより優れた分析を実行できます。たとえば、単体テストからすでに参照されているテストケースを見つけることができます。
プロジェクトでは、コードを対応するテストにリンクするアノテーションをすでに使用している場合があります。 その場合は、このアノテーションを認識するように IntelliJ IDEA の構成に進むことができます。
そうでない場合は、 サードパーティのアノテーションを使用するを実行するか、 独自のカスタムアノテーションを作成できます。 どちらのオプションも同じように機能します。
サードパーティのアノテーションをインポートする
プロジェクトのルートディレクトリで pom.xml を開きます。
pom.xml で、 Alt+Insert を押して、 依存 を選択します。
開いたツールウィンドウで、依存関係の名前 (
io.qameta.allure:allure-java-commonsなど) を入力します。必要な依存バージョンを選択して、 追加 をクリックしてください。
ビルドスクリプトの変更を適用します。 そのためには、エディターの右上隅に表示される通知で Ctrl+Shift+O を押すか、 Maven の変更を同期 をクリックします。
サードパーティのアノテーションをインポートする
プロジェクトのルートディレクトリで build.gradle を開きます。
build.gradle で、 Alt+Insert を押して、 Maven アーティファクト依存関係を追加 を選択します。
開いたツールウィンドウで、依存関係の名前 (
io.qameta.allure:allure-java-commonsなど) を入力します。必要な依存バージョンを選択して、 追加 をクリックしてください。
ビルドスクリプトの変更を適用します。 そのためには、エディターの右上隅に表示される通知で Ctrl+Shift+O を押すか、 Gradle の変更を同期 をクリックします。
モジュールに依存関係を追加できない場合は、独自のアノテーションクラスを作成できます。
カスタムアノテーションを作成する
プロジェクト ツールウィンドウ（Alt+1 ）で、新しいクラスを作成するノードを右クリックし、 を選択します。
以下のコードをファイルに貼り付けます。
MyTmsAnnotationは他の有効な名前に置き換えることができます。public @interface MyTmsAnnotation { public String value() default ""; }
カスタムアノテーションを作成する
プロジェクト ツールウィンドウ（Alt+1 ）で、新しいクラスを作成するノードを右クリックし、 を選択します。
以下のコードをファイルに貼り付けます。
MyTmsAnnotationは他の有効な名前に置き換えることができます。annotation class MyTmsAnnotation(val value: String = "")
アノテーションがすでにプロジェクトに含まれている場合は、その特定のアノテーションを使用するように TMS プラグインに指示する必要があります。
TMS 設定でアノテーションを有効にする
Ctrl+Alt+S を押して設定を開き、 を選択します。
アノテーションを追加するには、「追加
」をクリックします。
アノテーションクラスを指定し、 OK をクリックします。
最後に、IntelliJ IDEA が単体テストと TMS アイテム間のリンクを確立するには、プロジェクト用に構成されたアノテーションの 1 つでテストにアノテーションを付ける必要があります。
単体テストにアノテーションを付ける
エディターで単体テストファイルを開きます。
以下に示すように、メソッド定義の前に TMS リンクアノテーションを配置します。
// C58439 @MyTmsAnnotation("C58439") @Test void TestCase1() { Assertions.assertEquals(4, Calculator.multiply(2,2)); }
単体テストにアノテーションを付ける
エディターで単体テストファイルを開きます。
以下に示すように、メソッド定義の前に TMS リンクアノテーションを配置します。
// C58439 @MyTmsAnnotation("C58439") @Test fun TestCase1() { Assertions.assertEquals(4, Calculator.multiply(2,2)) }