Skip to main content

Agent for Reporting results of tests to the Report Portal

Project description

ReportPortal integration for pytest framework

Pytest plugin for reporting test results of the Pytest to the ReportPortal.

DISCLAIMER: We use Google Analytics for sending anonymous usage information such as agent's and client's names, and their versions after a successful launch start. This information might help us to improve both ReportPortal backend and client sides. It is used by the ReportPortal team only and is not supposed for sharing with 3rd parties.

PyPI Python versions Tests codecov Join Slack chat! stackoverflow Build with Love

Installation

To install pytest plugin execute next command in a terminal:

pip install pytest-reportportal

Look through the CONTRIBUTING.rst for contribution guidelines.

Configuration

Prepare the config file pytest.ini in root directory of tests or specify any one using pytest command line option:

py.test -c config.cfg

The pytest.ini file should have next mandatory fields:

  • rp_api_key - value could be found in the User Profile section
  • rp_project - name of project in ReportPortal
  • rp_endpoint - address of ReportPortal Server

Example of pytest.ini:

[pytest]
rp_api_key = fb586627-32be-47dd-93c1-678873458a5f
rp_endpoint = http://192.168.1.10:8080
rp_project = user_personal
rp_launch = AnyLaunchName
rp_launch_attributes = 'PyTest' 'Smoke'
rp_launch_description = 'Smoke test'
rp_ignore_attributes = 'xfail' 'usefixture'
  • The rp_api_key can also be set with the environment variable RP_API_KEY. This will override the value set for rp_api_key in pytest.ini

There are also optional parameters: https://reportportal.io/docs/log-data-in-reportportal/test-framework-integration/Python/pytest/

Examples

For logging of the test item flow to ReportPortal, please, use the python logging handler provided by plugin like below:

in conftest.py:

import logging

import pytest

from reportportal_client import RPLogger


@pytest.fixture(scope="session")
def rp_logger():
    logger = logging.getLogger(__name__)
    logger.setLevel(logging.DEBUG)
    logging.setLoggerClass(RPLogger)
    return logger

in tests:

# In this case only INFO messages will be sent to the ReportPortal.
def test_one(rp_logger):
    rp_logger.info("Case1. Step1")
    x = "this"
    rp_logger.info("x is: %s", x)
    assert 'h' in x

    # Message with an attachment.
    import subprocess
    free_memory = subprocess.check_output("free -h".split())
    rp_logger.info(
        "Case1. Memory consumption",
        attachment={
            "name": "free_memory.txt",
            "data": free_memory,
            "mime": "application/octet-stream",
        },
    )

    # This debug message will not be sent to the ReportPortal.
    rp_logger.debug("Case1. Debug message")

Launching

To run test with ReportPortal you must provide --reportportal flag:

py.test ./tests --reportportal

Check the documentation to find more detailed information about how to integrate pytest with ReportPortal using the agent: https://reportportal.io/docs/log-data-in-reportportal/test-framework-integration/Python/pytest/

Copyright Notice

Licensed under the Apache 2.0 license (see the LICENSE file).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest_reportportal-5.5.2.tar.gz (32.2 kB view details)

Uploaded Source

Built Distribution

pytest_reportportal-5.5.2-py2.py3-none-any.whl (31.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pytest_reportportal-5.5.2.tar.gz.

File metadata

  • Download URL: pytest_reportportal-5.5.2.tar.gz
  • Upload date:
  • Size: 32.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pytest_reportportal-5.5.2.tar.gz
Algorithm Hash digest
SHA256 a00d939776374ea0499ae3cb3ec7171dabe558ac8a766f27a817324b96267147
MD5 dae703ce77559054b1e5196380c8bd9f
BLAKE2b-256 ddee190b64f3a60ba1e09de00f794bd079de1e7b9f20b1ef81be2528fc631323

See more details on using hashes here.

File details

Details for the file pytest_reportportal-5.5.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_reportportal-5.5.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a041f47a5231984cf20bffcadb5c41342e83ae39cdfda0b51ae5716e4cc11cac
MD5 82b99553053393a978b59f2c4abbb7c5
BLAKE2b-256 00c8ff5453628205f3e6c6a51fd57de2b56ea9081cfb871d88c5de9041accd23

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page