Merge pull request vrnetlab#133 from ssasso/aoscx

Support for ArubaOS CX

aoscx/Makefile

@@ -0,0 +1,11 @@
+VENDOR=Aruba
+NAME=ArubaOS-CX
+IMAGE_FORMAT=vmdk
+IMAGE_GLOB=*.vmdk
+
+# match versions like:
+# arubaoscx-disk-image-genericx86-p4-20230531220439.vmdk
+VERSION=$(shell echo $(IMAGE) | sed -rn 's/.*arubaoscx-disk-image-genericx86-p4-(.+)\.vmdk/\1/p')
+
+-include ../makefile-sanity.include
+-include ../makefile.include

aoscx/README.md

@@ -0,0 +1,19 @@
+# vrnetlab / ArubaOS-CX (aoscx)
+
+This is the vrnetlab docker image for ArubaOS-CX.
+
+## Building the docker image
+Download the OVA image from [Aruba Support Portal](https://asp.arubanetworks.com/downloads/software/RmlsZTpkOGRiYjc2Ni0wMTdkLTExZWUtYTY3Yi00Zjg4YjUyOWExMzQ%3D), and extract the vmdk file from it.
+Copy the vmdk image into this folder, then run `make docker-image`.
+
+Tested booting and responding to SSH:
+ * `ArubaOS-CX_10_12_0006.ova` (`arubaoscx-disk-image-genericx86-p4-20230531220439.vmdk`)
+
+
+## System requirements
+CPU: 2 core
+
+RAM: 4GB
+
+Disk: <1GB
+

aoscx/docker/Dockerfile

@@ -0,0 +1,30 @@
+FROM debian:bullseye
+MAINTAINER Stefano Sasso <stesasso@gmail.com>
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update -qy \
+ && apt-get upgrade -qy \
+ && apt-get install -y \
+    bridge-utils \
+    iproute2 \
+    python3-ipy \
+    socat \
+    tcpdump \
+    ssh \
+    inetutils-ping \
+    dnsutils \
+    iptables \
+    telnet \
+    ftp \
+    qemu-system-x86=1:5.2+dfsg-11+deb11u2 \
+    qemu-utils=1:5.2+dfsg-11+deb11u2 \
+ && rm -rf /var/lib/apt/lists/*
+
+ARG IMAGE
+COPY $IMAGE* /
+COPY *.py /
+
+EXPOSE 22 80 161/udp 443 830 5000 5678 8291 10000-10099
+HEALTHCHECK CMD ["/healthcheck.py"]
+ENTRYPOINT ["/launch.py"]

aoscx/docker/launch.py

@@ -0,0 +1,190 @@
+#!/usr/bin/env python3
+
+import datetime
+import logging
+import os
+import re
+import signal
+import sys
+import time
+
+import vrnetlab
+
+STARTUP_CONFIG_FILE = "/config/startup-config.cfg"
+
+def handle_SIGCHLD(signal, frame):
+    os.waitpid(-1, os.WNOHANG)
+
+
+def handle_SIGTERM(signal, frame):
+    sys.exit(0)
+
+
+signal.signal(signal.SIGINT, handle_SIGTERM)
+signal.signal(signal.SIGTERM, handle_SIGTERM)
+signal.signal(signal.SIGCHLD, handle_SIGCHLD)
+
+TRACE_LEVEL_NUM = 9
+logging.addLevelName(TRACE_LEVEL_NUM, "TRACE")
+
+
+def trace(self, message, *args, **kws):
+    # Yes, logger takes its '*args' as 'args'.
+    if self.isEnabledFor(TRACE_LEVEL_NUM):
+        self._log(TRACE_LEVEL_NUM, message, args, **kws)
+
+
+logging.Logger.trace = trace
+
+
+class AOSCX_vm(vrnetlab.VM):
+    def __init__(self, hostname, username, password, conn_mode):
+        disk_image = ""
+        for e in os.listdir("/"):
+            if re.search(".vmdk$", e):
+                disk_image = "/" + e
+        if disk_image == "":
+            logging.getLogger().info("Disk image was not found")
+            exit(1)
+        super(AOSCX_vm, self).__init__(
+            username, password, disk_image=disk_image, ram=4096
+        )
+        self.hostname = hostname
+        self.conn_mode = conn_mode
+        self.num_nics = 20
+        self.nic_type = "virtio-net-pci"
+        self.qemu_args.extend(["-cpu", "host,level=9"])
+        self.qemu_args.extend(["-smp", "2"])
+
+    def bootstrap_spin(self):
+        """This function should be called periodically to do work."""
+
+        if self.spins > 300:
+            # too many spins with no result ->  give up
+            self.logger.info("To many spins with no result, restarting")
+            self.stop()
+            self.start()
+            return
+
+        (ridx, match, res) = self.tn.expect([b"switch login:"], 1)
+        if match:  # got a match!
+            if ridx == 0:  # login
+                self.logger.debug("trying to log in with 'admin'")
+                self.wait_write("\r", wait=None)
+                self.logger.debug("sent newline")
+                self.wait_write("admin", wait="switch login:")
+                self.logger.debug("sent username")
+                self.wait_write("\r", wait="Password:")
+                self.logger.debug("sent empty password")
+                self.logger.debug("resetting password")
+                self.wait_write("admin", wait="Enter new password:")
+                self.wait_write("admin", wait="Confirm new password:")
+
+                # run main config!
+                self.bootstrap_config()
+                self.startup_config()
+                # close telnet connection
+                self.tn.close()
+                # startup time?
+                startup_time = datetime.datetime.now() - self.start_time
+                self.logger.info("Startup complete in: %s" % startup_time)
+                # mark as running
+                self.running = True
+                return
+
+        # no match, if we saw some output from the router it's probably
+        # booting, so let's give it some more time
+        if res != b"":
+            self.logger.trace("OUTPUT: %s" % res.decode())
+            # reset spins if we saw some output
+            self.spins = 0
+
+        self.spins += 1
+
+        return
+
+    def bootstrap_config(self):
+        """Do the actual bootstrap config"""
+        self.logger.info("applying bootstrap configuration")
+        self.wait_write("", None)
+        self.wait_write("configure")
+        self.wait_write(
+            "user %s group administrators password plaintext %s"
+            % (self.username, self.password)
+        )
+
+        # configure mgmt interface
+        self.wait_write("interface mgmt")
+        self.wait_write("ip static 10.0.0.15/24")
+        self.wait_write("no shutdown")
+        self.wait_write("exit")
+        self.wait_write("ssh server vrf mgmt")
+        self.wait_write("https-server vrf mgmt")
+        self.wait_write("ntp vrf mgmt")
+
+        self.wait_write(f"hostname {self.hostname}")
+
+        self.wait_write("end")
+        self.wait_write("write memory")
+
+    def startup_config(self):
+        """Load additional config provided by user."""
+
+        if not os.path.exists(STARTUP_CONFIG_FILE):
+            self.logger.trace(f"Startup config file {STARTUP_CONFIG_FILE} is not found")
+            return
+
+        self.logger.trace(f"Startup config file {STARTUP_CONFIG_FILE} exists")
+        with open(STARTUP_CONFIG_FILE) as file:
+            config_lines = file.readlines()
+            config_lines = [line.rstrip() for line in config_lines]
+            self.logger.trace(f"Parsed startup config file {STARTUP_CONFIG_FILE}")
+
+        self.logger.info(f"Writing lines from {STARTUP_CONFIG_FILE}")
+
+        self.wait_write("configure")
+        # Apply lines from file
+        for line in config_lines:
+            self.wait_write(line)
+        # End and Save
+        self.wait_write("end")
+        self.wait_write("write memory")
+
+
+class AOSCX(vrnetlab.VR):
+    def __init__(self, hostname, username, password, conn_mode):
+        super(AOSCX, self).__init__(username, password)
+        self.vms = [AOSCX_vm(hostname, username, password, conn_mode)]
+
+
+if __name__ == "__main__":
+    import argparse
+
+    parser = argparse.ArgumentParser(description="")
+    parser.add_argument(
+        "--trace", action="store_true", help="enable trace level logging"
+    )
+    parser.add_argument("--hostname", default="vr-aoscx", help="Router hostname")
+    parser.add_argument("--username", default="vrnetlab", help="Username")
+    parser.add_argument("--password", default="VR-netlab9", help="Password")
+    parser.add_argument(
+        "--connection-mode",
+        default="vrxcon",
+        help="Connection mode to use in the datapath",
+    )
+    args = parser.parse_args()
+
+    LOG_FORMAT = "%(asctime)s: %(module)-10s %(levelname)-8s %(message)s"
+    logging.basicConfig(format=LOG_FORMAT)
+    logger = logging.getLogger()
+
+    logger.setLevel(logging.DEBUG)
+    if args.trace:
+        logger.setLevel(1)
+
+    logger.debug(f"Environment variables: {os.environ}")
+    vrnetlab.boot_delay()
+
+    vr = AOSCX(args.hostname, args.username, args.password, args.connection_mode)
+    vr.start()
+