Merge pull request #164 from iivanou/rp_v5_support

iivanou · web-flow · commit 32361bbeb60a · 2020-03-13T20:19:13.000+03:00
Report Portal V5 support.
diff --git a/README.rst b/README.rst
@@ -2,13 +2,12 @@
 agent-python-pytest
 ===================
 
-
-**Important:** this is BETA2 version. Please post issue in case if any found
-
-Pytest plugin for reporting test results of Pytest to the 'Reportal Portal'.
+Pytest plugin for reporting test results of Pytest to the Reportal Portal.
 
 * Usage
+* Installation
 * Configuration
+* Contribution
 * Examples
 * Launching
 * Send attachement (screenshots)
@@ -27,6 +26,22 @@ To install pytest plugin execute next command in a terminal:
 
     pip install pytest-reportportal
 
+**IMPORTANT!**
+The latest version **does not** support Report Portal versions below 5.0.0.
+
+Specify the last one release of the client version 1 to install or update the client for other versions of Report Portal below 5.0.0:
+
+.. code-block:: bash
+
+    pip install pytest-reportportal~=1.0
+
+
+Contribution
+~~~~~~~~~~~~~
+
+All the fixes for the agent that supports Report Portal versions below 5.0.0 should go into the v1 branch.
+The master branch will store the code base for the agent for Report Portal versions 5 and above.
+
 
 Configuration
 ~~~~~~~~~~~~~
@@ -105,7 +120,6 @@ in conftest.py:
 
     @pytest.fixture(scope="session")
     def rp_logger(request):
-        import logging
         logger = logging.getLogger(__name__)
         logger.setLevel(logging.DEBUG)
         # Create handler for Report Portal if the service has been
diff --git a/pytest_reportportal/listener.py b/pytest_reportportal/listener.py
@@ -38,7 +38,7 @@ def pytest_runtest_protocol(self, item):
         if not update_supported:
             self._add_issue_id_marks(item)
 
-        self.PyTestService.start_pytest_item(item)
+        item_id = self.PyTestService.start_pytest_item(item)
         if PYTEST_HAS_LOGGING_PLUGIN:
             # This check can go away once we support pytest >= 3.3
             with patching_logger_class():
@@ -53,7 +53,8 @@ def pytest_runtest_protocol(self, item):
             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)
+        self.PyTestService.finish_pytest_item(
+            item, item_id, self.result or 'SKIPPED', self.issue or None)
 
     @pytest.hookimpl(hookwrapper=True)
     def pytest_runtest_makereport(self, item):
diff --git a/pytest_reportportal/plugin.py b/pytest_reportportal/plugin.py
@@ -3,6 +3,7 @@
 
 import logging
 import dill as pickle
+import pkg_resources
 import pytest
 import requests
 import time
@@ -12,9 +13,15 @@
 
 try:
     # This try/except can go away once we support pytest >= 3.3
-    import _pytest.logging
+    pkg_resources.get_distribution('pytest >= 3.3.0')
     PYTEST_HAS_LOGGING_PLUGIN = True
-except ImportError:
+    try:
+        # This try/except can go away once we support pytest >= 5.4.0
+        from _pytest.logging import get_actual_log_level
+    except ImportError:
+        from _pytest.logging import get_log_level_for_setting as \
+            get_actual_log_level
+except pkg_resources.VersionConflict:
     PYTEST_HAS_LOGGING_PLUGIN = False
 
 log = logging.getLogger(__name__)
@@ -59,7 +66,7 @@ def pytest_sessionstart(session):
             description=session.config.option.rp_launch_description
         )
         if session.config.pluginmanager.hasplugin('xdist'):
-            wait_launch(session.config.py_test_service.RP.rp_client)
+            wait_launch(session.config.py_test_service.rp)
 
 
 @pytest.hookimpl(trylast=True)
@@ -101,14 +108,8 @@ def pytest_sessionfinish(session):
         # Stop now if the plugin is not properly configured
         return
 
-    shouldfail = getattr(session, 'shouldfail', False)
-    nowait = True if shouldfail else False
-
     if is_master(session.config):
-        session.config.py_test_service.finish_launch(
-            status='RP_Launch', force=nowait)
-
-    session.config.py_test_service.terminate_service(nowait=nowait)
+        session.config.py_test_service.finish_launch()
 
 
 def pytest_configure(config):
@@ -152,12 +153,11 @@ def pytest_configure(config):
         config.py_test_service = PyTestServiceClass()
     else:
         config.py_test_service = pickle.loads(config.slaveinput['py_test_service'])
-        config.py_test_service.RP.listener.start()
 
     # set Pytest_Reporter and configure it
     if PYTEST_HAS_LOGGING_PLUGIN:
         # This check can go away once we support pytest >= 3.3
