Merge pull request #360 from reportportal/pytest_8_support

Pytest 8 support

Author: HardNorth

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
 ## [Unreleased]
+### Added
+- Pytest version >= 8 support, by @HardNorth
+### Removed
+- `Packege` and `Dir` item types processing on test collection. This is done to preserve backward compatibility and improve name consistency, by @HardNorth
+### Changed
+- `rp_issue_system_url` renamed to `rp_bts_issue_url` to be consistent with other agents, by @HardNorth
 
 ## [5.3.2]
 ### Changed

pytest_reportportal/config.py

@@ -44,7 +44,7 @@ class AgentConfig:
     rp_ignore_attributes: set
     rp_is_skipped_an_issue: bool
     rp_issue_id_marks: bool
-    rp_issue_system_url: str
+    rp_bts_issue_url: str
     rp_bts_project: str
     rp_bts_url: str
     rp_launch: str
@@ -88,8 +88,16 @@ def __init__(self, pytest_config: Config) -> None:
         )
         self.rp_issue_id_marks = self.find_option(pytest_config,
                                                   'rp_issue_id_marks')
-        self.rp_issue_system_url = self.find_option(pytest_config,
-                                                    'rp_issue_system_url')
+        self.rp_bts_issue_url = self.find_option(pytest_config, 'rp_bts_issue_url')
+        if not self.rp_bts_issue_url:
+            self.rp_bts_issue_url = self.find_option(pytest_config, 'rp_issue_system_url')
+            if self.rp_bts_issue_url:
+                warnings.warn(
+                    'Parameter `rp_issue_system_url` is deprecated since 5.4.0 and will be subject for removing'
+                    'in the next major version. Use `rp_bts_issue_url` argument instead.',
+                    DeprecationWarning,
+                    2
+                )
         self.rp_bts_project = self.find_option(pytest_config, 'rp_bts_project')
         self.rp_bts_url = self.find_option(pytest_config, 'rp_bts_url')
         self.rp_launch = self.find_option(pytest_config, 'rp_launch')

pytest_reportportal/plugin.py

