Frequently Asked Questions

You can find the requirements in the Architecture section.

If you are having issues with performance, please also check the following:

1. Database server must not be running in a container.
2. S3 must be used as storage.

Additionally, if you are running a large amount of tests (several thousands or more daily), you need to scale up the Report service. Three instances of the Report service should be sufficient in this case.

Test is considered resolved when a user links a defect to it or marks the test as muted. The logic behind this is that both actions imply that the user has analyzed the test failure and decided either to mark it as known (defect) or to ignore it (mute).

You can add custom fields, tags, test layers and other properties to automated tests by specifying this information in your code. See this article for more information.

In the end of your test run, click on "Failed" in bottom right corner, "resolution" window will appear offering 5 options of different statuses.

While you run test case, press 3 dots at the step of interest and choose "Resolve step". The appeared window allows you to choose a status, category (to use an "error category" you must create it first, it can be done in either administrative(global) or project settings) and fill the description.

All the information regarding missing results in launches, upload errors, and etc. you can find in Troubleshooting article

When you click to delete a test case in Allure TestOps, it is marked as deleted and becomes hidden. All test cases marked as deleted become permanently deleted only when you remove the project they belong to.

To restore a deleted test case:

1. Open your project page.

2. In your browser's address bar, replace the last part of the URL with test-cases-list and press Enter.

   For example, change this URL
   https://demo.testops.cloud/project/1/test-cases?treeId=0
   to this
   https://demo.testops.cloud/project/1/test-cases-list

3. Check the Only deleted box.

4. Type an AQL query to filter the test cases or enter True to show all deleted test cases.

5. Click the search button (the magnifying glass).

6. Click on the ID of a test case you want to restore.

7. Click ⋮ on the right and select Restore.

8. Confirm the action.

You can create test case copies and move test cases between projects using the Bulk actions menu.

1. Select one or more test cases using checkboxes on the left.
2. Click the Bulk actions button.
3. Select Clone to create copies or Move to other project to move test cases to other project.

You can check the version of Allure TestOps by clicking on your avatar in the bottom left corner of the page.

To access the status page, open the URL ALLURE_URL/status, where ALLURE_URL is the base URL of your instance (for example, https://demo.testops.cloud/status).

Most widgets that display data chronologically only show data for the last 14 days. If there is data that matches the AQL query, but that data is older than 2 weeks, the widget will be empty.

Some widgets allow you to change the display style from Daily (last 2 weeks) to Weekly (last 2 months) or Monthly (last 12 months).

No, AQL functions like now(), dayStartUtc(), weekAgo(), and currentUser() cannot be used in widgets.

Allure TestOps mainly uses two types of storage:

1. PostgreSQL for storing the main data (projects, test cases, test results, etc.).
2. S3 storage for storing test artifacts (such as attachments and other files).

For more information, see Architecture.

To delete attachments and other test artifacts automatically, you can set up global or project-specific clean-up rules. For more information, see Clean up.

You can create a backup copy of Allure TestOps database using standard PostgreSQL utilities like pg_dump and psql. For detailed instructions, see Backup and restore.

See External database.

You need to locate the /data/v2 directory in your Report service volume and upload it to an S3 bucket. If you are using MinIO as S3 storage, we have a sample deployment configuration and migration instructions that you can find here. Even if you are using a different S3 storage server, we strongly recommend using MinIO Client command line tool to upload the files and set the correct access rights.

If you are using Kubernetes, see Kubernetes Deployment.

PostgreSQL VACUUM

Cleanup rules delete scenario data and artifact links from the database. However, it's important to note that this data isn't immediately deleted. The database incorporates mechanisms, particularly the VACUUM procedure, which is responsible for the ultimate deletion of data. This process not only frees up space but also enhances the database's query processing speed.

You need to perform full VACUUM from time to time, and for the tables where the application logic deletes the data frequently it's recommended to configure AUTOVACUUM procedures.

Traces and messages

Moreover, there are certain elements of test results, that aren't being deleted in the scope of the clean-up routine Allure TestOps runs. These are i) traces and ii) error messages. Traces and error messages are considered as part of the meta data in the system and are kept even all other artifacts are deleted.

To save space in the database, it's suggested to shorten very long traces and messages before adding them to test results. Another option is to keep traces as attachments to the test results.

To check your Allure TestOps license:

1. Log in to Allure TestOps using an administrator account.
2. Click on your avatar and go to Administration → License.

You should see information about your license, including expiration date, maximum and current number of users.

When Allure TestOps license expires, all user accounts are set to read-only mode and all integrations stop working. To enter a new license, you need to log in as administrator and paste it into the prompted field.

If your license has not expired:

1. Log in to Allure TestOps using an administrator account.
2. Click on your avatar and go to Administration → License.
3. Click Manage licenses and enter a new license.

If your license has expired, log in as administrator and enter a new license into the prompted field.

User sessions are stored in Redis. To terminate all active sessions, restart your Redis process. If you are using Redis persistence features, we recommend disabling them.

Allure TestOps Cloud includes 60 GB of total storage.

Allure TestOps Cloud instances are automatically updated to the latest stable version. You don't need to do anything to keep your instance up-to-date.

If you want to use the latest untested version, you can create a support ticket.

See Migrating to Allure TestOps Cloud.

No. If you are using an S3 storage to store test artifacts as recommended in the installation guide, you don't need to configure a PersistentVolume.

To ensure test cases are only created/updated when automated tests are executed on master/release branches, you need to configure documentation generation policy in Launches section of your project's configuration area.

You can use the following attributes of launches to control the creation of test cases: Launch Name, Launch Tags and Launch Environment data.

A detailed guide of using Allure Query Language (AQL) can be found in documentation here: Allure Query Language. You need to check the Launches related AQLs.

Retries occur when you run the same test more than once in a single launch. You can identify retries when the test results share the same ID and environment within one launch. History of retries is not visible on the test cases page. However, you can locate them on the main launch page in the "Retries" section or inside the launch, on the test results page, by selecting a test result and clicking the "Retries" tab.

If a rerun modifies the environment parameters for the test, it is considered as new result, not just a retry.