Merge pull request #9050 from LabNConsulting/chopps/reset-parallel

Chopps/reset parallel

tests/topotests/lib/common_config.py

@@ -22,18 +22,16 @@ from collections import OrderedDict
 from datetime import datetime, timedelta
 from time import sleep
 from copy import deepcopy
-from subprocess import call
-from subprocess import STDOUT as SUB_STDOUT
-from subprocess import PIPE as SUB_PIPE
-from subprocess import Popen
 from functools import wraps
 from re import search as re_search
 from tempfile import mkdtemp
 
+import json
 import os
 import sys
 import traceback
 import socket
+import subprocess
 import ipaddress
 import platform
 
@@ -235,14 +233,12 @@ def run_frr_cmd(rnode, cmd, isjson=False):
 
         if True:
             if isjson:
-                logger.debug(ret_data)
+                print_data = json.dumps(ret_data)
-                print_data = rnode.vtysh_cmd(cmd.rstrip("json"), isjson=False)
             else:
                 print_data = ret_data
-
             logger.info(
-                "Output for command [ %s] on router %s:\n%s",
+                "Output for command [%s] on router %s:\n%s",
-                cmd.rstrip("json"),
+                cmd,
                 rnode.name,
                 print_data,
             )
@@ -470,83 +466,114 @@ def reset_config_on_routers(tgen, routerName=None):
 
     logger.debug("Entering API: reset_config_on_routers")
 
+    # Trim the router list if needed
     router_list = tgen.routers()
-    for rname in ROUTER_LIST:
+    if routerName:
-        if routerName and routerName != rname:
+        if ((routerName not in ROUTER_LIST) or (routerName not in router_list)):
-            continue
+            logger.debug("Exiting API: reset_config_on_routers: no routers")
+            return True
+        router_list = { routerName: router_list[routerName] }
 
-        router = router_list[rname]
+    delta_fmt = TMPDIR + "/{}/delta.conf"
-        logger.info("Configuring router %s to initial test configuration", rname)
+    init_cfg_fmt = TMPDIR + "/{}/frr_json_initial.conf"
+    run_cfg_fmt = TMPDIR + "/{}/frr.sav"
 
