test_engine: test the non-verbose output mode

[kconfig-hardened-check.git] / kconfig_hardened_check / test_engine.py

diff --git a/kconfig_hardened_check/test_engine.py b/kconfig_hardened_check/test_engine.py
index 846dc91eaf51fb6c83e9a1c55840690b5f505b59..acb47b2544269bb20a36098b28ef7b8969df4279 100644 (file)
--- a/kconfig_hardened_check/test_engine.py
+++ b/kconfig_hardened_check/test_engine.py
@@ -13,6 +13,8 @@ This module performs unit-testing of the kconfig-hardened-check engine.
 # pylint: disable=missing-function-docstring,line-too-long
 
 import unittest
+import io
+import sys
 from collections import OrderedDict
 import json
 from .engine import KconfigCheck, CmdlineCheck, VersionCheck, OR, AND, populate_with_data, perform_checks
@@ -63,8 +65,9 @@ class TestEngine(unittest.TestCase):
         # print the table with the results
         print('TABLE:')
         for opt in checklist:
-            opt.table_print(None, True) # default mode, with_results
+            opt.table_print('verbose', True) # verbose mode, with_results
             print()
+            print('=' * 121)
 
         # print the results in JSON
         print('JSON:')
@@ -76,11 +79,24 @@ class TestEngine(unittest.TestCase):
 
     @staticmethod
     def get_engine_result(checklist, result, result_type):
-        assert(result_type in ('table', 'json')), \
+        assert(result_type in ('json', 'stdout', 'stdout_verbose')), \
                f'invalid result type "{result_type}"'
+
         if result_type == 'json':
             for opt in checklist:
                 result.append(opt.json_dump(True)) # with_results
+            return
+
+        captured_output = io.StringIO()
+        stdout_backup = sys.stdout
+        sys.stdout = captured_output
+        for opt in checklist:
+            if result_type == 'stdout_verbose':
+                opt.table_print('verbose', True) # verbose mode, with_results
+            else:
+                opt.table_print(None, True) # normal mode, with_results
+        sys.stdout = stdout_backup
+        result.append(captured_output.getvalue())
 
     def test_single_kconfig(self):
         # 1. prepare the checklist
@@ -290,3 +306,60 @@ class TestEngine(unittest.TestCase):
                  ["CONFIG_NAME_4", "kconfig", "expected_4", "decision_4", "reason_4", "OK: version >= 42.43"]]
         )
 
+    def test_stdout(self):
+        # 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'),
+                                    KconfigCheck('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'),
+                                    CmdlineCheck('reason_6', 'decision_6', 'name_6', 'expected_6')))]
+
+        # 2. prepare the parsed kconfig options
+        parsed_kconfig_options = OrderedDict()
+        parsed_kconfig_options['CONFIG_NAME_5'] = 'expected_5'
+
+        # 3. run the engine
+        self.run_engine(config_checklist, parsed_kconfig_options, None, None)
+
+        # 4. 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: is not found"]]
+        )
+
+        stdout_result = []
+        self.get_engine_result(config_checklist, stdout_result, 'stdout')
+        self.assertEqual(
+                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: is not found\
+"               ]
+        )
+
+        stdout_result = []
+        self.get_engine_result(config_checklist, stdout_result, 'stdout_verbose')
+        self.assertEqual(
+                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: CONFIG_NAME_3 is not \"expected_3\"\n\
+name_2                                  |cmdline| expected_2 |decision_2|     reason_2     | None\n\
+CONFIG_NAME_3                           |kconfig| expected_3 |decision_3|     reason_3     | FAIL: is not found\
+"\
+"\
+    <<< AND >>>                                                                            | FAIL: is not found\n\
+name_4                                  |cmdline| expected_4 |decision_4|     reason_4     | FAIL: is not found\n\
+    <<< OR >>>                                                                             | OK\n\
+CONFIG_NAME_5                           |kconfig| expected_5 |decision_5|     reason_5     | OK\n\
+name_6                                  |cmdline| expected_6 |decision_6|     reason_6     | None\
+"               ]
+        )