allure-report-mailer 0.1.1

Parse Allure BDD HTML test reports into Excel/HTML summaries and email them.

allure-report-mailer

Parse Allure BDD HTML test reports into Excel/HTML summaries and email them.

Three stages, each usable independently or chained via a pipeline command:

1. parse — reads Allure HTML report artifacts (widgets/summary.json, widgets/environment.json, data/test-cases/*.json embedded in each report), aggregates by (ID, FileName), dedupes to one row per test ID keeping the most recent run, and writes test_runtime_data.xlsx + test_env.json.
2. render — renders test_runtime_data.xlsx into a standalone, timestamped HTML report with client-side filter/sort, a color palette, and a configurable title.
3. email — finds the most recently generated HTML report and emails a compact, Outlook-safe summary (stats table + environment table) via SMTP, with the full report attached as a .zip.

Install

pip install allure-report-mailer

Usage

# Run all three stages in sequence
allure-report-mailer pipeline /path/to/allure/artifacts --output-dir ./out

# Or run each stage independently
allure-report-mailer parse /path/to/allure/artifacts --output-dir ./out
allure-report-mailer render ./out/test_runtime_data.xlsx ./out --report-title "My Regression Report"
allure-report-mailer email --report-dir ./out

Run allure-report-mailer --help, or allure-report-mailer <subcommand> --help for full option lists.

Email configuration

Secrets are read only from environment variables (never CLI flags, never hardcoded):

Variable	Required	Default
EMAIL_USER / EMAIL_PASS	Yes	none
EMAIL_FROM	No	falls back to EMAIL_USER
EMAIL_TO	Yes	none (comma-separated)
EMAIL_CC	No	none (comma-separated)
SMTP_HOST	No	smtp.azurecomm.net
SMTP_PORT	No	587
REPORT_DIR	No	current directory

The email's title, subject template, greeting/intro/closing copy, and environment-field labels can be overridden without touching source via --email-config path/to/config.json:

{
  "report_title": "Weekly Regression Report",
  "subject_template": "{report_title} - {date}",
  "email_body": {
    "greeting": "Hi Team,",
    "intro": "Please find below the test execution summary for the week of {date}."
  }
}

Only the keys you want to override need to be present — everything else falls back to the built-in defaults (see allure_report_mailer/config.py).

Development

pip install -e ".[dev]"
pytest --cov=allure_report_mailer --cov-report=term-missing

See SETUP.md for build/release steps.