test_engine: improve the output
[kconfig-hardened-check.git] / kconfig_hardened_check / test_engine.py
index c9177059ab4794413116afe5a94694ef2b2a19cc..8dcc5879e94d55a4e392f7368e16fd10ee820a00 100644 (file)
@@ -15,8 +15,8 @@ import io
 import sys
 from collections import OrderedDict
 import json
+import inspect
 from .engine import KconfigCheck, CmdlineCheck, SysctlCheck, VersionCheck, OR, AND, populate_with_data, perform_checks, override_expected_value
-import re
 
 
 class TestEngine(unittest.TestCase):
@@ -69,14 +69,14 @@ class TestEngine(unittest.TestCase):
         perform_checks(checklist)
 
         # print the table with the results
-        print('TABLE:')
+        print(f'\n{inspect.stack()[1].function}():')
+        print('=' * 121)
         for opt in checklist:
             opt.table_print('verbose', True) # verbose mode, with_results
             print()
             print('=' * 121)
 
         # print the results in JSON
-        print('JSON:')
         result = []
         for opt in checklist:
             result.append(opt.json_dump(True)) # with_results
@@ -242,12 +242,12 @@ class TestEngine(unittest.TestCase):
                                 KconfigCheck('reason_4', 'decision_4', 'NAME_4', 'expected_4'))]
         config_checklist += [OR(KconfigCheck('reason_5', 'decision_5', 'NAME_5', 'expected_5'),
                                 KconfigCheck('reason_6', 'decision_6', 'NAME_6', 'expected_6'))]
-        config_checklist += [OR(KconfigCheck('reason_6', 'decision_6', 'NAME_6', 'expected_6'),
-                                KconfigCheck('reason_7', 'decision_7', 'NAME_7', 'is not set'))]
-        config_checklist += [OR(KconfigCheck('reason_8', 'decision_8', 'NAME_8', 'expected_8'),
-                                KconfigCheck('reason_9', 'decision_9', 'NAME_9', 'is present'))]
-        config_checklist += [OR(KconfigCheck('reason_10', 'decision_10', 'NAME_10', 'expected_10'),
-                                KconfigCheck('reason_11', 'decision_11', 'NAME_11', 'is not off'))]
+        config_checklist += [OR(KconfigCheck('reason_7', 'decision_7', 'NAME_7', 'expected_7'),
+                                KconfigCheck('reason_8', 'decision_8', 'NAME_8', 'is not set'))]
+        config_checklist += [OR(KconfigCheck('reason_9', 'decision_9', 'NAME_9', 'expected_9'),
+                                KconfigCheck('reason_10', 'decision_10', 'NAME_10', 'is present'))]
+        config_checklist += [OR(KconfigCheck('reason_11', 'decision_11', 'NAME_11', 'expected_11'),
+                                KconfigCheck('reason_12', 'decision_12', 'NAME_12', 'is not off'))]
 
         # 2. prepare the parsed kconfig options
         parsed_kconfig_options = OrderedDict()
@@ -257,8 +257,8 @@ class TestEngine(unittest.TestCase):
         parsed_kconfig_options['CONFIG_NAME_4'] = 'expected_4'
         parsed_kconfig_options['CONFIG_NAME_5'] = 'UNexpected_5'
         parsed_kconfig_options['CONFIG_NAME_6'] = 'UNexpected_6'
-        parsed_kconfig_options['CONFIG_NAME_9'] = 'UNexpected_9'
-        parsed_kconfig_options['CONFIG_NAME_11'] = 'really_not_off'
+        parsed_kconfig_options['CONFIG_NAME_10'] = 'UNexpected_10'
+        parsed_kconfig_options['CONFIG_NAME_12'] = 'really_not_off'
 
         # 3. run the engine
         self.run_engine(config_checklist, parsed_kconfig_options, None, None, None)
