From: Alexander Popov Date: Fri, 24 Mar 2023 20:11:49 +0000 (+0300) Subject: Fix pylint warnings: add class docstring X-Git-Tag: v0.6.6~205 X-Git-Url: https://jxself.org/git/?a=commitdiff_plain;h=dd45244eae35fbbdeaf7783ac2f4700771b0504a;p=kconfig-hardened-check.git Fix pylint warnings: add class docstring --- diff --git a/kconfig_hardened_check/test_engine.py b/kconfig_hardened_check/test_engine.py index 4147da9..68bef44 100644 --- a/kconfig_hardened_check/test_engine.py +++ b/kconfig_hardened_check/test_engine.py @@ -15,7 +15,37 @@ from collections import OrderedDict import json from .engine import KconfigCheck, CmdlineCheck, populate_with_data, perform_checks + class TestEngine(unittest.TestCase): + """ + 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')] + + # 2. prepare the parsed kconfig options + parsed_kconfig_options = OrderedDict() + parsed_kconfig_options['CONFIG_KCONFIG_NAME'] = 'UNexpected_1' + + # 3. prepare the parsed cmdline options + parsed_cmdline_options = OrderedDict() + parsed_cmdline_options['cmdline_name'] = 'expected_2' + + # 4. prepare the kernel version + kernel_version = (42, 43) + + # 5. run the engine + result = [] + self.run_engine(config_checklist, + parsed_kconfig_options, parsed_cmdline_options, kernel_version, + result) + + # 6. check that the results are correct + # self.assertEqual(... + """ + @staticmethod def run_engine(checklist, parsed_kconfig_options, parsed_cmdline_options, kernel_version): # populate the checklist with data