Merge pull request #147 from bigbZik/issue-id-marks

Dmitriy Gumeniuk · web-flow · commit 59e55b9c976e · 2019-11-22T15:25:15.000+03:00
Adding support for issue-id marks
diff --git a/README.rst b/README.rst
@@ -78,6 +78,7 @@ The following parameters are optional:
 - :code:`rp_hierarchy_dirs_level = 0` - Directory starting hierarchy level (from pytest.ini level) (default `0`)
 - :code:`rp_issue_marks = 'xfail' 'issue'` - Pytest marks that could be used to get issue information (id, type, reason)
 - :code:`rp_issue_system_url = http://bugzilla.some.com/show_bug.cgi?id={%issue_id}` - issue URL (issue_id will be filled by parameter from pytest mark)
+- :code:`rp_issue_id_marks = True` - Enables adding marks for issue ids (e.g. "issue:123456")
 - :code:`rp_verify_ssl = True` - Verify SSL when connecting to the server
 - :code:`rp_display_suite_test_file = True` In case of True, include the suite's relative file path in the launch name as a convention of "<RELATIVE_FILE_PATH>::<SUITE_NAME>". In case of False, set the launch name to be the suite name only - this flag is relevant only when "rp_hierarchy_module" flag is set to False
 
diff --git a/pytest_reportportal/listener.py b/pytest_reportportal/listener.py
@@ -32,6 +32,12 @@ def __init__(self, py_test_service,
 
     @pytest.hookimpl(hookwrapper=True)
     def pytest_runtest_protocol(self, item):
+        # Adding issues id marks to the test item
+        # if client doesn't support item updates
+        update_supported = self.PyTestService.is_item_update_supported()
+        if not update_supported:
+            self._add_issue_id_marks(item)
+
         self.PyTestService.start_pytest_item(item)
         if PYTEST_HAS_LOGGING_PLUGIN:
             # This check can go away once we support pytest >= 3.3
@@ -41,6 +47,12 @@ def pytest_runtest_protocol(self, item):
                     yield
         else:
             yield
+        # Updating item in RP (tags and description)
+        # if client supports
+        if update_supported:
+            self._add_issue_id_marks(item)
+            self.PyTestService.update_pytest_item(item)
+        # Finishing item in RP
         self.PyTestService.finish_pytest_item(item, self.result or 'SKIPPED', self.issue or None)
 
     @pytest.hookimpl(hookwrapper=True)
@@ -53,67 +65,88 @@ def pytest_runtest_makereport(self, item):
                 loglevel='ERROR',
             )
 
+        # Defining test result
         if report.when == 'setup':
             self.result = None
             self.issue = {}
-            if report.failed:
-                # This happens for example when a fixture fails to run
-                # causing the test to error
-                self.result = 'FAILED'
-                self._add_issue_info(item, report)
-            elif report.skipped:
-                # This happens when a testcase is marked "skip".  It will
-                # show in reportportal as not requiring investigation.
+
+        if report.failed:
+            self.result = 'FAILED'
+        elif report.skipped:
+            if self.result in (None, 'PASSED'):
                 self.result = 'SKIPPED'
-                self._add_issue_info(item, report)
+        else:
+            if self.result is None:
+                self.result = 'PASSED'
 
-        if report.when == 'call':
-            if report.passed:
-                item_result = 'PASSED'
-            elif report.skipped:
-                item_result = 'SKIPPED'
-                self._add_issue_info(item, report)
-            else:
-                item_result = 'FAILED'
-                self._add_issue_info(item, report)
-            self.result = item_result
+        # Adding test comment and issue type
+        self._add_issue_info(item, report)
 
+    def _add_issue_id_marks(self, item):
+        """Add marks with issue id.
+
+        :param item: pytest test item
+        """
+        issue_marks = item.session.config.getini('rp_issue_marks')
+        if item.session.config.getini('rp_issue_id_marks'):
+            for mark_name in issue_marks:
+                for mark in item.iter_markers(name=mark_name):
+                    if mark:
+                        issue_ids = mark.kwargs.get("issue_id", [])
+                        if not isinstance(issue_ids, list):
+                            issue_ids = [issue_ids]
+                        for issue_id in issue_ids:
+                            mark_issue = "{}:{}".format(mark.name, issue_id)
+                            try:
+                                pytest.mark._markers.add(mark_issue)  # register mark in pytest,
+                            except AttributeError:               # for pytest >= 4.5.0
+                                pass
+                            item.add_marker(mark_issue)
 
     def _add_issue_info(self, item, report):