@@ -271,9 +271,9 @@ class TestEngine(unittest.TestCase):
                 [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK"],
                  ["CONFIG_NAME_3", "kconfig", "expected_3", "decision_3", "reason_3", "OK: CONFIG_NAME_4 is \"expected_4\""],
                  ["CONFIG_NAME_5", "kconfig", "expected_5", "decision_5", "reason_5", "FAIL: \"UNexpected_5\""],
-                 ["CONFIG_NAME_6", "kconfig", "expected_6", "decision_6", "reason_6", "OK: CONFIG_NAME_7 is not found"],
-                 ["CONFIG_NAME_8", "kconfig", "expected_8", "decision_8", "reason_8", "OK: CONFIG_NAME_9 is present"],
-                 ["CONFIG_NAME_10", "kconfig", "expected_10", "decision_10", "reason_10", "OK: CONFIG_NAME_11 is not off"]]
+                 ["CONFIG_NAME_7", "kconfig", "expected_7", "decision_7", "reason_7", "OK: CONFIG_NAME_8 is not found"],
+                 ["CONFIG_NAME_9", "kconfig", "expected_9", "decision_9", "reason_9", "OK: CONFIG_NAME_10 is present"],
+                 ["CONFIG_NAME_11", "kconfig", "expected_11", "decision_11", "reason_11", "OK: CONFIG_NAME_12 is not off"]]
         )
 
     def test_complex_and(self):
@@ -285,12 +285,12 @@ class TestEngine(unittest.TestCase):
                                  KconfigCheck('reason_4', 'decision_4', 'NAME_4', 'expected_4'))]
         config_checklist += [AND(KconfigCheck('reason_5', 'decision_5', 'NAME_5', 'expected_5'),
                                  KconfigCheck('reason_6', 'decision_6', 'NAME_6', 'expected_6'))]
-        config_checklist += [AND(KconfigCheck('reason_8', 'decision_8', 'NAME_8', 'expected_8'),
-                                 KconfigCheck('reason_9', 'decision_9', 'NAME_9', 'is present'))]
-        config_checklist += [AND(KconfigCheck('reason_10', 'decision_10', 'NAME_10', 'expected_10'),
-                                 KconfigCheck('reason_11', 'decision_11', 'NAME_11', 'is not off'))]
-        config_checklist += [AND(KconfigCheck('reason_12', 'decision_12', 'NAME_12', 'expected_12'),
-                                 KconfigCheck('reason_13', 'decision_13', 'NAME_13', 'is not off'))]
+        config_checklist += [AND(KconfigCheck('reason_7', 'decision_7', 'NAME_7', 'expected_7'),
+                                 KconfigCheck('reason_8', 'decision_8', 'NAME_8', 'is present'))]
+        config_checklist += [AND(KconfigCheck('reason_9', 'decision_9', 'NAME_9', 'expected_9'),
+                                 KconfigCheck('reason_10', 'decision_10', 'NAME_10', 'is not off'))]
+        config_checklist += [AND(KconfigCheck('reason_11', 'decision_11', 'NAME_11', 'expected_11'),
+                                 KconfigCheck('reason_12', 'decision_12', 'NAME_12', 'is not off'))]
 
         # 2. prepare the parsed kconfig options
         parsed_kconfig_options = OrderedDict()
@@ -300,10 +300,10 @@ class TestEngine(unittest.TestCase):
         parsed_kconfig_options['CONFIG_NAME_4'] = 'UNexpected_4'
         parsed_kconfig_options['CONFIG_NAME_5'] = 'UNexpected_5'
         parsed_kconfig_options['CONFIG_NAME_6'] = 'expected_6'
-        parsed_kconfig_options['CONFIG_NAME_8'] = 'expected_8'
-        parsed_kconfig_options['CONFIG_NAME_10'] = 'expected_10'
-        parsed_kconfig_options['CONFIG_NAME_11'] = '0'
-        parsed_kconfig_options['CONFIG_NAME_12'] = 'expected_12'
+        parsed_kconfig_options['CONFIG_NAME_7'] = 'expected_7'
+        parsed_kconfig_options['CONFIG_NAME_9'] = 'expected_9'
+        parsed_kconfig_options['CONFIG_NAME_10'] = '0'
+        parsed_kconfig_options['CONFIG_NAME_11'] = 'expected_11'
 
         # 3. run the engine
         self.run_engine(config_checklist, parsed_kconfig_options, None, None, None)