-        cfg = router.run("vtysh -c 'show running'")
+    #
-        fname = "{}/{}/frr.sav".format(TMPDIR, rname)
+    # Get all running configs in parallel
-        dname = "{}/{}/delta.conf".format(TMPDIR, rname)
+    #
-        f = open(fname, "w")
+    procs = {}
-        for line in cfg.split("\n"):
+    for rname in router_list:
-            line = line.strip()
+        logger.info("Fetching running config for router %s", rname)
-
+        procs[rname] = router_list[rname].popen(
-            if (
+            ["/usr/bin/env", "vtysh", "-c", "show running-config no-header"],
-                line == "Building configuration..."
+            stdin=None,
-                or line == "Current configuration:"
+            stdout=open(run_cfg_fmt.format(rname), "w"),
-                or not line
+            stderr=subprocess.PIPE,
-            ):
-                continue
-            f.write(line)
-            f.write("\n")
-
-        f.close()
-        run_cfg_file = "{}/{}/frr.sav".format(TMPDIR, rname)
-        init_cfg_file = "{}/{}/frr_json_initial.conf".format(TMPDIR, rname)
-        command = "/usr/lib/frr/frr-reload.py --test --test-reset --input {} {} > {}".format(
-            run_cfg_file, init_cfg_file, dname
         )
-        result = call(command, shell=True, stderr=SUB_STDOUT, stdout=SUB_PIPE)
+    for rname, p in procs.items():
+        _, error = p.communicate()
+        if p.returncode:
+            logger.error("Get running config for %s failed %d: %s", rname, p.returncode, error)
+            raise InvalidCLIError("vtysh show running error on {}: {}".format(rname, error))
 
-        # Assert if command fail
+    #
-        if result > 0:
+    # Get all delta's in parallel
-            logger.error("Delta file creation failed. Command executed %s", command)
+    #
-            with open(run_cfg_file, "r") as fd:
+    procs = {}
-                logger.info(
+    for rname in router_list:
-                    "Running configuration saved in %s is:\n%s", run_cfg_file, fd.read()
+        logger.info("Generating delta for router %s to new configuration", rname)
+        procs[rname] = subprocess.Popen(
+            [ "/usr/lib/frr/frr-reload.py",
+              "--test-reset",
+              "--input",
+              run_cfg_fmt.format(rname),
+              "--test",
+              init_cfg_fmt.format(rname) ],
+            stdin=None,
+            stdout=open(delta_fmt.format(rname), "w"),
+            stderr=subprocess.PIPE,
+        )
+    for rname, p in procs.items():
+        _, error = p.communicate()
+        if p.returncode:
+            logger.error("Delta file creation for %s failed %d: %s", rname, p.returncode, error)
+            raise InvalidCLIError("frr-reload error for {}: {}".format(rname, error))
+
+    #
+    # Apply all the deltas in parallel
+    #
+    procs = {}
+    for rname in router_list:
+        logger.info("Applying delta config on router %s", rname)
+
+        procs[rname] = router_list[rname].popen(
+            ["/usr/bin/env", "vtysh", "-f", delta_fmt.format(rname)],
+            stdin=None,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.STDOUT,
+        )
+    for rname, p in procs.items():
+        output, _ = p.communicate()
+        vtysh_command = "vtysh -f {}".format(delta_fmt.format(rname))
+        if not p.returncode:
+            router_list[rname].logger.info(
+                '\nvtysh config apply => "{}"\nvtysh output <= "{}"'.format(vtysh_command, output)
+            )
+        else:
+            router_list[rname].logger.error(
+                '\nvtysh config apply => "{}"\nvtysh output <= "{}"'.format(vtysh_command, output)
+            )
+            logger.error("Delta file apply for %s failed %d: %s", rname, p.returncode, output)
+
+            # We really need to enable this failure; however, currently frr-reload.py
+            # producing invalid "no" commands as it just preprends "no", but some of the
+            # command forms lack matching values (e.g., final values). Until frr-reload
+            # is fixed to handle this (or all the CLI no forms are adjusted) we can't
+            # fail tests.
+            # raise InvalidCLIError("frr-reload error for {}: {}".format(rname, output))
+
+    #
+    # Optionally log all new running config if "show_router_config" is defined in
+    # "pytest.ini"
+    #
+    if show_router_config:
+        procs = {}
+        for rname in router_list:
+            logger.info("Fetching running config for router %s", rname)
+            procs[rname] = router_list[rname].popen(
+                ["/usr/bin/env", "vtysh", "-c", "show running-config no-header"],
+                stdin=None,
+                stdout=subprocess.PIPE,
+                stderr=subprocess.STDOUT,
+            )
+        for rname, p in procs.items():
+            output, _ = p.communicate()
+            if p.returncode:
+                logger.warning(
+                    "Get running config for %s failed %d: %s", rname, p.returncode, output
                 )
-            with open(init_cfg_file, "r") as fd:
+            else:
-                logger.info(
+                logger.info("Configuration on router {} after reset:\n{}".format(rname, output))
-                    "Test configuration saved in %s is:\n%s", init_cfg_file, fd.read()
-                )
-
-            err_cmd = ["/usr/bin/vtysh", "-m", "-f", run_cfg_file]
-            result = Popen(err_cmd, stdout=SUB_PIPE, stderr=SUB_PIPE)
-            output = result.communicate()
-            for out_data in output:
-                temp_data = out_data.decode("utf-8").lower()
-                for out_err in ERROR_LIST:
-                    if out_err.lower() in temp_data:
-                        logger.error(
-                            "Found errors while validating data in" " %s", run_cfg_file
-                        )
-                        raise InvalidCLIError(out_data)
-            raise InvalidCLIError("Unknown error in %s", output)
-
-        delta = StringIO()
-        with open(dname, "r") as f:
-            delta.write(f.read())
-
-        output = router.vtysh_multicmd(delta.getvalue(), pretty_output=False)
-
-        delta.close()
-        delta = StringIO()
-        cfg = router.run("vtysh -c 'show running'")
-        for line in cfg.split("\n"):
-            line = line.strip()
-            delta.write(line)
-            delta.write("\n")
-
-        # Router current configuration to log file or console if
-        # "show_router_config" is defined in "pytest.ini"
-        if show_router_config:
-            logger.info("Configuration on router {} after reset:".format(rname))
-            logger.info(delta.getvalue())
-        delta.close()
 
     logger.debug("Exiting API: reset_config_on_routers")
     return True
@@ -707,8 +734,8 @@ def generate_support_bundle():
         bundle_procs[rname] = tgen.net[rname].popen(
             "/usr/lib/frr/generate_support_bundle.py",
             stdin=None,
-            stdout=SUB_PIPE,
+            stdout=subprocess.PIPE,
-            stderr=SUB_PIPE,
+            stderr=subprocess.PIPE,
         )
 
     for rname, rnode in router_list.items():

tests/topotests/lib/topogen.py

@@ -471,6 +471,12 @@ class TopoGear(object):
         """
         return self.tgen.net[self.name].cmd(command)
 
+    def popen(self, *params, **kwargs):
+        """
+        Popen on the router.
+        """
+        return self.tgen.net[self.name].popen(*params, **kwargs)
+
     def add_link(self, node, myif=None, nodeif=None):
         """
         Creates a link (connection) between myself and the specified node.