kconfig_hardened_check/test_engine.py

   1 #!/usr/bin/python3
   2
   3 """
   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!
   7
   8 Author: Alexander Popov <alex.popov@linux.com>
   9
  10 This module performs unit-testing of the kconfig-hardened-check engine.
  11 """
  12
  13 import unittest
  14 from collections import OrderedDict
  15 import json
  16 from .engine import KconfigCheck, CmdlineCheck, populate_with_data, perform_checks
  17
  18
  19 class TestEngine(unittest.TestCase):
  20     """
  21     Example test scenario:
  22
  23         # 1. prepare the checklist
  24         config_checklist = []
  25         config_checklist += [KconfigCheck('reason_1', 'decision_1', 'KCONFIG_NAME', 'expected_1')]
  26         config_checklist += [CmdlineCheck('reason_2', 'decision_2', 'cmdline_name', 'expected_2')]
  27
  28         # 2. prepare the parsed kconfig options
  29         parsed_kconfig_options = OrderedDict()
  30         parsed_kconfig_options['CONFIG_KCONFIG_NAME'] = 'UNexpected_1'
  31
  32         # 3. prepare the parsed cmdline options
  33         parsed_cmdline_options = OrderedDict()
  34         parsed_cmdline_options['cmdline_name'] = 'expected_2'
  35
  36         # 4. prepare the kernel version
  37         kernel_version = (42, 43)
  38
  39         # 5. run the engine
  40         result = []
  41         self.run_engine(config_checklist,
  42                         parsed_kconfig_options, parsed_cmdline_options, kernel_version,
  43                         result)
  44
  45         # 6. check that the results are correct
  46         # self.assertEqual(...
  47     """
  48
  49     @staticmethod
  50     def run_engine(checklist, parsed_kconfig_options, parsed_cmdline_options, kernel_version):
  51         # populate the checklist with data
  52         populate_with_data(checklist, parsed_kconfig_options, 'kconfig')
  53         populate_with_data(checklist, parsed_cmdline_options, 'cmdline')
  54         populate_with_data(checklist, kernel_version, 'version')
  55
  56         # now everything is ready, perform the checks
  57         perform_checks(checklist)
  58
  59         # print the results in JSON
  60         output = []
  61         print('JSON:')
  62         for opt in checklist:
  63             output.append(opt.json_dump(True)) # with_results
  64         print(json.dumps(output))
  65
  66         # print the table with the results
  67         print('TABLE:')
  68         for opt in checklist:
  69             opt.table_print(None, True) # default mode, with_results
  70             print()
  71         print()
  72
  73     def test_1(self):
  74         # 1. prepare the checklist
  75         config_checklist = []
  76         config_checklist += [KconfigCheck('reason_1', 'decision_1', 'KCONFIG_NAME', 'expected_1')]
  77         config_checklist += [CmdlineCheck('reason_2', 'decision_2', 'cmdline_name', 'expected_2')]
  78
  79         # 2. prepare the parsed kconfig options
  80         parsed_kconfig_options = OrderedDict()
  81         parsed_kconfig_options['CONFIG_KCONFIG_NAME'] = 'UNexpected_1'
  82
  83         # 3. prepare the parsed cmdline options
  84         parsed_cmdline_options = OrderedDict()
  85         parsed_cmdline_options['cmdline_name'] = 'expected_2'
  86
  87         # 4. prepare the kernel version
  88         kernel_version = (42, 43)
  89
  90         # 5. run the engine
  91         self.run_engine(config_checklist, parsed_kconfig_options, parsed_cmdline_options, kernel_version)
  92
  93         # 6. check that the results are correct
  94         self.assertEqual('foo'.upper(), 'FOO')
  95
  96     def test_2(self):
  97         self.assertTrue('FOO'.isupper())