run_engine(): add the 'result' argument and put the JSON output into it

[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 90c6fa8d57d71d1d9ca51a33a700321a8ce68166..c5f6beb55c8800a5e3c29f343240d5641fca1d9b 100644 (file)
--- a/kconfig_hardened_check/test_engine.py
+++ b/kconfig_hardened_check/test_engine.py
@@ -15,8 +15,41 @@ from collections import OrderedDict
 import json
 from .engine import KconfigCheck, CmdlineCheck, populate_with_data, perform_checks
 
+
 class TestEngine(unittest.TestCase):
-    def run_engine(self, checklist, parsed_kconfig_options, parsed_cmdline_options, kernel_version):
+    """
+    Example test scenario:
+
+        # 1. prepare the checklist
+        config_checklist = []
+        config_checklist += [KconfigCheck('reason_1', 'decision_1', 'KCONFIG_NAME', 'expected_1')]
+        config_checklist += [CmdlineCheck('reason_2', 'decision_2', 'cmdline_name', 'expected_2')]
+
+        # 2. prepare the parsed kconfig options
+        parsed_kconfig_options = OrderedDict()
+        parsed_kconfig_options['CONFIG_KCONFIG_NAME'] = 'UNexpected_1'
+
+        # 3. prepare the parsed cmdline options
+        parsed_cmdline_options = OrderedDict()
+        parsed_cmdline_options['cmdline_name'] = 'expected_2'
+
+        # 4. prepare the kernel version
+        kernel_version = (42, 43)
+
+        # 5. run the engine
+        result = []
+        self.run_engine(config_checklist,
+                        parsed_kconfig_options, parsed_cmdline_options, kernel_version,
+                        result)
+
+        # 6. check that the results are correct
+        # self.assertEqual(...
+    """
+
+    @staticmethod
+    def run_engine(checklist,
+                   parsed_kconfig_options, parsed_cmdline_options, kernel_version,
+                   result):
         # populate the checklist with data
         populate_with_data(checklist, parsed_kconfig_options, 'kconfig')
         populate_with_data(checklist, parsed_cmdline_options, 'cmdline')
@@ -25,18 +58,17 @@ class TestEngine(unittest.TestCase):
         # now everything is ready, perform the checks
         perform_checks(checklist)
 
-        # print the results in JSON
-        output = []
-        print('JSON:')
-        for opt in checklist:
-            output.append(opt.json_dump(True)) # with_results
-        print(json.dumps(output))
-
         # print the table with the results
         print('TABLE:')
         for opt in checklist:
             opt.table_print(None, True) # default mode, with_results
             print()
+
+        # print the results in JSON
+        print('JSON:')
+        for opt in checklist:
+            result.append(opt.json_dump(True)) # with_results
+        print(json.dumps(result))
         print()
 
     def test_1(self):