updated watchdog handling and nfcli commands

Author: dmulyalin

docs/norfab_changelog.md

@@ -1,3 +1,25 @@
+# 0.16.5
+
+## BUGS
+
+1. Fixing Nornir N2G diagram calling UUID handling
+
+## CHANGES
+
+1. Splitting Nornir parse task into 3 tasks `parse_ttp`, `parse_napalm`, `parse_textfsm`
+2. Enhancing nfcli shell `nornir parse` commands
+3. Watchdog thread now starts automatically for every worker, so far implemented RAM usage monitoring
+
+## FEATURES
+
+1. Nornir service nfcli added `nornir parse textfsm` command
+2. Nfcli - adding these commands:
+
+  - `show workers statistics`
+  - `show workers brief`
+
+---
+
 # 0.16.4
 
 ## BREAKING CHANGES

docs/workers/nornir/services_nornir_service_tasks_parse.md

@@ -36,7 +36,7 @@ def listen_events_thread(uuid, stop, NFCLIENT):
     start_time = time.time()
     time_fmt = "%d-%b-%Y %H:%M:%S.%f"
     richconsole.print(
-        "-" * 45 + " Job Events " + "-" * 47 + "\n"
+        "-" * 45 + " Job Events " + "-" * 47 + "\n\n"
         f"{datetime.now().strftime(time_fmt)[:-3]} {uuid} job started"
     )
     while not (stop.is_set() or NFCLIENT.exit_event.is_set()):
@@ -54,7 +54,7 @@ def listen_events_thread(uuid, stop, NFCLIENT):
             status,
             data,
         ) = event
-        if job_uuid != uuid.encode("utf-8"):
+        if not job_uuid.decode("utf-8").startswith(uuid):
             NFCLIENT.event_queue.put(event)
             continue
 

norfab/clients/shell_clients/common.py

@@ -247,13 +247,13 @@ class PicleConfig:
 
 class NrCliPlugins(BaseModel):
     netmiko: NrCliPluginNetmiko = Field(
-        None, description="Use Netmiko plugin to configure devices"
+        None, description="Use Netmiko plugin to collect output from devices"
     )
     scrapli: NrCliPluginScrapli = Field(
-        None, description="Use Scrapli plugin to configure devices"
+        None, description="Use Scrapli plugin to collect output from devices"
     )
     napalm: NrCliPluginNapalm = Field(
-        None, description="Use NAPALM plugin to configure devices"
+        None, description="Use NAPALM plugin to collect output from devices"
     )
 
 

norfab/clients/shell_clients/nornir/nornir_picle_shell_cli.py

@@ -286,7 +286,7 @@ def run(uuid, *args, **kwargs):
         workers = kwargs.pop("workers", "all")
         timeout = kwargs.pop("timeout", 600)
         _ = kwargs.pop("verbose_result", False)
-        nowait = kwargs.pop("nowait", False)
+        nowait = kwargs.pop("nowait")
         ctime = time.strftime("%Y-%m-%d_%H-%M-%S")
         FM = kwargs.pop("FM", [])
         n2g_data = {}  # to store collected from devices data
@@ -327,7 +327,7 @@ def run(uuid, *args, **kwargs):
         )
 
         # retrieve output on a per-platform basis
-        for platform in platforms:
+        for index, platform in enumerate(platforms):
             n2g_data.setdefault(platform, [])
             cli_kwargs = copy.deepcopy(kwargs)
             cli_kwargs["FM"] = [platform]
@@ -348,14 +348,11 @@ def run(uuid, *args, **kwargs):
                 "cli",
                 workers=workers,
                 kwargs=cli_kwargs,
-                uuid=uuid,
+                uuid=f"{uuid}-{index}",
                 timeout=timeout,
-                nowait=nowait,
+                nowait=False,
             )
 
-            if nowait:
-                return job_results, Outputters.outputter_nested
-
             # populate n2g data dictionary keyed by platform and save results to files
             for worker, results in job_results.items():
                 if results["failed"]:

norfab/clients/shell_clients/nornir/nornir_picle_shell_diagram.py

@@ -1,19 +1,28 @@
 import builtins
 from enum import Enum
-from typing import List, Union
+from typing import List, Union, Any
+
+try:
+    from ttp_templates import list_templates_refs, list_templates
+
+    HAS_TTP_TEMPLATES = True
+except Exception as e:
+    HAS_TTP_TEMPLATES = False
 
 from picle.models import Outputters, PipeFunctionsModel
-from pydantic import (
-    BaseModel,
-    Field,
-    StrictStr,
-)
+from pydantic import BaseModel, Field, StrictStr, StrictBool, model_validator
 
 from ..common import ClientRunJobArgs, listen_events, log_error_or_result
 from .nornir_picle_shell_common import (
     NorniHostsFilters,
     NornirCommonArgs,
 )
+from .nornir_picle_shell_cli import (
+    NrCliPluginNetmiko,
+    NrCliPluginScrapli,
+    NrCliPluginNapalm,
+)
+from norfab.workers.nornir_worker.parse_task import ParseTTPInput
 
 
 class NapalmGettersEnum(str, Enum):
@@ -49,7 +58,9 @@ class NapalmGettersEnum(str, Enum):
 
 
 class NapalmGettersModel(NorniHostsFilters, NornirCommonArgs, ClientRunJobArgs):
-    getters: NapalmGettersEnum = Field(..., description="Select NAPALM getters")
+    getters: Union[NapalmGettersEnum, List[NapalmGettersEnum]] = Field(
+        ..., description="Select NAPALM getters"
+    )
 
     @staticmethod
     @listen_events
