Merge pull request #131 from bigbZik/logging_fix

Fix logging issue and adding support for pytest --setup-plan option

Author: Dmitriy Gumeniuk

pytest_reportportal/plugin.py

@@ -37,16 +37,10 @@ def pytest_configure_node(node):
 
 
 def pytest_sessionstart(session):
-    if session.config.getoption('--collect-only', default=False) is True:
-        return
-
     if session.config._reportportal_configured is False:
         # Stop now if the plugin is not properly configured
         return
 
-    if not session.config.option.rp_enabled:
-        return
-
     if is_master(session.config):
         session.config.py_test_service.init_service(
             project=session.config.getini('rp_project'),
@@ -87,9 +81,6 @@ def pytest_collection_modifyitems(session, config, items):
 
 
 def pytest_collection_finish(session):
-    if session.config.getoption('--collect-only', default=False) is True:
-        return
-
     if session.config._reportportal_configured is False:
         # Stop now if the plugin is not properly configured
         return
@@ -106,16 +97,10 @@ def wait_launch(rp_client):
 
 
 def pytest_sessionfinish(session):
-    if session.config.getoption('--collect-only', default=False) is True:
-        return
-
     if session.config._reportportal_configured is False:
         # Stop now if the plugin is not properly configured
         return
 
-    if not session.config.option.rp_enabled:
-        return
-
     # FixMe: currently method of RP api takes the string parameter
     # so it is hardcoded
     if is_master(session.config):
@@ -125,6 +110,13 @@ def pytest_sessionfinish(session):
 
 
 def pytest_configure(config):
+
+    if config.getoption('--collect-only', default=False) or \
+            config.getoption('--setup-plan', default=False) or \
+            not config.option.rp_enabled:
+        config._reportportal_configured = False
+        return
+
     project = config.getini('rp_project')
     endpoint = config.getini('rp_endpoint')
     uuid = config.getini('rp_uuid')

pytest_reportportal/rp_logging.py

@@ -44,7 +44,7 @@ def _log(self, level, msg, args,
             record = self.makeRecord(self.name, level, fn, lno, msg, args,
                                      exc_info, func, extra, sinfo)
 
-        if not record.attachment:
+        if not getattr(record, 'attachment', None):
             record.attachment = attachment
         self.handle(record)
 

tests/test_plugin.py

@@ -1,15 +1,22 @@
 """This modules includes unit tests for the plugin."""
 
-from requests.exceptions import RequestException
 try:
     from unittest.mock import create_autospec, Mock, patch
 except ImportError:
     from mock import create_autospec, Mock, patch
 
 from _pytest.config import Config
 from  delayed_assert import expect, assert_expectations
+import pytest
+from requests.exceptions import RequestException
 
 from pytest_reportportal.plugin import pytest_configure
+from pytest_reportportal import RPLogger
+
+
+@pytest.fixture
+def logger():
+    return RPLogger("pytest_reportportal.test")
 
 
 @patch('pytest_reportportal.plugin.requests.get')
@@ -31,3 +38,28 @@ def test_stop_plugin_configuration_on_conn_error(mocked_get):
     expect(mocked_config._reportportal_configured is False,
            'The value of the _reportportal_configured is not False.')
     assert_expectations()
+
+
+@patch('pytest_reportportal.RPLogger.handle')
+@pytest.mark.parametrize("log_level", ("info", "debug", "warning", "error"))
+def test_logger_handle_attachment(mock_handler, logger, log_level):
+    """Test logger call for different log levels with some text attachment."""
+    log_call = getattr(logger, log_level)
+    attachment = "Some {} attachment".format(log_level)
+    log_call("Some {} message".format(log_level), attachment=attachment)
+    expect(mock_handler.call_count == 1, "logger.handle called more than 1 time")
+    expect(getattr(mock_handler.call_args[0][0], "attachment") == attachment,
+           "record.attachment in args doesn't match real value")
+    assert_expectations()
+
+
+@patch('pytest_reportportal.RPLogger.handle')
+@pytest.mark.parametrize("log_level", ("info", "debug", "warning", "error"))
+def test_logger_handle_no_attachment(mock_handler, logger, log_level):
+    """Test logger call for different log levels without any attachment."""
+    log_call = getattr(logger, log_level)
+    log_call("Some {} message".format(log_level))
+    expect(mock_handler.call_count == 1, "logger.handle called more than 1 time")
+    expect(getattr(mock_handler.call_args[0][0], "attachment") is None,
+           "record.attachment in args is not None")
+    assert_expectations()