Merge pull request #328 from reportportal/develop

Release

Author: HardNorth

.github/workflows/release.yml

@@ -33,9 +33,27 @@ env:
 
 jobs:
   deploy:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.8'
+
+      - name: Install dependencies
+        run: python -m pip install --upgrade pip setuptools wheel
+
+      - name: Build package
+        run: python setup.py sdist bdist_wheel
+
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: ${{ secrets.PYPI_USERNAME }}
+          password: ${{ secrets.PYPI_PASSWORD }}
 
       - name: Generate versions
         uses: HardNorth/github-version-generate@v1
@@ -57,29 +75,6 @@ jobs:
           git tag -a ${{ env.RELEASE_VERSION }} -m "Release ${{ env.RELEASE_VERSION }}"
           git push --tags
 
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.6'
-
-      - name: Install dependencies
-        run: python -m pip install --upgrade pip setuptools wheel
-
-      - name: Build package
-        run: python setup.py sdist bdist_wheel
-
-      - name: Publish package
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          user: ${{ secrets.PYPI_USERNAME }}
-          password: ${{ secrets.PYPI_PASSWORD }}
-
-      - name: Checkout develop branch
-        uses: actions/checkout@v3
-        with:
-          ref: 'develop'
-          fetch-depth: 0
-
       - name: Update CHANGELOG.md
         id: changelogUpdate
         run: |
@@ -108,6 +103,12 @@ jobs:
           name: Release ${{ env.RELEASE_VERSION }}
           body: ${{ steps.readChangelogEntry.outputs.changes }}
 
+      - name: Checkout develop branch
+        uses: actions/checkout@v3
+        with:
+          ref: 'develop'
+          fetch-depth: 0
+
       - name: Merge release branch into develop
         id: mergeIntoDevelop
         run: |

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## [Unreleased]
 ### Added
+- Feature [#325](https://github.com/reportportal/agent-python-pytest/issues/325) Support of runtime attribute adding, by @yakovbabich, @HardNorth
+- `rp_launch_timeout` parameter to limit test execution in case of process hanging, by @HardNorth
+
+## [5.1.3]
+### Added
 - Support for thread logs and `rp_thread_logging` flag, by @dagansandler
 
 ## [5.1.2]

README.rst

@@ -7,13 +7,19 @@ agent-python-pytest
     :alt: Latest Version
 .. image:: https://img.shields.io/pypi/pyversions/pytest-reportportal.svg
     :target: https://pypi.org/project/pytest-reportportal
+    :alt: Supported python versions
 .. image:: https://github.com/reportportal/agent-python-pytest/actions/workflows/tests.yml/badge.svg
     :target: https://github.com/reportportal/agent-python-pytest/actions/workflows/tests.yml
     :alt: Test status
 .. image:: https://codecov.io/gh/reportportal/agent-python-pytest/branch/master/graph/badge.svg
     :target: https://codecov.io/gh/reportportal/agent-python-pytest
+    :alt: Test coverage
+.. image:: https://slack.epmrpp.reportportal.io/badge.svg
+    :target: https://slack.epmrpp.reportportal.io/
+    :alt: Join Slack chat!
 
-Pytest plugin for reporting test results of the Pytest to the Reportal Portal.
+
+Pytest plugin for reporting test results of the Pytest to the Report Portal.
 
 * Usage
 * Installation
@@ -70,7 +76,7 @@ any one using pytest command line option:
 The :code:`pytest.ini` file should have next mandatory fields:
 
 - :code:`rp_uuid` - value could be found in the User Profile section
-- :code:`rp_project` - name of project in Report Potal
+- :code:`rp_project` - name of project in Report Portal
 - :code:`rp_endpoint` - address of Report Portal Server
 
 Example of :code:`pytest.ini`:
@@ -114,6 +120,8 @@ The following parameters are optional:
 - :code:`rp_verify_ssl = True` - Verify SSL when connecting to the server
 - :code:`rp_mode = DEFAULT` - DEBUG or DEFAULT launch mode. DEBUG launches are displayed in a separate tab and not visible to anyone except owner
 - :code:`rp_thread_logging` - EXPERIMENTAL - Enables support for reporting logs from threads by patching the builtin Thread class. Use with caution.
+- :code:`rp_launch_timeout = 86400` - Maximum time to wait for child processes finish, default value: 86400 seconds (1 day)
+
 
 
 If you like to override the above parameters from command line, or from CI environment based on your build, then pass

examples/attributes/test_one_attribute.py

@@ -17,7 +17,7 @@
 @pytest.mark.scope("smoke")
 def test_custom_attributes_report():
     """
-    This is a test with one custom markers which shall appear on
+    This is a test with one custom marker which shall appear on
     ReportPortal on test's item
     """
     assert True

examples/attributes/test_runtime_attribute.py

@@ -0,0 +1,26 @@
+#  Copyright (c) 2022 https://reportportal.io .
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License
+
+import pytest
+
+
+@pytest.mark.scope("smoke")
+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()
+    )
+    assert True

