test_engine: add test_version()
[kconfig-hardened-check.git] / kconfig_hardened_check / test_engine.py
index 2f33a0e0afe6f5951234faf55aad576b216c0236..acb4d7ce475bf5d8b391df2a62da314c10f97b86 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, OR, AND, populate_with_data, perform_checks
+from .engine import KconfigCheck, CmdlineCheck, VersionCheck, OR, AND, populate_with_data, perform_checks
 
 
 class TestEngine(unittest.TestCase):
@@ -83,11 +83,21 @@ class TestEngine(unittest.TestCase):
         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')]
+        config_checklist += [KconfigCheck('reason_7', 'decision_7', 'NAME_7', 'is not off')]
+        config_checklist += [KconfigCheck('reason_8', 'decision_8', 'NAME_8', 'is not off')]
+        config_checklist += [KconfigCheck('reason_9', 'decision_9', 'NAME_9', 'is not off')]
+        config_checklist += [KconfigCheck('reason_10', 'decision_10', 'NAME_10', 'is not off')]
 
         # 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'
+        parsed_kconfig_options['CONFIG_NAME_7'] = 'really_not_off'
+        parsed_kconfig_options['CONFIG_NAME_8'] = 'off'
+        parsed_kconfig_options['CONFIG_NAME_9'] = '0'
 
         # 3. run the engine
         result = []
@@ -99,7 +109,13 @@ class TestEngine(unittest.TestCase):
                 [["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_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"],
+                 ["CONFIG_NAME_7", "kconfig", "is not off", "decision_7", "reason_7", "OK: is not off, \"really_not_off\""],
+                 ["CONFIG_NAME_8", "kconfig", "is not off", "decision_8", "reason_8", "FAIL: is off"],
+                 ["CONFIG_NAME_9", "kconfig", "is not off", "decision_9", "reason_9", "FAIL: is off, \"0\""],
+                 ["CONFIG_NAME_10", "kconfig", "is not off", "decision_10", "reason_10", "FAIL: is off, not found"]]
         )
 
     def test_single_cmdline(self):
@@ -109,12 +125,21 @@ class TestEngine(unittest.TestCase):
         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')]
+        config_checklist += [CmdlineCheck('reason_7', 'decision_7', 'name_7', 'is not off')]
+        config_checklist += [CmdlineCheck('reason_8', 'decision_8', 'name_8', 'is not off')]
+        config_checklist += [CmdlineCheck('reason_9', 'decision_9', 'name_9', 'is not off')]
+        config_checklist += [CmdlineCheck('reason_10', 'decision_10', 'name_10', 'is not off')]
 
         # 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'] = ''
+        parsed_cmdline_options['name_7'] = ''
+        parsed_cmdline_options['name_8'] = 'off'
+        parsed_cmdline_options['name_9'] = '0'
 
         # 3. run the engine
         result = []
@@ -126,7 +151,13 @@ class TestEngine(unittest.TestCase):
                 [["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_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"],
+                 ["name_7", "cmdline", "is not off", "decision_7", "reason_7", "OK: is not off, \"\""],
+                 ["name_8", "cmdline", "is not off", "decision_8", "reason_8", "FAIL: is off"],
+                 ["name_9", "cmdline", "is not off", "decision_9", "reason_9", "FAIL: is off, \"0\""],
+                 ["name_10", "cmdline", "is not off", "decision_10", "reason_10", "FAIL: is off, not found"]]
         )
 
     def test_OR(self):
@@ -138,6 +169,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'))]
 
         # 2. prepare the parsed kconfig options
         parsed_kconfig_options = OrderedDict()
@@ -147,6 +184,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'
 
         # 3. run the engine
         result = []
@@ -157,18 +196,27 @@ class TestEngine(unittest.TestCase):
                 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_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"]]
         )
 
     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'))]
+                                 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'))]
+                                 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'))]
+                                 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'))]
 
         # 2. prepare the parsed kconfig options
         parsed_kconfig_options = OrderedDict()
@@ -178,6 +226,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'
 
         # 3. run the engine
         result = []
@@ -188,5 +240,42 @@ class TestEngine(unittest.TestCase):
                 result,
                 [["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_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"]]
+        )
+
+    def test_version(self):
+        # 1. prepare the checklist
+        config_checklist = []
+        config_checklist += [OR(KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1'),
+                                VersionCheck((41, 101)))]
+        config_checklist += [AND(KconfigCheck('reason_2', 'decision_2', 'NAME_2', 'expected_2'),
+                                VersionCheck((44, 1)))]
+        config_checklist += [AND(KconfigCheck('reason_3', 'decision_3', 'NAME_3', 'expected_3'),
+                                VersionCheck((42, 44)))]
+        config_checklist += [OR(KconfigCheck('reason_4', 'decision_4', 'NAME_4', 'expected_4'),
+                                VersionCheck((42, 43)))]
+
+        # 2. prepare the parsed kconfig options
+        parsed_kconfig_options = OrderedDict()
+        parsed_kconfig_options['CONFIG_NAME_2'] = 'expected_2'
+        parsed_kconfig_options['CONFIG_NAME_3'] = 'expected_3'
+
+        # 3. prepare the kernel version
+        kernel_version = (42, 43)
+
+        # 4. run the engine
+        result = []
+        self.run_engine(config_checklist, parsed_kconfig_options, None, kernel_version, result)
+
+        # 5. check that the results are correct
+        self.assertEqual(
+                result,
+                [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK: version >= 41.101"],
+                 ["CONFIG_NAME_2", "kconfig", "expected_2", "decision_2", "reason_2", "FAIL: version < 44.1"],
+                 ["CONFIG_NAME_3", "kconfig", "expected_3", "decision_3", "reason_3", "FAIL: version < 42.44"],
+                 ["CONFIG_NAME_4", "kconfig", "expected_4", "decision_4", "reason_4", "OK: version >= 42.43"]]
         )
+