refactor for to prepare for nornir3

Author: jtdub

netnir/core/tasks/config_plan.py

@@ -1,11 +1,10 @@
 from netnir.helpers.scaffold.command import CommandScaffold
-from netnir.core.template import CompileTemplate
+from netnir.plugins.template import template_file
 from netnir.plugins.netmiko import netmiko_send_commands
-from netnir.helpers import output_writer, TextColor
 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
 
 
 class ConfigPlan(CommandScaffold):
@@ -43,7 +42,7 @@ def parser(parser):
             required=False,
         )
 
-    def run(self, template_file="main.conf.j2"):
+    def run(self):
         """
         cli execution
 
@@ -52,31 +51,27 @@ 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
 
-        results = self.nr(
+        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,
@@ -86,6 +81,7 @@ def run(self, template_file="main.conf.j2"):
             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/ssh.py

@@ -44,13 +44,9 @@ def run(self):
                 name="SSH COMMAND EXECUTION",
             )
 
-        if isinstance(results, str):
-            results = [results]
+        if self.args.output:
+            output_writer(nornir_results=results, output_file=self.args.output)
 
-        for task in results:
-            if self.args.output:
-                output_writer(nornir_results=task, output_file=self.args.output)
-
-            print_result(task)
+        print_result(results)
 
         return results

netnir/core/template.py

@@ -169,3 +169,12 @@ def plugins_import(tasks: dict, subparsers: object):
         plugin.parser(cmdparser)
 
     return loaded_plugins
+
+
+def merge_two_dicts(x, y):
+    try:
+        z = x.copy()
+    except AttributeError:
+        z = dict(x)
+    z.update(y)
+    return z

netnir/helpers/__init__.py

@@ -1,2 +0,0 @@
-"""common helpers
-"""

netnir/helpers/common/__init__.py

@@ -1,5 +1,4 @@
 from netnir.constants import HIER_DIR
-from netnir.core.output import Output
 from nornir.core.task import Task, Result
 from hier_config import Host
 import logging
@@ -67,10 +66,8 @@ def hier_host(
         )
 
     host.load_remediation()
-
-    output = Output(host=task.host.name, output_file="remediation.conf")
-    output.write(
-        host.filter_remediation(include_tags=include_tags, exclude_tags=exclude_tags)
+    results = host.filter_remediation(
+        include_tags=include_tags, exclude_tags=exclude_tags
     )
 
-    return Result(host=task.host, result=output.read())
+    return Result(host=task.host, result=results)

netnir/plugins/hier.py

@@ -3,7 +3,7 @@
 from netnir.helpers import device_mapper
 
 
-def netmiko_send_commands(task: Task, commands: list()):
+def netmiko_send_commands(task: Task, commands: list()) -> Result:
     """send show commands to a device via netmiko
 
     :param task: nornir Task object
@@ -29,7 +29,7 @@ def netmiko_send_commands(task: Task, commands: list()):
     return Result(host=task.host, result=output)
 
 
-def netmiko_send_config(task: Task, commands: list()):
+def netmiko_send_config(task: Task, commands: list()) -> Result:
     """execute configuration changes on a device via netmiko
 
     :param task: nornir Task object

netnir/plugins/netmiko.py

@@ -0,0 +1,29 @@
+from nornir.core.task import Task, Result
+from netnir.helpers import merge_two_dicts
+from jinja2 import Environment, FileSystemLoader, StrictUndefined
+
+
+def template_file(
+    task: Task, template_file: str, jinja_filters: dict = {}, **kwargs: dict,
+) -> Result:
+    """compile a jinja2 template and write it to a file.
+
+    :param task: nornir task object
+    :param template_file: template file name
+    :param jinja_filters: jinja2 filters
+    :param kwargs: key/value pairs to render templates
+
+    :returns: nornir result object
+    """
+    template_path = task.host.data["template_path"]
+    env = Environment(
+        loader=FileSystemLoader(template_path),
+        undefined=StrictUndefined,
+        trim_blocks=True,
+    )
+    env.filters.update(jinja_filters)
+    template = env.get_template(template_file)
+    merged_dicts = merge_two_dicts(kwargs, task.host)
+    result = template.render(**merged_dicts)
+
+    return Result(host=task.host, result=result)

netnir/plugins/template.py

@@ -0,0 +1,4 @@
+hostname {{ name }}
+os {{ os }}
+bb_asn {{ bb_asn }}
+dc_asn {{ dc_asn }}