-        log_level = _pytest.logging.get_actual_log_level(config, 'rp_log_level')
+        log_level = get_actual_log_level(config, 'rp_log_level')
         if log_level is None:
             log_level = logging.NOTSET
     else:
diff --git a/pytest_reportportal/service.py b/pytest_reportportal/service.py
@@ -24,7 +24,7 @@
 from _pytest.python import Class, Function, Instance, Module
 from _pytest.unittest import TestCaseFunction, UnitTestCase
 
-from reportportal_client import ReportPortalServiceAsync
+from reportportal_client import ReportPortalService
 from six import with_metaclass
 from six.moves import queue
 
@@ -74,12 +74,15 @@ def __call__(cls, *args, **kwargs):
 class PyTestServiceClass(with_metaclass(Singleton, object)):
 
     def __init__(self):
-        self.RP = None
+        self.rp = None
+        self.rp_supports_parameters = True
         try:
             pkg_resources.get_distribution('reportportal_client >= 3.2.0')
-            self.RP_SUPPORTS_PARAMETERS = True
         except pkg_resources.VersionConflict:
-            self.RP_SUPPORTS_PARAMETERS = False
+            self.rp_supports_parameters = False
+
+        self.log_item_id = None
+        self.parent_item_id = None
 
         self.ignore_errors = True
         self.ignored_tags = []
@@ -93,64 +96,57 @@ def init_service(self, endpoint, project, uuid, log_batch_size,
                      ignore_errors, ignored_tags, verify_ssl=True,
                      retries=0):
         self._errors = queue.Queue()
-        if self.RP is None:
+        if self.rp is None:
             self.ignore_errors = ignore_errors
-            if self.RP_SUPPORTS_PARAMETERS:
+            if self.rp_supports_parameters:
                 self.ignored_tags = list(set(ignored_tags).union({'parametrize'}))
             else:
                 self.ignored_tags = ignored_tags
             log.debug('ReportPortal - Init service: endpoint=%s, '
                       'project=%s, uuid=%s', endpoint, project, uuid)
-            self.RP = ReportPortalServiceAsync(
+            self.rp = ReportPortalService(
                 endpoint=endpoint,
                 project=project,
                 token=uuid,
-                error_handler=self.async_error_handler,
                 retries=retries,
-                log_batch_size=log_batch_size,
                 verify_ssl=verify_ssl
             )
-            if self.RP and hasattr(self.RP.rp_client, "get_project_settings"):
-                self.project_settings = self.RP.rp_client.get_project_settings()
+            if self.rp and hasattr(self.rp, "get_project_settings"):
+                self.project_settings = self.rp.get_project_settings()
             else:
                 self.project_settings = None
             self.issue_types = self.get_issue_types()
         else:
             log.debug('The pytest is already initialized')
-        return self.RP
+        return self.rp
 
     def async_error_handler(self, exc_info):
-        self.terminate_service(nowait=True)
-        self.RP = None
+        self.rp = None
         self._errors.put_nowait(exc_info)
 
-    def terminate_service(self, nowait=False):
-        if self.RP is not None:
-            self.RP.terminate(nowait)
-            self.RP = None
-
-    def start_launch(self, launch_name,
+    def start_launch(self,
+                     launch_name,
                      mode=None,
-                     tags=None,
-                     description=None):
+                     description=None,
+                     **kwargs):
         self._stop_if_necessary()
-        if self.RP is None:
+        if self.rp is None:
             return
 
         sl_pt = {
             'name': launch_name,
             'start_time': timestamp(),
             'description': description,
             'mode': mode,
-            'tags': tags
         }
         log.debug('ReportPortal - Start launch: equest_body=%s', sl_pt)
-        req_data = self.RP.start_launch(**sl_pt)
-        log.debug('ReportPortal - Launch started: response_body=%s', req_data)
+        item_id = self.rp.start_launch(**sl_pt)
+        log.debug('ReportPortal - Launch started: id=%s', item_id)
+        return item_id
 
     def collect_tests(self, session):
         self._stop_if_necessary()
-        if self.RP is None:
+        if self.rp is None:
             return
 
         hier_dirs = False
@@ -209,7 +205,7 @@ def collect_tests(self, session):
 
     def start_pytest_item(self, test_item=None):
         self._stop_if_necessary()
-        if self.RP is None:
+        if self.rp is None:
             return
 
         for part in self._item_parts[test_item]:
@@ -220,37 +216,42 @@ def start_pytest_item(self, test_item=None):
             payload = {
                 'name': self._get_item_name(part),
                 'description': self._get_item_description(part),
-                'tags': self._get_item_tags(part),
                 'start_time': timestamp(),
-                'item_type': 'SUITE'
+                'item_type': 'SUITE',
+                'parent_item_id': self.parent_item_id
             }
             log.debug('ReportPortal - Start Suite: request_body=%s', payload)
-            self.RP.start_test_item(**payload)
+            item_id = self.rp.start_test_item(**payload)
+            self.log_item_id = item_id
+            self.parent_item_id = item_id
+            self._hier_parts[part]["item_id"] = item_id
 
         start_rq = {
             'name': self._get_item_name(test_item),
             'description': self._get_item_description(test_item),
-            'tags': self._get_item_tags(test_item),
             'start_time': timestamp(),
-            'item_type': 'STEP'
+            'item_type': 'TEST',
+            'parent_item_id': self.parent_item_id
         }
-        if self.RP_SUPPORTS_PARAMETERS:
+        if self.rp_supports_parameters:
             start_rq['parameters'] = self._get_parameters(test_item)
 
         log.debug('ReportPortal - Start TestItem: request_body=%s', start_rq)
-        self.RP.start_test_item(**start_rq)
+        item_id = self.rp.start_test_item(**start_rq)
+        self.log_item_id = item_id
+        return item_id
 
     def is_item_update_supported(self):
         """Check item update API call client support."""
-        return hasattr(self.RP, "update_test_item")
+        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:
+        if self.rp is None:
             return
 
         # if update_test_item is not supported in client
@@ -263,23 +264,25 @@ def update_pytest_item(self, test_item=None):
             'tags': self._get_item_tags(test_item),
         }
         log.debug('ReportPortal - Update TestItem: request_body=%s', start_rq)
