Logging tests

Author: HardNorth

reportportal_client/logs/__init__.py

@@ -77,7 +77,7 @@ def _log(self, level, msg, args,
             record = self.makeRecord(self.name, level, fn, lno, msg, args,
                                      exc_info, func, extra, sinfo)
 
-        if not hasattr(record, 'attachment'):
+        if not getattr(record, 'attachment', None):
             record.attachment = attachment
         self.handle(record)
 
@@ -156,6 +156,6 @@ def emit(self, record):
                     timestamp(),
                     msg,
                     level=self._loglevel_map[level],
-                    attachment=record.__dict__.get('attachment', None),
+                    attachment=getattr(record, 'attachment'),
                     item_id=rp_client.current_item()
                 )

tests/logs/test_rp_log_handler.py

@@ -0,0 +1,97 @@
+#  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 re
+
+import pytest
+from six.moves import mock
+
+from reportportal_client._local import set_current
+from reportportal_client.logs import RPLogHandler, RPLogger
+
+
+@pytest.mark.parametrize(
+    'logger_name, filter_logs,expected_result',
+    [
+        ('reportportal_client', False, True),
+        ('reportportal_client', True, False),
+        ('some_logger', False, True),
+        ('some_logger', True, True)
+    ]
+)
+@mock.patch('reportportal_client.logs.logging.Logger.handle')
+def test_filter_client_logs(mocked_handle, logger_name, filter_logs,
+                            expected_result):
+    RPLogger(logger_name).info('test message')
+    record = mocked_handle.call_args[0][0]
+
+    log_handler = RPLogHandler(filter_client_logs=filter_logs)
+    assert log_handler.filter(record) == expected_result
+
+
+@pytest.mark.parametrize(
+    'hostname, expected_result',
+    [
+        ('localhost', True),
+        ('docker.local', False)
+    ]
+)
+@mock.patch('reportportal_client.logs.logging.Logger.handle')
+def test_filter_by_endpoint(mocked_handle, hostname, expected_result):
+    RPLogger('urllib3.connectionpool').info(hostname + ': test message')
+    record = mocked_handle.call_args[0][0]
+    log_handler = RPLogHandler(
+        filter_client_logs=True,
+        endpoint='http://docker.local:8080'
+    )
+    assert log_handler.filter(record) == expected_result
+
+
+@mock.patch('reportportal_client.logs.logging.Logger.handle')
+def test_emit_simple(mocked_handle):
+    test_message = 'test message'
+    RPLogger('test_logger').info(test_message)
+    record = mocked_handle.call_args[0][0]
+
+    item_id = 'item_id'
+    mock_client = mock.Mock()
+    mock_client.current_item.side_effect = lambda: item_id
+    set_current(mock_client)
+
+    log_handler = RPLogHandler()
+    log_handler.emit(record)
+
+    assert mock_client.log.call_count == 1
+    call_args = mock_client.log.call_args[0]
+    call_kwargs = mock_client.log.call_args[1]
+
+    assert re.match('^[0-9]+$', call_args[0])
+    assert test_message == call_args[1]
+    assert call_kwargs['level'] == 'INFO'
+    assert not call_kwargs['attachment']
+    assert call_kwargs['item_id'] == item_id
+
+
+@mock.patch('reportportal_client.logs.logging.Logger.handle')
+def test_emit_custom_level(mocked_handle):
+    test_message = 'test message'
+    RPLogger('test_logger').log(30, test_message)
+    record = mocked_handle.call_args[0][0]
+
+    mock_client = mock.Mock()
+    set_current(mock_client)
+
+    log_handler = RPLogHandler()
+    log_handler.emit(record)
+    assert mock_client.log.call_count == 1
+    call_kwargs = mock_client.log.call_args[1]
+    assert call_kwargs['level'] == 'WARN'

tests/logs/test_rp_logger.py

@@ -0,0 +1,67 @@
+#  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
+from logging import LogRecord
+
+import pytest
+from six.moves import mock
+
+from reportportal_client._local import set_current
+from reportportal_client.logs import RPLogger, RPLogHandler
+
+
+def verify_record(logger_handler):
+    assert logger_handler.call_count == 1
+    call_args = logger_handler.call_args[0]
+    assert len(call_args) == 1
+    record = call_args[0]
+    assert isinstance(record, LogRecord)
+    return record
+
+
+@mock.patch('reportportal_client.logs.logging.Logger.handle')
+def test_record_make(logger_handler):
+    logger = RPLogger('test_logger')
+    logger.info('test_log')
+    record = verify_record(logger_handler)
+    assert not getattr(record, 'attachment')
+
+
+@mock.patch('reportportal_client.logs.logging.Logger.handle')
+def test_record_attachment(logger_handler):
+    logger = RPLogger('test_logger')
+    attachment = {'name': 'test.txt', 'content': 'test',
+                  'content_type': 'text/plain'}
+    logger.info('test_log', attachment=attachment)
+    record = verify_record(logger_handler)
+    result_attachment = getattr(record, 'attachment')
+    assert result_attachment
+    assert result_attachment == attachment
+
+
+@pytest.mark.parametrize(
+    'handler_level, log_level, expected_calls',
+    [
+        (logging.WARN, 'info', 0),
+        (logging.INFO, 'info', 1),
+    ]
+)
+def test_log_level_filter(handler_level, log_level, expected_calls):
+    mock_client = mock.Mock()
+    set_current(mock_client)
+
+    logger = RPLogger('test_logger')
+    logger.addHandler(RPLogHandler(level=handler_level))
+    getattr(logger, log_level)('test_log')
+
+    assert mock_client.log.call_count == expected_calls