Merge pull request #20 from netdevops/nornir3

[WIP] nornir3 preparation

Author: jtdub

netnir/__init__.py

@@ -3,4 +3,4 @@
 netnir will create the default config and folders.
 """
 
-__version__ = "0.0.16"
+__version__ = "0.0.17"

netnir/cli.py

@@ -5,10 +5,6 @@
 import sys
 
 
-"""cli class to build and execute cli commands
-"""
-
-
 class Cli:
     """
     a class object used to setup the netnir cli.

netnir/core/__init__.py

@@ -1,2 +0,0 @@
-"""netnir core initialization
-"""

netnir/core/credentials.py

@@ -5,10 +5,6 @@
 import os
 
 
-"""credentials create/fetch/delete class
-"""
-
-
 class Credentials:
     """
     a class to do credentials administration.

netnir/core/inventory.py

@@ -3,9 +3,6 @@
 import yaml
 
 
-"""dynamic inventory builder class"""
-
-
 class NornirInventory(Inventory):
     """
     default inventory module to dynamically create inventory objects from host_vars and group_vars
@@ -21,7 +18,6 @@ def __init__(self, **kwargs):
         )
 
     def nhosts(self):
-        from netnir.helpers import device_mapper
         from netnir.core.credentials import Credentials
         from netnir.constants import (
             HOSTVARS,
@@ -47,7 +43,7 @@ def nhosts(self):
                 "username": host_vars.get("username", creds["username"]),
                 "password": host_vars.get("password", creds["password"]),
                 "port": host_vars.get("port", 22),
-                "platform": device_mapper(host_vars["os"]),
+                "platform": host_vars["os"],
                 "groups": host_vars.get("groups", list()),
                 "data": {
                     **host_vars,
@@ -61,18 +57,6 @@ def nhosts(self):
                     ),
                     "mgmt_protocol": host_vars.get("mgmt_protocol", "ssh"),
                 },
-                "connection_options": {
-                    "netconf": {
-                        "hostname": f"{host}.{domain}" if domain else host,
-                        "username": host_vars.get("username", creds["username"]),
-                        "password": host_vars.get("password", creds["password"]),
-                        "platform": device_mapper(
-                            os_type=host_vars["os"], proto="netconf"
-                        ),
-                        "port": host_vars.get("port", 830),
-                        "extras": {"hostkey_verify": False},
-                    },
-                },
             }
 
         return data

netnir/core/networking.py

@@ -2,10 +2,6 @@
 import os
 
 
-"""ouput read/write/delete class
-"""
-
-
 class Output:
     """
     a class for writing, reading, and deleting output data to/from a file

netnir/core/output.py

@@ -1 +0,0 @@
-"""built-in tasks initialization"""

netnir/core/tasks/__init__.py

@@ -1,15 +1,10 @@
 from netnir.helpers.scaffold.command import CommandScaffold
-from netnir.core.template import CompileTemplate
-from netnir.core.networking import Networking
-from netnir.helpers import output_writer, TextColor
+from netnir.plugins.template import template_file
+from netnir.plugins.netmiko import netmiko_send_commands
 from netnir.plugins.hier import hier_host
+from netnir.helpers import output_writer
 from netnir.constants import OUTPUT_DIR
 from nornir.plugins.functions.text import print_result
-import logging
-
-
-"""config plan cli commands
-"""
 
 
 class ConfigPlan(CommandScaffold):
@@ -47,7 +42,7 @@ def parser(parser):
             required=False,
         )
 
-    def run(self, template_file="main.conf.j2"):
+    def run(self):
         """
         cli execution
 
@@ -56,36 +51,37 @@ def run(self, template_file="main.conf.j2"):
         :returns: result string
         """
         self.nr = self._inventory()
-
-        for host in self.nr.inventory.hosts:
-            compiled_template = CompileTemplate(
-                nr=self.nr, host=host, template=template_file
-            )
-            output_writer(
-                nornir_results=compiled_template.render(), output_file="compiled.conf",
-            )
-            print_result(compiled_template.render())
+        results = self.nr.run(
+            task=template_file,
+            template_file="main.conf.j2",
+            output_file="compiled.conf",
+            name="COMPILE TEMPLATES",
+        )
+        output_writer(nornir_results=results, output_file="compiled.conf")
+        print_result(results)
 
         if self.args.compile:
-            if self.args.host:
-                return compiled_template.render()
-            message = TextColor.green("templates compiled for all hosts")
-            return logging.info(message)
+            return results
 
-        networking = Networking(nr=self.nr)
-        running_config = networking.fetch(commands="show running")
-        output_writer(nornir_results=running_config, output_file="running.conf")
-        print_result(running_config)
+        results = self.nr.run(
+            task=netmiko_send_commands,
+            commands="show running",
+            name="FETCH RUNNING CONFIG",
+        )
+        output_writer(nornir_results=results, output_file="running.conf")
+        print_result(results)
 
-        result = self.nr.run(
+        results = self.nr.run(
             task=hier_host,
             include_tags=self.args.include_tags,
             exclude_tags=self.args.exclude_tags,
             running_config="running.conf",
             compiled_config="compiled.conf",
             config_path=OUTPUT_DIR,
             load_file=True,
+            name="RENDER REMEDIATION CONFIG",
         )
+        output_writer(nornir_results=results, output_file="remediation.conf")
+        print_result(results)
 
-        print_result(result)
-        return result
+        return results

netnir/core/tasks/config_plan.py

@@ -1,10 +1,6 @@
 from netnir.helpers.scaffold.subcommand import SubCommandParser
 
 
-"""fetch subcommands initialization
-"""
-
-
 class Fetch(SubCommandParser):
     """
     fetch subcommand parser