IntelliJ IDEA
 
2021.1
Shortcuts: Windows
Get IntelliJ IDEA
You are viewing the documentation for an earlier version of IntelliJ IDEA.
  1. Testing
  2. Test Management Systems
  3. TMS Annotations

TMS Annotations

Last modified: 29 March 2021

Annotations are special markers in code that contain metadata about code. You can configure TMS annotations to provide additional information about tests. This allows IntelliJ IDEA to link your unit tests to TMS items.

TMS annotations enable IntelliJ IDEA to perform better analysis, for example, to find test cases that are already referenced from unit tests.

For this purpose, you can use third-party annotations or create your custom annotation.

Import a third-party annotation

  1. Open pom.xml in the root directory of your project.

    tip

    To quickly navigate to a file, press Ctrl+Shift+N and enter its name.

  2. In pom.xml, press Alt+Insert, select Dependency. In the dialog that opens, enter the name of the dependency, for example, io.qameta.allure:allure-java-commons:2.13.8.

    Tms import annotation

  3. Apply the changes in the build script. For that, press Ctrl+Shift+O or click Load Maven Changes in the notification that appears in the top-right corner of the editor.

    Tms import annotation reload maven

If, for some reason, you cannot add extra dependencies to your module, you can create your own annotation class.

Create a custom annotation

  1. Create a Java file.

  2. Paste the code below to the file. You can replace MyTmsAnnotation with any other valid name.

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

After the annotation is already in the project, you need to tell the TMS plugin to use that specific annotation.

Enable annotations in TMS settings

  1. Go to Settings/Preferences | Tools | TMS | TMS Annotations.

  2. Click Add Icons general add and specify the annotation class.

    Tms setup annotation

Finally, for IntelliJ IDEA to establish a linkage between a unit test and a TMS item, the test needs to be annotated with one of the annotations configured for the project.

Annotate a unit test

  1. Open the unit test file in the editor.

  2. Put a TMS annotation before the method definition as shown below.

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