Add launch_uuid_print and print_output arguments in RPClient class constructor

Author: HardNorth

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
 ## [Unreleased]
+### Added
+- `launch_uuid_print` and `print_output` arguments in `RPClient` class constructor, by @HardNorth
 
 ## [5.3.5]
 ### Added

reportportal_client/client.py

@@ -14,9 +14,10 @@
 #  limitations under the License
 
 import logging
+import sys
 import warnings
 from os import getenv
-from typing import Union, Tuple, List, Dict, Any, Optional
+from typing import Union, Tuple, List, Dict, Any, Optional, TextIO
 
 import requests
 from requests.adapters import HTTPAdapter, Retry, DEFAULT_RETRIES
@@ -70,6 +71,8 @@ class RPClient:
     session: requests.Session = ...
     step_reporter: StepReporter = ...
     mode: str = ...
+    launch_uuid_print: Optional[bool] = ...
+    print_output: Optional[TextIO] = ...
     _skip_analytics: str = ...
     _item_stack: List[str] = ...
 
@@ -87,6 +90,8 @@ def __init__(
             http_timeout: Union[float, Tuple[float, float]] = (10, 10),
             log_batch_payload_size: int = MAX_LOG_BATCH_PAYLOAD_SIZE,
             mode: str = 'DEFAULT',
+            launch_uuid_print: bool = False,
+            print_output: TextIO = sys.stdout,
             **kwargs: Any
     ) -> None:
         """Initialize required attributes.
@@ -131,6 +136,8 @@ def __init__(
         self._item_stack = []
         self.mode = mode
         self._skip_analytics = getenv('AGENT_NO_ANALYTICS')
+        self.launch_uuid_print = launch_uuid_print
+        self.print_output = print_output
 
         self.api_key = api_key
         if not self.api_key:
@@ -414,6 +421,8 @@ def start_launch(self,
 
         self._log_manager.launch_id = self.launch_id = response.id
         logger.debug('start_launch - ID: %s', self.launch_id)
+        if self.launch_uuid_print and self.print_output:
+            print(f'Report Portal Launch UUID: {self.launch_id}', file=self.print_output)
         return self.launch_id
 
     def start_test_item(self,

tests/test_client.py

@@ -10,6 +10,7 @@
 #  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 io import StringIO
 
 import pytest
 from requests import Response
@@ -196,3 +197,13 @@ def test_empty_api_key_argument(warn):
 
     assert warn.call_count == 1
     assert client.api_key == api_key
+
+
+def test_launch_uuid_print():
+    str_io = StringIO()
+    client = RPClient(endpoint='http://endpoint', project='project',
+                      api_key='test', launch_uuid_print=True, print_output=str_io)
+    client.session = mock.Mock()
+    client._skip_analytics = True
+    client.start_launch('Test Launch', timestamp())
+    assert 'Report Portal Launch UUID: ' in str_io.getvalue()