frr/tools/generate_support_bundle.py

#!/usr/bin/env python3
# SPDX-License-Identifier: GPL-2.0-or-later
#
# Copyright (c) 2021, LabN Consulting, L.L.C.
#

########################################################
### Python Script to generate the FRR support bundle ###
########################################################
import argparse
import logging
import os
import subprocess
import tempfile


def open_with_backup(path):
    if os.path.exists(path):
        print("Making backup of " + path)
        subprocess.check_call("mv {0} {0}.prev".format(path), shell=True)
    return open(path, "w")


def main():
    parser = argparse.ArgumentParser()
    parser.add_argument(
        "-c",
        "--config",
        default="/etc/frr/support_bundle_commands.conf",
        help="input config",
    )
    parser.add_argument(
        "-l", "--log-dir", default="/var/log/frr", help="directory for logfiles"
    )
    parser.add_argument(
        "-N", "--pathspace", help="Insert prefix into config & socket paths"
    )
    args = parser.parse_args()

    collecting = False  # file format has sentinels (seem superfluous)
    proc_cmds = {}
    proc = None
    temp = None

    # Collect all the commands for each daemon
    try:
        for line in open(args.config):
            line = line.rstrip()
            if len(line) == 0 or line[0] == "#":
                continue

            cmd_line = line.split(":")
            if cmd_line[0] == "PROC_NAME":
                proc = cmd_line[1]
                temp = tempfile.NamedTemporaryFile("w+")
                collecting = False
            elif cmd_line[0] == "CMD_LIST_START":
                collecting = True
            elif cmd_line[0] == "CMD_LIST_END":
                collecting = False
                temp.flush()
                proc_cmds[proc] = open(temp.name)
                temp.close()
            elif collecting:
                temp.write(line + "\n")
            else:
                print("Ignoring unexpected input " + line.rstrip())
    except IOError as error:
        logging.fatal("Cannot read config file: %s: %s", args.config, str(error))
        return

    # Spawn a vtysh to fetch each set of commands
    procs = []
    for proc in proc_cmds:
        if args.pathspace:
            ofn = os.path.join(args.log_dir, args.pathspace + "_" + proc + "_support_bundle.log")
            p = subprocess.Popen(
                ["/usr/bin/env", "vtysh", "-t", "-N", args.pathspace],
                stdin=proc_cmds[proc],
                stdout=open_with_backup(ofn),
                stderr=subprocess.STDOUT,
            )
        else:
            ofn = os.path.join(args.log_dir, proc + "_support_bundle.log")
            p = subprocess.Popen(
                ["/usr/bin/env", "vtysh", "-t"],
                stdin=proc_cmds[proc],
                stdout=open_with_backup(ofn),
                stderr=subprocess.STDOUT,
            )
        procs.append(p)

    for p in procs:
        p.wait()


if __name__ == "__main__":
    main()