+        """Add issues description and issue_type to the test item.
 
-        issue_type = None
-        comment = ""
+        :param item: pytest test item
+        :param report: pytest report instance
+        """
         url = item.session.config.getini('rp_issue_system_url')
         issue_marks = item.session.config.getini('rp_issue_marks')
+        issue_type = None
+        comment = ""
 
         for mark_name in issue_marks:
-            try:
-                mark = item.get_closest_marker(mark_name)
-            except AttributeError:
-                # pytest < 3.6
-                mark = item.get_marker(mark_name)
-
-            if mark:
-                if "reason" in mark.kwargs:
-                    comment += "\n" if comment else ""
-                    comment += mark.kwargs["reason"]
-                if "issue_id" in mark.kwargs:
-                    issue_ids = mark.kwargs["issue_id"]
-                    if not isinstance(issue_ids, list):
-                        issue_ids = [issue_ids]
-                    comment += "\n" if comment else ""
-                    comment += "Issues:"
+            for mark in item.iter_markers(name=mark_name):
+                if not mark:
+                    continue
+
+                mark_comment = ""
+                mark_url = mark.kwargs.get("url", None) or url
+                issue_ids = mark.kwargs.get("issue_id", [])
+                if not isinstance(issue_ids, list):
+                    issue_ids = [issue_ids]
+
+                if issue_ids:
+                    mark_comment = mark.kwargs.get("reason", mark.name)
+                    mark_comment += ":"
                     for issue_id in issue_ids:
-                        template = (" [{issue_id}]" + "({})".format(url)) if url else " {issue_id}"
-                        comment += template.format(issue_id=issue_id)
+                        issue_url = mark_url.format(issue_id=issue_id) if mark_url else None
+                        template = " [{issue_id}]({url})" if issue_url else " {issue_id}"
+                        mark_comment += template.format(issue_id=issue_id, url=issue_url)
+                elif "reason" in mark.kwargs:
+                     mark_comment = mark.kwargs["reason"]
+
+                if mark_comment:
+                    comment += ("\n* " if comment else "* ") + mark_comment
 
-                if "issue_type" in mark.kwargs:
+                # Set issue_type only for first issue mark
+                if "issue_type" in mark.kwargs and issue_type is None:
                     issue_type = mark.kwargs["issue_type"]
 
+        # default value
         issue_type = "TI" if issue_type is None else issue_type
 
-        if issue_type and getattr(self.PyTestService, 'issue_types', False) \
-                and (issue_type in self.PyTestService.issue_types):
+        if issue_type and \
+                (issue_type in getattr(self.PyTestService, 'issue_types', ())):
             if comment:
                 self.issue['comment'] = comment
             self.issue['issue_type'] = self.PyTestService.issue_types[issue_type]
diff --git a/pytest_reportportal/plugin.py b/pytest_reportportal/plugin.py
@@ -317,6 +317,12 @@ def pytest_addoption(parser):
              "'<RELATIVE_FILE_PATH>::<SUITE_NAME>'. In case of False, set the launch name to be the suite name "
              "only - this flag is relevant only when 'rp_hierarchy_module' flag is set to False")
 
