test_engine: implement get_engine_result() for stdout

[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 acb4d7ce475bf5d8b391df2a62da314c10f97b86..960f5168f8fa14f4c0996ccbb0260d29d2e508a1 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
@@ -39,19 +41,16 @@ class TestEngine(unittest.TestCase):
         kernel_version = (42, 43)
 
         # 5. run the engine
-        result = []
-        self.run_engine(config_checklist,
-                        parsed_kconfig_options, parsed_cmdline_options, kernel_version,
-                        result)
+        self.run_engine(config_checklist, parsed_kconfig_options, parsed_cmdline_options, kernel_version)
 
         # 6. check that the results are correct
-        # self.assertEqual(...
+        result = []
+        self.get_engine_result(config_checklist, result, 'json')
+        self.assertEqual(...
     """
 
     @staticmethod
-    def run_engine(checklist,
-                   parsed_kconfig_options, parsed_cmdline_options, kernel_version,
-                   result):
+    def run_engine(checklist, parsed_kconfig_options, parsed_cmdline_options, kernel_version):
         # populate the checklist with data
         if parsed_kconfig_options:
             populate_with_data(checklist, parsed_kconfig_options, 'kconfig')
@@ -66,16 +65,36 @@ 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:')
+        result = []
         for opt in checklist:
             result.append(opt.json_dump(True)) # with_results
         print(json.dumps(result))
         print()
 
+    @staticmethod
+    def get_engine_result(checklist, result, result_type):
+        assert(result_type in ('json', 'stdout')), \
+               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:
+            opt.table_print('verbose', True) # verbose mode, with_results
+        sys.stdout = stdout_backup
+        result.append(captured_output.getvalue())
+
     def test_single_kconfig(self):
         # 1. prepare the checklist
         config_checklist = []
@@ -100,10 +119,11 @@ class TestEngine(unittest.TestCase):
         parsed_kconfig_options['CONFIG_NAME_9'] = '0'
 
         # 3. run the engine
-        result = []
-        self.run_engine(config_checklist, parsed_kconfig_options, None, None, result)
+        self.run_engine(config_checklist, parsed_kconfig_options, None, None)
 
         # 4. check that the results are correct
+        result = []
+        self.get_engine_result(config_checklist, result, 'json')
         self.assertEqual(
                 result,
                 [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK"],
@@ -142,10 +162,11 @@ class TestEngine(unittest.TestCase):
         parsed_cmdline_options['name_9'] = '0'
 
         # 3. run the engine
-        result = []
-        self.run_engine(config_checklist, None, parsed_cmdline_options, None, result)
+        self.run_engine(config_checklist, None, parsed_cmdline_options, None)
 
         # 4. check that the results are correct
+        result = []
+        self.get_engine_result(config_checklist, result, 'json')
         self.assertEqual(
                 result,
                 [["name_1", "cmdline", "expected_1", "decision_1", "reason_1", "OK"],
@@ -188,10 +209,11 @@ class TestEngine(unittest.TestCase):
         parsed_kconfig_options['CONFIG_NAME_11'] = 'really_not_off'
 
         # 3. run the engine
-        result = []
-        self.run_engine(config_checklist, parsed_kconfig_options, None, None, result)
+        self.run_engine(config_checklist, parsed_kconfig_options, None, None)
 
         # 4. check that the results are correct
+        result = []
+        self.get_engine_result(config_checklist, result, 'json')
         self.assertEqual(
                 result,
                 [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK"],
@@ -232,10 +254,11 @@ class TestEngine(unittest.TestCase):
         parsed_kconfig_options['CONFIG_NAME_12'] = 'expected_12'
 
         # 3. run the engine
-        result = []
-        self.run_engine(config_checklist, parsed_kconfig_options, None, None, result)
+        self.run_engine(config_checklist, parsed_kconfig_options, None, None)
 
         # 4. check that the results are correct
+        result = []
+        self.get_engine_result(config_checklist, result, 'json')
         self.assertEqual(
                 result,
                 [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK"],
@@ -267,10 +290,11 @@ class TestEngine(unittest.TestCase):
         kernel_version = (42, 43)
 
         # 4. run the engine
-        result = []
-        self.run_engine(config_checklist, parsed_kconfig_options, None, kernel_version, result)
+        self.run_engine(config_checklist, parsed_kconfig_options, None, kernel_version)
 
         # 5. check that the results are correct
+        result = []
+        self.get_engine_result(config_checklist, result, 'json')
         self.assertEqual(
                 result,
                 [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK: version >= 41.101"],