@@ -316,9 +316,9 @@ class TestEngine(unittest.TestCase):
                 [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK"],
                  ["CONFIG_NAME_3", "kconfig", "expected_3", "decision_3", "reason_3", "FAIL: CONFIG_NAME_4 is not \"expected_4\""],
                  ["CONFIG_NAME_5", "kconfig", "expected_5", "decision_5", "reason_5", "FAIL: \"UNexpected_5\""],
-                 ["CONFIG_NAME_8", "kconfig", "expected_8", "decision_8", "reason_8", "FAIL: CONFIG_NAME_9 is not present"],
-                 ["CONFIG_NAME_10", "kconfig", "expected_10", "decision_10", "reason_10", "FAIL: CONFIG_NAME_11 is off"],
-                 ["CONFIG_NAME_12", "kconfig", "expected_12", "decision_12", "reason_12", "FAIL: CONFIG_NAME_13 is off, not found"]]
+                 ["CONFIG_NAME_7", "kconfig", "expected_7", "decision_7", "reason_7", "FAIL: CONFIG_NAME_8 is not present"],
+                 ["CONFIG_NAME_9", "kconfig", "expected_9", "decision_9", "reason_9", "FAIL: CONFIG_NAME_10 is off"],
+                 ["CONFIG_NAME_11", "kconfig", "expected_11", "decision_11", "reason_11", "FAIL: CONFIG_NAME_12 is off, not found"]]
         )
 
     def test_version(self):
@@ -359,64 +359,64 @@ class TestEngine(unittest.TestCase):
         # 1. prepare the checklist
         config_checklist = []
         config_checklist += [OR(KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1'),
-                                AND(CmdlineCheck('reason_2', 'decision_2', 'name_2', 'expected_2'),
-                                    SysctlCheck('reason_3', 'decision_3', 'name_3', 'expected_3')))]
-        config_checklist += [AND(CmdlineCheck('reason_4', 'decision_4', 'name_4', 'expected_4'),
-                                 OR(KconfigCheck('reason_5', 'decision_5', 'NAME_5', 'expected_5'),
-                                    SysctlCheck('reason_6', 'decision_6', 'name_6', 'expected_6')))]
+                                CmdlineCheck('reason_2', 'decision_2', 'name_2', 'expected_2'),
+                                SysctlCheck('reason_3', 'decision_3', 'name_3', 'expected_3'))]
+        config_checklist += [AND(KconfigCheck('reason_4', 'decision_4', 'NAME_4', 'expected_4'),
+                                 CmdlineCheck('reason_5', 'decision_5', 'name_5', 'expected_5'),
+                                 SysctlCheck('reason_6', 'decision_6', 'name_6', 'expected_6'))]
 
-        # 2. prepare the parsed cmdline options
+        # 2. prepare the parsed kconfig options
+        parsed_kconfig_options = OrderedDict()
+        parsed_kconfig_options['CONFIG_NAME_1'] = 'UNexpected_1'
+
+        # 3. prepare the parsed cmdline options
         parsed_cmdline_options = OrderedDict()
-        parsed_cmdline_options['name_4'] = 'expected_4'
+        parsed_cmdline_options['name_2'] = 'expected_2'
+        parsed_cmdline_options['name_5'] = 'UNexpected_5'
 
-        # 3. prepare the parsed sysctl options
+        # 4. prepare the parsed sysctl options
         parsed_sysctl_options = OrderedDict()
-        parsed_sysctl_options['name_3'] = 'UNexpected_3'
-        parsed_sysctl_options['name_6'] = 'UNexpected_6'
+        parsed_sysctl_options['name_6'] = 'expected_6'
 
-        # 4. run the engine
-        self.run_engine(config_checklist, None, parsed_cmdline_options, parsed_sysctl_options, None)
+        # 5. run the engine
+        self.run_engine(config_checklist, parsed_kconfig_options, parsed_cmdline_options, parsed_sysctl_options, None)
 
