rp_launch_uuid_print and rp_launch_uuid_print_output configuration parameters

Author: HardNorth

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
 ## [Unreleased]
+### Added
+- `rp_launch_uuid_print` and `rp_launch_uuid_print_output` configuration parameters, by @HardNorth
+### Removed
+- Python 2.7, 3.6 support, by @HardNorth
 
 ## [5.1.9]
 ### Added

README.rst

@@ -84,15 +84,18 @@ 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_launch_description = 'Smoke test'` - launch description (could be overridden by pytest --rp-launch-description option, default value is '').
+- :code:`rp_launch_timeout = 86400` - Maximum time to wait for child processes finish, default value: 86400 seconds (1 day).
+- :code:`rp_launch_uuid_print = True` - Enables printing Launch UUID on test run start. Default `False`.
+- :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_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_is_skipped_an_issue = False` - Treat skipped tests as required investigation. Default is True.
+- :code:`rp_is_skipped_an_issue = False` - Treat skipped tests as required investigation. Default `True`.
 - :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).
@@ -102,7 +105,6 @@ The following parameters are optional:
 - :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_api_retries = 0` - Amount of retries for performing REST calls to RP server.
 
 

pytest_reportportal/config.py

@@ -1,9 +1,12 @@
 """This module contains class that stores RP agent configuration data."""
+import sys
 import warnings
 
 from distutils.util import strtobool
 from os import getenv
+from typing import Optional, Union, Any, TextIO, Dict
 
+from _pytest.config import Config
 from reportportal_client.logs.log_manager import MAX_LOG_BATCH_PAYLOAD_SIZE
 
 try:
@@ -14,10 +17,49 @@
         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."""
 
-    def __init__(self, pytest_config):
+    rp_rerun: Optional[bool]
+    pconfig: Config
+    rp_endpoint: str
+    rp_hierarchy_code: bool
+    rp_dir_level: int
+    rp_hierarchy_dirs: bool
+    rp_dir_path_separator: str
+    rp_ignore_attributes: set
+    rp_is_skipped_an_issue: bool
+    rp_issue_id_marks: bool
+    rp_issue_system_url: str
+    rp_bts_project: str
+    rp_bts_url: str
+    rp_launch: str
+    rp_launch_id: Optional[str]
+    rp_launch_attributes: Optional[list]
+    rp_launch_description: str
+    rp_log_batch_size: int
+    rp_log_batch_payload_size: int
+    rp_log_level: Optional[int]
+    rp_log_format: Optional[str]
+    rp_mode: str
+    rp_parent_item_id: Optional[str]
+    rp_project: str
+    rp_rerun_of: Optional[str]
+    rp_api_retries: int
+    rp_skip_connection_test: bool
+    rp_api_key: str
+    rp_verify_ssl: Union[bool, str]
+    rp_launch_timeout: int
+    rp_launch_uuid_print: bool
+    rp_launch_uuid_print_output: TextIO
+
+    def __init__(self, pytest_config: Config) -> None:
         """Initialize required attributes."""
         self.rp_rerun = (pytest_config.option.rp_rerun or
                          pytest_config.getini('rp_rerun'))
@@ -32,8 +74,7 @@ def __init__(self, pytest_config):
             self.find_option(pytest_config, 'rp_hierarchy_dir_path_separator')
         ignore_attributes = self.find_option(pytest_config,
                                              'rp_ignore_attributes')
-        self.rp_ignore_attributes = set(ignore_attributes) \
-            if ignore_attributes else set()
+        self.rp_ignore_attributes = ignore_attributes and set(ignore_attributes)
         self.rp_is_skipped_an_issue = self.find_option(
             pytest_config,
             'rp_is_skipped_an_issue'
@@ -127,8 +168,15 @@ def __init__(self, pytest_config):
         self.rp_launch_timeout = int(
             self.find_option(pytest_config, 'rp_launch_timeout'))
 
+        self.rp_launch_uuid_print = bool(strtobool(self.find_option(
+            pytest_config, 'rp_launch_uuid_print'
+        )))
+        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'])
+
     # noinspection PyMethodMayBeStatic
-    def find_option(self, pytest_config, option_name, default=None):
+    def find_option(self, pytest_config: Config, option_name: str, default: Any = None):
         """
         Find a single configuration setting from multiple places.
 
@@ -148,4 +196,4 @@ def find_option(self, pytest_config, option_name, default=None):
         )
         if isinstance(value, bool):
             return value
-        return value if value else default
+        return value or default

pytest_reportportal/config.pyi

@@ -104,6 +104,9 @@ def pytest_sessionstart(session):
 
     if is_control(config) and not config._reporter_config.rp_launch_id:
         config.py_test_service.start_launch()
+        if config._reporter_config.rp_launch_uuid_print:
+            launch_id = config.py_test_service.rp.launch_id
+            print(f'Report Portal Launch UUID: {launch_id}', file=config._reporter_config.rp_launch_uuid_print_output)
         if config.pluginmanager.hasplugin('xdist') \
                 or config.pluginmanager.hasplugin('pytest-parallel'):
             if not wait_launch(session.config.py_test_service.rp):
@@ -400,6 +403,16 @@ def add_shared_option(name, help_str, default=None, action='store'):
         default=False,
         action='store_true'
     )
+    add_shared_option(
+        name='rp_launch_uuid_print',
+        help_str='Enables printing Launch UUID on test run start. Possible values: [True, False]',
+        default='False'
+    )
+    add_shared_option(
+        name='rp_launch_uuid_print_output',
+        help_str='Launch UUID print output. Default `stdout`. Possible values: [stderr, stdout]',
+        default='stdout'
+    )
 
     parser.addini(
         'rp_launch_attributes',

pytest_reportportal/plugin.py

@@ -14,11 +14,13 @@
 
 import sys
 import warnings
+from io import StringIO
 
 from delayed_assert import expect, assert_expectations
 from unittest import mock
 
 from examples.test_rp_logging import LOG_MESSAGE
+from pytest_reportportal.config import OUTPUT_TYPES
 from tests import REPORT_PORTAL_SERVICE
 from tests.helpers import utils
 
@@ -283,3 +285,89 @@ def test_retries(mock_client_init):
         expect(constructor_args['retries'] == retries)
         expect(len(filter_agent_calls(w)) == 1)
     assert_expectations()
+
+
+@mock.patch(REPORT_PORTAL_SERVICE)
+def test_launch_uuid_print(mock_client_init):
+    print_uuid = True
+    variables = utils.DEFAULT_VARIABLES.copy()
+    variables.update({'rp_launch_uuid_print': str(print_uuid)}.items())
+
+    str_io = StringIO()
+    stdout = sys.stdout
+    try:
+        OUTPUT_TYPES['stdout'] = str_io
+        result = utils.run_pytest_tests(['examples/test_rp_logging.py'],
+                                        variables=variables)
+    finally:
+        OUTPUT_TYPES['stdout'] = stdout
+
+    assert int(result) == 0, 'Exit code should be 0 (no errors)'
+    expect(mock_client_init.call_count == 1)
+
+    expect('Report Portal Launch UUID:' in str_io.getvalue())
+    assert_expectations()
+
+
+@mock.patch(REPORT_PORTAL_SERVICE)
+def test_launch_uuid_print_stderr(mock_client_init):
+    print_uuid = True
+    variables = utils.DEFAULT_VARIABLES.copy()
+    variables.update({'rp_launch_uuid_print': str(print_uuid), 'rp_launch_uuid_print_output': 'stderr'}.items())
+
+    str_io = StringIO()
+    stderr = sys.stderr
+    try:
+        OUTPUT_TYPES['stderr'] = str_io
+        result = utils.run_pytest_tests(['examples/test_rp_logging.py'],
+                                        variables=variables)
+    finally:
+        OUTPUT_TYPES['stderr'] = stderr
+
+    assert int(result) == 0, 'Exit code should be 0 (no errors)'
+    expect(mock_client_init.call_count == 1)
+
+    expect('Report Portal Launch UUID:' in str_io.getvalue())
+    assert_expectations()
+
+
+@mock.patch(REPORT_PORTAL_SERVICE)
+def test_launch_uuid_print_invalid_output(mock_client_init):
+    print_uuid = True
+    variables = utils.DEFAULT_VARIABLES.copy()
+    variables.update({'rp_launch_uuid_print': str(print_uuid), 'rp_launch_uuid_print_output': 'something'}.items())
+
+    str_io = StringIO()
+    stdout = sys.stdout
+    try:
+        OUTPUT_TYPES['stdout'] = str_io
+        result = utils.run_pytest_tests(['examples/test_rp_logging.py'],
+                                        variables=variables)
+    finally:
+        OUTPUT_TYPES['stdout'] = stdout
+
+    assert int(result) == 0, 'Exit code should be 0 (no errors)'
+    expect(mock_client_init.call_count == 1)
+
+    expect('Report Portal Launch UUID:' in str_io.getvalue())
+    assert_expectations()
+
+
+@mock.patch(REPORT_PORTAL_SERVICE)
+def test_no_launch_uuid_print(mock_client_init):
+    variables = utils.DEFAULT_VARIABLES.copy()
+
+    str_io = StringIO()
+    stdout = sys.stdout
+    try:
+        OUTPUT_TYPES['stdout'] = str_io
+        result = utils.run_pytest_tests(['examples/test_rp_logging.py'],
+                                        variables=variables)
+    finally:
+        OUTPUT_TYPES['stdout'] = stdout
+
+    assert int(result) == 0, 'Exit code should be 0 (no errors)'
+    expect(mock_client_init.call_count == 1)
+
+    expect('Report Portal Launch UUID:' not in str_io.getvalue())
+    assert_expectations()