What is it?

Installation

python3 -m pip install kathara-lab-checker

How does it work?

python3 -m kathara_lab_checker --config<path-to-the-configuration-file> --labs<path-to-the-labs-directory>

Running the example

python3 -m kathara_lab_checker --config examples/palabra/correction.json --no-cache --labs examples/palabra/labs

Running on Docker

How to configure?

lab_inline:|  router1[0]="net12"  router2[0]="net12"  ...

{  "labs_path": "<path>", # path to the folder containing the network scenarios  "convergence_time": "<sec>", # second to wait for routing convergence in the network scenarios  "structure": "<path>", # path to a lab_conf file specifying the correct lab schema  "default_image": "<image_name>", # Kathara image to use as default image in the network scenarios  "test": {    "requiring_startup": [    "<device_name>" # Check the presence of startup files for the specified device    ],     "ip_mapping": {      "<device_name>": {        "<interface_name>>": "<ip/netmask>" # Check that the ip/netmask is configured on the interface of the device        "<interface_num>>": "<ip/netmask>" # Check that the ip/netmask is configured on the interface eth# of the device      },    },    "daemons": {      "<device_name>": [        "<daemon_name>", # check that the daemon is running on the device.>",        "!<daemon_name>, # check that the daemon is not running on the device.>"      ]    },    # checks that the expected routing table is equal to the the actual table of a device    "kernel_routes": {       "<device_name>": [        "<route>", # Check the presence of the route in the data-plane of the device        "[<route>, [<iface_name_1>, <iface_name_2>, <next_hop_1>]]" # Check the presence of the route in the data-plane of the device                                                      # And checks also that the nexthops are set on the correct interfaces      ]    },    "protocols": { # Checks on routing protocols      "bgpd": { # Specific checks for BGP        "neighbors": { # Check that a peering is up          "<device_name>": [            {"ip": <neighbour_ip>, "asn": <neighbor_asn>}, # Check that a peering is up between the device and                                                            # the specified neighbour ip          ],        },        "networks": {          "<device_name>": [            "<route>" # Check that the device announce the route in BGP          ],        },      },       "<protocol_name>": { # General protocol checks        "injections": { # Check injections into the protocol. Also valid for BGP          "<device_name>": [            "<protocol_name>", # Check that the protocol is injected in BGP by the device            "!<protocol_name>" # Check that the protocol is not injected in BGP by the device          ],        }      }    },    "applications": {      "dns": { # Checks on DNS        "authoritative": {          "<zone>": [            "<ip>" # Check that the authority for the zone is the specified ip           ],        },        "local_ns": {          "<local_ns_ip>": [            "<device_name>", # Check if the device has the local_ns_ip as local name server.          ]        },        "records": {  "A": { # The software can check for every type of DNS records"<dns_name>": ["<ip>" # Check if the dns_name is resolved to the ip]  }        }      }    },    "reachability": { # Check reachability between devices      "<device_name>": [        "<ip>", # Check if the device reaches the ip        "<dns_name>", # Check if the device reaches the dns_name      ],    },"custom_commands": { # Execute a command inside a device and checks the output"<device_name>": [{"command": "<command>", # Command to execute"regex_match": "<regex>", # Check if the output matches the regex"output": "<expected_output>", # Check if the output is the expected one"exit_code": <expected_exit_code> # Check if the command exit code is the expected one}]}  }}