+    parser.addini(
+        'rp_issue_id_marks',
+        type='bool',
+        default=True,
+        help='Adding tag with issue id to the test')
+
     parser.addini(
         'retries',
         default='0',
diff --git a/pytest_reportportal/service.py b/pytest_reportportal/service.py
@@ -240,6 +240,31 @@ def start_pytest_item(self, test_item=None):
         log.debug('ReportPortal - Start TestItem: request_body=%s', start_rq)
         self.RP.start_test_item(**start_rq)
 
+    def is_item_update_supported(self):
+        """Check item update API call client support."""
+        return hasattr(self.RP, "update_test_item")
+
+    def update_pytest_item(self, test_item=None):
+        """Make item update API call.
+
+        :param test_item: pytest test item
+        """
+        self._stop_if_necessary()
+        if self.RP is None:
+            return
+
+        # if update_test_item is not supported in client
+        if not self.is_item_update_supported():
+            log.debug('ReportPortal - Update TestItem: method is not defined')
+            return
+
+        start_rq = {
+            'description': self._get_item_description(test_item),
+            'tags': self._get_item_tags(test_item),
+        }
+        log.debug('ReportPortal - Update TestItem: request_body=%s', start_rq)
+        self.RP.update_test_item(**start_rq)
+
     def finish_pytest_item(self, test_item, status, issue=None):
         self._stop_if_necessary()
         if self.RP is None:
diff --git a/tests/test_plugin.py b/tests/test_plugin.py
@@ -10,7 +10,9 @@
 import pytest
 from requests.exceptions import RequestException
 
+from pytest_reportportal.listener import RPReportListener
 from pytest_reportportal.plugin import pytest_configure
+from pytest_reportportal.service import PyTestServiceClass
 from pytest_reportportal import RPLogger
 
 
@@ -63,3 +65,107 @@ def test_logger_handle_no_attachment(mock_handler, logger, log_level):
     expect(getattr(mock_handler.call_args[0][0], "attachment") is None,
            "record.attachment in args is not None")
     assert_expectations()
+
+
+def test_pytest_runtest_protocol(request):
+    """Test listener pytest_runtest_protocol hook."""
+    rp_service = Mock()
+    rp_service.is_item_update_supported = Mock(return_value=False)
+    rp_listener = RPReportListener(rp_service)
+    rp_listener._add_issue_id_marks = Mock()
+    test_item = Mock()
+
+    next(rp_listener.pytest_runtest_protocol(test_item))
+
+    expect(rp_listener._add_issue_id_marks.call_count == 1,
+            "_add_issue_id_marks called more than 1 time")
+    assert_expectations()
+
+
+@patch('reportportal_client.service.ReportPortalService.get_project_settings')
+def test_is_item_update_supported(request):
+    """Test listener public is_client_support_item_update method."""
+    func = None
+    rp_service = PyTestServiceClass()
+    rp_service.init_service("endpoint", "project", "uuid", 20, False, [])
+
+    if hasattr(rp_service.RP, "update_test_item"):
+        rp_service.RP.supported_methods.remove("update_test_item")
+        func = rp_service.RP.update_test_item
+        delattr(type(rp_service.RP), "update_test_item")
+
+
+    result = rp_service.is_item_update_supported()
+    expect(result == False,
+           "incorrect result for is_client_support_item_update method")
+
+    rp_service.RP.update_test_item = func
+    rp_service.RP.supported_methods.append("update_test_item")
+
+    result = rp_service.is_item_update_supported()
+    expect(result == True,
+           "incorrect result for is_client_support_item_update method")
+    assert_expectations()
+
+
+def test_add_issue_info(request):
+    """Test listener helper _add_issue_info method."""
+    rp_service = Mock()
+    rp_listener = RPReportListener(rp_service)
+    rp_service.issue_types = {"TST": "TEST"}
+
+    report = Mock()
+    report.when = "call"
+    report.skipped = False
+
+    def getini(option):
+        if option == "rp_issue_system_url":
+            return "https://bug.com/{issue_id}"
+        elif option == "rp_issue_marks":
+            return ["issue"]
+        return None
+
+    def iter_markers(name=None):
+        for mark in [pytest.mark.issue(issue_id="456823", issue_type="TST")]:
+            yield mark
+
+    test_item = Mock()
+    test_item.session.config.getini = getini
+    test_item.iter_markers = iter_markers
+
+    rp_listener._add_issue_info(test_item, report)
+
+    expect(rp_listener.issue['issue_type'] == "TEST",
+           "incorrect test issue_type")
+    expect(rp_listener.issue['comment'] == "* issue: [456823](https://bug.com/456823)",
+           "incorrect test comment")
+    assert_expectations()
+
+
+def test_add_issue_id_marks(request):
+    """Test listener helper _add_issue_id_marks method."""
+    rp_service = Mock()
+    rp_listener = RPReportListener(rp_service)
+
+    def getini(option):
+        if option == "rp_issue_id_marks":
+            return True
+        elif option == "rp_issue_marks":
+            return ["issue"]
+        return None
+
+    def iter_markers(name=None):
+        for mark in [pytest.mark.issue(issue_id="456823")]:
+            yield mark
+
+    test_item = Mock()
+    test_item.session.config.getini = getini
+    test_item.iter_markers = iter_markers
+
+    rp_listener._add_issue_id_marks(test_item)
+
+    expect(test_item.add_marker.call_count == 1,
+           "item.add_marker called more than 1 time")
+    expect(test_item.add_marker.call_args[0][0] == "issue:456823",
+           "item.add_marker called with incorrect parameters")
+    assert_expectations()
