IntelliJ IDEA 2024.1 ヘルプ

TMS リンクアノテーション

アノテーションは、コードに関するメタデータを含むコード内の特別なマーカーです。TMS リンクアノテーションを使用して、テストに関する追加情報を提供できます。これにより、IntelliJ IDEA はユニットテストを TMS アイテムにリンクできます。

TMS リンクアノテーションにより、IntelliJ IDEA はより優れた分析を実行できます。たとえば、単体テストからすでに参照されているテストケースを見つけることができます。

プロジェクトでは、コードを対応するテストにリンクするアノテーションをすでに使用している場合があります。その場合は、このアノテーションを認識するように IntelliJ IDEA の構成に進むことができます。

そうでない場合は、サードパーティのアノテーションを使用するを実行するか、独自のカスタムアノテーションを作成できます。どちらのオプションも同じように機能します。

サードパーティのアノテーションをインポートする

  1. プロジェクトのルートディレクトリで pom.xml を開きます。

  2. pom.xml で Alt+Insert を押し、依存を選択します。

    Generate a dependency

  3. 開いたツールウィンドウで、依存関係の名前 ( io.qameta.allure:allure-java-commons など) を入力します。

    必要な依存バージョンを選択して、追加をクリックしてください。

    Selecting dependency

  4. ビルドスクリプトの変更を適用します。そのためには、エディターの右上隅に表示される通知で Ctrl+Shift+O を押すか、Maven の変更をロードをクリックします。

    Loading changes

サードパーティのアノテーションをインポートする

  1. プロジェクトのルートディレクトリで build.gradle を開きます。

  2. build.gradle で Alt+Insert を押し、Maven アーティファクト依存関係を追加を選択します。

    Generate a dependency

  3. 開いたツールウィンドウで、依存関係の名前 ( io.qameta.allure:allure-java-commons など) を入力します。

    必要な依存バージョンを選択して、追加をクリックしてください。

    Selecting dependency

  4. ビルドスクリプトの変更を適用します。そのためには、エディターの右上隅に表示される通知で Ctrl+Shift+O を押すか、Gradle の変更をロードをクリックします。

    Loading changes

モジュールに依存関係を追加できない場合は、独自のアノテーションクラスを作成できます。

カスタムアノテーションを作成する

  1. プロジェクトツールウィンドウ（Alt+1）で、新しいクラスを作成するノードを右クリックし、新規 | Java クラスを選択します。

  2. 以下のコードをファイルに貼り付けます。MyTmsAnnotation は他の有効な名前に置き換えることができます。

    public @interface MyTmsAnnotation { public String value() default ""; }

カスタムアノテーションを作成する

  1. プロジェクトツールウィンドウ（Alt+1）で、新しいクラスを作成するノードを右クリックし、新規 | Kotlin ファイル / クラスを選択します。

  2. 以下のコードをファイルに貼り付けます。MyTmsAnnotation は他の有効な名前に置き換えることができます。

    annotation class MyTmsAnnotation(val value: String = "")

アノテーションがすでにプロジェクトに含まれている場合は、その特定のアノテーションを使用するように TMS プラグインに指示する必要があります。

TMS 設定でアノテーションを有効にする

  1. Ctrl+Alt+S を押して設定を開き、ツール | TMS | コードからの参照 | Java/Kotlin を選択します。

  2. アノテーションを追加するには、「追加 」をクリックします。

    TMS settings

  3. アノテーションクラスを指定し、OK をクリックします。

    Enable annotations in settings

最後に、IntelliJ IDEA が単体テストと TMS アイテム間のリンクを確立するには、プロジェクト用に構成されたアノテーションの 1 つでテストにアノテーションを付ける必要があります。

単体テストにアノテーションを付ける

  1. エディターで単体テストファイルを開きます。

  2. 以下に示すように、メソッド定義の前に TMS リンクアノテーションを配置します。

    // C58439 @MyTmsAnnotation("C58439") @Test void TestCase1() { Assertions.assertEquals(4, Calculator.multiply(2,2)); }

単体テストにアノテーションを付ける

  1. エディターで単体テストファイルを開きます。

  2. 以下に示すように、メソッド定義の前に TMS リンクアノテーションを配置します。

    // C58439 @MyTmsAnnotation("C58439") @Test fun TestCase1() { Assertions.assertEquals(4, Calculator.multiply(2,2)) }
TMS 統合を開始する ローカル TMS