Merge pull request #333 from reportportal/develop

Release

Author: HardNorth

pytest_reportportal/config.py

@@ -3,7 +3,7 @@
 from distutils.util import strtobool
 from os import getenv
 
-from reportportal_client.core.log_manager import MAX_LOG_BATCH_PAYLOAD_SIZE
+from reportportal_client.logs.log_manager import MAX_LOG_BATCH_PAYLOAD_SIZE
 
 try:
     # This try/except can go away once we support pytest >= 5.4.0

pytest_reportportal/plugin.py

@@ -11,8 +11,8 @@
 import pytest
 import requests
 from reportportal_client import RPLogHandler
-from reportportal_client.core.log_manager import MAX_LOG_BATCH_PAYLOAD_SIZE
 from reportportal_client.errors import ResponseError
+from reportportal_client.logs.log_manager import MAX_LOG_BATCH_PAYLOAD_SIZE
 
 from pytest_reportportal import LAUNCH_WAIT_TIMEOUT
 from .config import AgentConfig
@@ -34,6 +34,7 @@ def pytest_configure_node(node):
 
     :param node: Object of the xdist WorkerController class
     """
+    # noinspection PyProtectedMember
     if not node.config._rp_enabled:
         # Stop now if the plugin is not properly configured
         return
@@ -62,6 +63,7 @@ def wait_launch(rp_client):
         time.sleep(1)
 
 
+# noinspection PyProtectedMember
 def pytest_sessionstart(session):
     """Start Report Portal launch.
 
@@ -96,13 +98,15 @@ def pytest_collection_finish(session):
 
     :param session: Object of the pytest Session class
     """
+    # noinspection PyProtectedMember
     if not session.config._rp_enabled:
         # Stop now if the plugin is not properly configured
         return
 
     session.config.py_test_service.collect_tests(session)
 
 
+# noinspection PyProtectedMember
 def pytest_sessionfinish(session):
     """Finish current test session.
 
@@ -162,6 +166,7 @@ def check_connection(agent_config):
         return False
 
 
+# noinspection PyProtectedMember
 def pytest_configure(config):
     """Update Config object with attributes required for reporting to RP.
 
@@ -204,6 +209,7 @@ def pytest_configure(config):
             config.workerinput['py_test_service'])
 
 
+# noinspection PyProtectedMember
 @pytest.hookimpl(hookwrapper=True)
 def pytest_runtestloop(session):
     """
@@ -222,6 +228,7 @@ def pytest_runtestloop(session):
         yield
 
 
+# noinspection PyProtectedMember
 @pytest.hookimpl(hookwrapper=True)
 def pytest_runtest_protocol(item):
     """
@@ -253,6 +260,7 @@ def pytest_runtest_protocol(item):
     service.finish_pytest_item(item)
 
 
+# noinspection PyProtectedMember
 @pytest.hookimpl(hookwrapper=True)
 def pytest_runtest_makereport(item):
     """
@@ -278,28 +286,28 @@ def pytest_addoption(parser):
     """
     group = parser.getgroup('reporting')
 
-    def add_shared_option(name, help, default=None, action='store'):
+    def add_shared_option(name, help_str, default=None, action='store'):
         """
         Add an option to both the command line and the .ini file.
 
         This function modifies `parser` and `group` from the outer scope.
 
         :param name:     name of the option
