feat: Add custom_allowlist to verify_messages function

Signed-off_by: Kacper Tokarzewski <kacper.tokarzewski@intel.com>

Author: KTokarze

mfd_dmesg/base.py

@@ -5,7 +5,7 @@
 import datetime
 import logging
 import re
-from typing import Iterable, Optional, Union, List, Tuple, TYPE_CHECKING
+from typing import Iterable, Optional, Union, List, Tuple, TYPE_CHECKING, Any
 
 from mfd_common_libs import add_logging_level, log_levels, os_supported
 from mfd_connect.exceptions import ConnectionCalledProcessError
@@ -220,9 +220,11 @@ def _check_specific_errors(self, error_msg: str) -> bool:
         else:
             return True
 
-    def verify_messages(self) -> dict:
+    def verify_messages(self, custom_allowlist: list[str | Any] = DMESG_WHITELIST) -> dict:
         """Verify if there are err level messages in dmesg output.
 
+        :param custom_allowlist: list of error messages to ignore in the dmesg output, if any.
+                                 By default, it uses DMESG_WHITELIST which contains known benign errors.
         :return: dictionary indicating success or failure and the error messages if present.
         """
         logger.log(level=log_levels.MODULE_DEBUG, msg="Verify Dmesg Errors.")
@@ -233,7 +235,7 @@ def verify_messages(self) -> dict:
             for error in out.splitlines():
                 is_error = True
                 if self._check_specific_errors(error):
-                    for benign_message in DMESG_WHITELIST:
+                    for benign_message in custom_allowlist:
                         if benign_message in error:
                             is_error = False
                             logger.log(

mfd_dmesg/constants.py

@@ -4,7 +4,7 @@
 
 from dataclasses import dataclass
 from typing import Optional
-from .enums import DmesgLevelOptions # noqa: F401
+from .enums import DmesgLevelOptions  # noqa: F401
 
 
 @dataclass

tests/unit/test_mfd_dmesg/test_base.py

@@ -386,6 +386,50 @@ def test_verify_messages_no_errors(self, dmesg):
         )
         assert dmesg.verify_messages()["successful"]
 
+    def test_verify_messages_with_custom_allowlist(self, dmesg):
+        output = dedent(
+            """
+            [    4.660616] Couldn't get size: 0x800000000000000e
+            [    4.694322] MODSIGN: Couldn't get UEFI db list
+            [    4.728454] Couldn't get size: 0x800000000000000e
+            [   33.580364] cdc_ether 1-1.1.2:1.0 enp0s29u1u1u2: CDC: unexpected notification 20!"""
+        )
+        custom_allowlist = ["Couldn't get size", "MODSIGN", "unexpected notification"]
+        dmesg._connection.execute_command.return_value = ConnectionCompletedProcess(
+            return_code=0, args="command", stdout=output, stderr="stderr"
+        )
+        result = dmesg.verify_messages(custom_allowlist=custom_allowlist)
+        assert result["successful"]
+        assert result["error"] == ""
+
+    def test_verify_messages_with_custom_allowlist_partial_match(self, dmesg):
+        output = dedent(
+            """
+            [    4.660616] Couldn't get size: 0x800000000000000e
+            [    4.694322] MODSIGN: Couldn't get UEFI db list
+            [   33.580364] cdc_ether 1-1.1.2:1.0 enp0s29u1u1u2: CDC: unexpected notification 20!"""
+        )
+        custom_allowlist = ["Couldn't get size"]
+        dmesg._connection.execute_command.return_value = ConnectionCompletedProcess(
+            return_code=0, args="command", stdout=output, stderr="stderr"
+        )
+        result = dmesg.verify_messages(custom_allowlist=custom_allowlist)
+        assert not result["successful"]
+        assert "MODSIGN" in result["error"]
+        assert "unexpected notification" in result["error"]
+
+    def test_verify_messages_with_empty_custom_allowlist(self, dmesg):
+        output = dedent(
+            """
+            [    4.660616] Couldn't get size: 0x800000000000000e"""
+        )
+        dmesg._connection.execute_command.return_value = ConnectionCompletedProcess(
+            return_code=0, args="command", stdout=output, stderr="stderr"
+        )
+        result = dmesg.verify_messages(custom_allowlist=[])
+        assert not result["successful"]
+        assert "Couldn't get size" in result["error"]
+
     def test_check_errors(self, dmesg):
         output = dedent(
             """
@@ -841,6 +885,35 @@ def test_verify_messages_no_errors(self, dmesg):
         )
         assert dmesg.verify_messages()["successful"]
 
+    def test_verify_messages_with_custom_allowlist(self, dmesg):
+        output = dedent(
+            """
+            [    4.660616] Couldn't get size error: 0x800000000000000e
+            [    4.694322] MODSIGN ERROR: Couldn't get UEFI db list
+            [    4.728454] Couldn't get size ERROR: 0x800000000000000e"""
+        )
+        custom_allowlist = ["Couldn't get size", "MODSIGN"]
+        dmesg._connection.execute_command.return_value = ConnectionCompletedProcess(
+            return_code=0, args="command", stdout=output, stderr="stderr"
+        )
+        result = dmesg.verify_messages(custom_allowlist=custom_allowlist)
+        assert result["successful"]
+        assert result["error"] == ""
+
+    def test_verify_messages_with_custom_allowlist_partial_match(self, dmesg):
+        output = dedent(
+            """
+            [    4.660616] Couldn't get size error: 0x800000000000000e
+            [    4.694322] MODSIGN ERROR: Couldn't get UEFI db list"""
+        )
+        custom_allowlist = ["Couldn't get size"]
+        dmesg._connection.execute_command.return_value = ConnectionCompletedProcess(
+            return_code=0, args="command", stdout=output, stderr="stderr"
+        )
+        result = dmesg.verify_messages(custom_allowlist=custom_allowlist)
+        assert not result["successful"]
+        assert "MODSIGN ERROR" in result["error"]
+
     def test_check_errors(self, dmesg):
         output = dedent(
             """