@@ -62,10 +73,10 @@ def run(uuid, *args, **kwargs):
 
         result = NFCLIENT.run_job(
             "nornir",
-            "parse",
+            "parse_napalm",
             workers=workers,
             args=args,
-            kwargs={"plugin": "napalm", **kwargs},
+            kwargs=kwargs,
             uuid=uuid,
             timeout=timeout,
             nowait=nowait,
@@ -80,16 +91,119 @@ class PicleConfig:
         outputter = Outputters.outputter_nested
 
 
-class TTPParseModel(NorniHostsFilters, NornirCommonArgs, ClientRunJobArgs):
-    template: StrictStr = Field(
-        ..., description="TTP Template to parse commands output"
+class TTPStructureOptions(str, Enum):
+    list_ = "list"
+    dictionary = "dictionary"
+    flat_list = "flat_list"
+
+
+class TTPParseNrCliPluginNetmiko(NrCliPluginNetmiko):
+    @staticmethod
+    def run(*args, **kwargs):
+        kwargs["plugin"] = "netmiko"
+        return TTPParseModel.run(*args, **kwargs)
+
+
+class TTPParseNrCliPluginScrapli(NrCliPluginScrapli):
+    @staticmethod
+    def run(*args, **kwargs):
+        kwargs["plugin"] = "scrapli"
+        return TTPParseModel.run(*args, **kwargs)
+
+
+class TTPParseNrCliPluginNapalm(NrCliPluginNapalm):
+    @staticmethod
+    def run(*args, **kwargs):
+        kwargs["plugin"] = "napalm"
+        return TTPParseModel.run(*args, **kwargs)
+
+
+class TTPParseNrCliPlugins(BaseModel):
+    netmiko: TTPParseNrCliPluginNetmiko = Field(
+        None, description="Use Netmiko plugin to collect output from devices"
+    )
+    scrapli: TTPParseNrCliPluginScrapli = Field(
+        None, description="Use Scrapli plugin to collect output from devices"
+    )
+    napalm: TTPParseNrCliPluginNapalm = Field(
+        None, description="Use NAPALM plugin to collect output from devices"
+    )
+
+
+class TTPParseModel(
+    NorniHostsFilters, NornirCommonArgs, ClientRunJobArgs, ParseTTPInput
+):
+    commands: Union[StrictStr, List[StrictStr]] = Field(
+        None,
+        description="List of commands to collect form devices",
+        json_schema_extra={"multiline": True},
+    )
+    plugin: TTPParseNrCliPlugins = Field(
+        None, description="CLI connection plugin parameters"
     )
-    commands: Union[List[StrictStr], StrictStr] = Field(
-        None, description="Commands to collect form devices"
+    enable: StrictBool = Field(
+        None, description="Enter exec mode", json_schema_extra={"presence": True}
     )
+    strict: StrictBool = Field(
+        True,
+        description="Strict mode, raise error on empty results",
+        json_schema_extra={"presence": True},
+    )
+
+    @staticmethod
+    def source_template(choice):
+        if choice and choice.startswith("nf://"):
+            return ClientRunJobArgs.walk_norfab_files()
+        elif choice and choice.startswith("ttp://") and HAS_TTP_TEMPLATES:
+            return list_templates_refs()
+        else:
+            return ["nf://", "ttp://"]
 
     @staticmethod
-    def source_template():
+    def source_get():
+        if HAS_TTP_TEMPLATES:
+            return [t.replace(".txt", "") for t in list_templates()["get"]]
+        return []
+
+    @staticmethod
+    @listen_events
+    def run(uuid, *args, **kwargs):
+        NFCLIENT = builtins.NFCLIENT
+        workers = kwargs.pop("workers", "all")
+        timeout = kwargs.pop("timeout", 600)
+        verbose_result = kwargs.pop("verbose_result", False)
+        nowait = kwargs.pop("nowait", False)
+
+        result = NFCLIENT.run_job(
+            "nornir",
+            "parse_ttp",
+            workers=workers,
+            args=args,
+            kwargs=kwargs,
+            uuid=uuid,
+            timeout=timeout,
+            nowait=nowait,
+        )
+
+        if nowait:
+            return result, Outputters.outputter_nested
+
+        return log_error_or_result(result, verbose_result=verbose_result)
+
+    class PicleConfig:
+        outputter = Outputters.outputter_nested
+
+
+class TextFSMParseModel(NorniHostsFilters, NornirCommonArgs, ClientRunJobArgs):
+    template: StrictStr = Field(None, description="Path to a TextFSM template file")
+    commands: Union[StrictStr, List[StrictStr]] = Field(
+        None,
+        description="List of commands to parse form devices",
+        json_schema_extra={"multiline": True},
+    )
+
+    @staticmethod
+    def source_template(choice):
         return ClientRunJobArgs.walk_norfab_files()
 
     @staticmethod
@@ -103,10 +217,10 @@ def run(uuid, *args, **kwargs):
 
         result = NFCLIENT.run_job(
             "nornir",
-            "parse",
+            "parse_textfsm",
             workers=workers,
             args=args,
-            kwargs={"plugin": "ttp", **kwargs},
+            kwargs=kwargs,
             uuid=uuid,
             timeout=timeout,
             nowait=nowait,
@@ -128,6 +242,9 @@ class NornirParseShell(BaseModel):
     ttp: TTPParseModel = Field(
         None, description="Parse devices output using TTP templates"
     )
+    textfsm: TextFSMParseModel = Field(
+        None, description="Parse devices output using TextFSM templates"
+    )
 
     class PicleConfig:
         subshell = True