added utest for cli function

Author: alexandraBara

nodescraper/cli/cli.py

@@ -25,11 +25,11 @@
 ###############################################################################
 import argparse
 import datetime
+import json
 import logging
 import os
 import platform
 import sys
-from pathlib import Path
 from typing import Optional
 
 from nodescraper.cli.constants import DEFAULT_CONFIG, META_VAR_MAP
@@ -376,10 +376,21 @@ def main(arg_input: Optional[list[str]] = None):
 
     try:
         results = plugin_executor.run_queue()
+
         if parsed_args.reference_config:
-            generate_reference_config(
-                results, plugin_reg, logger, path=Path.cwd() / "reference_config.json"
-            )
+            ref_config = generate_reference_config(results, plugin_reg, logger)
+            path = os.path.join(os.getcwd(), "reference_config.json")
+            try:
+                with open(path, "w") as f:
+                    json.dump(
+                        ref_config.model_dump(mode="json", exclude_none=True),
+                        f,
+                        indent=2,
+                    )
+                    logger.info("Reference config written to: %s", path)
+            except Exception as exp:
+                logger.error(exp)
+
         if any(result.status > ExecutionStatus.WARNING for result in results):
             sys.exit(1)
         else:

nodescraper/cli/helper.py

@@ -283,7 +283,7 @@ def log_system_info(log_path: str | None, system_info: SystemInfo, logger: loggi
             logger.error(exp)
 
 
-def generate_reference_config(results, plugin_reg, logger, path):
+def generate_reference_config(results, plugin_reg, logger):
     plugin_config = PluginConfig()
     plugins = {}
     for obj in results:
@@ -308,15 +308,4 @@ def generate_reference_config(results, plugin_reg, logger, path):
         plugins[obj.source]["analysis_args"] = args.model_dump(exclude_none=True)
     plugin_config.plugins = plugins
 
-    if not path:
-        path = os.path.join(os.getcwd(), "reference_config.json")
-    try:
-        with open(path, "w") as f:
-            json.dump(
-                plugin_config.model_dump(mode="json", exclude_none=True),
-                f,
-                indent=2,
-            )
-            logger.info("Reference config written to: %s", path)
-    except Exception as exp:
-        logger.error(exp)
+    return plugin_config

test/unit/framework/common/shared_utils.py

@@ -31,6 +31,7 @@
 from nodescraper.enums import ExecutionStatus
 from nodescraper.interfaces import ConnectionManager, PluginInterface
 from nodescraper.models import PluginResult, TaskResult
+from nodescraper.models.datamodel import DataModel
 
 
 class MockConnectionManager(ConnectionManager):
@@ -71,10 +72,19 @@ def disconnect(self):
 class TestModelArg(BaseModel):
     model_attr: int = 123
 
+    @classmethod
+    def build_from_model(cls, model):
+        return cls()
+
+
+class DummyDataModel(DataModel):
+    some_version: str = None
+
 
 class TestPluginA(PluginInterface[MockConnectionManager, None]):
 
     CONNECTION_TYPE = MockConnectionManager
+    ANALYZER_ARGS = TestModelArg
 
     def run(
         self,

test/unit/framework/test_analyzerargs.py

@@ -17,10 +17,10 @@ def test_build_from_model(dummy_data_model):
 
     a2 = MyArgs()
     dumped = a2.model_dump()  # noqa: F841
-    # assert "data_model" not in dumped
+    assert "data_model" not in dumped
 
     json_str = a2.model_dump_json()  # noqa: F841
-    # assert '"data_model"' not in json_str
+    assert '"data_model"' not in json_str
 
 
 def test_base_build_from_model_not_implemented():

test/unit/framework/test_cli.py

@@ -28,12 +28,16 @@
 import os
 
 import pytest
+from common.shared_utils import DummyDataModel
 from pydantic import BaseModel
 
 from nodescraper.cli import cli, inputargtypes
+from nodescraper.cli.helper import build_config
 from nodescraper.configregistry import ConfigRegistry
-from nodescraper.enums import SystemInteractionLevel, SystemLocation
-from nodescraper.models import PluginConfig, SystemInfo
+from nodescraper.enums import ExecutionStatus, SystemInteractionLevel, SystemLocation
+from nodescraper.models import PluginConfig, SystemInfo, TaskResult
+from nodescraper.models.datapluginresult import DataPluginResult
+from nodescraper.models.pluginresult import PluginResult
 
 
 def test_log_path_arg():
@@ -200,7 +204,7 @@ def test_get_plugin_configs():
 
 def test_config_builder(plugin_registry):
 
-    config = cli.build_config(
+    config = build_config(
         config_reg=ConfigRegistry(config_path=os.path.join(os.path.dirname(__file__), "fixtures")),
         plugin_reg=plugin_registry,
         logger=logging.getLogger(),
@@ -215,3 +219,27 @@ def test_config_builder(plugin_registry):
         },
         "ExamplePlugin": {},
     }
+
+
+def test_generate_reference_config(plugin_registry):
+    results = [
+        PluginResult(
+            status=ExecutionStatus.OK,
+            source="TestPluginA",
+            message="Plugin tasks completed successfully",
+            result_data=DataPluginResult(
+                system_data=DummyDataModel(some_version="M17"),
+                collection_result=TaskResult(
+                    status=ExecutionStatus.OK,
+                    message="BIOS: M17",
+                    task="BiosCollector",
+                    parent="TestPluginA",
+                    artifacts=[],
+                ),
+            ),
+        )
+    ]
+
+    ref_config = cli.generate_reference_config(results, plugin_registry, logging.getLogger())
+    dump = ref_config.dict()
+    assert dump["plugins"] == {"TestPluginA": {"analysis_args": {"model_attr": 123}}}