Debug mode imlplementation

Author: HardNorth

examples/test_simple.py

@@ -0,0 +1,6 @@
+"""Simple example test."""
+
+
+def test_simple():
+    """Simple example test."""
+    assert True

pytest_reportportal/config.py

@@ -30,6 +30,7 @@ def __init__(self, pytest_config):
         self.rp_launch_description = self.find_option('rp_launch_description')
         self.rp_log_batch_size = int(self.find_option('rp_log_batch_size'))
         self.rp_log_level = get_actual_log_level(self.pconfig, 'rp_log_level')
+        self.rp_mode = self.find_option('rp_mode')
         self.rp_parent_item_id = self.find_option('rp_parent_item_id')
         self.rp_project = self.find_option('rp_project')
         self.rp_rerun_of = self.find_option('rp_rerun_of')

pytest_reportportal/config.pyi

@@ -20,8 +20,9 @@ class AgentConfig:
     rp_retries: int = ...
     rp_uuid: Text = ...
     rp_verify_ssl: bool = ...
+    rp_mode: str = ...
     def __init__(self, pytest_config: Config) -> None: ...
     @property
     def rp_rerun(self) -> Optional[bool]: ...
 
-    def find_option(self, param: str) -> Union[str, bool]: ...
+    def find_option(self, param: str) -> Union[str, bool, list]: ...

pytest_reportportal/plugin.py

@@ -109,12 +109,13 @@ def pytest_sessionstart(session):
             log.debug(str(response_error))
             config.py_test_service.rp = None
             return
-
-        attributes = gen_attributes(
-            config._reporter_config.rp_launch_attributes)
+        rp_launch_attributes = config._reporter_config.rp_launch_attributes
+        attributes = gen_attributes(rp_launch_attributes) \
+            if rp_launch_attributes else None
         if not config._reporter_config.rp_launch_id:
             config.py_test_service.start_launch(
                 config._reporter_config.rp_launch,
+                mode=config._reporter_config.rp_mode,
                 attributes=attributes,
                 description=config._reporter_config.rp_launch_description,
                 rerun=config._reporter_config.rp_rerun,
@@ -287,6 +288,11 @@ def add_shared_option(name, help, default=None, action='store'):
     )
     add_shared_option(name='rp_uuid', help='UUID')
     add_shared_option(name='rp_endpoint', help='Server endpoint')