pytest_reportportal/config.py

@@ -82,6 +82,8 @@ def __init__(self, pytest_config):
             self.rp_verify_ssl = bool(strtobool(rp_verify_ssl))
         except (ValueError, AttributeError):
             self.rp_verify_ssl = rp_verify_ssl
+        self.rp_launch_timeout = int(
+            self.find_option(pytest_config, 'rp_launch_timeout'))
 
     # noinspection PyMethodMayBeStatic
     def find_option(self, pytest_config, option_name, default=None):

pytest_reportportal/config.pyi

@@ -31,6 +31,7 @@ class AgentConfig:
     rp_skip_connection_test: bool = ...
     rp_uuid: Text = ...
     rp_verify_ssl: Union[bool, Text] = ...
+    rp_launch_timeout: int = ...
 
     def __init__(self, pytest_config: Config) -> None: ...
 

pytest_reportportal/plugin.py

@@ -447,3 +447,9 @@ def add_shared_option(name, help, default=None, action='store'):
         default=False,
         type='bool',
         help='Skip Report Portal connection test')
+    parser.addini(
+        'rp_launch_timeout',
+        default=86400,
+        help='Maximum time to wait for child processes finish, default value: '
+             '86400 seconds (1 day)'
+    )

pytest_reportportal/service.py

@@ -515,6 +515,7 @@ def _get_issue(self, mark):
         """Add issues description and issue_type to the test item.
 
         :param mark: pytest mark
+        :return: Issue object
         """
         default_url = self._config.rp_issue_system_url
 
@@ -562,29 +563,40 @@ def _get_parameters(self, item):
         """
         return item.callspec.params if hasattr(item, 'callspec') else None
 
-    def _process_attributes(self, leaf):
+    def _process_test_case_id(self, leaf):
         """
-        Process all types of attributes of item.
+        Process Test Case ID if set.
 
         :param leaf: item context
+        :return: Test Case ID string
         """
-        item = leaf['item']
+        for marker in leaf['item'].iter_markers():
+            if marker.name == 'tc_id':
+                return self._get_test_case_id(marker, leaf)
 
-        parameters = self._get_parameters(item)
-        leaf['parameters'] = parameters
+        return self._get_test_case_id(None, leaf)
 
-        code_ref = self._get_code_ref(item)
-        leaf['code_ref'] = code_ref
+    def _process_issue(self, item):
+        """
+        Process Issue if set.
 
+        :param item: Pytest.Item
+        :return: Issue
+        """
+        for marker in item.iter_markers():
+            if marker.name == 'issue':
+                return self._get_issue(marker)
+
+    def _process_attributes(self, item):
+        """
+        Process attributes of item.
+
+        :param item: Pytest.Item
+        :return: a set of attributes
+        """
         attributes = set()
-        for marker in leaf['item'].iter_markers():
-            if marker.name == 'tc_id':
-                test_case_id = self._get_test_case_id(marker, leaf)
-                leaf['test_case_id'] = test_case_id
-                continue
+        for marker in item.iter_markers():
             if marker.name == 'issue':
-                issue = self._get_issue(marker)
-                leaf['issue'] = issue
                 if self._config.rp_issue_id_marks:
                     for issue_id in self._get_issue_ids(marker):
                         attributes.add((marker.name, issue_id))
@@ -597,11 +609,29 @@ def _process_attributes(self, leaf):
             else:
                 attributes.add((None, marker.name))
 
-        leaf['attributes'] = [self._to_attribute(attribute)
-                              for attribute in attributes]
+        return [self._to_attribute(attribute)
+                for attribute in attributes]
+
+    def _process_metadata_item_start(self, leaf):
+        """
+        Process all types of item metadata for its start event.
 
