import sys
from collections import OrderedDict
import json
-from .engine import KconfigCheck, CmdlineCheck, VersionCheck, OR, AND, populate_with_data, perform_checks
+from .engine import KconfigCheck, CmdlineCheck, VersionCheck, OR, AND, populate_with_data, perform_checks, override_expected_value
class TestEngine(unittest.TestCase):
@staticmethod
def get_engine_result(checklist, result, result_type):
- assert(result_type in ('json', 'stdout')), \
+ assert(result_type in ('json', 'stdout', 'stdout_verbose')), \
f'invalid result type "{result_type}"'
if result_type == 'json':
stdout_backup = sys.stdout
sys.stdout = captured_output
for opt in checklist:
- opt.table_print('verbose', True) # verbose mode, with_results
+ 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):
+ def test_simple_kconfig(self):
# 1. prepare the checklist
config_checklist = []
config_checklist += [KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1')]
["CONFIG_NAME_10", "kconfig", "is not off", "decision_10", "reason_10", "FAIL: is off, not found"]]
)
- def test_single_cmdline(self):
+ def test_simple_cmdline(self):
# 1. prepare the checklist
config_checklist = []
config_checklist += [CmdlineCheck('reason_1', 'decision_1', 'name_1', 'expected_1')]
["name_10", "cmdline", "is not off", "decision_10", "reason_10", "FAIL: is off, not found"]]
)
- def test_OR(self):
+ def test_complex_or(self):
# 1. prepare the checklist
config_checklist = []
config_checklist += [OR(KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1'),
["CONFIG_NAME_10", "kconfig", "expected_10", "decision_10", "reason_10", "OK: CONFIG_NAME_11 is not off"]]
)
- def test_AND(self):
+ def test_complex_and(self):
# 1. prepare the checklist
config_checklist = []
config_checklist += [AND(KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1'),
["CONFIG_NAME_4", "kconfig", "expected_4", "decision_4", "reason_4", "OK: version >= 42.43"]]
)
- def test_verbose(self):
+ def test_stdout(self):
# 1. prepare the checklist
config_checklist = []
config_checklist += [OR(KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1'),
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'
+ # 2. prepare the parsed cmdline options
+ parsed_cmdline_options = OrderedDict()
+ parsed_cmdline_options['name_4'] = 'expected_4'
+ parsed_cmdline_options['name_6'] = 'UNexpected_6'
# 3. run the engine
- self.run_engine(config_checklist, parsed_kconfig_options, None, None)
+ self.run_engine(config_checklist, None, parsed_cmdline_options, None)
# 4. check that the results are correct
json_result = []
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"]]
+ ["name_4", "cmdline", "expected_4", "decision_4", "reason_4", "FAIL: CONFIG_NAME_5 is not \"expected_5\""]]
)
stdout_result = []
self.assertEqual(
stdout_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: CONFIG_NAME_5 is not \"expected_5\"\
+" ]
+ )
+
+ 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\
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\
+ <<< AND >>> | FAIL: CONFIG_NAME_5 is not \"expected_5\"\n\
+name_4 |cmdline| expected_4 |decision_4| reason_4 | None\n\
+ <<< OR >>> | FAIL: is not found\n\
+CONFIG_NAME_5 |kconfig| expected_5 |decision_5| reason_5 | FAIL: is not found\n\
+name_6 |cmdline| expected_6 |decision_6| reason_6 | FAIL: \"UNexpected_6\"\
" ]
)
+
+ def test_value_overriding(self):
+ # 1. prepare the checklist
+ config_checklist = []
+ config_checklist += [KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1')]
+ config_checklist += [CmdlineCheck('reason_2', 'decision_2', 'name_2', 'expected_2')]
+
+ # 2. prepare the parsed kconfig options
+ parsed_kconfig_options = OrderedDict()
+ parsed_kconfig_options['CONFIG_NAME_1'] = 'expected_1_new'
+
+ # 3. prepare the parsed cmdline options
+ parsed_cmdline_options = OrderedDict()
+ parsed_cmdline_options['name_2'] = 'expected_2_new'
+
+ # 4. run the engine
+ self.run_engine(config_checklist, parsed_kconfig_options, parsed_cmdline_options, None)
+
+ # 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", "FAIL: \"expected_1_new\""],
+ ["name_2", "cmdline", "expected_2", "decision_2", "reason_2", "FAIL: \"expected_2_new\""]]
+ )
+
+ # 6. override expected value and perform the checks again
+ override_expected_value(config_checklist, "CONFIG_NAME_1", "expected_1_new")
+ perform_checks(config_checklist)
+
+ # 7. check that the results are correct
+ result = []
+ self.get_engine_result(config_checklist, result, 'json')
+ self.assertEqual(
+ result,
+ [["CONFIG_NAME_1", "kconfig", "expected_1_new", "decision_1", "reason_1", "OK"],
+ ["name_2", "cmdline", "expected_2", "decision_2", "reason_2", "FAIL: \"expected_2_new\""]]
+ )
+
+ # 8. override expected value and perform the checks again
+ override_expected_value(config_checklist, "name_2", "expected_2_new")
+ perform_checks(config_checklist)
+
+ # 9. check that the results are correct
+ result = []
+ self.get_engine_result(config_checklist, result, 'json')
+ self.assertEqual(
+ result,
+ [["CONFIG_NAME_1", "kconfig", "expected_1_new", "decision_1", "reason_1", "OK"],
+ ["name_2", "cmdline", "expected_2_new", "decision_2", "reason_2", "OK"]]
+ )
projects / kconfig-hardened-check.git / blobdiff