netmiko_cli first version

Author: ubaumann

README.md

@@ -0,0 +1,14 @@
+# Example Custom NETMIKO CLI test
+
+
+## Setup Project
+
+Example using `uv`:
+```bash
+uv init example-custom-netmiko-cli-test --lib --package -p python3.10
+uv add --dev ruff
+uv add --dev mypy
+uv add nuts
+```
+
+

pyproject.toml

@@ -7,8 +7,16 @@ authors = [
     { name = "Urs Baumann", email = "github@m.ubaumann.ch" }
 ]
 requires-python = ">=3.10"
-dependencies = []
+dependencies = [
+    "nuts>=3.4.0",
+]
 
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "mypy>=1.13.0",
+    "ruff>=0.7.1",
+]

src/example_custom_netmiko_cli_test/netmiko_cli.py

@@ -0,0 +1,64 @@
+"""Query CLI output of a device."""
+
+from typing import Callable, Dict, Any
+
+import pytest
+from nornir.core.task import MultiResult, Result
+from nornir_netmiko import netmiko_send_command
+
+from nuts.helpers.result import (
+    AbstractHostResultExtractor,
+    NutsResult,
+)
+from nuts.context import NornirNutsContext
+
+EXAMPLE = """
+- test_class: TestNetmikoCLI
+  test_module: example_custom_netmiko_cli_test.netmiko_cli
+  test_execution:
+    command_string: show call-home
+    use_timing: False
+  test_data:
+    - host: switch01
+      contains: "call home feature : disable"
+      not_contains: "enable"
+"""
+
+
+class CLIExtractor(AbstractHostResultExtractor):
+    def single_transform(self, single_result: MultiResult) -> Dict[str, Dict[str, Any]]:
+        cli_result = self._simple_extract(single_result)
+        return cli_result
+
+
+class CLIContext(NornirNutsContext):
+    def nuts_task(self) -> Callable[..., Result]:
+        return netmiko_send_command
+
+    def nuts_extractor(self) -> CLIExtractor:
+        return CLIExtractor(self)
+
+
+CONTEXT = CLIContext
+
+
+class TestNetmikoCLI:
+    @pytest.mark.nuts("contains")
+    def test_contains_in_result(
+        self, nuts_ctx, single_result: NutsResult, contains: Any
+    ) -> None:
+        cmd = nuts_ctx.nuts_parameters.get("test_execution", {}).get(
+            "command_string", None
+        )
+        result = single_result.result
+        assert contains in result, f"'{contains}' NOT found in '{cmd}' output"
+
+    @pytest.mark.nuts("not_contains")
+    def test_not_contains_in_result(
+        self, nuts_ctx, single_result: NutsResult, not_contains: Any
+    ) -> None:
+        cmd = nuts_ctx.nuts_parameters.get("test_execution", {}).get(
+            "command_string", None
+        )
+        result = single_result.result
+        assert not_contains in result, f"'{not_contains}' FOUND in '{cmd}' output"