Mute some pylint warnings for test_engine.py

[kconfig-hardened-check.git] / kconfig_hardened_check / test_engine.py

diff --git a/kconfig_hardened_check/test_engine.py b/kconfig_hardened_check/test_engine.py
index 7b3467984a08c3e8e1e0bd5a6c89968735f3dd13..8dea037bc701bd3a9660c460829ff513a0e9a5f2 100644 (file)
--- a/kconfig_hardened_check/test_engine.py
+++ b/kconfig_hardened_check/test_engine.py
@@ -10,50 +10,87 @@ Author: Alexander Popov <alex.popov@linux.com>
 This module performs unit-testing of the kconfig-hardened-check engine.
 """
 
+# pylint: disable=missing-function-docstring,line-too-long
+
 import unittest
 from collections import OrderedDict
 import json
 from .engine import KconfigCheck, CmdlineCheck, 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
+        result = []
+        self.run_engine(config_checklist,
+                        parsed_kconfig_options, parsed_cmdline_options, kernel_version,
+                        result)
 
-        # 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
+        # self.assertEqual(...
+    """
 
-        # print the results
+    @staticmethod
+    def run_engine(checklist,
+                   parsed_kconfig_options, parsed_cmdline_options, kernel_version,
+                   result):
+        # populate the checklist with data
+        populate_with_data(checklist, parsed_kconfig_options, 'kconfig')
+        populate_with_data(checklist, parsed_cmdline_options, 'cmdline')
+        populate_with_data(checklist, kernel_version, 'version')
+
+        # 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(None, True) # default mode, with_results
             print()
+
+        # print the results in JSON
+        print('JSON:')
+        for opt in checklist:
+            result.append(opt.json_dump(True)) # with_results
+        print(json.dumps(result))
         print()
 
-        self.assertEqual('foo'.upper(), 'FOO')
+    def test_kconfig_ok(self):
+        # 1. prepare the checklist
+        config_checklist = []
+        config_checklist += [KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1')]
+
+        # 2. prepare the parsed kconfig options
+        parsed_kconfig_options = OrderedDict()
+        parsed_kconfig_options['CONFIG_NAME_1'] = 'expected_1'
+
+        # 3. run the engine
+        result = []
+        self.run_engine(config_checklist, parsed_kconfig_options, None, None, result)
+
+        # 4. check that the results are correct
+        self.assertEqual(
+                result,
+                [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK"]]
+        )
+
+
 
-    def test_2(self):
-        self.assertTrue('FOO'.isupper())