Aller au contenu

La version 0.1.0 est une première version, à l'essai. Voir ce qui n'est pas prouvé →

bogolang
EN

← Exemples

snapshot_compare

Prend des instantanés avant une maintenance et montre ce qui a bougé après.

Prend un instantané de chaque équipement (routes, voisins CDP, interfaces, configuration) avant une maintenance et l'enregistre dans le dossier before. Après les travaux, il prend de nouveaux instantanés et affiche ce qui a bougé sur chaque équipement, puis un tableau récapitulatif. Les temps de fonctionnement et les temps de maintien ne sont pas comptés comme des changements.

Les deux moments demandent deux jeux de réponses, donc il y a deux dossiers de rejeu : saved_before contient les réponses d'avant les travaux, saved les réponses d'après. Le dossier before contient déjà les instantanés pris à partir de saved_before, donc la deuxième commande fonctionne seule.

bogo run --replay saved_before snapshot_compare.bogo before
bogo run --replay saved snapshot_compare.bogo
bogo test snapshot_compare.bogo

Pour l'utiliser sur votre propre réseau :

  • Listez vos équipements dans devices.csv (name, ip, platform).
  • Avant les travaux, lancez bogo run snapshot_compare.bogo before. Après, lancez bogo run snapshot_compare.bogo.
  • Sans --replay, il se connecte vraiment à chaque équipement par SSH, avec les identifiants enregistrés par bogo login. Les sessions sont en lecture seule.
  • Un fichier d'instantané contient la configuration de l'équipement. Gardez-le avec autant de soin qu'une sauvegarde.
snapshot_compare.bogo
edition 2027
"""Snapshots of the devices before a maintenance, and what moved after it."""

from pathlib import Path


class SnapshotCompare:
    """Run with the word "before" ahead of the work: it saves one snapshot file per device
    in the folder before. Run with no word after the work: it takes new snapshots,
    compares them with the saved ones and prints what moved."""

    folder: str = "before"

    @staticmethod
    def file_of(d: Device) -> str:
        return f"{SnapshotCompare.folder}/{d.name}.json"

    @staticmethod
    def counts(c: SnapshotDiff) -> dict[str, str]:
        """One line of the summary table: what was added (+), removed (-) or changed (~)."""
        return {
            "routes": f"+{len(c.routes_added)} -{len(c.routes_removed)}",
            "neighbours": f"+{len(c.neighbors_added)} -{len(c.neighbors_removed)}",
            "interfaces": f"+{len(c.interfaces_added)} -{len(c.interfaces_removed)} ~{len(c.interfaces_changed)}",
            "config lines": f"+{len(c.config.added)} -{len(c.config.removed)}",
            "result": "CHANGED" if c else "same",
        }

    @staticmethod
    def main(args: list[str]) -> None:
        devices: list[Device] = inventory("devices.csv")
        if args == ["before"]:
            Path(SnapshotCompare.folder).mkdir(exist_ok=True)
            for d in devices:
                s: Snapshot = snapshot(d)
                s.save(SnapshotCompare.file_of(d))
                print(f"saved {SnapshotCompare.file_of(d)}: {s}")
            return

        rows: list[dict[str, str]] = []
        for d in devices:
            before: Snapshot = load_snapshot(SnapshotCompare.file_of(d))
            change: SnapshotDiff = compare(before, snapshot(d))
            print(f"== {d.name}, against the snapshot of {before.taken}")
            print(change)
            print()
            rows.append({"device": d.name, **SnapshotCompare.counts(change)})
        table(rows)


class TestSnapshotCompare:
    def snap(self, routes: list[Row], config: str) -> Snapshot:
        d: Device = Device(name="r1", ip=192.0.2.1, platform="iosxe")
        return Snapshot("r1", "iosxe", now(), routes, [], [], Config(d, config, ""))

    def route(self, network: str) -> Row:
        return Row(
            {
                "protocol": "C",
                "network": network,
                "prefix_length": "26",
                "nexthop_ip": "",
                "nexthop_if": "GigabitEthernet0/0/2",
            }
        )

    def test_a_new_route_and_line_are_counted(self) -> None:
        a: Snapshot = self.snap([], "hostname r1\n")
        b: Snapshot = self.snap(
            [self.route("192.0.2.64")], "hostname r1\nntp server 198.51.100.41\n"
        )
        got: dict[str, str] = SnapshotCompare.counts(compare(a, b))
        assert got["routes"] == "+1 -0"
        assert got["config lines"] == "+1 -0"
        assert got["result"] == "CHANGED"

    def test_nothing_moved_is_same(self) -> None:
        a: Snapshot = self.snap([self.route("192.0.2.0")], "hostname r1\n")
        got: dict[str, str] = SnapshotCompare.counts(compare(a, a))
        assert got["result"] == "same"
        assert str(compare(a, a)) == "No difference."