Adapt test_version() in the unittest

[kconfig-hardened-check.git] / kernel_hardening_checker / engine.py

diff --git a/kernel_hardening_checker/engine.py b/kernel_hardening_checker/engine.py
index 4fdc222e7e8ac3d9fec6a2cf0a3c60c411f8c918..268a142387b87940d1803adbb2fe72b6d6c71a24 100644 (file)
--- a/kernel_hardening_checker/engine.py
+++ b/kernel_hardening_checker/engine.py
@@ -1,4 +1,4 @@
-#!/usr/bin/python3
+#!/usr/bin/env python3
 
 """
 This tool is for checking the security hardening options of the Linux kernel.
@@ -20,10 +20,9 @@ def colorize_result(input_text):
         return input_text
     if input_text.startswith('OK'):
         color = GREEN_COLOR
-    elif input_text.startswith('FAIL:'):
-        color = RED_COLOR
     else:
-        assert(False), f'unexpected result "{input_text}"'
+        assert(input_text.startswith('FAIL:')), f'unexpected result "{input_text}"'
+        color = RED_COLOR
     return f'{color}{input_text}{COLOR_END}'
 
 
@@ -58,6 +57,15 @@ class OptCheck:
         self.state = None
         self.result = None
 
+    @property
+    def type(self):
+        return None
+
+    def set_state(self, data):
+        assert(data is None or isinstance(data, str)), \
+               f'invalid state "{data}" for "{self.name}" check'
+        self.state = data
+
     def check(self):
         # handle the 'is present' check
         if self.expected == 'is present':
@@ -105,7 +113,7 @@ class OptCheck:
 class KconfigCheck(OptCheck):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        self.name = 'CONFIG_' + self.name
+        self.name = f'CONFIG_{self.name}'
 
     @property
     def type(self):
@@ -126,8 +134,10 @@ class SysctlCheck(OptCheck):
 
 class VersionCheck:
     def __init__(self, ver_expected):
-        assert(ver_expected and isinstance(ver_expected, tuple) and len(ver_expected) == 2), \
-               f'invalid version "{ver_expected}" for VersionCheck'
+        assert(ver_expected and isinstance(ver_expected, tuple) and len(ver_expected) == 3), \
+               f'invalid expected version "{ver_expected}" for VersionCheck (1)'
+        assert(all(map(lambda x: isinstance(x, int), ver_expected))), \
+               f'invalid expected version "{ver_expected}" for VersionCheck (2)'
         self.ver_expected = ver_expected
         self.ver = ()
         self.result = None
@@ -136,20 +146,33 @@ class VersionCheck:
     def type(self):
         return 'version'
 
+    def set_state(self, data):
+        assert(data and isinstance(data, tuple) and len(data) >= 3), \
+               f'invalid version "{data}" for VersionCheck'
+        self.ver = data[:3]
+
     def check(self):
         if self.ver[0] > self.ver_expected[0]:
-            self.result = f'OK: version >= {self.ver_expected[0]}.{self.ver_expected[1]}'
+            self.result = f'OK: version >= {self.ver_expected}'
             return
         if self.ver[0] < self.ver_expected[0]:
-            self.result = f'FAIL: version < {self.ver_expected[0]}.{self.ver_expected[1]}'
+            self.result = f'FAIL: version < {self.ver_expected}'
+            return
+        # self.ver[0] and self.ver_expected[0] are equal
+        if self.ver[1] > self.ver_expected[1]:
+            self.result = f'OK: version >= {self.ver_expected}'
+            return
+        if self.ver[1] < self.ver_expected[1]:
+            self.result = f'FAIL: version < {self.ver_expected}'
             return
-        if self.ver[1] >= self.ver_expected[1]:
-            self.result = f'OK: version >= {self.ver_expected[0]}.{self.ver_expected[1]}'
+        # self.ver[1] and self.ver_expected[1] are equal too
+        if self.ver[2] >= self.ver_expected[2]:
+            self.result = f'OK: version >= {self.ver_expected}'
             return
-        self.result = f'FAIL: version < {self.ver_expected[0]}.{self.ver_expected[1]}'
+        self.result = f'FAIL: version < {self.ver_expected}'
 
     def table_print(self, _mode, with_results):
-        ver_req = f'kernel version >= {self.ver_expected[0]}.{self.ver_expected[1]}'
+        ver_req = f'kernel version >= {self.ver_expected}'
         print(f'{ver_req:<91}', end='')
         if with_results:
             print(f'| {colorize_result(self.result)}', end='')
@@ -180,7 +203,8 @@ class ComplexOptCheck:
 
     def table_print(self, mode, with_results):
         if mode == 'verbose':
-            print(f'    {"<<< " + self.__class__.__name__ + " >>>":87}', end='')
+            class_name = f'<<< {self.__class__.__name__} >>>'
+            print(f'    {class_name:87}', end='')
             if with_results:
                 print(f'| {colorize_result(self.result)}', end='')
             for o in self.opts:
@@ -276,11 +300,11 @@ def populate_simple_opt_with_data(opt, data, data_type):
         return
 
     if data_type in ('kconfig', 'cmdline', 'sysctl'):
-        opt.state = data.get(opt.name, None)
+        opt.set_state(data.get(opt.name, None))
     else:
         assert(data_type == 'version'), \
                f'unexpected data type "{data_type}"'
-        opt.ver = data
+        opt.set_state(data)
 
 
 def populate_opt_with_data(opt, data, data_type):