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, populate_with_data, perform_checks
+from .engine import KconfigCheck, CmdlineCheck, VersionCheck, OR, AND, populate_with_data, perform_checks
+
class TestEngine(unittest.TestCase):
- def test_1(self):
- # add checks to the checklist
+ """
+ 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')]
- # populate the checklist with the parsed kconfig data
+ # 2. prepare the parsed kconfig options
parsed_kconfig_options = OrderedDict()
parsed_kconfig_options['CONFIG_KCONFIG_NAME'] = 'UNexpected_1'
- populate_with_data(config_checklist, parsed_kconfig_options, 'kconfig')
- # populate the checklist with the parsed cmdline data
+ # 3. prepare the parsed cmdline options
parsed_cmdline_options = OrderedDict()
parsed_cmdline_options['cmdline_name'] = 'expected_2'
- populate_with_data(config_checklist, parsed_cmdline_options, 'cmdline')
- # populate the checklist with the kernel version data
+ # 4. prepare the kernel version
kernel_version = (42, 43)
- populate_with_data(config_checklist, kernel_version, 'version')
- # now everything is ready, perform the checks
- perform_checks(config_checklist)
+ # 5. run the engine
+ self.run_engine(config_checklist, parsed_kconfig_options, parsed_cmdline_options, kernel_version)
- # print the results in json
- output = []
- print('JSON:')
- for opt in config_checklist:
- output.append(opt.json_dump(True))
- print(json.dumps(output))
+ # 6. check that the results are correct
+ result = []
+ self.get_engine_result(config_checklist, result, 'json')
+ self.assertEqual(...
+ """
+
+ @staticmethod
+ 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')
+ if parsed_cmdline_options:
+ populate_with_data(checklist, parsed_cmdline_options, 'cmdline')
+ if kernel_version:
+ populate_with_data(checklist, kernel_version, 'version')
- # print the results
+ # now everything is ready, perform the checks
+ perform_checks(checklist)
+
+ # print the table with the results
print('TABLE:')
- for opt in config_checklist:
- opt.table_print(None, True)
+ for opt in checklist:
+ 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()
- self.assertEqual('foo'.upper(), 'FOO')
+ @staticmethod
+ def get_engine_result(checklist, result, result_type):
+ 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
+ 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')]
+ 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
+ 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"],
+ ["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"],
+ ["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):
+ # 1. prepare the checklist
+ config_checklist = []
+ 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')]
+ 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
+ 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"],
+ ["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"],
+ ["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):
+ # 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'))]
+ 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()
+ 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'
+ parsed_kconfig_options['CONFIG_NAME_9'] = 'UNexpected_9'
+ parsed_kconfig_options['CONFIG_NAME_11'] = 'really_not_off'
+
+ # 3. run the engine
+ 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"],
+ ["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"],
+ ["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'))]
+ 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'))]
+ 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()
+ 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'
+ 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
+ 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"],
+ ["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_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
+ 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"],
+ ["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"]]
+ )
+
+ def test_verbose(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"]]
+ )
- def test_2(self):
- self.assertTrue('FOO'.isupper())
+ 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\
+" ]
+ )
projects / kconfig-hardened-check.git / blobdiff