Pytest ReportPortal Agent

Warnings

• breaking Python 3.8 support was removed starting from `pytest-reportportal` version 5.6.0. Users on Python 3.8 or older must upgrade their Python version to use recent agent versions.
  Fix: Upgrade Python to 3.9 or newer.
• deprecated The `rp_uuid` configuration parameter for authentication has been removed since version 5.5.3. It was replaced by `rp_api_key` for API Key authentication or a set of `rp_oauth_*` parameters for OAuth 2.0 Password Grant.
  Fix: Replace `rp_uuid` in your `pytest.ini` or environment variables with `rp_api_key` or the appropriate `rp_oauth_*` parameters. Your API key can be found in your ReportPortal user profile.
• breaking The `retries` parameter for ReportPortal client configuration was removed in version 5.6.0. This parameter is no longer supported and will cause configuration errors if present.
  Fix: Remove the `retries` parameter from your `pytest.ini` or environment variables. The client now handles retries internally.
• gotcha Using `pytest-xdist` with `pytest-reportportal` can lead to issues, especially with hierarchy reporting. While some fixes for `xdist` compatibility have been introduced (e.g., for code reference generation), complex scenarios might still exhibit unexpected behavior or limitations.
  Fix: Test your `pytest-xdist` setup thoroughly with `pytest-reportportal`. If you encounter issues, consider disabling hierarchy-related features (`rp_hierarchy_dirs`, `rp_hierarchy_code`) or running tests without `xdist` if full ReportPortal feature fidelity is critical.
• gotcha Configuration parameters can be overridden by environment variables and command-line arguments. Environment variables (e.g., `RP_API_KEY`) take precedence over `pytest.ini` settings, and command-line arguments (e.g., `--rp-launch`) take precedence over both. This can lead to unexpected behavior if not managed carefully.
  Fix: Be explicit about your configuration hierarchy. For CI/CD, prefer environment variables or command-line arguments to override `pytest.ini` for sensitive data or dynamic launch parameters. Always check the effective configuration if reporting issues arise.

Install

• pip install pytest-reportportal Install latest version

Imports

• RPLogger

  from reportportal_client import RPLogger

  Used for integrating Python's standard logging module with ReportPortal to send logs during test execution.
• RPLogHandler

  from reportportal_client import RPLogHandler

  Used as a logging handler to direct Python logs to ReportPortal.

Quickstart

This quickstart demonstrates how to configure and run Pytest with `pytest-reportportal`. The core configuration involves setting `rp_endpoint`, `rp_project`, and `rp_api_key` (or OAuth credentials) either in a `pytest.ini` file or via environment variables. The `--reportportal` flag activates the plugin during test execution. A simple test file with passing, failing, and skipped tests is provided to show how results are reported.

import pytest
import os

# --- pytest.ini (simulated content for quickstart) ---
# [pytest]
# rp_endpoint = http://localhost:8080
# rp_project = default_personal
# rp_api_key = your_api_key_from_reportportal_profile
# rp_launch = MyPytestLaunch

# To run this example:
# 1. Ensure ReportPortal is running (e.g., via Docker).
# 2. Set environment variables or create a pytest.ini file:
#    export RP_ENDPOINT="http://localhost:8080"
#    export RP_PROJECT="default_personal"
#    export RP_API_KEY="your_api_key"
# 3. Save the test below as `test_example.py`.
# 4. Run from your terminal: `pytest --reportportal test_example.py`

def test_passing_example():
    assert True

def test_failing_example():
    assert False

@pytest.mark.skip(reason="demonstrating skip")
def test_skipped_example():
    pass