-        :param help:     help message
+        :param help_str: help message
         :param default:  default value
         :param action:   `group.addoption` action
         """
         parser.addini(
             name=name,
             default=default,
-            help=help,
+            help=help_str,
         )
         group.addoption(
             '--{0}'.format(name.replace('_', '-')),
             action=action,
             dest=name,
             help='{help} (overrides {name} config option)'.format(
-                help=help,
+                help=help_str,
                 name=name,
             ),
         )
@@ -313,57 +321,57 @@ def add_shared_option(name, help, default=None, action='store'):
     )
     add_shared_option(
         name='rp_launch',
-        help='Launch name',
+        help_str='Launch name',
         default='Pytest Launch',
     )
     add_shared_option(
         name='rp_launch_id',
-        help='Use already existing launch-id. The plugin won\'t control the '
-             'Launch status',
+        help_str='Use already existing launch-id. The plugin won\'t control '
+        'the Launch status',
     )
     add_shared_option(
         name='rp_launch_description',
-        help='Launch description',
+        help_str='Launch description',
         default='',
     )
-    add_shared_option(name='rp_project', help='Project name')
+    add_shared_option(name='rp_project', help_str='Project name')
     add_shared_option(
         name='rp_log_level',
-        help='Logging level for automated log records reporting',
+        help_str='Logging level for automated log records reporting',
     )
     add_shared_option(
         name='rp_log_format',
-        help='Logging format for automated log records reporting',
+        help_str='Logging format for automated log records reporting',
     )
     add_shared_option(
         name='rp_rerun',
-        help='Marks the launch as a rerun',
+        help_str='Marks the launch as a rerun',
         default=False,
         action='store_true',
     )
     add_shared_option(
         name='rp_rerun_of',
-        help='ID of the launch to be marked as a rerun (use only with '
-             'rp_rerun=True)',
+        help_str='ID of the launch to be marked as a rerun (use only with '
+                 'rp_rerun=True)',
         default='',
     )
     add_shared_option(
         name='rp_parent_item_id',
-        help='Create all test item as child items of the given (already '
-             'existing) item.',
+        help_str='Create all test item as child items of the given (already '
+                 'existing) item.',
     )
-    add_shared_option(name='rp_uuid', help='UUID')
-    add_shared_option(name='rp_endpoint', help='Server endpoint')
+    add_shared_option(name='rp_uuid', help_str='UUID')
+    add_shared_option(name='rp_endpoint', help_str='Server endpoint')
     add_shared_option(
         name='rp_mode',
-        help='Visibility of current launch [DEFAULT, DEBUG]',
+        help_str='Visibility of current launch [DEFAULT, DEBUG]',
         default='DEFAULT'
     )
     add_shared_option(
         name='rp_thread_logging',
-        help='EXPERIMENTAL: Report logs from threads. '
-             'This option applies a patch to the builtin Thread class, '
-             'and so it is turned off by default. Use with caution.',
+        help_str='EXPERIMENTAL: Report logs from threads. '
+                 'This option applies a patch to the builtin Thread class, '
+                 'and so it is turned off by default. Use with caution.',
         default=False,
         action='store_true'
     )

pytest_reportportal/service.py

@@ -19,7 +19,6 @@
     # in pytest >= 7.0 this type was removed
     Instance = type('dummy', (), {})
 from reportportal_client.client import RPClient
-from reportportal_client.external.google_analytics import send_event
 from reportportal_client.helpers import (
     dict_to_payload,
     gen_attributes,
@@ -134,7 +133,7 @@ def _get_launch_attributes(self, ini_attrs):
         attributes = ini_attrs or []
         system_attributes = get_launch_sys_attrs()
         system_attributes['agent'] = (
-            '{}-{}'.format(self.agent_name, self.agent_version))
+            '{}|{}'.format(self.agent_name, self.agent_version))
         return attributes + dict_to_payload(system_attributes)
 
     def _build_start_launch_rq(self):
@@ -165,8 +164,6 @@ def start_launch(self):
         log.debug('ReportPortal - Start launch: request_body=%s', sl_pt)
         self._launch_id = self.rp.start_launch(**sl_pt)
         log.debug('ReportPortal - Launch started: id=%s', self._launch_id)
-        if not self._skip_analytics:
-            send_event(self.agent_name, self.agent_version)
         return self._launch_id
 
     def _get_item_dirs(self, item):
@@ -878,9 +875,10 @@ def start(self):
             launch_id=launch_id,
             log_batch_payload_size=self._config.rp_log_batch_payload_size
         )
-        if self.rp and hasattr(self.rp, "get_project_settings"):
+        if hasattr(self.rp, "get_project_settings"):
             self.project_settings = self.rp.get_project_settings()
         self.rp.start()
+        # noinspection PyUnresolvedReferences
         self._start_tracker.add(self.__unique_id())
 
     def stop(self):

pytest_reportportal/service.pyi

@@ -36,3 +36,4 @@ class PyTestServiceClass:
     project_settings: Dict[Text, Any] = ...
 
     def __init__(self, agent_config: AgentConfig) -> None: ...
+    def start(self) -> None: ...

requirements.txt

@@ -1,6 +1,6 @@
 dill>=0.2.7.1
 pytest>=3.8.0
-reportportal-client==5.2.5
+reportportal-client==5.3.0
 six>=1.15.0
 aenum>=3.1.0
 requests

setup.py

@@ -5,7 +5,7 @@
 from setuptools import setup
 
 
-__version__ = '5.1.5'
+__version__ = '5.1.6'
 
 
 def read_file(fname):

tests/unit/conftest.py

@@ -18,6 +18,7 @@
 from _pytest.main import Session
 from pluggy._tracing import TagTracer
 from pytest import fixture, Module
+# noinspection PyUnresolvedReferences
 from six.moves import mock
 
 from reportportal_client import RPLogger

tests/unit/test_plugin.py

@@ -1,4 +1,4 @@
-"""This modules includes unit tests for the plugin."""
+"""This module includes unit tests for the plugin."""
 
 #  Copyright (c) 2021 http://reportportal.io .
 #  Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,6 +17,7 @@
 import pytest
 from delayed_assert import expect, assert_expectations
 from requests.exceptions import RequestException
+# noinspection PyUnresolvedReferences
 from six.moves import mock
 
 from reportportal_client.errors import ResponseError