-        # 5. check that the results are correct
+        # 6. check that the results are correct
         json_result = []
         self.get_engine_result(config_checklist, json_result, 'json')
         self.assertEqual(
                 json_result,
-                [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "FAIL: is not found"],
-                 ["name_4", "cmdline", "expected_4", "decision_4", "reason_4", "FAIL: CONFIG_NAME_5 is not \"expected_5\""]]
+                [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK: name_2 is \"expected_2\""],
+                 ["CONFIG_NAME_4", "kconfig", "expected_4", "decision_4", "reason_4", "FAIL: name_5 is not \"expected_5\""]]
         )
 
         stdout_result = []
         self.get_engine_result(config_checklist, stdout_result, 'stdout')
-        stdout_result_clean = [re.sub(r'\x1b(\[.*?[@-~]|\].*?(\x07|\x1b\\))', '', s) for s in stdout_result]
         self.assertEqual(
-                stdout_result_clean,
+                stdout_result,
                 [
 "\
-CONFIG_NAME_1                           |kconfig| expected_1 |decision_1|     reason_1     | FAIL: is not found\
-name_4                                  |cmdline| expected_4 |decision_4|     reason_4     | FAIL: CONFIG_NAME_5 is not \"expected_5\"\
+CONFIG_NAME_1                           |kconfig| expected_1 |decision_1|     reason_1     | \x1b[32mOK: name_2 is \"expected_2\"\x1b[0m\
+CONFIG_NAME_4                           |kconfig| expected_4 |decision_4|     reason_4     | \x1b[31mFAIL: name_5 is not \"expected_5\"\x1b[0m\
 "               ]
         )
 
         stdout_result = []
         self.get_engine_result(config_checklist, stdout_result, 'stdout_verbose')
-        stdout_result_clean = [re.sub(r'\x1b(\[.*?[@-~]|\].*?(\x07|\x1b\\))', '', s) for s in stdout_result]
         self.assertEqual(
-                stdout_result_clean,
+                stdout_result,
                 [
 "\
-    <<< OR >>>                                                                             | FAIL: is not found\n\
-CONFIG_NAME_1                           |kconfig| expected_1 |decision_1|     reason_1     | FAIL: is not found\n\
-    <<< AND >>>                                                                            | FAIL: name_3 is not \"expected_3\"\n\
-name_2                                  |cmdline| expected_2 |decision_2|     reason_2     | None\n\
-name_3                                  |sysctl | expected_3 |decision_3|     reason_3     | FAIL: \"UNexpected_3\"\
+    <<< OR >>>                                                                             | \x1b[32mOK: name_2 is \"expected_2\"\x1b[0m\n\
+CONFIG_NAME_1                           |kconfig| expected_1 |decision_1|     reason_1     | \x1b[31mFAIL: \"UNexpected_1\"\x1b[0m\n\
+name_2                                  |cmdline| expected_2 |decision_2|     reason_2     | \x1b[32mOK\x1b[0m\n\
+name_3                                  |sysctl | expected_3 |decision_3|     reason_3     | None\
 "\
 "\
-    <<< AND >>>                                                                            | FAIL: CONFIG_NAME_5 is not \"expected_5\"\n\
-name_4                                  |cmdline| expected_4 |decision_4|     reason_4     | None\n\
-    <<< OR >>>                                                                             | FAIL: is not found\n\
-CONFIG_NAME_5                           |kconfig| expected_5 |decision_5|     reason_5     | FAIL: is not found\n\
-name_6                                  |sysctl | expected_6 |decision_6|     reason_6     | FAIL: \"UNexpected_6\"\
+    <<< AND >>>                                                                            | \x1b[31mFAIL: name_5 is not \"expected_5\"\x1b[0m\n\
+CONFIG_NAME_4                           |kconfig| expected_4 |decision_4|     reason_4     | None\n\
+name_5                                  |cmdline| expected_5 |decision_5|     reason_5     | \x1b[31mFAIL: \"UNexpected_5\"\x1b[0m\n\
+name_6                                  |sysctl | expected_6 |decision_6|     reason_6     | \x1b[32mOK\x1b[0m\
 "               ]
         )