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

device_table

Lit show version sur chaque équipement d'un inventaire, quatre à la fois, et affiche le modèle, la version et la durée de fonctionnement.

Lit les équipements de devices.csv, ouvre une session en lecture seule vers chacun (quatre à la fois), et exécute show version. La réponse est lue comme un tableau avec .table(), et le programme affiche une ligne par équipement : modèle, version du logiciel, temps de fonctionnement en jours, et une note quand un équipement a redémarré dans la dernière journée.

Exécutez-le sur les sorties enregistrées dans saved, sans équipement :

bogo run --replay saved device_table.bogo
bogo test device_table.bogo

Pour l'utiliser sur votre propre réseau :

  • Mettez vos équipements dans devices.csv : les colonnes name et ip sont nécessaires, platform, role et site sont facultatives. Ou donnez un autre fichier : bogo run device_table.bogo my_devices.csv.
  • Enregistrez des identifiants une fois avec bogo login default.
  • Exécutez-le sans --replay : il se connecte alors vraiment à chaque équipement par SSH.
  • bogo run --save-replay saved device_table.bogo garde les vraies sorties pour un rejeu ultérieur.
device_table.bogo
edition 2027
"""What runs where? Software version, model and uptime of every device in an inventory."""


class DeviceTable:
    """Reads devices.csv, asks each device for show version, and prints one table."""

    recent: Duration = 1d

    @staticmethod
    def number(text: str) -> int:
        return int(text) if text else 0

    @staticmethod
    def uptime(v: Row) -> Duration:
        """The uptime of one parsed show version line, as one Duration."""
        days: int = (
            365 * DeviceTable.number(v.uptime_years)
            + 7 * DeviceTable.number(v.uptime_weeks)
            + DeviceTable.number(v.uptime_days)
        )
        return (
            Duration(days, "d")
            + Duration(DeviceTable.number(v.uptime_hours), "h")
            + Duration(DeviceTable.number(v.uptime_minutes), "min")
        )

    @staticmethod
    def note(up: Duration, reason: str) -> str:
        """A word for the engineer when a device restarted lately."""
        return f"restarted lately ({reason})" if up < DeviceTable.recent else ""

    @staticmethod
    def main(args: list[str]) -> None:
        devices: list[Device] = inventory(args[0] if args else "devices.csv")
        rows: list[dict[str, object]] = []
        for d in devices parallel 4:
            with ssh(d) as s:
                v: Row = s.show("version").table()[0]
            up: Duration = DeviceTable.uptime(v)
            rows.append(
                {
                    "device": d.name,
                    "site": d.site,
                    "model": v.hardware,
                    "version": v.version,
                    "uptime": round(up.to("d"), 1),
                    "note": DeviceTable.note(up, v.reload_reason),
                }
            )
        rows.sort(key=lambda r: str(r["device"]))
        table(rows)
        print(
            f"\n{len(rows)} devices, {len({r['version'] for r in rows})} software versions. Uptime in days."
        )


class TestDeviceTable:
    def test_uptime_adds_every_part(self) -> None:
        v: Row = Row(
            {
                "uptime_years": "1",
                "uptime_weeks": "2",
                "uptime_days": "3",
                "uptime_hours": "12",
                "uptime_minutes": "0",
            }
        )
        assert DeviceTable.uptime(v).to("d") == 365 + 14 + 3 + 0.5

    def test_missing_parts_count_as_zero(self) -> None:
        v: Row = Row(
            {
                "uptime_years": "",
                "uptime_weeks": "",
                "uptime_days": "",
                "uptime_hours": "6",
                "uptime_minutes": "30",
            }
        )
        assert DeviceTable.uptime(v).to("min") == 390

    def test_note_only_after_a_recent_restart(self) -> None:
        assert DeviceTable.note(6h, "PowerOn") == "restarted lately (PowerOn)"
        assert DeviceTable.note(3d, "PowerOn") == ""