+    add_shared_option(
+        name='rp_mode',
+        help='Visibility of current launch [DEFAULT, DEBUG]',
+        default='DEFAULT'
+    )
 
     parser.addini(
         'rp_launch_attributes',

pytest_reportportal/service.py

@@ -1,20 +1,19 @@
 """This module includes Service functions for work with pytest agent."""
 
 import logging
-from os import getenv
 import sys
 import traceback
+from os import getenv
 from time import time
 
 import pkg_resources
 import pytest
 from _pytest.doctest import DoctestItem
 from _pytest.main import Session
 from _pytest.nodes import File, Item
-from _pytest.warning_types import PytestWarning
 from _pytest.python import Class, Function, Instance, Module
 from _pytest.unittest import TestCaseFunction, UnitTestCase
-
+from _pytest.warning_types import PytestWarning
 from reportportal_client import ReportPortalService
 from reportportal_client.external.google_analytics import send_event
 from reportportal_client.helpers import (
@@ -26,7 +25,6 @@
 from six import with_metaclass
 from six.moves import queue
 
-
 log = logging.getLogger(__name__)
 
 
@@ -137,11 +135,11 @@ def init_service(self,
         self._errors = queue.Queue()
         if self.rp is None:
             self.ignore_errors = ignore_errors
-            self.ignored_attributes = ignored_attributes
+            self.ignored_attributes = ignored_attributes or []
             self.parent_item_id = parent_item_id
             if self.rp_supports_parameters:
                 self.ignored_attributes = list(
-                    set(ignored_attributes).union({'parametrize'}))
+                    set(self.ignored_attributes).union({'parametrize'}))
             self.log_batch_size = log_batch_size
             log.debug('ReportPortal - Init service: endpoint=%s, '
                       'project=%s, uuid=%s', endpoint, project, uuid)
@@ -392,6 +390,7 @@ def finish_launch(self, status=None, **kwargs):
         }
         log.debug('ReportPortal - Finish launch: request_body=%s', fl_rq)
         self.rp.finish_launch(**fl_rq)
+        self.rp = None
 
     def post_log(self, message, loglevel='INFO', attachment=None):
         """

tests/__init__.py

@@ -1,4 +1,21 @@
-"""This package contains unit tests for the project."""
+"""This package contains tests for the project.
+
+Copyright (c) 2021 http://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
+
+http://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 six import add_move, MovedModule
 add_move(MovedModule('mock', 'mock', 'unittest.mock'))
+
+REPORT_PORTAL_SERVICE = (
+    'pytest_reportportal.service.ReportPortalService')

tests/helpers/__init__.py

@@ -0,0 +1,15 @@
+"""This package contains integration tests for the project.
+
+Copyright (c) 2021 http://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
+
+http://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
+"""

tests/helpers/utils.py

@@ -0,0 +1,46 @@
+"""This module contains utility code for unit tests.
+
+Copyright (c) 2021 http://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
+
+http://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
+"""
+import pytest
+
+DEFAULT_VARIABLES = {
+    'rp_launch': 'Pytest',
+    'rp_endpoint': "http://localhost:8080",
+    'rp_project': "default_personal",
+    'rp_uuid': "test_uuid"
+}
+
+
+def run_pytest_tests(tests=None, variables=None):
+    """Run specific pytest tests.
+
+    :param tests:     a list of tests to run
+    :param variables: parameter  variables which will be passed to pytest
+    :return: exit code
+    """
+    if variables is None:
+        variables = DEFAULT_VARIABLES
+
+    arguments = []
+    arguments.append('--reportportal')
+    for k, v in variables.items():
+        arguments.append('-o')
+        arguments.append('{0}={1}'.format(k, str(v)))
+
+    if tests is not None:
+        for t in tests:
+            arguments.append(t)
+
+    return pytest.main(arguments)

tests/integration/__init__.py

@@ -0,0 +1,15 @@
+"""This package contains integration tests for the project.
+
+Copyright (c) 2021 http://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
+
+http://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
+"""

tests/integration/test_debug_mode.py

@@ -0,0 +1,50 @@
+"""This module includes integration tests for the debug mode switch."""
+
+#  Copyright (c) 2021 http://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
+#
+#  http://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
+
+import pytest
+from six.moves import mock
+
+from tests import REPORT_PORTAL_SERVICE
+from tests.helpers import utils
+
+
+@mock.patch(REPORT_PORTAL_SERVICE)
+@pytest.mark.parametrize(['mode', 'expected_mode'], [('DEFAULT', 'DEFAULT'),
+                                                     ('DEBUG', 'DEBUG'),
+                                                     (None, 'DEFAULT')])
+def test_launch_mode(mock_client_init, mode, expected_mode):
+    """Verify different launch modes are passed to `start_launch` method.
+
+    :param mock_client_init: Pytest fixture
+    :param mode:             a variable to be passed to pytest
+    :param expected_mode:    a value which should be passed to
+    ReportPortalService
+    :return: exit code
+    """
+    variables = dict()
+    if mode is not None:
+        variables['rp_mode'] = mode
+    variables.update(utils.DEFAULT_VARIABLES.items())
+    result = utils.run_pytest_tests(tests=['examples/test_simple.py'],
+                                    variables=variables)
+    assert int(result) == 0, 'Exit code should be 0 (no errors)'
+
+    mock_client = mock_client_init.return_value
+    assert mock_client.start_launch.call_count == 1, \
+        '"start_launch" method was not called'
+
+    call_args = mock_client.start_launch.call_args_list
+    start_launch_kwargs = call_args[0][1]
+    assert start_launch_kwargs['mode'] == expected_mode