Release

.github/workflows/release.yml

@@ -19,7 +19,7 @@ on:
     paths-ignore:
       - '.github/**'
       - CHANGELOG.md
-      - README.rst
+      - README.md
       - CONTRIBUTING.rst
 
 env:
@@ -41,7 +41,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.8'
+          python-version: '3.10'
 
       - name: Install dependencies
         run: python -m pip install --upgrade pip setuptools wheel

.github/workflows/tests.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ '3.7', '3.8', '3.9', '3.10', '3.11', '3.12', '3.13' ]
+        python-version: [ '3.8', '3.9', '3.10', '3.11', '3.12', '3.13' ]
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4

.pre-commit-config.yaml

@@ -1,27 +1,32 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.4.0
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
     hooks:
-    -   id: trailing-whitespace
-    -   id: end-of-file-fixer
-    -   id: check-yaml
-    -   id: check-added-large-files
--   repo: https://github.com/PyCQA/pydocstyle
-    rev: 6.0.0
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/PyCQA/pydocstyle
+    rev: 6.3.0
     hooks:
-    -   id: pydocstyle
+      - id: pydocstyle
         exclude: |
-            (?x)^(
-                tests/.* |
-                examples/.*
-            )
--   repo: https://github.com/Lucas-C/pre-commit-hooks-markup
-    rev: v1.0.1
+          (?x)^(
+              tests/.* |
+              examples/.*
+          )
+  - repo: https://github.com/psf/black
+    rev: 24.10.0
+    hooks:
+      - id: black
+        args: [ '--check', 'pytest_reportportal', 'tests' ]
+  - repo: https://github.com/pycqa/isort
+    rev: 6.0.0
     hooks:
-    -   id: rst-linter
--   repo: https://github.com/pycqa/flake8
-    rev: 5.0.4
+      - id: isort
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.1.1
     hooks:
-    -   id: flake8
+      - id: flake8

CHANGELOG.md

@@ -1,8 +1,14 @@
 # Changelog
 
 ## [Unreleased]
+### Removed
+- `Python 3.7` support, by @HardNorth
+
+## [5.4.7]
 ### Added
-- Escaping of binary symbol '\0' in parameters, by @HardNorth
+- Issue [#382](https://github.com/reportportal/agent-python-pytest/issues/382): Escaping of binary symbol '\0' in parameters, by @HardNorth
+### Changed
+- Client version updated on [5.6.0](https://github.com/reportportal/client-Python/releases/tag/5.6.0), by @HardNorth
 
 ## [5.4.6]
 ### Added

README.md

@@ -0,0 +1,122 @@
+# 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](https://img.shields.io/pypi/v/pytest-reportportal.svg?maxAge=259200)](https://pypi.python.org/pypi/pytest-reportportal)
+[![Python versions](https://img.shields.io/pypi/pyversions/pytest-reportportal.svg)](https://pypi.org/project/pytest-reportportal)
+[![Tests](https://github.com/reportportal/agent-python-pytest/actions/workflows/tests.yml/badge.svg)](https://github.com/reportportal/agent-python-pytest/actions/workflows/tests.yml)
+[![codecov](https://codecov.io/gh/reportportal/agent-python-pytest/graph/badge.svg?token=x5ZHqZKJFV)](https://codecov.io/gh/reportportal/agent-python-pytest)
+[![Join Slack chat!](https://img.shields.io/badge/slack-join-brightgreen.svg)](https://slack.epmrpp.reportportal.io/)
+[![stackoverflow](https://img.shields.io/badge/reportportal-stackoverflow-orange.svg?style=flat)](http://stackoverflow.com/questions/tagged/reportportal)
+[![Build with Love](https://img.shields.io/badge/build%20with-❤%EF%B8%8F%E2%80%8D-lightgrey.svg)](http://reportportal.io?style=flat)
+
+## Installation
+
+To install pytest plugin execute next command in a terminal:
+
+```bash
+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:
+
+```bash
+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`:
+
+```text
+[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`:
+
+```python
+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:
+
+```python
+# 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:
+
+```bash
+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](https://www.apache.org/licenses/LICENSE-2.0) license (see the LICENSE file).

examples/attributes/test_runtime_attribute.py

@@ -20,7 +20,5 @@ def test_custom_attributes_report(request):
     This is a test with one custom marker as a decorator and one custom marker
     added at runtime which shall both appear on  ReportPortal on test's item
     """
-    request.node.add_marker(
-        pytest.mark.runtime()
-    )
+    request.node.add_marker(pytest.mark.runtime())
     assert True

examples/bdd/features/arguments_four_steps.feature

@@ -0,0 +1,8 @@
+Feature: Four step arguments
+    Scenario: Arguments for given, when, and, then
+        Given there are 5 cucumbers
+
+        When I eat 3 cucumbers
+        And I eat 2 cucumbers
+
+        Then I should have 0 cucumbers

examples/bdd/features/arguments_four_steps_description.feature

@@ -0,0 +1,11 @@
+Feature: Four step arguments
+    Description for the feature
+
+    Scenario: Arguments for given, when, and, then
+        Description for the scenario
+
+        Given there are 5 cucumbers
+        When I eat 3 cucumbers
+        And I eat 2 cucumbers
+
+        Then I should have 0 cucumbers