mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-20 22:00:58 +00:00
a507b3622c
- Refactor log_container.py into log_view and log_store - Move LogPane toolbar classes into log_pane_toolbars.py - Add new tests for LogView and LogStore. No-Docs-Update-Reason: Refactoring Change-Id: I5187f9638558ea4ef7f0dc609cb2444201d4d028 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/52440 Commit-Queue: Anthony DiGirolamo <tonymd@google.com> Reviewed-by: Keir Mierle <keir@google.com>
122 lines
4.2 KiB
Python
122 lines
4.2 KiB
Python
# Copyright 2021 The Pigweed Authors
|
|
#
|
|
# 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.
|
|
"""Tests for pw_console.log_store"""
|
|
|
|
import logging
|
|
import unittest
|
|
from unittest.mock import MagicMock
|
|
|
|
from pw_console.log_store import LogStore
|
|
|
|
|
|
def _create_log_store():
|
|
log_store = LogStore()
|
|
viewer = MagicMock()
|
|
viewer.new_logs_arrived = MagicMock()
|
|
log_store.register_viewer(viewer)
|
|
return log_store, viewer
|
|
|
|
|
|
class TestLogStore(unittest.TestCase):
|
|
"""Tests for LogStore."""
|
|
def setUp(self):
|
|
self.maxDiff = None # pylint: disable=invalid-name
|
|
|
|
def test_get_total_count(self) -> None:
|
|
# self.assertEqual(self.log_store.get_total_count(), 0)
|
|
|
|
log_store, viewer = _create_log_store()
|
|
test_log = logging.getLogger('log_store.test')
|
|
# Must use the assertLogs context manager and the addHandler call.
|
|
with self.assertLogs(test_log, level='DEBUG') as log_context:
|
|
test_log.addHandler(log_store)
|
|
for i in range(5):
|
|
test_log.debug('Test log %s', i)
|
|
|
|
# Expected log message content
|
|
self.assertEqual(
|
|
log_context.output,
|
|
['DEBUG:log_store.test:Test log {}'.format(i) for i in range(5)])
|
|
# LogStore state checks
|
|
viewer.new_logs_arrived.assert_called()
|
|
self.assertEqual(log_store.get_total_count(), 5)
|
|
self.assertEqual(log_store.get_last_log_line_index(), 4)
|
|
|
|
log_store.clear_logs()
|
|
self.assertEqual(log_store.get_total_count(), 0)
|
|
|
|
def test_channel_counts_and_prefix_width(self) -> None:
|
|
log_store, _viewer = _create_log_store()
|
|
|
|
# Log some messagse on 3 separate logger instances
|
|
for i, logger_name in enumerate([
|
|
'log_store.test',
|
|
'log_store.dev',
|
|
'log_store.production',
|
|
]):
|
|
test_log = logging.getLogger(logger_name)
|
|
with self.assertLogs(test_log, level='DEBUG') as _log_context:
|
|
test_log.addHandler(log_store)
|
|
test_log.debug('Test log message')
|
|
for j in range(i):
|
|
test_log.debug('%s', j)
|
|
|
|
self.assertEqual(log_store.channel_counts, {
|
|
'log_store.test': 1,
|
|
'log_store.dev': 2,
|
|
'log_store.production': 3,
|
|
})
|
|
self.assertEqual(
|
|
log_store.get_channel_counts(),
|
|
'log_store.test: 1, log_store.dev: 2, log_store.production: 3')
|
|
|
|
self.assertRegex(
|
|
log_store.logs[0].ansi_stripped_log,
|
|
r'[0-9]{8} [0-9]{2}:[0-9]{2}:[0-9]{2} DEBUG Test log message')
|
|
self.assertEqual(
|
|
log_store.channel_formatted_prefix_widths,
|
|
{
|
|
'log_store.test': 24,
|
|
'log_store.dev': 24,
|
|
'log_store.production': 24
|
|
},
|
|
)
|
|
|
|
def test_render_table_header_with_metadata(self) -> None:
|
|
log_store, _viewer = _create_log_store()
|
|
test_log = logging.getLogger('log_store.test')
|
|
|
|
# Log table with extra columns
|
|
with self.assertLogs(test_log, level='DEBUG') as _log_context:
|
|
test_log.addHandler(log_store)
|
|
test_log.debug('Test log %s',
|
|
extra=dict(extra_metadata_fields={
|
|
'planet': 'Jupiter',
|
|
'galaxy': 'Milky Way'
|
|
}))
|
|
|
|
self.assertEqual(log_store.render_table_header(), [
|
|
('bold', 'Time '),
|
|
('', ' '),
|
|
('bold', 'Lvl '),
|
|
('', ' '),
|
|
('bold', 'Planet '),
|
|
('bold', 'Galaxy '),
|
|
('bold', 'Message'),
|
|
])
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|