Custom fields

Custom fields are arbitrary key-value pairs that can be assigned to test cases. Similar to a tag, the actual meaning of a custom field is project-specific.

The general purpose of custom fields is to help filter and group test cases. You can use them:

• to group test cases by specific values in custom trees,
• to search for test cases using filters,
• to filter test cases via AQL (e.g., when creating test plans).

To start using a new custom field:

1. As an administrator, declare the custom field.
2. As an administrator or a project owner, add the custom field to the project.
3. As a project owner or a test author, edit values for test cases manually or automatically.

System fields

To each project in Allure TestOps, some system fields are added automatically. This includes:

• Epic, Feature, Story — used by default for the “Features” tree,
• Suite — used by default for the “Suites” tree,
• Component — not used by default but often used for custom trees or filters.

The system fields cannot be removed from a project. You can, however, add or remove mappings for any field, see Setting custom fields automatically.

The labels in the default mappings for Epic, Feature, Story, and Suite match the labels generated by the standard functions in most Allure adapters.

Declaring custom fields

Before a custom field can be added to individual projects, it must be declared globally by an Allure TestOps instance administrator. At this point, only the human-readable name of the field is being determined.

To declare a new custom field:

1. Go to Administration → Custom Fields.
2. Click New field.
3. Enter a human-readable name for the new field and click Create.

To rename or remove an existing custom field, use the icons in the top right corner.

Adding custom fields to a project

Once you have declared a custom field in the Allure TestOps instance, you need to add it to your project to start using it. This can be done either from the administration panel by an administrator or from the project settings by the project owner.

• From the administration panel
• From the project settings

1. Go to Administration → Custom Fields.
2. Select the field you want to add to a project.
3. Click Add to projects.
4. In the dialog that appears, select the projects for which the field should be available, then click Add.
5. Optionally, click ⋯ next to the project name and switch on the Required field toggle.

1. Go to Settings → Custom Fields.
2. Click Add field.
3. In the dialog that appears, select the custom fields that should be available for the project, then click Add.
4. Optionally, click ⋯ in the upper-right corner of the screen and switch on the Required field toggle.

The Required field option means that a user is expected to provide a value for the custom field in every test case. In the test case details, a required field is always visible. If no value is assigned, it will display the red “No values” caption.

Setting custom field values

Allure TestOps provides multiple ways of setting the values for a test case's custom fields:

• set values manually for one or several test cases (supported for the manual QA; can be enabled for the automation QA);
• set values manually using test case trees (supported for both the manual QA and the automation QA);
• set values automatically (supported for the automation QA only).

To manually change the values of custom fields for automated test cases, change your project's upload policy.

Set values manually for one or several test cases

To add a custom field value to a test case:

1. Go to the Test cases section of your project.

2. Open a test case.

3. On the right side of the screen, next to Fields, click the pencil icon.

4. In the dialog that appears, edit the table of custom field values.

   In each row, the Custom Field must be a field name previously added to the project, and Value can contain one or more arbitrary text values.

   

5. Click Submit to save the changes.

To add custom field values to several test cases at once, use the Add metadata item in the bulk actions menu. As a result:

• Allure TestOps will add the specified values to each selected test case.
• Existing values will not be affected.

To remove certain custom field values from several test cases at once, use the Remove metadata item in the bulk actions menu. As a result:

• Allure TestOps will remove the specified values from each selected test case where they are present.
• Other values will not be affected.

Set values manually using trees

Trees is an Allure TestOps feature that allows you to work with custom fields as easily as with files and folders on your PC.

Each folder in a tree is a set of test cases grouped by the value of a specific custom field. You can drag and drop test cases from one folder to another, change the custom field value of all test cases in a folder, create new test cases with the required value, etc.

You can find more information about working with trees in the Trees article.

Set values automatically

1. Go to Settings → Custom Fields.

2. Select the custom field that should be loaded from test results.

3. Click New mapping.

4. In the dialog that appears, enter the name of the label and click Create.

5. In your test code, use the specified label name to set the values.

   • Test code
   • Test result

   The example is written in Java.

   @Test
   public void testAuthentication() {
       Allure.label("component", "Core");
       Allure.label("version", "1.23");
       // ...
   }
   

   Depending on the language and framework you use, there can be multiple ways to define labels for your test cases. See your Allure adapter's reference for more details.

   The example shows a part of a test result file that will be generated when running the test. After uploading the test results, Allure TestOps will use the values from this file.

   "labels": [
     { "name": "component", "value": "Core" },
     { "name": "version", "value": "1.23" }
   ],
   

   For more details on the file format, see the Allure Report documentation.

Once the mapping is configured and the code is updated where necessary, make sure to run a new launch and close it to apply the changes.

Changing upload policy

If you want to change the values of custom fields for automated test cases using the web interface instead of specifying values in test results, you can change your upload policy to ignore custom fields values from test results.

1. Open your project.
2. Go to Settings → Upload.
3. Click the + Create button.
4. Under Field, select custom_field.
5. Under Policy, select from_test_case.
6. Click Submit.