4 This tool helps me to check Linux kernel options against
5 my security hardening preferences for X86_64, ARM64, X86_32, and ARM.
6 Let the computers do their job!
8 Author: Alexander Popov <alex.popov@linux.com>
10 This module performs unit-testing of the kconfig-hardened-check engine.
13 # pylint: disable=missing-function-docstring,line-too-long
16 from collections import OrderedDict
18 from .engine import KconfigCheck, CmdlineCheck, populate_with_data, perform_checks
21 class TestEngine(unittest.TestCase):
23 Example test scenario:
25 # 1. prepare the checklist
27 config_checklist += [KconfigCheck('reason_1', 'decision_1', 'KCONFIG_NAME', 'expected_1')]
28 config_checklist += [CmdlineCheck('reason_2', 'decision_2', 'cmdline_name', 'expected_2')]
30 # 2. prepare the parsed kconfig options
31 parsed_kconfig_options = OrderedDict()
32 parsed_kconfig_options['CONFIG_KCONFIG_NAME'] = 'UNexpected_1'
34 # 3. prepare the parsed cmdline options
35 parsed_cmdline_options = OrderedDict()
36 parsed_cmdline_options['cmdline_name'] = 'expected_2'
38 # 4. prepare the kernel version
39 kernel_version = (42, 43)
43 self.run_engine(config_checklist,
44 parsed_kconfig_options, parsed_cmdline_options, kernel_version,
47 # 6. check that the results are correct
48 # self.assertEqual(...
52 def run_engine(checklist,
53 parsed_kconfig_options, parsed_cmdline_options, kernel_version,
55 # populate the checklist with data
56 if parsed_kconfig_options:
57 populate_with_data(checklist, parsed_kconfig_options, 'kconfig')
58 if parsed_cmdline_options:
59 populate_with_data(checklist, parsed_cmdline_options, 'cmdline')
61 populate_with_data(checklist, kernel_version, 'version')
63 # now everything is ready, perform the checks
64 perform_checks(checklist)
66 # print the table with the results
69 opt.table_print(None, True) # default mode, with_results
72 # print the results in JSON
75 result.append(opt.json_dump(True)) # with_results
76 print(json.dumps(result))
79 def test_kconfig_ok(self):
80 # 1. prepare the checklist
82 config_checklist += [KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1')]
84 # 2. prepare the parsed kconfig options
85 parsed_kconfig_options = OrderedDict()
86 parsed_kconfig_options['CONFIG_NAME_1'] = 'expected_1'
90 self.run_engine(config_checklist, parsed_kconfig_options, None, None, result)
92 # 4. check that the results are correct
95 [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK"]]
98 def test_kconfig_fail(self):
99 # 1. prepare the checklist
100 config_checklist = []
101 config_checklist += [KconfigCheck('reason_2', 'decision_2', 'NAME_2', 'expected_2')]
103 # 2. prepare the parsed kconfig options
104 parsed_kconfig_options = OrderedDict()
105 parsed_kconfig_options['CONFIG_NAME_2'] = 'UNexpected_2'
109 self.run_engine(config_checklist, parsed_kconfig_options, None, None, result)
111 # 4. check that the results are correct
114 [["CONFIG_NAME_2", "kconfig", "expected_2", "decision_2", "reason_2", "FAIL: \"UNexpected_2\""]]
117 def test_cmdline_ok(self):
118 # 1. prepare the checklist
119 config_checklist = []
120 config_checklist += [CmdlineCheck('reason_3', 'decision_3', 'name_3', 'expected_3')]
122 # 2. prepare the parsed cmdline options
123 parsed_cmdline_options = OrderedDict()
124 parsed_cmdline_options['name_3'] = 'expected_3'
128 self.run_engine(config_checklist, None, parsed_cmdline_options, None, result)
130 # 4. check that the results are correct
133 [["name_3", "cmdline", "expected_3", "decision_3", "reason_3", "OK"]]
136 def test_cmdline_fail(self):
137 # 1. prepare the checklist
138 config_checklist = []
139 config_checklist += [CmdlineCheck('reason_4', 'decision_4', 'name_4', 'expected_4')]
141 # 2. prepare the parsed cmdline options
142 parsed_cmdline_options = OrderedDict()
143 parsed_cmdline_options['name_4'] = 'UNexpected_4'
147 self.run_engine(config_checklist, None, parsed_cmdline_options, None, result)
149 # 4. check that the results are correct
152 [["name_4", "cmdline", "expected_4", "decision_4", "reason_4", "FAIL: \"UNexpected_4\""]]