pytest-notifier

English | Русский

A pytest plugin that sends notifications about failed tests to different channels (Console, Mattermost, Telegram).

Features

• Notifications when tests fail.
• Support for multiple channels at once.
• Flexible configuration through environment variables or .env files.
• Detailed error information, including tracebacks.
• Custom messages appended to notifications (for Telegram and Mattermost).

Installation

Requires Python 3.13 or later.

pip install cloudru-qa-pytest-notifier

Import the plugin as the pytest_notifier module.

Skills for AI agents

This library does not have its own skill yet. If your project has other libraries from this collection with skills for AI agents, select and install them from the project root (requires uv):

uvx library-skills

For Claude Code, add --claude.

Usage

The plugin activates automatically when running pytest if installed.

Configuration

Configure it through environment variables. All variables use the PYTEST_NOTIFIER_ prefix.

Main settings

PYTEST_NOTIFIER_DESTINATIONS is the main variable specifying notification destinations (a bitmask).

Calculating DESTINATIONS

Add the flags for the required channels:

Example combinations:

Mattermost

Telegram

Example .env file

# Enable Mattermost and Telegram (2 + 4 = 6)
PYTEST_NOTIFIER_DESTINATIONS=6

# Mattermost
PYTEST_NOTIFIER_MATTERMOST__WEBHOOK_URL=https://mattermost.example.com/hooks/xxx
PYTEST_NOTIFIER_MATTERMOST__USERNAME=TestBot
PYTEST_NOTIFIER_MATTERMOST__CHANNEL=qa-alerts
PYTEST_NOTIFIER_MATTERMOST__ADDITIONAL_MESSAGE="Documentation: https://docs.example.com"

# Telegram
PYTEST_NOTIFIER_TELEGRAM__BOT_TOKEN=123456789:ABCdefGHIjklMNOpqrsTUVwxyz
PYTEST_NOTIFIER_TELEGRAM__CHAT_ID=-1001234567890
PYTEST_NOTIFIER_TELEGRAM__SEND_TRACEBACK=false
PYTEST_NOTIFIER_TELEGRAM__ADDITIONAL_MESSAGE="Contact the QA team for details"

Development

The plugin is developed in the qa-libraries monorepo alongside the other cloudru-qa-* libraries. You need uv, GNU Make, and checkmake. Run commands from the repository root:

make sync                        # install dependencies for all libraries from uv.lock
make test-pytest-notifier        # tests for this plugin
make typecheck-pytest-notifier   # mypy for this plugin
make check                       # formatting, ruff, mypy, and tests for the entire workspace

The plugin loads in every monorepo test run, so make always sets PYTEST_NOTIFIER_DESTINATIONS=1: notifications go only to the console, even if .env configures Mattermost or Telegram.

Tests run on Python 3.13 and 3.14. Create a separate environment for another version: make sync test-pytest-notifier PYTHON_VERSION=3.14.

Publish a release with the git tag pytest-notifier/v<version>. The tag version must match the version in packages/pytest-notifier/pyproject.toml.