added docstrings

Author: alexandraBara

nodescraper/plugins/inband/kernel_module/analyzer_args.py

@@ -39,7 +39,7 @@ class KernelModuleAnalyzerArgs(AnalyzerArgs):
 
     @classmethod
     def build_from_model(cls, datamodel: KernelModuleDataModel) -> "KernelModuleAnalyzerArgs":
-        """build analyzer args from data model
+        """build analyzer args from data model and filter by datamodel.regex_filter
 
         Args:
             datamodel (KernelModuleDataModel): data model for plugin

nodescraper/plugins/inband/kernel_module/kernel_module_analyzer.py

@@ -42,6 +42,16 @@ class KernelModuleAnalyzer(DataAnalyzer[KernelModuleDataModel, KernelModuleAnaly
     def filter_modules_by_pattern(
         self, modules: dict[str, dict], patterns: list[str] = None
     ) -> tuple[dict[str, dict], list[str]]:
+        """Filter modules by pattern
+
+        Args:
+            modules (dict[str, dict]): modules to be filtered
+            patterns (list[str], optional): pattern to us. Defaults to None.
+
+        Returns:
+            tuple[dict[str, dict], list[str]]: tuple - dict of modules filtered,
+            list of unmatched pattern
+        """
         if patterns is None:
             return modules, []
 
@@ -64,6 +74,16 @@ def filter_modules_by_pattern(
     def filter_modules_by_name_and_param(
         self, modules: dict[str, dict], to_match: dict[str, dict]
     ) -> tuple[dict[str, dict], dict[str, dict]]:
+        """Filter modules by name, param and value
+
+        Args:
+            modules (dict[str, dict]): modules to be filtered
+            to_match (dict[str, dict]): modules to match
+
+        Returns:
+            tuple[dict[str, dict], dict[str, dict]]: tuple - dict of modules filtered,
+            dict of modules unmatched
+        """
         if not to_match:
             return modules, {}
 
@@ -75,7 +95,6 @@ def filter_modules_by_name_and_param(
             actual_data = modules.get(mod_name)
 
             if not actual_data:
-                # Module completely missing
                 unmatched[mod_name] = expected_data
                 continue
 

nodescraper/plugins/inband/kernel_module/kernel_module_collector.py

@@ -24,6 +24,7 @@
 #
 ###############################################################################
 from nodescraper.base import InBandDataCollector
+from nodescraper.connection.inband.inband import CommandArtifact
 from nodescraper.enums import EventCategory, EventPriority, ExecutionStatus, OSFamily
 from nodescraper.models import TaskResult
 
@@ -35,8 +36,15 @@ class KernelModuleCollector(InBandDataCollector[KernelModuleDataModel, None]):
 
     DATA_MODEL = KernelModuleDataModel
 
-    def parse_proc_modules(self, output):
-        """Parses the output of /proc/modules into a dictionary."""
+    def parse_proc_modules(self, output: dict) -> dict:
+        """Parse command output and return dict of modules
+
+        Args:
+            output (dict): sut cmd output
+
+        Returns:
+            dict: parsed modules
+        """
         modules = {}
         for line in output.strip().splitlines():
             parts = line.split()
@@ -48,8 +56,15 @@ def parse_proc_modules(self, output):
             }
         return modules
 
-    def get_module_parameters(self, module_name):
-        """Fetches parameter names and values for a given kernel module using _run_sut_cmd."""
+    def get_module_parameters(self, module_name: str) -> dict:
+        """Fetches parameter names and values for a given kernel module using _run_sut_cmd
+
+        Args:
+            module_name (str): name of module to fetch params for
+
+        Returns:
+            dict: param dict of module
+        """
         param_dict = {}
         param_dir = f"/sys/module/{module_name}/parameters"
 
@@ -66,7 +81,15 @@ def get_module_parameters(self, module_name):
 
         return param_dict
 
-    def collect_all_module_info(self):
+    def collect_all_module_info(self) -> tuple[dict, CommandArtifact]:
+        """Get all modules and its associated params and values
+
+        Raises:
+            RuntimeError: error for failing to get modules
+
+        Returns:
+            tuple[dict, CommandArtifact]: modules found and exit code
+        """
         res = self._run_sut_cmd("cat /proc/modules")
         if res.exit_code != 0:
             raise RuntimeError("Failed to read /proc/modules")
@@ -78,10 +101,7 @@ def collect_all_module_info(self):
 
         return modules, res
 
-    def collect_data(
-        self,
-        args=None,
-    ) -> tuple[TaskResult, KernelModuleDataModel | None]:
+    def collect_data(self, args=None) -> tuple[TaskResult, KernelModuleDataModel | None]:
         """
         Collect kernel modules data.