Merge pull request #351 from reportportal/develop

Release

Author: HardNorth

.github/workflows/tests.yml

@@ -39,7 +39,7 @@ jobs:
         run: tox
 
       - name: Upload coverage to Codecov
-        if: matrix.python-version == 3.7 && success()
+        if: matrix.python-version == 3.8 && success()
         uses: codecov/codecov-action@v3
         with:
           files: coverage.xml

CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
 
 ## [Unreleased]
+### Added
+- `RP_CLIENT_TYPE` configuration variable, by @HardNorth
+- `RP_CONNECT_TIMEOUT` and `RP_READ_TIMEOUT` configuration variables, by @HardNorth
+### Changed
+- Client version updated on [5.5.2](https://github.com/reportportal/client-Python/releases/tag/5.5.2), by @HardNorth
+
+## [5.2.2]
 ### Changed
 - Client version updated on [5.4.1](https://github.com/reportportal/client-Python/releases/tag/5.4.1), by @HardNorth
 

README.rst

@@ -81,6 +81,7 @@ Example of :code:`pytest.ini`:
 
 The following parameters are optional:
 
+- :code:`rp_client_type = SYNC` - Type of the under-the-hood ReportPortal client implementation. Possible values: [SYNC, ASYNC_THREAD, ASYNC_BATCHED].
 - :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.
@@ -90,6 +91,8 @@ The following parameters are optional:
 - :code:`rp_launch_uuid_print_output = stderr` - Launch UUID print output. Default `stdout`. Possible values: [stderr, stdout].
 - :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_connect_timeout = 15` - Connection timeout to ReportPortal server. Default value is "10.0".
+- :code:`rp_read_timeout = 15` - Response read timeout for ReportPortal connection. Default value is "10.0".
 - :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.

pytest_reportportal/__init__.py

@@ -1,3 +1,16 @@
+#  Copyright (c) 2023 EPAM Systems
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License
+
 """This package contains Pytest agent's code for the Report Portal."""
 
 __all__ = ['LAUNCH_WAIT_TIMEOUT']

pytest_reportportal/config.py

@@ -1,13 +1,26 @@
+#  Copyright (c) 2023 EPAM Systems
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License
+
 """This module contains class that stores RP agent configuration data."""
-import sys
-import warnings
 
+import warnings
 from distutils.util import strtobool
 from os import getenv
-from typing import Optional, Union, Any, TextIO, Dict
+from typing import Optional, Union, Any, Tuple
 
 from _pytest.config import Config
-from reportportal_client.logs.log_manager import MAX_LOG_BATCH_PAYLOAD_SIZE
+from reportportal_client import OutputType, ClientType
+from reportportal_client.logs import MAX_LOG_BATCH_PAYLOAD_SIZE
 
 try:
     # This try/except can go away once we support pytest >= 5.4.0
@@ -17,15 +30,10 @@
         get_actual_log_level
 
 
-OUTPUT_TYPES: Dict[str, TextIO] = {
-    'stdout': sys.stdout,
-    'stderr': sys.stderr
-}
-
-
 class AgentConfig(object):
     """Storage for the RP agent initialization attributes."""
 
+    rp_client_type: Optional[ClientType]
     rp_rerun: Optional[bool]
     pconfig: Config
     rp_endpoint: str
@@ -57,7 +65,8 @@ class AgentConfig(object):
     rp_verify_ssl: Union[bool, str]
     rp_launch_timeout: int
     rp_launch_uuid_print: bool
-    rp_launch_uuid_print_output: TextIO
+    rp_launch_uuid_print_output: Optional[OutputType]
+    rp_http_timeout: Optional[Union[Tuple[float, float], float]]
 
     def __init__(self, pytest_config: Config) -> None:
         """Initialize required attributes."""
@@ -169,12 +178,24 @@ def __init__(self, pytest_config: Config) -> None:
         self.rp_launch_uuid_print = bool(strtobool(self.find_option(
             pytest_config, 'rp_launch_uuid_print'
         ) or 'False'))
-        self.rp_launch_uuid_print_output = OUTPUT_TYPES.get((self.find_option(
-            pytest_config, 'rp_launch_uuid_print_output'
-        ) or 'stdout').lower(), OUTPUT_TYPES['stdout'])
+        print_output = self.find_option(pytest_config, 'rp_launch_uuid_print_output')
+        self.rp_launch_uuid_print_output = OutputType[print_output.upper()] if print_output else None
+        client_type = self.find_option(pytest_config, 'rp_client_type')
+        self.rp_client_type = ClientType[client_type.upper()] if client_type else ClientType.SYNC
+
+        connect_timeout = self.find_option(pytest_config, 'rp_connect_timeout')
+        connect_timeout = float(connect_timeout) if connect_timeout else None
+        read_timeout = self.find_option(pytest_config, 'rp_read_timeout')
+        read_timeout = float(read_timeout) if read_timeout else None
+        if connect_timeout is None and read_timeout is None:
+            self.rp_http_timeout = None
+        elif connect_timeout is not None and read_timeout is not None:
+            self.rp_http_timeout = (connect_timeout, read_timeout)
+        else:
+            self.rp_http_timeout = connect_timeout or read_timeout
 
     # noinspection PyMethodMayBeStatic
-    def find_option(self, pytest_config: Config, option_name: str, default: Any = None):
+    def find_option(self, pytest_config: Config, option_name: str, default: Any = None) -> Any:
         """
         Find a single configuration setting from multiple places.
 

pytest_reportportal/errors.py

@@ -1,3 +1,16 @@
+#  Copyright (c) 2023 EPAM Systems
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License
+
 """This module includes exceptions used in the package."""
 
 

pytest_reportportal/plugin.py

@@ -1,5 +1,3 @@
-"""This module contains changed pytest for report-portal."""
-
 #  Copyright (c) 2023 https://reportportal.io .
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -13,6 +11,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
+"""This module contains changed pytest for ReportPortal."""
+
 import logging
 import os.path
 import time
@@ -23,7 +23,7 @@
 import requests
 from reportportal_client import RPLogHandler
 from reportportal_client.errors import ResponseError
-from reportportal_client.logs.log_manager import MAX_LOG_BATCH_PAYLOAD_SIZE
+from reportportal_client.logs import MAX_LOG_BATCH_PAYLOAD_SIZE
 
 from pytest_reportportal import LAUNCH_WAIT_TIMEOUT
 from .config import AgentConfig
@@ -402,13 +402,11 @@ def add_shared_option(name, help_str, default=None, action='store'):
     )
     add_shared_option(
         name='rp_launch_uuid_print',
-        help_str='Enables printing Launch UUID on test run start. Possible values: [True, False]',
-        default='False'
+        help_str='Enables printing Launch UUID on test run start. Possible values: [True, False]'
     )
     add_shared_option(
         name='rp_launch_uuid_print_output',
-        help_str='Launch UUID print output. Default `stdout`. Possible values: [stderr, stdout]',
-        default='stdout'
+        help_str='Launch UUID print output. Default `stdout`. Possible values: [stderr, stdout]'
     )
 
     parser.addini(
@@ -500,3 +498,16 @@ def add_shared_option(name, help_str, default=None, action='store'):
         help='Maximum time to wait for child processes finish, default value: '
              '86400 seconds (1 day)'
     )
+    parser.addini(
+        'rp_client_type',
+        help='Type of the under-the-hood ReportPortal client implementation. Possible values: [SYNC, ASYNC_THREAD, '
+             'ASYNC_BATCHED]'
+    )
+    parser.addini(
+        'rp_connect_timeout',
+        help='Connection timeout to ReportPortal server'
+    )
+    parser.addini(
+        'rp_read_timeout',
+        help='Response read timeout for ReportPortal connection'
+    )

pytest_reportportal/plugin.pyi

@@ -1,5 +1,18 @@
+#  Copyright (c) 2023 https://reportportal.io .
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License
+
 from logging import Logger
-from typing import Text
+from typing import Text, Any
 
 import pytest
 
@@ -8,7 +21,6 @@ from _pytest.config import Config
 from _pytest.config.argparsing import Parser
 from _pytest.main import Session
 from reportportal_client import RPClient
-from xdist.workermanage import WorkerController
 
 log: Logger
 MANDATORY_PARAMETER_MISSED_PATTERN: Text
@@ -17,7 +29,7 @@ FAILED_LAUNCH_WAIT: Text
 def check_connection(agent_config: AgentConfig) -> bool: ...
 def is_control(config: Config) -> bool: ...
 def wait_launch(rp_client: RPClient) -> bool: ...
-def pytest_configure_node(node: WorkerController) -> None: ...
+def pytest_configure_node(node: Any) -> None: ...
 def pytest_sessionstart(session: Session) -> None: ...
 def pytest_collection_finish(session: Session) -> None: ...
 def pytest_sessionfinish(session: Session) -> None: ...

pytest_reportportal/rp_logging.py

@@ -1,3 +1,16 @@
+#  Copyright (c) 2023 https://reportportal.io .
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License
+
 """RPLogger class for low-level logging in tests."""
 
 import sys
@@ -6,7 +19,7 @@
 from contextlib import contextmanager
 from functools import wraps
 
-from reportportal_client._local import current, set_current
+from reportportal_client import current, set_current
 from reportportal_client import RPLogger
 from reportportal_client.core.worker import APIWorker
 
@@ -62,13 +75,12 @@ def _run(self, *args, **kwargs):
                     ):
                         parent = self.parent_rp_client
                         client = parent.clone()
-                        client.start()
                     try:
                         return original_func(self, *args, **kwargs)
                     finally:
                         if client:
                             # Stop the client and remove any references
-                            client.terminate()
+                            client.close()
                             self.parent_rp_client = None
                             del self.parent_rp_client
                             set_current(None)