Log buffer flushing

Author: HardNorth

examples/test_rp_logging.py

@@ -0,0 +1,24 @@
+#  Copyright (c) 2022 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
+
+import logging
+
+logging.basicConfig(level=logging.INFO)
+
+logger = logging.getLogger(__name__)
+
+LOG_MESSAGE = "Standard logger logs to Report Portal"
+
+
+def test_report_portal_logging():
+    logger.info(LOG_MESSAGE)

pytest_reportportal/listener.py

@@ -1,21 +1,16 @@
 """RPReportListener implements Pytest hooks required for item reporting."""
 
-import pytest
 import logging
+
+import pytest
+
 try:
     from html import escape  # python3
 except ImportError:
     from cgi import escape  # python2
 
-
-try:
-    # This try/except can go away once we support pytest >= 3.3
-    import _pytest.logging
-
-    PYTEST_HAS_LOGGING_PLUGIN = True
-    from .rp_logging import RPLogHandler, patching_logger_class
-except ImportError:
-    PYTEST_HAS_LOGGING_PLUGIN = False
+import _pytest.logging
+from .rp_logging import RPLogHandler, patching_logger_class
 
 
 class RPReportListener(object):
@@ -36,12 +31,11 @@ def __init__(self, py_test_service,
         self.result = None
         self.issue = {}
         self._log_level = log_level
-        if PYTEST_HAS_LOGGING_PLUGIN:
-            self._log_handler = \
-                RPLogHandler(py_test_service=py_test_service,
-                             level=log_level,
-                             filter_client_logs=True,
-                             endpoint=endpoint)
+        self._log_handler = \
+            RPLogHandler(py_test_service=py_test_service,
+                         level=log_level,
+                         filter_client_logs=True,
+                         endpoint=endpoint)
 
     @pytest.hookimpl(hookwrapper=True)
     def pytest_runtest_protocol(self, item):
@@ -53,17 +47,15 @@ def pytest_runtest_protocol(self, item):
         """
         self._add_issue_id_marks(item)
         item_id = self.py_test_service.start_pytest_item(item)
-        if PYTEST_HAS_LOGGING_PLUGIN:
-            # This check can go away once we support pytest >= 3.3
-            with patching_logger_class():
-                with _pytest.logging.catching_logs(self._log_handler,
-                                                   level=self._log_level):
-                    yield
-        else:
-            yield
+        with patching_logger_class():
+            with _pytest.logging.catching_logs(self._log_handler,
+                                               level=self._log_level):
+                yield
         # Finishing item in RP
         self.py_test_service.finish_pytest_item(
             item, item_id, self.result or 'SKIPPED', self.issue or None)
+        # Flush log buffer
+        self.py_test_service.rp.terminate()
 
     @pytest.hookimpl(hookwrapper=True)
     def pytest_runtest_makereport(self, item):

tests/helpers/utils.py

@@ -13,6 +13,9 @@
 See the License for the specific language governing permissions and
 limitations under the License
 """
+import random
+import time
+
 import pytest
 
 DEFAULT_VARIABLES = {
@@ -44,3 +47,8 @@ def run_pytest_tests(tests=None, variables=None):
             arguments.append(t)
 
     return pytest.main(arguments)
+
+
+def item_id_gen(**kwargs):
+    return "{}-{}-{}".format(kwargs['name'], str(round(time.time() * 1000)),
+                             random.randint(0, 9999))

tests/integration/test_logging_flush.py

@@ -0,0 +1,41 @@
+"""This module includes integration test for the log flushing."""
+
+#  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.moves import mock
+
+from tests import REPORT_PORTAL_SERVICE
+from tests.helpers import utils
+from multiprocessing.pool import ThreadPool
+
+
+@mock.patch(REPORT_PORTAL_SERVICE)
+def test_logging_flushing(mock_client_init):
+    """Verify log buffer flushes after test finish.
+
+    :param mock_client_init: Pytest fixture
+    """
+    def run_test():
+        return utils.run_pytest_tests(['examples/test_rp_logging.py'])
+
+    pool = ThreadPool(processes=1)
+    async_result = pool.apply_async(run_test)
+    result = async_result.get()
+    pool.terminate()
+
+    assert int(result) == 0, 'Exit code should be 0 (no errors)'
+
+    mock_client = mock_client_init.return_value
+    assert mock_client.terminate.call_count == 1, \
+        '"terminate" method was not called at the end of the test'

tests/integration/test_suite_hierarchy.py

@@ -13,9 +13,6 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
-import random
-import time
-
 import pytest
 from delayed_assert import expect, assert_expectations
 from six.moves import mock
@@ -25,11 +22,6 @@
 from tests.helpers import utils
 
 
-def item_id_gen(**kwargs):
-    return "{}-{}-{}".format(kwargs['name'], str(round(time.time() * 1000)),
-                             random.randint(0, 9999))
-
-
 def verify_start_item_parameters(mock_client, expected_items):
     assert mock_client.start_test_item.call_count == len(expected_items), \
         '"start_test_item" method was called incorrect number of times'
@@ -54,7 +46,7 @@ def test_rp_hierarchy_parameters(mock_client_init, test, variables,
     :param mock_client_init: Pytest fixture
     """
     mock_client = mock_client_init.return_value
-    mock_client.start_test_item.side_effect = item_id_gen
+    mock_client.start_test_item.side_effect = utils.item_id_gen
 
     result = utils.run_pytest_tests(tests=test, variables=variables)
     assert int(result) == 0, 'Exit code should be 0 (no errors)'