test_engine: test 'is present'
[kconfig-hardened-check.git] / kconfig_hardened_check / test_engine.py
index 12241d16944524967e9d12621baedcebbb5a3e5e..dd551c1c9083de76972f5d2f3ba21720390282e8 100644 (file)
@@ -15,7 +15,7 @@ This module performs unit-testing of the kconfig-hardened-check engine.
 import unittest
 from collections import OrderedDict
 import json
-from .engine import KconfigCheck, CmdlineCheck, populate_with_data, perform_checks
+from .engine import KconfigCheck, CmdlineCheck, OR, AND, populate_with_data, perform_checks
 
 
 class TestEngine(unittest.TestCase):
@@ -53,9 +53,12 @@ class TestEngine(unittest.TestCase):
                    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')
-        populate_with_data(checklist, kernel_version, 'version')
+        if parsed_kconfig_options:
+            populate_with_data(checklist, parsed_kconfig_options, 'kconfig')
+        if parsed_cmdline_options:
+            populate_with_data(checklist, parsed_cmdline_options, 'cmdline')
+        if kernel_version:
+            populate_with_data(checklist, kernel_version, 'version')
 
         # now everything is ready, perform the checks
         perform_checks(checklist)
@@ -73,14 +76,21 @@ class TestEngine(unittest.TestCase):
         print(json.dumps(result))
         print()
 