-        if 'test_case_id' not in leaf:
-            leaf['test_case_id'] = self._get_test_case_id(None, leaf)
+        :param leaf: item context
+        """
+        item = leaf['item']
+        leaf['parameters'] = self._get_parameters(item)
+        leaf['code_ref'] = self._get_code_ref(item)
+        leaf['test_case_id'] = self._process_test_case_id(leaf)
+        leaf['issue'] = self._process_issue(item)
+        leaf['attributes'] = self._process_attributes(item)
+
+    def _process_metadata_item_finish(self, leaf):
+        """
+        Process all types of item metadata for its finish event.
+
+        :param leaf: item context
+        """
+        leaf['attributes'] = self._process_attributes(leaf['item'])
 
     def _build_start_step_rq(self, leaf):
         payload = {
@@ -647,7 +677,7 @@ def start_pytest_item(self, test_item=None):
         # Details at:
         # https://github.com/reportportal/agent-Python-RobotFramework/issues/56
         current_leaf = self._tree_path[test_item][-1]
-        self._process_attributes(current_leaf)
+        self._process_metadata_item_start(current_leaf)
         item_id = self._start_step(self._build_start_step_rq(current_leaf))
         current_leaf['item_id'] = item_id
         current_leaf['exec'] = ExecStatus.IN_PROGRESS
@@ -683,6 +713,7 @@ def _build_finish_step_rq(self, leaf):
         if status == 'PASSED':
             issue = None
         payload = {
+            'attributes': leaf.get('attributes', None),
             'end_time': timestamp(),
             'status': status,
             'issue': issue,
@@ -741,6 +772,7 @@ def finish_pytest_item(self, test_item):
 
         path = self._tree_path[test_item]
         leaf = path[-1]
+        self._process_metadata_item_finish(leaf)
         self._finish_step(self._build_finish_step_rq(leaf))
         leaf['exec'] = ExecStatus.FINISHED
         self._finish_parents(leaf)
@@ -759,7 +791,9 @@ def finish_suites(self):
         at once.
         """
         # Ensure there is no running items
-        while len(self._get_items(ExecStatus.IN_PROGRESS)) > 0:
+        finish_time = time()
+        while len(self._get_items(ExecStatus.IN_PROGRESS)) > 0 \
+                and time() - finish_time <= self._config.rp_launch_timeout:
             sleep(0.1)
         skipped_items = self._get_items(ExecStatus.CREATED)
         for item in skipped_items:

setup.py

@@ -5,7 +5,7 @@
 from setuptools import setup
 
 
-__version__ = '5.1.3'
+__version__ = '5.1.4'
 
 
 def read_file(fname):
@@ -23,13 +23,13 @@ def read_file(fname):
     version=__version__,
     description='Agent for Reporting results of tests to the Report Portal',
     long_description=read_file('README.rst'),
-    long_description_content_type='text/markdown',
-    author_email='SupportEPMC-TSTReportPortal@epam.com',
+    long_description_content_type='text/x-rst',
+    author_email='support@reportportal.io',
     url='https://github.com/reportportal/agent-python-pytest',
     packages=['pytest_reportportal'],
     install_requires=read_file('requirements.txt').splitlines(),
     license='Apache 2.0',
-    keywords=['testing', 'reporting', 'reportportal', 'pytest'],
+    keywords=['testing', 'reporting', 'reportportal', 'pytest', 'agent'],
     classifiers=[
         'Framework :: Pytest',
         'Programming Language :: Python :: 2.7',