RP_CONNECT_TIMEOUT and RP_READ_TIMEOUT configuration variables

Author: HardNorth

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## [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.1](https://github.com/reportportal/client-Python/releases/tag/5.5.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/config.py

@@ -16,7 +16,7 @@
 import warnings
 from distutils.util import strtobool
 from os import getenv
-from typing import Optional, Union, Any
+from typing import Optional, Union, Any, Tuple
 
 from _pytest.config import Config
 from reportportal_client import OutputType, ClientType
@@ -66,6 +66,7 @@ class AgentConfig(object):
     rp_launch_timeout: int
     rp_launch_uuid_print: bool
     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."""
@@ -182,6 +183,17 @@ def __init__(self, pytest_config: Config) -> 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) -> Any:
         """

pytest_reportportal/plugin.py

@@ -503,3 +503,11 @@ def add_shared_option(name, help_str, default=None, action='store'):
         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/service.py

@@ -912,7 +912,8 @@ def start(self) -> None:
             launch_id=launch_id,
             log_batch_payload_size=self._config.rp_log_batch_payload_size,
             launch_uuid_print=self._config.rp_launch_uuid_print,
-            print_output=self._config.rp_launch_uuid_print_output
+            print_output=self._config.rp_launch_uuid_print_output,
+            http_timeout=self._config.rp_http_timeout
         )
         if hasattr(self.rp, "get_project_settings"):
             self.project_settings = self.rp.get_project_settings()

tests/integration/test_config_handling.py

@@ -16,6 +16,8 @@
 import warnings
 from unittest import mock
 
+import pytest
+
 from delayed_assert import expect, assert_expectations
 from reportportal_client import OutputType
 
@@ -248,8 +250,7 @@ def test_rp_api_retries(mock_client_init):
     variables.update({'rp_api_retries': str(retries)}.items())
 
     with warnings.catch_warnings(record=True) as w:
-        result = utils.run_pytest_tests(['examples/test_rp_logging.py'],
-                                        variables=variables)
+        result = utils.run_pytest_tests(['examples/test_rp_logging.py'], variables=variables)
         assert int(result) == 0, 'Exit code should be 0 (no errors)'
 
         expect(mock_client_init.call_count == 1)
@@ -324,3 +325,28 @@ def test_no_launch_uuid_print(mock_client_init):
     expect(mock_client_init.call_args_list[0][1]['launch_uuid_print'] is False)
     expect(mock_client_init.call_args_list[0][1]['print_output'] is None)
     assert_expectations()
+
+
+@pytest.mark.parametrize(
+    'connect_value, read_value, expected_result',
+    [
+        ('5', '15', (5.0, 15.0)),
+        ('5.5', '15.5', (5.5, 15.5)),
+        (None, None, None),
+        (None, '5', 5),
+        ('5', None, 5)
+    ]
+)
+@mock.patch(REPORT_PORTAL_SERVICE)
+def test_client_timeouts(mock_client_init, connect_value, read_value, expected_result):
+    variables = utils.DEFAULT_VARIABLES.copy()
+    if connect_value:
+        variables['rp_connect_timeout'] = connect_value
+    if read_value:
+        variables['rp_read_timeout'] = read_value
+
+    result = utils.run_pytest_tests(['examples/test_rp_logging.py'], variables=variables)
+
+    assert int(result) == 0, 'Exit code should be 0 (no errors)'
+    assert mock_client_init.call_count == 1
+    assert mock_client_init.call_args_list[0][1]['http_timeout'] == expected_result

tests/unit/test_plugin.py

@@ -367,7 +367,9 @@ def test_pytest_addoption_adds_correct_ini_file_arguments():
         'rp_api_retries',
         'rp_skip_connection_test',
         'rp_launch_timeout',
-        'rp_client_type'
+        'rp_client_type',
+        'rp_connect_timeout',
+        'rp_read_timeout'
     )
     mock_parser = mock.MagicMock(spec=Parser)