-    def test_kconfig_ok(self):
+    def test_single_kconfig(self):
         # 1. prepare the checklist
         config_checklist = []
         config_checklist += [KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1')]
+        config_checklist += [KconfigCheck('reason_2', 'decision_2', 'NAME_2', 'expected_2')]
+        config_checklist += [KconfigCheck('reason_3', 'decision_3', 'NAME_3', 'expected_3')]
+        config_checklist += [KconfigCheck('reason_4', 'decision_4', 'NAME_4', 'is not set')]
+        config_checklist += [KconfigCheck('reason_5', 'decision_5', 'NAME_5', 'is present')]
+        config_checklist += [KconfigCheck('reason_6', 'decision_6', 'NAME_6', 'is present')]
 
         # 2. prepare the parsed kconfig options
         parsed_kconfig_options = OrderedDict()
         parsed_kconfig_options['CONFIG_NAME_1'] = 'expected_1'
+        parsed_kconfig_options['CONFIG_NAME_2'] = 'UNexpected_2'
+        parsed_kconfig_options['CONFIG_NAME_5'] = 'UNexpected_5'
 
         # 3. run the engine
         result = []
@@ -89,17 +99,97 @@ class TestEngine(unittest.TestCase):
         # 4. check that the results are correct
         self.assertEqual(
                 result,
-                [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK"]]
+                [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK"],
+                 ["CONFIG_NAME_2", "kconfig", "expected_2", "decision_2", "reason_2", "FAIL: \"UNexpected_2\""],
+                 ["CONFIG_NAME_3", "kconfig", "expected_3", "decision_3", "reason_3", "FAIL: is not found"],
+                 ["CONFIG_NAME_4", "kconfig", "is not set", "decision_4", "reason_4", "OK: is not found"],
+                 ["CONFIG_NAME_5", "kconfig", "is present", "decision_5", "reason_5", "OK: is present"],
+                 ["CONFIG_NAME_6", "kconfig", "is present", "decision_6", "reason_6", "FAIL: is not present"]]
         )
 
-    def test_kconfig_fail(self):
+    def test_single_cmdline(self):
         # 1. prepare the checklist
         config_checklist = []
-        config_checklist += [KconfigCheck('reason_2', 'decision_2', 'NAME_2', 'expected_2')]
+        config_checklist += [CmdlineCheck('reason_1', 'decision_1', 'name_1', 'expected_1')]
+        config_checklist += [CmdlineCheck('reason_2', 'decision_2', 'name_2', 'expected_2')]
+        config_checklist += [CmdlineCheck('reason_3', 'decision_3', 'name_3', 'expected_3')]
+        config_checklist += [CmdlineCheck('reason_4', 'decision_4', 'name_4', 'is not set')]
+        config_checklist += [CmdlineCheck('reason_5', 'decision_5', 'name_5', 'is present')]
+        config_checklist += [CmdlineCheck('reason_6', 'decision_6', 'name_6', 'is present')]
+
+        # 2. prepare the parsed cmdline options
+        parsed_cmdline_options = OrderedDict()
+        parsed_cmdline_options['name_1'] = 'expected_1'
+        parsed_cmdline_options['name_2'] = 'UNexpected_2'
+        parsed_cmdline_options['name_5'] = ''
+
+        # 3. run the engine
+        result = []
+        self.run_engine(config_checklist, None, parsed_cmdline_options, None, result)
+
+        # 4. check that the results are correct
+        self.assertEqual(
+                result,
+                [["name_1", "cmdline", "expected_1", "decision_1", "reason_1", "OK"],
+                 ["name_2", "cmdline", "expected_2", "decision_2", "reason_2", "FAIL: \"UNexpected_2\""],
+                 ["name_3", "cmdline", "expected_3", "decision_3", "reason_3", "FAIL: is not found"],
+                 ["name_4", "cmdline", "is not set", "decision_4", "reason_4", "OK: is not found"],
+                 ["name_5", "cmdline", "is present", "decision_5", "reason_5", "OK: is present"],
+                 ["name_6", "cmdline", "is present", "decision_6", "reason_6", "FAIL: is not present"]]
+        )
+
+    def test_OR(self):
+        # 1. prepare the checklist
+        config_checklist = []
+        config_checklist += [OR(KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1'),
+                                KconfigCheck('reason_2', 'decision_2', 'NAME_2', 'expected_2'))]
+        config_checklist += [OR(KconfigCheck('reason_3', 'decision_3', 'NAME_3', 'expected_3'),
+                                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'))]
 
         # 2. prepare the parsed kconfig options
         parsed_kconfig_options = OrderedDict()
+        parsed_kconfig_options['CONFIG_NAME_1'] = 'expected_1'
         parsed_kconfig_options['CONFIG_NAME_2'] = 'UNexpected_2'
+        parsed_kconfig_options['CONFIG_NAME_3'] = 'UNexpected_3'
+        parsed_kconfig_options['CONFIG_NAME_4'] = 'expected_4'
+        parsed_kconfig_options['CONFIG_NAME_5'] = 'UNexpected_5'
+        parsed_kconfig_options['CONFIG_NAME_6'] = 'UNexpected_6'
+
+        # 3. run the engine
+        result = []
+        self.run_engine(config_checklist, parsed_kconfig_options, None, None, result)
+
+        # 4. check that the results are correct
+        self.assertEqual(
+                result,
+                [["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"]]
+        )
+
+    def test_AND(self):
+        # 1. prepare the checklist
+        config_checklist = []
+        config_checklist += [AND(KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1'),
+                                KconfigCheck('reason_2', 'decision_2', 'NAME_2', 'expected_2'))]
+        config_checklist += [AND(KconfigCheck('reason_3', 'decision_3', 'NAME_3', 'expected_3'),
+                                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'))]
+
+        # 2. prepare the parsed kconfig options
+        parsed_kconfig_options = OrderedDict()
+        parsed_kconfig_options['CONFIG_NAME_1'] = 'expected_1'
+        parsed_kconfig_options['CONFIG_NAME_2'] = 'expected_2'
+        parsed_kconfig_options['CONFIG_NAME_3'] = 'expected_3'
+        parsed_kconfig_options['CONFIG_NAME_4'] = 'UNexpected_4'
+        parsed_kconfig_options['CONFIG_NAME_5'] = 'UNexpected_5'
+        parsed_kconfig_options['CONFIG_NAME_6'] = 'expected_6'
 
         # 3. run the engine
         result = []
@@ -108,5 +198,7 @@ class TestEngine(unittest.TestCase):
         # 4. check that the results are correct
         self.assertEqual(
                 result,
-                [["CONFIG_NAME_2", "kconfig", "expected_2", "decision_2", "reason_2", "FAIL: \"UNexpected_2\""]]
+                [["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\""]]
         )