@@ -452,8 +452,13 @@ def add_shared_option(name, help_str, default=None, action='store'):
     parser.addini(
         'rp_issue_system_url',
         default='',
-        help='URL to get issue description. Issue id '
-             'from pytest mark will be added to this URL')
+        help='URL to get issue description. Issue id from pytest mark will be added to this URL. '
+             'Deprecated: use "rp_bts_issue_url".')
+    parser.addini(
+        'rp_bts_issue_url',
+        default='',
+        help='URL to get issue description. Issue ID from pytest mark will be added to this URL by replacing '
+             '"{issue_id}" placeholder.')
     parser.addini(
         'rp_bts_project',
         default='',

pytest_reportportal/service.py

@@ -36,6 +36,11 @@
 except ImportError:
     # in pytest >= 7.0 this type was removed
     Instance = type('dummy', (), {})
+try:
+    from pytest import Dir
+except ImportError:
+    # in pytest < 8.0 there is no such type
+    Dir = type('dummy', (), {})
 from reportportal_client import RP, create_client
 from reportportal_client.helpers import (
     dict_to_payload,
@@ -233,7 +238,7 @@ def _get_tree_path(self, item):
         path = [item]
         parent = item.parent
         while parent is not None and not isinstance(parent, Session):
-            if not isinstance(parent, Instance):
+            if not isinstance(parent, Instance) and not isinstance(parent, Dir) and not isinstance(parent, Package):
                 path.append(parent)
             parent = parent.parent
 
@@ -282,22 +287,6 @@ def _build_test_tree(self, session):
                 current_leaf = children_leafs[leaf]
         return test_tree
 
-    def _remove_root_package(self, test_tree):
-        if test_tree['type'] == LeafType.ROOT or \
-                test_tree['type'] == LeafType.DIR:
-            for item, child_leaf in test_tree['children'].items():
-                self._remove_root_package(child_leaf)
-                return
-        if test_tree['type'] == LeafType.CODE and \
-                isinstance(test_tree['item'], Package) and \
-                test_tree['parent']['type'] == LeafType.DIR:
-            parent_leaf = test_tree['parent']
-            current_item = test_tree['item']
-            del parent_leaf['children'][current_item]
-            for item, child_leaf in test_tree['children'].items():
-                parent_leaf['children'][item] = child_leaf
-                child_leaf['parent'] = parent_leaf
-
     def _remove_root_dirs(self, test_tree, max_dir_level, dir_level=0):
         if test_tree['type'] == LeafType.ROOT:
             for item, child_leaf in test_tree['children'].items():
@@ -323,10 +312,7 @@ def _generate_names(self, test_tree):
 
         if test_tree['type'] == LeafType.CODE:
             item = test_tree['item']
-            if isinstance(item, Package):
-                test_tree['name'] = \
-                    os.path.split(os.path.split(str(item.fspath))[0])[1]
-            elif isinstance(item, Module):
+            if isinstance(item, Module):
                 test_tree['name'] = os.path.split(str(item.fspath))[1]
             else:
                 test_tree['name'] = item.name
@@ -376,7 +362,6 @@ def collect_tests(self, session):
         """
         # Create a test tree to be able to apply mutations
         test_tree = self._build_test_tree(session)
-        self._remove_root_package(test_tree)
         self._remove_root_dirs(test_tree, self._config.rp_dir_level)
         self._generate_names(test_tree)
         if not self._config.rp_hierarchy_dirs:
@@ -554,7 +539,7 @@ def _get_issue(self, mark):
         :param mark: pytest mark
         :return: Issue object
         """
-        default_url = self._config.rp_issue_system_url
+        default_url = self._config.rp_bts_issue_url
 
         issue_description_line = \
             self._get_issue_description_line(mark, default_url)

requirements.txt

@@ -1,5 +1,5 @@
 dill>=0.3.6
-pytest>=3.8.0,<8.0.0
+pytest>=3.8.0
 reportportal-client~=5.5.4
 aenum>=3.1.0
 requests>=2.28.0

setup.py

@@ -18,7 +18,7 @@
 from setuptools import setup
 
 
-__version__ = '5.3.3'
+__version__ = '5.4.0'
 
 
 def read_file(fname):

tests/integration/test_config_handling.py

@@ -258,6 +258,21 @@ def test_retries(mock_client_init):
     assert_expectations()
 
 
+@mock.patch(REPORT_PORTAL_SERVICE)
+def test_rp_issue_system_url_warning(mock_client_init):
+    url = 'https://bugzilla.some.com/show_bug.cgi?id={issue_id}'
+    variables = utils.DEFAULT_VARIABLES.copy()
+    variables.update({'rp_issue_system_url': str(url)}.items())
+
+    with warnings.catch_warnings(record=True) as w:
+        result = utils.run_pytest_tests(['examples/test_issue_id.py'], variables=variables)
+        assert int(result) == 1, 'Exit code should be 1 (test failure)'
+
+        expect(mock_client_init.call_count == 1)
+        expect(len(filter_agent_calls(w)) == 1)
+    assert_expectations()
+
+
 @mock.patch(REPORT_PORTAL_SERVICE)
 def test_launch_uuid_print(mock_client_init):
     print_uuid = True

tests/integration/test_issue_report.py

@@ -24,8 +24,7 @@
 from tests.helpers import utils
 
 ISSUE_PLACEHOLDER = '{issue_id}'
-ISSUE_URL_PATTERN = 'https://bugzilla.some.com/show_bug.cgi?id=' + \
-                    ISSUE_PLACEHOLDER
+ISSUE_URL_PATTERN = f'https://bugzilla.some.com/show_bug.cgi?id={ISSUE_PLACEHOLDER}'
 BTS_PROJECT = 'RP-TEST'
 BTS_URL = 'https://bugzilla.some.com'
 
@@ -42,11 +41,9 @@ def test_issue_id_attribute(mock_client_init, issue_id_mark):
     mock_client.start_test_item.side_effect = utils.item_id_gen
     mock_client.get_project_settings.side_effect = utils.project_settings
 
-    variables = dict()
-    variables['rp_issue_id_marks'] = issue_id_mark
+    variables = {'rp_issue_id_marks': issue_id_mark}
     variables.update(utils.DEFAULT_VARIABLES.items())
-    result = utils.run_pytest_tests(tests=['examples/test_issue_id.py'],
-                                    variables=variables)
+    result = utils.run_pytest_tests(tests=['examples/test_issue_id.py'], variables=variables)
     assert int(result) == 1, 'Exit code should be 1 (test failed)'
 
     call_args = mock_client.start_test_item.call_args_list
@@ -73,8 +70,7 @@ def test_issue_report(mock_client_init):
     mock_client.start_test_item.side_effect = utils.item_id_gen
     mock_client.get_project_settings.side_effect = utils.project_settings
 
-    variables = dict()
-    variables['rp_issue_system_url'] = ISSUE_URL_PATTERN
+    variables = {'rp_issue_system_url': ISSUE_URL_PATTERN}
     variables.update(utils.DEFAULT_VARIABLES.items())
     result = utils.run_pytest_tests(tests=['examples/test_issue_id.py'],
                                     variables=variables)
@@ -106,11 +102,9 @@ def test_passed_no_issue_report(mock_client_init):
     mock_client.start_test_item.side_effect = utils.item_id_gen
     mock_client.get_project_settings.side_effect = utils.project_settings
 
-    variables = dict()
-    variables['rp_issue_system_url'] = ISSUE_URL_PATTERN
+    variables = {'rp_issue_system_url': ISSUE_URL_PATTERN}
     variables.update(utils.DEFAULT_VARIABLES.items())
-    result = utils.run_pytest_tests(tests=['examples/test_issue_id_pass.py'],
-                                    variables=variables)
+    result = utils.run_pytest_tests(tests=['examples/test_issue_id_pass.py'], variables=variables)
     assert int(result) == 0, 'Exit code should be 0 (no failures)'
 
     call_args = mock_client.finish_test_item.call_args_list
@@ -164,8 +158,7 @@ def test_skipped_custom_issue(mock_client_init):
     variables['rp_issue_system_url'] = ISSUE_URL_PATTERN
     variables.update(utils.DEFAULT_VARIABLES.items())
 
-    result = utils.run_pytest_tests(tests=['examples/skip/test_skip_issue.py'],
-                                    variables=variables)
+    result = utils.run_pytest_tests(tests=['examples/skip/test_skip_issue.py'], variables=variables)
 
     assert int(result) == 0, 'Exit code should be 0 (no failures)'
     call_args = mock_client.finish_test_item.call_args_list
@@ -187,14 +180,14 @@ def test_external_issue(mock_client_init):
     mock_client.start_test_item.side_effect = utils.item_id_gen
     mock_client.get_project_settings.side_effect = utils.project_settings
 
-    variables = dict()
-    variables['rp_bts_project'] = BTS_PROJECT
-    variables['rp_bts_url'] = BTS_URL
-    variables['rp_issue_system_url'] = ISSUE_URL_PATTERN
+    variables = {
+        'rp_bts_project': BTS_PROJECT,
+        'rp_bts_url': BTS_URL,
+        'rp_bts_issue_url': ISSUE_URL_PATTERN
+    }
     variables.update(utils.DEFAULT_VARIABLES.items())
 
-    result = utils.run_pytest_tests(tests=['examples/test_issue_id.py'],
-                                    variables=variables)
+    result = utils.run_pytest_tests(tests=['examples/test_issue_id.py'], variables=variables)
 
     assert int(result) == 1, 'Exit code should be 1 (test failed)'
     call_args = mock_client.finish_test_item.call_args_list
@@ -210,6 +203,5 @@ def test_external_issue(mock_client_init):
     expect(external_issue['btsUrl'] == BTS_URL)
     expect(external_issue['btsProject'] == BTS_PROJECT)
     expect(external_issue['ticketId'] == test_issue_id.ID)
-    expect(external_issue['url'] ==
-           ISSUE_URL_PATTERN.replace(ISSUE_PLACEHOLDER, test_issue_id.ID))
+    expect(external_issue['url'] == ISSUE_URL_PATTERN.replace(ISSUE_PLACEHOLDER, test_issue_id.ID))
     assert_expectations()

tests/unit/test_plugin.py

@@ -355,6 +355,7 @@ def test_pytest_addoption_adds_correct_ini_file_arguments():
         'rp_hierarchy_dirs',
         'rp_hierarchy_dir_path_separator',
         'rp_issue_system_url',
+        'rp_bts_issue_url',
         'rp_bts_project',
         'rp_bts_url',
         'rp_verify_ssl',