JetBrains IDE integration

With the Allure plugin for the JetBrains IDEs, you can quickly generate and open test reports from the IDE's context menu. The plugin can be used in all the IDEs based on the IntelliJ platform, including IntelliJ IDEA, WebStorm, PyCharm, GoLand and others.

In addition to Allure Report, the plugin also provides some functionality related to Allure TestOps. See the Allure TestOps documentation.

Installation and configuration

WARNING

Before installing the plugin, make sure that the Allure Report command-line tool is installed in your operating system.

1. Launch the IDE.

2. Go to File → Settings.

3. In the settings navigation tree, select the Plugins section.

4. Go to the Marketplace tab.

5. In the search box, enter: /organization:Qameta.

6. Next to the Allure TestOps Support plugin, click Install.

7. Wait for the installation to complete and click Apply.

8. In the settings navigation tree, select the Tools → Allure TestOps section.

9. Make sure that the Allure Report path field contains the command or the full path to the Allure Report utility. Edit the path if necessary.

10. Click OK.

Generate a test report

1. Run your tests as you would do normally.

   Assuming an Allure adapter is configured correctly in your project, this must produce a test results directory at allure-results, build/allure-results or other location, depending on the configuration.

2. In the Project tool window, right-click on the test results directory and select Allure Report: Generate.

   The test report will be generated in a new directory, whose name will contain the suffix -report-⟨DATE⟩_⟨TIME⟩, for example: allure-results-report-2023-05-23_08-37-17.

3. To view the test report in a web browser, right-lick on the test report directory and select Allure Report: Open Generated Report.

Automatically regenerate a test report

To start a service that will regenerate the test report automatically:

1. Run your tests as you would do normally.

   Assuming an Allure adapter is configured correctly in your project, this must produce a test results directory at allure-results, build/allure-results or other path, depending on the configuration.

2. In the Project tool window, right-click on the test results directory and select Allure Report: Generate On-The-Fly.

   The test report will be generated in a new directory, whose name will contain the suffix -report, for example: allure-results-report. The report will be also automatically opened in the web browser.

   Whenever you run your tests again, the plugin will automatically regenerate the test report. The page in the web browser will be refreshed automatically.

   TIP

   If you use a wide monitor or multiple monitors, it may be convenient to keep the IDE and the web browser visible simultaneously while you are working on the code or the tests. This will allow you to see how your modifications affect the report.

In the Allure tool window (View → Tool Windows → Allure), a list item will appear, describing the parameters of the local web server, for example: ⟨PROJECT⟩/build/allure-results → ⟨PROJECT⟩/build/allure-results-report. Select it to enable additional actions:

Icon	Meaning
	Stop on the fly report generation.
	Force regenerate report, regardless of whether new results are available.
	Open the test report in the web browser.
	Open the rest report directory in the file manager.