Allure Behave

2.15.3 · active · verified Tue Apr 14

Allure behave is an adapter for Behave that integrates Behave tests with Allure Report, a flexible and lightweight multi-language test report tool. It enhances standard Behave reporting by providing capabilities for crafting more informative and structured tests, allowing for metadata annotation, test organization, step division, and attachment of files like screenshots. The current version is 2.15.3 and it generally follows the Allure Python project's release cadence, with frequent updates for bug fixes and new features.

Warnings

gotcha Generating the final HTML Allure Report requires the Allure Report command-line tool, which is a separate Java-based dependency and needs to be installed outside of Python (e.g., via Homebrew on macOS or manual download).
Fix: Install the Allure Report CLI tool (e.g., `brew install allure` or follow official installation guides: `https://allurereport.org/docs/gettingstarted-installation/`).
gotcha When running Behave tests in parallel (e.g., with `behave-parallel` or `behavex`), using the formatter directly (`-f allure_behave.formatter:AllureFormatter`) might be incompatible or lead to missing features.
Fix: For parallel execution, it's often necessary to integrate Allure Behave via `environment.py` hooks, calling `from allure_behave.hooks import allure_report` and then `allure_report('path/to/result/dir')` in appropriate `before_all` or `after_all` hooks. Consult `behavex` documentation for its specific Allure integration details.
gotcha The error `format=allure_behave.formatter:AllureFormatter is unknown` typically indicates that `allure-behave` is not correctly installed or not accessible in the Python environment where `behave` is being run.
Fix: Ensure `pip install allure-behave` has been successfully executed in the active Python environment. Verify the package is listed by `pip list`.
gotcha Using `AllureFormatter.hide_excluded=true` with tag-excluded scenarios can lead to steps from the excluded scenarios incorrectly bleeding into the results of the next matching scenario.
Fix: As a workaround, avoid using `hide_excluded=true` or carefully inspect reports for incorrect step counts if this option is enabled. Check for official bug fixes in newer releases.
breaking Older versions (pre-2.14.2) could produce `AttributeError` if `Allure Behave` was set up via `AllureHooks` or generate extra test results after consecutive in-process runs of `Behave`.
Fix: Upgrade to `allure-behave` 2.14.2 or newer to resolve these specific issues.

Install

pip install allure-behave Install package
brew install allure # For macOS # Or install via other package managers: https://allurereport.org/docs/gettingstarted-installation/ Install Allure Report CLI (required)

Imports

AllureFormatter
```
behave -f allure_behave.formatter:AllureFormatter ...
```
Used as a Behave formatter string in command line or behave.ini
allure
```
import allure
```
Main module for runtime API annotations (e.g., @allure.step, allure.dynamic.issue)
allure_report
```
from allure_behave.hooks import allure_report
```
Required for parallel execution setup in environment.py instead of direct formatter usage on the command line.

Quickstart

This quickstart demonstrates how to integrate Allure Behave with a simple Behave feature file and step definitions. It includes an example of using `@allure.step` for sub-steps and `allure.attach` for adding content to the report. The `behave.ini` configuration is shown as an alternative to command-line arguments for specifying the Allure formatter. Finally, it shows how to generate and view the interactive Allure report using the Allure Report CLI tool.

# 1. features/example.feature
Feature: Allure Behave Example
  Scenario: A simple test scenario
    Given I have a step
    When I perform an action
    Then I should see a result

# 2. steps/example_steps.py
from behave import given, when, then
import allure

@given('I have a step')
def step_have_step(context):
    pass

@when('I perform an action')
def step_perform_action(context):
    with allure.step('Sub-step: doing something important'):
        print('Performing action...')

@then('I should see a result')
def step_see_result(context):
    allure.attach('This is some attachment content.', name='Text Attachment', attachment_type=allure.attachment_type.TEXT)
    assert True

# 3. behave.ini (optional, but good practice)
# [behave]
# format=allure_behave.formatter:AllureFormatter
# outfiles=allure-results

# 4. Run Behave tests and collect results
# behave -f allure_behave.formatter:AllureFormatter -o allure-results features/

# 5. Generate and open the Allure Report
# allure serve allure-results

view raw JSON →