Allure Python Integrations

Severity tags can be applied at different levels of granularity in Gherkin:

1. Scenario Level: Applying a tag directly to a Scenario sets the severity for that specific test case.
2. Feature Level: Applying a tag to a Feature causes all scenarios within that feature to inherit that severity level.
3. Precedence: If a scenario is affected by multiple severity tags (e.g., one from the Feature level and one from the Scenario level), the last one wins.

@critical
Feature: Allure severity support
    Scenario: This scenario inherits the @critical tag
        Given noop

    @minor @trivial
    Scenario: This is a trivial scenario
        Given noop

    Scenario: While this one is a blocker
        Given noop

An Allure testplan is a JSON file that specifies which tests to run. It uses a tests array containing objects with either a selector (for name-based selection) or an id (for ID-based selection).

• Selector: Use the format Testplan.<TestName> to select a test by its name.
• ID: Use the allure.id:<value> tag in your Robot Framework tests and reference the <value> in the JSON id field.

{
    "version":"1.0",
    "tests": [
        {
            "selector": "Testplan.Selected by Name"
        },
        {"id": "1008"}
    ]
}

Allure automatically picks up the docstring of a test method and uses it as the test description in the report. This is a convenient way to add documentation without using additional decorators. This method supports Unicode characters.

def test_docstring_description():
    """ Docstring """
    pass

def test_unicode_docstring_description():
    """ Докстринг в юникоде """
    pass

Allure support for the nose2 testing framework is provided via the allure-nose2 package.

pip install allure-nose2

Set the ALLURE_TESTPLAN_PATH environment variable to the path of your JSON testplan file and run behave with the allure_behave.formatter:AllureFormatter.

Linux or MacOS (bash):

ALLURE_TESTPLAN_PATH=./testplan.json behave -f allure_behave.formatter:AllureFormatter -f pretty -o allure-results

Windows (PowerShell):

$Env:ALLURE_TESTPLAN_PATH = "./testplan.json"
behave -f allure_behave.formatter:AllureFormatter -f pretty -o allure-results

To use Allure with Pytest-BDD, install the adapter via pip, run your tests using pytest with the --alluredir flag to specify the results directory, and then use the allure serve command to view the report.

Note: Replace %allure_result_folder% with your desired directory path.

$ pip install allure-pytest-bdd
$ pytest --alluredir=%allure_result_folder% ./tests
$ allure serve %allure_result_folder%

You can inject descriptions into scenarios using Behave hooks like before_scenario or after_scenario inside your environment.py file. This is useful for applying descriptions based on scenario names or other metadata.

import allure

def before_scenario(context, scenario):
    if "before_scenario" in scenario.name:
        allure.dynamic.description(
            "This scenario has a description specified in the "
            "before_scenario hook"
        )


def after_scenario(context, scenario):
    if "after_scenario" in scenario.name:
        allure.dynamic.description(
            "This scenario has a description specified in the "
            "after_scenario hook"
        )

You can filter which test cases are executed by providing a JSON testplan file via the ALLURE_TESTPLAN_PATH environment variable. When running behave with the Allure formatter, only the tests explicitly listed in the testplan will be executed. Other tests will be marked as skipped in the console output.

To use a testplan based on selectors, create a JSON file with a version and a tests array containing selector strings that match the feature/scenario names.

{
    "version":"1.0",
    "tests": [
        {
            "selector": "Feature Name: Scenario Name"
        }
    ]
}