Merge pull request #340 from reportportal/develop

Release

Author: HardNorth

CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
 
 ## [Unreleased]
+### Added
+- `rp_api_retries` configuration parameter, by @HardNorth
+### Changed
+- Client version updated on [5.3.5](https://github.com/reportportal/client-Python/releases/tag/5.3.5), by @HardNorth
+- `rp_uuid` configuration parameter was renamed to `rp_api_key` to maintain common convention, by @HardNorth
+
+## [5.1.8]
 ### Fixed
 - `rp_thread_logging = False` config parameter handling, by @HardNorth
 - Recursive thread init issue in case of `rp_thread_logging = True`, by @HardNorth

README.rst

@@ -60,7 +60,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_api_key` - value could be found in the User Profile section
 - :code:`rp_project` - name of project in Report Portal
 - :code:`rp_endpoint` - address of Report Portal Server
 
@@ -69,43 +69,41 @@ Example of :code:`pytest.ini`:
 .. code-block:: text
 
     [pytest]
-    rp_uuid = fb586627-32be-47dd-93c1-678873458a5f
+    rp_api_key = fb586627-32be-47dd-93c1-678873458a5f
     rp_endpoint = http://192.168.1.10:8080
     rp_project = user_personal
     rp_launch = AnyLaunchName
     rp_launch_attributes = 'PyTest' 'Smoke'
     rp_launch_description = 'Smoke test'
     rp_ignore_attributes = 'xfail' 'usefixture'
 
-- The :code:`rp_uuid` can also be set with the environment variable `RP_UUID`. This will override the value set for :code:`rp_uuid` in pytest.ini
+- The :code:`rp_api_key` can also be set with the environment variable `RP_API_KEY`. This will override the value set for :code:`rp_api_key` in pytest.ini
 
 The following parameters are optional:
 
-- :code:`rp_launch = AnyLaunchName` - launch name (could be overridden
-  by pytest --rp-launch option, default value is 'Pytest Launch')
-- :code:`rp_launch_id = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` - id of the existing launch (the session will not handle the lifecycle of the given launch)
-- :code:`rp_launch_attributes = 'PyTest' 'Smoke' 'Env:Python3'` - list of attributes for launch
-- :code:`rp_parent_item_id = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` - id of the existing test item for session to use as parent item for the tests (the session will not handle the lifecycle of the given test item)
-- :code:`rp_tests_attributes = 'PyTest' 'Smoke'` - list of attributes that will be added for each item in the launch
-- :code:`rp_launch_description = 'Smoke test'` - launch description (could be overridden
-  by pytest --rp-launch-description option, default value is '')
-
-- :code:`rp_log_batch_size = 20` - size of batch log request
-- :code:`rp_log_batch_payload_size = 65000000` - maximum payload size in bytes of async batch log requests
-- :code:`rp_log_level = INFO` - The log level that will be reported
+- :code:`rp_launch = AnyLaunchName` - launch name (could be overridden by pytest --rp-launch option, default value is 'Pytest Launch').
+- :code:`rp_launch_id = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` - id of the existing launch (the session will not handle the lifecycle of the given launch).
+- :code:`rp_launch_attributes = 'PyTest' 'Smoke' 'Env:Python3'` - list of attributes for launch.
+- :code:`rp_parent_item_id = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` - id of the existing test item for session to use as parent item for the tests (the session will not handle the lifecycle of the given test item).
+- :code:`rp_tests_attributes = 'PyTest' 'Smoke'` - list of attributes that will be added for each item in the launch.
+- :code:`rp_launch_description = 'Smoke test'` - launch description (could be overridden by pytest --rp-launch-description option, default value is '').
+- :code:`rp_log_batch_size = 20` - size of batch log request.
+- :code:`rp_log_batch_payload_size = 65000000` - maximum payload size in bytes of async batch log requests.
+- :code:`rp_log_level = INFO` - The log level that will be reported.
 - :code:`rp_log_format = [%(levelname)7s] (%(name)s) %(message)s (%(filename)s:%(lineno)s)` - Format string to be used for logs sent to the service.
-- :code:`rp_ignore_attributes = 'xfail' 'usefixture'` - Ignore specified pytest markers
+- :code:`rp_ignore_attributes = 'xfail' 'usefixture'` - Ignore specified pytest markers.
 - :code:`rp_is_skipped_an_issue = False` - Treat skipped tests as required investigation. Default is True.
-- :code:`rp_hierarchy_dirs_level = 0` - Directory starting hierarchy level (from pytest.ini level) (default `0`)
+- :code:`rp_hierarchy_dirs_level = 0` - Directory starting hierarchy level (from pytest.ini level) (default `0`).
 - :code:`rp_hierarchy_dirs = True` - Enables hierarchy for tests directories, default `False`. Doesn't support 'xdist' plugin.
-- :code:`rp_hierarchy_dir_path_separator` - Path separator to display directories in test hierarchy. In case of empty value current system path separator will be used (os.path.sep)
+- :code:`rp_hierarchy_dir_path_separator` - Path separator to display directories in test hierarchy. In case of empty value current system path separator will be used (os.path.sep).
 - :code:`rp_hierarchy_code` - Enables hierarchy for inner classes and parametrized tests, default `False`. Doesn't support 'xdist' plugin.
-- :code:`rp_issue_system_url = https://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_mode = DEFAULT` - DEBUG or DEFAULT launch mode. DEBUG launches are displayed in a separate tab and not visible to anyone except owner
+- :code:`rp_issue_system_url = https://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_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)
+- :code:`rp_launch_timeout = 86400` - Maximum time to wait for child processes finish, default value: 86400 seconds (1 day).
+- :code:`rp_api_retries = 0` - Amount of retries for performing REST calls to RP server.
 
 
 

pytest_reportportal/config.py

@@ -1,4 +1,5 @@
 """This module contains class that stores RP agent configuration data."""
+import warnings
 
 from distutils.util import strtobool
 from os import getenv
@@ -69,14 +70,55 @@ def __init__(self, pytest_config):
                                            'rp_project')
         self.rp_rerun_of = self.find_option(pytest_config,
                                             'rp_rerun_of')
-        self.rp_retries = int(self.find_option(pytest_config,
-                                               'retries'))
         self.rp_skip_connection_test = str(
             self.find_option(pytest_config,
                              'rp_skip_connection_test')).lower() in (
                                            'true', '1', 'yes', 'y')
-        self.rp_uuid = getenv('RP_UUID') or self.find_option(pytest_config,
-                                                             'rp_uuid')
+
+        rp_api_retries_str = self.find_option(pytest_config, 'rp_api_retries')
+        rp_api_retries = rp_api_retries_str and int(rp_api_retries_str)
+        if rp_api_retries and rp_api_retries > 0:
+            self.rp_api_retries = rp_api_retries
+        else:
+            rp_api_retries_str = self.find_option(pytest_config, 'retries')
+            rp_api_retries = rp_api_retries_str and int(rp_api_retries_str)
+            if rp_api_retries and rp_api_retries > 0:
+                self.rp_api_retries = rp_api_retries
+                warnings.warn(
+                    'Parameter `retries` is deprecated since 5.1.9 '
+                    'and will be subject for removing in the next '
+                    'major version. Use `rp_api_retries` argument '
+                    'instead.',
+                    DeprecationWarning,
+                    2
+                )
+            else:
+                self.rp_api_retries = 0
+
+        self.rp_api_key = getenv(
+            'RP_API_KEY') or self.find_option(pytest_config, 'rp_api_key')
+        if not self.rp_api_key:
+            self.rp_api_key = getenv(
+                'RP_UUID') or self.find_option(pytest_config, 'rp_uuid')
+            if self.rp_api_key:
+                warnings.warn(
+                    'Parameter `rp_uuid` is deprecated since 5.1.9 '
+                    'and will be subject for removing in the next '
+                    'major version. Use `rp_api_key` argument '
+                    'instead.',
+                    DeprecationWarning,
+                    2
+                )
+            else:
+                warnings.warn(
+                    'Argument `rp_api_key` is `None` or empty string, '
+                    'that is not supposed to happen because Report '
+                    'Portal is usually requires an authorization key. '
+                    'Please check your configuration.',
+                    RuntimeWarning,
+                    2
+                )
+
         rp_verify_ssl = self.find_option(pytest_config, 'rp_verify_ssl', True)
         try:
             self.rp_verify_ssl = bool(strtobool(rp_verify_ssl))

pytest_reportportal/config.pyi

@@ -27,9 +27,9 @@ class AgentConfig:
     rp_parent_item_id: Optional[Text]
     rp_project: Text
     rp_rerun_of: Optional[Text]
-    rp_retries: int
+    rp_api_retries: int
     rp_skip_connection_test: bool
-    rp_uuid: Text
+    rp_api_key: Text
     rp_verify_ssl: Union[bool, Text]
     rp_launch_timeout: int
 

pytest_reportportal/plugin.py

@@ -36,7 +36,7 @@
     'One of the following mandatory parameters is unset: ' + \
     'rp_project: {}, ' + \
     'rp_endpoint: {}, ' + \
-    'rp_uuid: {}'
+    'rp_api_key: {}'
 
 FAILED_LAUNCH_WAIT = 'Failed to initialize reportportal-client service. ' \
                      + 'Waiting for Launch start timed out. ' \
@@ -172,7 +172,7 @@ def check_connection(agent_config):
     """
     url = '{0}/api/v1/project/{1}'.format(agent_config.rp_endpoint,
                                           agent_config.rp_project)
-    headers = {'Authorization': 'bearer {0}'.format(agent_config.rp_uuid)}
+    headers = {'Authorization': 'bearer {0}'.format(agent_config.rp_api_key)}
     try:
         resp = requests.get(url, headers=headers,
                             verify=agent_config.rp_verify_ssl)
@@ -203,7 +203,7 @@ def pytest_configure(config):
     agent_config = AgentConfig(config)
 
     cond = (agent_config.rp_project, agent_config.rp_endpoint,
-            agent_config.rp_uuid)
+            agent_config.rp_api_key)
     config._rp_enabled = all(cond)
     if not config._rp_enabled:
         log.debug(MANDATORY_PARAMETER_MISSED_PATTERN.format(*cond))
@@ -379,7 +379,13 @@ def add_shared_option(name, help_str, default=None, action='store'):
         help_str='Create all test item as child items of the given (already '
                  'existing) item.',
     )
-    add_shared_option(name='rp_uuid', help_str='UUID')
+    add_shared_option(name='rp_uuid', help_str='Deprecated: use `rp_api_key` '
+                      'instead.')
+    add_shared_option(
+        name='rp_api_key',
+        help_str='API key of Report Portal. Usually located on UI profile '
+                 'page.'
+    )
     add_shared_option(name='rp_endpoint', help_str='Server endpoint')
     add_shared_option(
         name='rp_mode',
@@ -468,6 +474,10 @@ def add_shared_option(name, help_str, default=None, action='store'):
     parser.addini(
         'retries',
         default='0',
+        help='Deprecated: use `rp_api_retries` instead')
+    parser.addini(
+        'rp_api_retries',
+        default='0',
         help='Amount of retries for performing REST calls to RP server')
     parser.addini(
         'rp_skip_connection_test',

pytest_reportportal/service.py

@@ -859,18 +859,18 @@ def start(self):
             ).union({'parametrize'})
         )
         log.debug('ReportPortal - Init service: endpoint=%s, '
-                  'project=%s, uuid=%s', self._config.rp_endpoint,
-                  self._config.rp_project, self._config.rp_uuid)
+                  'project=%s, api_key=%s', self._config.rp_endpoint,
+                  self._config.rp_project, self._config.rp_api_key)
         launch_id = self._launch_id
         if self._config.rp_launch_id:
             launch_id = self._config.rp_launch_id
         self.rp = RPClient(
             endpoint=self._config.rp_endpoint,
             project=self._config.rp_project,
-            token=self._config.rp_uuid,
+            api_key=self._config.rp_api_key,
             is_skipped_an_issue=self._config.rp_is_skipped_an_issue,
             log_batch_size=self._config.rp_log_batch_size,
-            retries=self._config.rp_retries,
+            retries=self._config.rp_api_retries,
             verify_ssl=self._config.rp_verify_ssl,
             launch_id=launch_id,
             log_batch_payload_size=self._config.rp_log_batch_payload_size

requirements.txt

@@ -1,6 +1,6 @@
 dill>=0.2.7.1
 pytest>=3.8.0
-reportportal-client==5.3.4
+reportportal-client==5.3.5
 six>=1.16.0
 aenum>=3.1.0
 requests>=2.27.1

setup.py

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

tests/__init__.py

@@ -17,5 +17,6 @@
 from six import add_move, MovedModule
 add_move(MovedModule('mock', 'mock', 'unittest.mock'))
 
-REPORT_PORTAL_SERVICE = (
-    'pytest_reportportal.service.RPClient')
+REPORT_PORTAL_PACKAGE = 'pytest_reportportal'
+
+REPORT_PORTAL_SERVICE = REPORT_PORTAL_PACKAGE + '.service.RPClient'

tests/helpers/utils.py

@@ -24,7 +24,7 @@
     'rp_launch': 'Pytest',
     'rp_endpoint': 'http://localhost:8080',
     'rp_project': 'default_personal',
-    'rp_uuid': 'test_uuid',
+    'rp_api_key': 'test_api_key',
     'rp_skip_connection_test': 'True'
 }