add logger to client system tests

Make system tests more stable.

Author: mdabrowski1990

examples/transport_interface/class_logger.py

@@ -0,0 +1,33 @@
+"""Configure logger for class of Transport Interface."""
+
+import logging
+
+from uds.transport_interface import AbstractTransportInterface, TransportLogger
+
+
+# configure your logging
+# https://docs.python.org/3/library/logging.html
+logger = logging.getLogger("UDS")  # example logger name
+logger.setLevel(logging.INFO)  # example logging level
+# optionally configure logging to file
+file_handler = logging.FileHandler(filename="uds.log", encoding="utf-8")
+file_handler.setLevel(logging.INFO)
+logger.addHandler(file_handler)
+# optionally configure logging to python console
+stream_handler = logging.StreamHandler()
+stream_handler.setLevel(logging.INFO)
+logger.addHandler(stream_handler)
+
+# configure your logger
+# https://uds.readthedocs.io/en/stable/pages/user_guide/logging.html#configuration
+transport_logger = TransportLogger(logger_name="UDS",  # the same name as previously configured logger
+                                   message_logging_level=logging.INFO,
+                                   packet_logging_level=logging.INFO,
+                                   log_sending=True,
+                                   log_receiving=True)
+
+# activate your logger
+# https://uds.readthedocs.io/en/stable/pages/user_guide/logging.html#decorating-transport-interface-class
+@transport_logger
+class CustomTransportInterface(AbstractTransportInterface):
+    ...  # TODO: implement your interface class

examples/transport_interface/instance_logger.py

@@ -30,7 +30,7 @@
                                    log_receiving=True)
 
 # activate your logger
-# http://localhost:63342/uds/docs/build/html/pages/user_guide/logging.html#decorating-transport-interface-instance
+# https://uds.readthedocs.io/en/stable/pages/user_guide/logging.html#decorating-transport-interface-instance
 transport_interface_with_logger = transport_logger(transport_interface)
 
 # TODO: use `transport_interface_with_logger` the same way as `transport_interface`

tests/software_tests/transport_interface/test_logger.py

@@ -1,6 +1,3 @@
-from asyncio import iscoroutine, iscoroutinefunction
-from inspect import *
-
 import pytest
 from mock import AsyncMock, MagicMock, Mock, call, patch
 

…ts/system_tests/client/can/python_can.py …sts/client/can/test_python_can_kvaser.pytests/system_tests/client/can/python_can.py renamed to tests/system_tests/client/can/test_python_can_kvaser.py tests/system_tests/client/can/python_can.py renamed to tests/system_tests/client/can/test_python_can_kvaser.py

@@ -1,12 +1,13 @@
 from random import choice
+from time import sleep
 
 from tests.conftest import make_can_addressing_information
 
 from can import Bus
 from uds.can import CanAddressingFormat, DefaultFlowControlParametersGenerator, PyCanTransportInterface
 from uds.utilities import TimeMillisecondsAlias
 
-from ..test_client import (
+from ..client import (
     AbstractBaseClientFunctionalityTests,
     AbstractClientErrorGuessing,
     AbstractClientTests,
@@ -32,9 +33,10 @@ def _define_transport_interfaces(self):
         self.can_interface_2 = Bus(interface="kvaser",
                                    channel=1,
                                    fd=True)
-        self.transport_interface_1 = PyCanTransportInterface(
+        transport_interface_1 = PyCanTransportInterface(
             network_manager=self.can_interface_1,
             addressing_information=addressing_information)
+        self.transport_interface_1 = self.transport_logger(transport_interface_1)
         self.transport_interface_2 = PyCanTransportInterface(
             network_manager=self.can_interface_2,
             addressing_information=addressing_information.get_other_end())
@@ -46,6 +48,7 @@ def teardown_method(self):
         super().teardown_method()
         self.can_interface_1.shutdown()
         self.can_interface_2.shutdown()
+        sleep(0.1)
 
     def configure_slow_message_reception(self):
         """Change configuration of Transport Interfaces to reach timeouts easily."""

tests/system_tests/client/test_client.py tests/system_tests/client/client.pytests/system_tests/client/test_client.py renamed to tests/system_tests/client/client.py

@@ -7,6 +7,8 @@
 
 from abc import ABC, abstractmethod
 from time import perf_counter, sleep
+import logging
+from datetime import datetime
 
 import pytest
 from tests.system_tests import BaseSystemTests
@@ -15,12 +17,16 @@
 from uds.client import Client
 from uds.message import RequestSID, UdsMessage, UdsMessageRecord
 from uds.translator import BASE_TRANSLATOR
-from uds.transport_interface import AbstractTransportInterface
+from uds.transport_interface import AbstractTransportInterface, TransportLogger
 
 
 class AbstractClientTests(BaseSystemTests, ABC):
     """Abstract definition of System tests for UDS Client."""
 
+    LOGGER_NAME: str = "UDS"
+
+    logger: logging.Logger
+    transport_logger: TransportLogger
     transport_interface_1: AbstractTransportInterface
     transport_interface_2: AbstractTransportInterface
 
@@ -36,6 +42,20 @@ def _define_transport_interfaces(self):
     def configure_slow_message_reception(self):
         """Change configuration of Transport Interfaces to reach timeouts easily."""
 
+    @classmethod
+    def configure_logger(cls):
+        cls.logger = logging.getLogger(cls.LOGGER_NAME)
+        cls.logger.setLevel(logging.INFO)
+        date_and_time = datetime.now().strftime('%Y-%m-%d_%H-%M-%S')
+        file_handler = logging.FileHandler(filename=f"{date_and_time}.log", encoding="utf-8")
+        file_handler.setLevel(logging.INFO)
+        cls.logger.addHandler(file_handler)
+        cls.transport_logger = TransportLogger(logger_name=cls.LOGGER_NAME)
+
+    @classmethod
+    def setup_class(cls):
+        cls.configure_logger()
+
     def setup_method(self):
         """
         Prepare for testing:

uds/can/transport_interface/python_can.py

@@ -205,7 +205,7 @@ def __teardown_sync_listening(self, suppress_warning: bool = False) -> None:
         :param suppress_warning: Do not warn about mixing Synchronous and Asynchronous implementation.
         """
         if self.notifier is not None:
-            self.notifier.stop(self._MIN_NOTIFIER_TIMEOUT)
+            self.notifier.stop()
             self.notifier = None
             if not suppress_warning:
                 warn(message="Notifier (python-can) was stopped. "
@@ -222,7 +222,7 @@ def __teardown_async_listening(self, suppress_warning: bool = False) -> None:
         :param suppress_warning: Do not warn about mixing Synchronous and Asynchronous implementation.
         """
         if self.async_notifier is not None:
-            self.async_notifier.stop(self._MIN_NOTIFIER_TIMEOUT)
+            self.async_notifier.stop()
             self.async_notifier = None
             if not suppress_warning:
                 warn(message="Async notifier (python-can) was stopped. "

uds/transport_interface/logger.py

@@ -121,7 +121,7 @@ def log_receiving(self) -> bool:
 
     @log_receiving.setter
     def log_receiving(self, value: bool) -> None:
-        """Set whether outgoing traffic shall be logged."""
+        """Set whether incoming traffic shall be logged."""
         self.__log_receiving = bool(value)
 
     @property