1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
|
#!/usr/bin/env python
"""
This module tests the functions inside of logger.py
"""
import gzip
import os
import sys
import unittest
from unittest import mock
from unittest.mock import Mock
import pytest
import can
import can.cli
import can.logger
class TestLoggerScriptModule(unittest.TestCase):
def setUp(self) -> None:
# Patch VirtualBus object
patcher_virtual_bus = mock.patch("can.interfaces.virtual.VirtualBus", spec=True)
self.MockVirtualBus = patcher_virtual_bus.start()
self.addCleanup(patcher_virtual_bus.stop)
self.mock_virtual_bus = self.MockVirtualBus.return_value
self.mock_virtual_bus.shutdown = Mock()
# Patch Logger object
patcher_logger = mock.patch("can.logger.Logger", spec=True)
self.MockLogger = patcher_logger.start()
self.addCleanup(patcher_logger.stop)
self.mock_logger = self.MockLogger.return_value
self.mock_logger.stop = Mock()
self.MockLoggerUse = self.MockLogger
self.loggerToUse = self.mock_logger
# Patch SizedRotatingLogger object
patcher_logger_sized = mock.patch("can.logger.SizedRotatingLogger", spec=True)
self.MockLoggerSized = patcher_logger_sized.start()
self.addCleanup(patcher_logger_sized.stop)
self.mock_logger_sized = self.MockLoggerSized.return_value
self.mock_logger_sized.stop = Mock()
self.testmsg = can.Message(
arbitration_id=0xC0FFEE, data=[0, 25, 0, 1, 3, 1, 4, 1], is_extended_id=True
)
self.baseargs = [sys.argv[0], "-i", "virtual"]
def assertSuccessfullCleanup(self):
self.MockVirtualBus.assert_called_once()
self.mock_virtual_bus.shutdown.assert_called_once()
self.MockLoggerUse.assert_called_once()
self.loggerToUse.stop.assert_called_once()
def test_log_virtual(self):
self.mock_virtual_bus.recv = Mock(side_effect=[self.testmsg, KeyboardInterrupt])
sys.argv = self.baseargs
can.logger.main()
self.assertSuccessfullCleanup()
self.mock_logger.assert_called_once()
def test_log_virtual_active(self):
self.mock_virtual_bus.recv = Mock(side_effect=[self.testmsg, KeyboardInterrupt])
sys.argv = self.baseargs + ["--active"]
can.logger.main()
self.assertSuccessfullCleanup()
self.mock_logger.assert_called_once()
self.assertEqual(self.mock_virtual_bus.state, can.BusState.ACTIVE)
def test_log_virtual_passive(self):
self.mock_virtual_bus.recv = Mock(side_effect=[self.testmsg, KeyboardInterrupt])
sys.argv = self.baseargs + ["--passive"]
can.logger.main()
self.assertSuccessfullCleanup()
self.mock_logger.assert_called_once()
self.assertEqual(self.mock_virtual_bus.state, can.BusState.PASSIVE)
def test_log_virtual_with_config(self):
self.mock_virtual_bus.recv = Mock(side_effect=[self.testmsg, KeyboardInterrupt])
sys.argv = self.baseargs + [
"--bitrate",
"250000",
"--fd",
"--data-bitrate",
"2000000",
]
can.logger.main()
self.assertSuccessfullCleanup()
self.mock_logger.assert_called_once()
def test_log_virtual_sizedlogger(self):
self.mock_virtual_bus.recv = Mock(side_effect=[self.testmsg, KeyboardInterrupt])
self.MockLoggerUse = self.MockLoggerSized
self.loggerToUse = self.mock_logger_sized
sys.argv = self.baseargs + ["--file_size", "1000000"]
can.logger.main()
self.assertSuccessfullCleanup()
self.mock_logger_sized.assert_called_once()
def test_parse_logger_args(self):
args = self.baseargs + [
"--bitrate",
"250000",
"--fd",
"--data-bitrate",
"2000000",
"--receive-own-messages=True",
]
results, additional_config = can.logger._parse_logger_args(args[1:])
assert results.interface == "virtual"
assert results.bitrate == 250_000
assert results.fd is True
assert results.data_bitrate == 2_000_000
assert additional_config["receive_own_messages"] is True
def test_parse_can_filters(self):
expected_can_filters = [{"can_id": 0x100, "can_mask": 0x7FC}]
results, additional_config = can.logger._parse_logger_args(
["--filter", "100:7FC", "--bitrate", "250000"]
)
assert results.can_filters == expected_can_filters
def test_parse_can_filters_list(self):
expected_can_filters = [
{"can_id": 0x100, "can_mask": 0x7FC},
{"can_id": 0x200, "can_mask": 0x7F0},
]
results, additional_config = can.logger._parse_logger_args(
["--filter", "100:7FC", "200:7F0", "--bitrate", "250000"]
)
assert results.can_filters == expected_can_filters
def test_parse_timing(self) -> None:
can20_args = self.baseargs + [
"--timing",
"f_clock=8_000_000",
"tseg1=5",
"tseg2=2",
"sjw=2",
"brp=2",
"nof_samples=1",
"--app-name=CANalyzer",
]
results, additional_config = can.logger._parse_logger_args(can20_args[1:])
assert results.timing == can.BitTiming(
f_clock=8_000_000, brp=2, tseg1=5, tseg2=2, sjw=2, nof_samples=1
)
assert additional_config["app_name"] == "CANalyzer"
canfd_args = self.baseargs + [
"--timing",
"f_clock=80_000_000",
"nom_tseg1=119",
"nom_tseg2=40",
"nom_sjw=40",
"nom_brp=1",
"data_tseg1=29",
"data_tseg2=10",
"data_sjw=10",
"data_brp=1",
"--app-name=CANalyzer",
]
results, additional_config = can.logger._parse_logger_args(canfd_args[1:])
assert results.timing == can.BitTimingFd(
f_clock=80_000_000,
nom_brp=1,
nom_tseg1=119,
nom_tseg2=40,
nom_sjw=40,
data_brp=1,
data_tseg1=29,
data_tseg2=10,
data_sjw=10,
)
assert additional_config["app_name"] == "CANalyzer"
# remove f_clock parameter, parsing should fail
incomplete_args = self.baseargs + [
"--timing",
"tseg1=5",
"tseg2=2",
"sjw=2",
"brp=2",
"nof_samples=1",
"--app-name=CANalyzer",
]
with self.assertRaises(SystemExit):
can.logger._parse_logger_args(incomplete_args[1:])
def test_parse_additional_config(self):
unknown_args = [
"--app-name=CANalyzer",
"--serial=5555",
"--receive-own-messages=True",
"--false-boolean=False",
"--offset=1.5",
"--tseg1-abr=127",
]
parsed_args = can.cli._parse_additional_config(unknown_args)
assert "app_name" in parsed_args
assert parsed_args["app_name"] == "CANalyzer"
assert "serial" in parsed_args
assert parsed_args["serial"] == 5555
assert "receive_own_messages" in parsed_args
assert (
isinstance(parsed_args["receive_own_messages"], bool)
and parsed_args["receive_own_messages"] is True
)
assert "false_boolean" in parsed_args
assert (
isinstance(parsed_args["false_boolean"], bool)
and parsed_args["false_boolean"] is False
)
assert "offset" in parsed_args
assert parsed_args["offset"] == 1.5
assert "tseg1_abr" in parsed_args
assert parsed_args["tseg1_abr"] == 127
with pytest.raises(ValueError):
can.cli._parse_additional_config(["--wrong-format"])
with pytest.raises(ValueError):
can.cli._parse_additional_config(["-wrongformat=value"])
with pytest.raises(ValueError):
can.cli._parse_additional_config(["--wrongformat=value1 value2"])
with pytest.raises(ValueError):
can.cli._parse_additional_config(["wrongformat="])
class TestLoggerCompressedFile(unittest.TestCase):
def setUp(self) -> None:
# Patch VirtualBus object
self.patcher_virtual_bus = mock.patch(
"can.interfaces.virtual.VirtualBus", spec=True
)
self.MockVirtualBus = self.patcher_virtual_bus.start()
self.mock_virtual_bus = self.MockVirtualBus.return_value
self.testmsg = can.Message(
arbitration_id=0xC0FFEE, data=[0, 25, 0, 1, 3, 1, 4, 1], is_extended_id=True
)
self.baseargs = [sys.argv[0], "-i", "virtual"]
self.testfile = open("coffee.log.gz", "w+")
def test_compressed_logfile(self):
"""
Basic test to verify Logger is able to write gzip files.
"""
self.mock_virtual_bus.recv = Mock(side_effect=[self.testmsg, KeyboardInterrupt])
sys.argv = self.baseargs + ["--file_name", self.testfile.name]
can.logger.main()
with gzip.open(self.testfile.name, "rt") as testlog:
last_line = testlog.readlines()[-1]
self.assertEqual(last_line, "(0.000000) vcan0 00C0FFEE#0019000103010401 R\n")
def tearDown(self) -> None:
self.testfile.close()
os.remove(self.testfile.name)
self.patcher_virtual_bus.stop()
if __name__ == "__main__":
unittest.main()
|