docstring + utest update

Author: alexandraBara

nodescraper/cli/helper.py

@@ -34,7 +34,7 @@
 from nodescraper.configbuilder import ConfigBuilder
 from nodescraper.configregistry import ConfigRegistry
 from nodescraper.enums import SystemInteractionLevel, SystemLocation
-from nodescraper.models import PluginConfig, SystemInfo
+from nodescraper.models import PluginConfig, PluginResult, SystemInfo
 from nodescraper.pluginexecutor import PluginExecutor
 from nodescraper.pluginregistry import PluginRegistry
 from nodescraper.resultcollators.tablesummary import TableSummary
@@ -283,7 +283,19 @@ def log_system_info(log_path: str | None, system_info: SystemInfo, logger: loggi
             logger.error(exp)
 
 
-def generate_reference_config(results, plugin_reg, logger):
+def generate_reference_config(
+    results: list[PluginResult], plugin_reg: PluginRegistry, logger: logging.Logger
+) -> PluginConfig:
+    """Generate reference config from plugin results
+
+    Args:
+        results (list[PluginResult]): list of plugin results
+        plugin_reg (PluginRegistry): registry containing all registered plugins
+        logger (logging.Logger): logger
+
+    Returns:
+        PluginConfig: holds model that defines final reference config
+    """
     plugin_config = PluginConfig()
     plugins = {}
     for obj in results:

nodescraper/plugins/inband/bios/analyzer_args.py

@@ -26,6 +26,7 @@
 from pydantic import Field, field_validator
 
 from nodescraper.interfaces import AnalyzerArgs
+from nodescraper.plugins.inband.os.osdata import OsDataModel
 
 
 class BiosAnalyzerArgs(AnalyzerArgs):
@@ -49,5 +50,13 @@ def validate_exp_bios_version(cls, exp_bios_version: str | list) -> list:
         return exp_bios_version
 
     @classmethod
-    def build_from_model(cls, datamodel) -> "BiosAnalyzerArgs":
+    def build_from_model(cls, datamodel: OsDataModel) -> "BiosAnalyzerArgs":
+        """build analyzer args from data model
+
+        Args:
+            datamodel (BiosDataModel): data model for plugin
+
+        Returns:
+            BiosAnalyzerArgs: instance of analyzer args class
+        """
         return cls(exp_bios_version=datamodel.bios_version)

nodescraper/plugins/inband/cmdline/analyzer_args.py

@@ -26,6 +26,7 @@
 from pydantic import Field, field_validator
 
 from nodescraper.interfaces import AnalyzerArgs
+from nodescraper.plugins.inband.cmdline.cmdlinedata import CmdlineDataModel
 
 
 class CmdlineAnalyzerArgs(AnalyzerArgs):
@@ -65,5 +66,13 @@ def validate_banned_cmdline(cls, banned_cmdline: str | list) -> list:
         return banned_cmdline
 
     @classmethod
-    def build_from_model(cls, datamodel) -> "CmdlineAnalyzerArgs":
+    def build_from_model(cls, datamodel: CmdlineDataModel) -> "CmdlineAnalyzerArgs":
+        """build analyzer args from data model
+
+        Args:
+            datamodel (CmdlineDataModel): data model for plugin
+
+        Returns:
+            CmdlineAnalyzerArgs: instance of analyzer args class
+        """
         return cls(required_cmdline=datamodel.cmdline, banned_cmdline=datamodel.cmdline)

nodescraper/plugins/inband/dkms/analyzer_args.py

@@ -28,6 +28,7 @@
 from pydantic import Field, field_validator
 
 from nodescraper.interfaces import AnalyzerArgs
+from nodescraper.plugins.inband.dkms.dkmsdata import DkmsDataModel
 
 
 class DkmsAnalyzerArgs(AnalyzerArgs):
@@ -72,5 +73,13 @@ def validate_dkms_version(cls, dkms_version: str | list) -> list:
         return dkms_version
 
     @classmethod
-    def build_from_model(cls, datamodel) -> "DkmsAnalyzerArgs":
+    def build_from_model(cls, datamodel: DkmsDataModel) -> "DkmsAnalyzerArgs":
+        """build analyzer args from data model
+
+        Args:
+            datamodel (DkmsDataModel): data model for plugin
+
+        Returns:
+            DkmsAnalyzerArgs: instance of analyzer args class
+        """
         return cls(dkms_status=datamodel.status, dkms_version=datamodel.version)

nodescraper/plugins/inband/dmesg/analyzer_args.py

@@ -26,12 +26,24 @@
 from typing import Optional
 
 from nodescraper.models import TimeRangeAnalysisArgs
+from nodescraper.plugins.inband.dmesg.dmesgdata import DmesgData
 
 
 class DmesgAnalyzerArgs(TimeRangeAnalysisArgs):
     check_unknown_dmesg_errors: Optional[bool] = True
     exclude_category: Optional[set[str]] = None
 
     @classmethod
-    def build_from_model(cls, datamodel) -> "TimeRangeAnalysisArgs":
+    def build_from_model(cls, datamodel: DmesgData) -> "TimeRangeAnalysisArgs":
+        """build analyzer args from data model
+
+        Args:
+            datamodel (DmesgDataModel): data model for plugin
+
+        Raises:
+            NotImplementedError: does not implement abstract function
+
+        Returns:
+            TimeRangeAnalysisArgs: instance of analyzer args class
+        """
         raise NotImplementedError("Dmesg does not support reference config creation")

nodescraper/plugins/inband/kernel/analyzer_args.py

@@ -26,6 +26,7 @@
 from pydantic import Field, field_validator
 
 from nodescraper.interfaces import AnalyzerArgs
+from nodescraper.plugins.inband.kernel.kerneldata import KernelDataModel
 
 
 class KernelAnalyzerArgs(AnalyzerArgs):
@@ -49,5 +50,13 @@ def validate_exp_kernel(cls, exp_kernel: str | list) -> list:
         return exp_kernel
 
     @classmethod
-    def build_from_model(cls, datamodel) -> "KernelAnalyzerArgs":
+    def build_from_model(cls, datamodel: KernelDataModel) -> "KernelAnalyzerArgs":
+        """build analyzer args from data model
+
+        Args:
+            datamodel (KernelDataModel): data model for plugin
+
+        Returns:
+            KernelAnalyzerArgs: instance of analyzer args class
+        """
         return cls(exp_kernel=datamodel.kernel_version)

nodescraper/plugins/inband/os/analyzer_args.py

@@ -26,6 +26,7 @@
 from pydantic import Field, field_validator
 
 from nodescraper.interfaces import AnalyzerArgs
+from nodescraper.plugins.inband.os.osdata import OsDataModel
 
 
 class OsAnalyzerArgs(AnalyzerArgs):
@@ -49,5 +50,13 @@ def validate_exp_os(cls, exp_os: str | list) -> list:
         return exp_os
 
     @classmethod
-    def build_from_model(cls, datamodel) -> "OsAnalyzerArgs":
+    def build_from_model(cls, datamodel: OsDataModel) -> "OsAnalyzerArgs":
+        """build analyzer args from data model
+
+        Args:
+            datamodel (OsDataModel): data model for plugin
+
+        Returns:
+            OsAnalyzerArgs: instance of analyzer args class
+        """
         return cls(exp_os=datamodel.os_version)

nodescraper/plugins/inband/package/analyzer_args.py

@@ -26,12 +26,13 @@
 from pydantic import Field
 
 from nodescraper.interfaces import AnalyzerArgs
+from nodescraper.plugins.inband.package.packagedata import PackageDataModel
 
 
 class PackageAnalyzerArgs(AnalyzerArgs):
     exp_package_ver: dict[str, str | None] = Field(default_factory=dict)
     regex_match: bool = True
 
     @classmethod
-    def build_from_model(cls, datamodel) -> "PackageAnalyzerArgs":
+    def build_from_model(cls, datamodel: PackageDataModel) -> "PackageAnalyzerArgs":
         return cls(exp_package_ver=datamodel.version_info)

nodescraper/plugins/inband/process/analyzer_args.py

@@ -25,12 +25,21 @@
 ###############################################################################
 
 from nodescraper.interfaces import AnalyzerArgs
+from nodescraper.plugins.inband.process.processdata import ProcessDataModel
 
 
 class ProcessAnalyzerArgs(AnalyzerArgs):
     max_kfd_processes: int = 0
     max_cpu_usage: float = 20.0
 
     @classmethod
-    def build_from_model(cls, datamodel) -> "ProcessAnalyzerArgs":
+    def build_from_model(cls, datamodel: ProcessDataModel) -> "ProcessAnalyzerArgs":
+        """build analyzer args from data model
+
+        Args:
+            datamodel (ProcessDataModel): data model for plugin
+
+        Returns:
+            ProcessAnalyzerArgs: instance of analyzer args class
+        """
         return cls(max_kfd_processes=datamodel.kfd_process, max_cpu_usage=datamodel.cpu_usage)

nodescraper/plugins/inband/rocm/analyzer_args.py

@@ -25,6 +25,8 @@
 ###############################################################################
 from pydantic import BaseModel, Field, field_validator
 
+from nodescraper.plugins.inband.rocm.rocmdata import RocmDataModel
+
 
 class RocmAnalyzerArgs(BaseModel):
     exp_rocm: str | list = Field(default_factory=list)
@@ -46,5 +48,13 @@ def validate_exp_rocm(cls, exp_rocm: str | list) -> list:
         return exp_rocm
 
     @classmethod
-    def build_from_model(cls, datamodel) -> "RocmAnalyzerArgs":
+    def build_from_model(cls, datamodel: RocmDataModel) -> "RocmAnalyzerArgs":
+        """build analyzer args from data model
+
+        Args:
+            datamodel (RocmDataModel): data model for plugin
+
+        Returns:
+            RocmAnalyzerArgs: instance of analyzer args class
+        """
         return cls(exp_rocm=datamodel.rocm_version)