-        self.RP.update_test_item(**start_rq)
+        self.rp.update_test_item(**start_rq)
 
-    def finish_pytest_item(self, test_item, status, issue=None):
+    def finish_pytest_item(self, test_item, item_id, status, issue=None):
         self._stop_if_necessary()
-        if self.RP is None:
+        if self.rp is None:
             return
 
         fta_rq = {
             'end_time': timestamp(),
             'status': status,
-            'issue': issue
+            'issue': issue,
+            'item_id': item_id
         }
 
         log.debug('ReportPortal - Finish TestItem: request_body=%s', fta_rq)
-        self.RP.finish_test_item(**fta_rq)
 
         parts = self._item_parts[test_item]
+        if not parts:
+            self.rp.finish_test_item(**fta_rq)
         while len(parts) > 0:
             part = parts.pop()
             if status == "FAILED":
@@ -290,14 +293,15 @@ def finish_pytest_item(self, test_item, status, issue=None):
             payload = {
                 'end_time': timestamp(),
                 'issue': issue,
+                'item_id': self._hier_parts[part]["item_id"],
                 'status': part._rp_result
             }
             log.debug('ReportPortal - End TestSuite: request_body=%s', payload)
-            self.RP.finish_test_item(**payload)
+            self.rp.finish_test_item(**payload)
 
-    def finish_launch(self, status='rp_launch', force=False):
+    def finish_launch(self, status=None, **kwargs):
         self._stop_if_necessary()
-        if self.RP is None:
+        if self.rp is None:
             return
 
         # To finish launch session str parameter is needed
@@ -306,14 +310,11 @@ def finish_launch(self, status='rp_launch', force=False):
             'status': status
         }
         log.debug('ReportPortal - Finish launch: request_body=%s', fl_rq)
-        if not force:
-            self.RP.finish_launch(**fl_rq)
-        else:
-            self.RP.stop_launch(**fl_rq)
+        self.rp.finish_launch(**fl_rq)
 
     def post_log(self, message, loglevel='INFO', attachment=None):
         self._stop_if_necessary()
-        if self.RP is None:
+        if self.rp is None:
             return
 
         if loglevel not in self._loglevels:
@@ -327,7 +328,7 @@ def post_log(self, message, loglevel='INFO', attachment=None):
             'level': loglevel,
             'attachment': attachment,
         }
-        self.RP.log(**sl_rq)
+        self.rp.log_batch((sl_rq,), item_id=self.log_item_id)
 
     def _stop_if_necessary(self):
         try:
diff --git a/setup.py b/setup.py
@@ -8,11 +8,11 @@ def read_file(fname):
         return f.read()
 
 
-version = '1.10.0'
+version = '5.0.0'
 
 
 requirements = [
-    'reportportal-client~=3.0',
+    'reportportal-client~=5.0.0',
     'pytest>=3.0.7',
     'six>=1.10.0',
     'dill>=0.2.7.1',
@@ -25,7 +25,6 @@ def read_file(fname):
     description='Agent for Reporting results of tests to the Report Portal',
     long_description=read_file('README.rst'),
     long_description_content_type='text/markdown',
-    author='Pavel Papou',
     author_email='SupportEPMC-TSTReportPortal@epam.com',
     url='https://github.com/reportportal/agent-python-pytest',
     packages=['pytest_reportportal'],
diff --git a/tests/test_plugin.py b/tests/test_plugin.py
