pyateos 0.1.3

python framework to test operational status of an Arista network

pyATEOS

Deliberately inspired by pyATS and based on pyEAPI and jsodiff libraries, pyATEOS is a python framework for operational status test on Arista network. pyATS is based on SSH show command parsed via regex. Thanks to the powerful Arista API, every show command can be returned in JSON format skipping all the parse unstructured output pain. Ideally, a day pyATS will supprt Arista API as well.

HOW IT WORKS

A snapshot of the operational status of a switch is taken before a config or network change and compare against a second snapshot taken after the change. A diff file format is generated in .json format.

Diff example after removing a NTP server and add new one:

{
    "peers": {
[...]
        "insert": {
            "216.239.35.0": {
                "delay": 10.11,
                "jitter": 0.0,
                "lastReceived": 1582533810.0,
                "peerType": "unicast",
                "reachabilityHistory": [
                    true
                ],
                "condition": "reject",
                "offset": 160338.608,
                "peerIpAddr": "216.239.35.0",
                "pollInterval": 64,
                "refid": ".GOOG.",
                "stratumLevel": 1
            }
        },
        "delete": {
            "10.75.33.5": {
                "delay": 0.0,
                "jitter": 0.0,
                "lastReceived": 2085978496.0,
                "peerType": "unicast",
                "reachabilityHistory": [
                    false
                ],
                "condition": "reject",
                "offset": 0.0,
                "peerIpAddr": "10.75.33.5",
                "pollInterval": 1024,
                "refid": ".INIT.",
                "stratumLevel": 16
            }
        }
    }
}

Remember, this does not show a config change, instead it shows the difference of the operational status of the NTP servers. This means that you will see a diff in jitter or offset between 2 snapshots. Example:

{
    "peers": {
        "ns2.sys.cloudsys.tmcs": {
            "jitter": [
                6.36,
                3.826
            ],
            "lastReceived": [
                1582537393.0,
                1582537586.0
            ],
            "condition": [
                "candidate",
                "sys.peer"
            ]
        },
        "ns1.sys.cloudsys.tmcs": {
            "delay": [
                0.408,
                0.355
            ],
            "jitter": [
                5.075,
                6.241
            ],
            "lastReceived": [
                1582537405.0,
                1582537605.0
            ],
            "condition": [
                "sys.peer",
                "candidate"
            ],
            "offset": [
                5.477,
                -6.42
            ]
        }
    }
}

HOW TO RUN - IMPORT

>>> from pyateos import pyateos
>>> 
>>> my_dict = {
    'invetory': 'eos_invenotry.ini',
    'before': True,
    'after': False,
    'compare': False,
    'test': ['snmp'],
    'node': ['lf4'],
    'file_name': None
}
>>> 
>>> pyateos.pyateos(**my_dict)
>>> BEFORE file ID for NTP test: 1582619302
>>> 
>>> my_dict = {
    'invetory': 'eos_invenotry.ini',
    'before': False,
    'after': True,
    'compare': False,
    'test': ['snmp'],
    'node': ['lf4'],
    'file_name': None
}
>>> 
>>> pyateos.pyateos(**my_dict)
>>> AFTER file ID for NTP test: 1582619366
>>> 
>>> my_dict = {
    'invetory': 'eos_invenotry.ini',
    'before': False,
    'after': False,
    'compare': True,
    'test': ['snmp'],
    'node': ['lf4'],
    'file_name': [1582627863, 1582627909]
}
>>> 
>>> pyateos.pyateos(**my_dict)
>>> DIFF file ID for NTP test: 64

HOW TO RUN - CLI

An inventory must be defined as described in pyEAPI doc. A filesystem is automatically created at every code iteration (if required - idempotent). The fiename of before and after are in the follwing format timestamp_node_test.json. Diff filename is (after_timpestamp - before_timestamp)_node_test.json.

Arguments list:

usage: pyATEOS [-h] (-B | -A | -C) [-i INVENTORY] -n NODE [NODE ...] -t TEST
               [TEST ...] [-F FILE [FILE ...]]

pyATEOS - A simple python application for operational status test on Arista
device. Based on pyATS idea and pyeapi library for API calls.

optional arguments:
  -h, --help            show this help message and exit
  -B, --before          write json file containing the test result BEFORE. To
                        be run BEFORE the config change. File path example:
                        $PWD/before/ntp/router1_ntp.json
  -A, --after           write json file containing the test result AFTER. To
                        be run AFTER the config change. File path example:
                        $PWD/after/ip_route/router1_ip_route.json
  -C, --compare         diff between before and after test files. File path
                        example: $PWD/diff/snmp/router1_snmp.json
  -i INVENTORY, --inventory INVENTORY
                        specify pyeapi inventory file path
  -n NODE [NODE ...], --node NODE [NODE ...]
                        specify inventory node. Multiple values are accepted
                        separated by space
  -t TEST [TEST ...], --test TEST [TEST ...]
                        run one or more specific test. Multiple values are
                        accepted separated by space
  -F FILE [FILE ...], --file_name FILE [FILE ...]
                        provide the 2 filename IDs to compare, separated by
                        space. BEFORE first, AFTER second. i.e [..] -C -f
                        1582386835 1582387929

example - BEFORE a network config change for NTP server:

pyateos -i eos_inventory.ini -n lf4 -t mgmt -B
BEFORE file ID for NTP test: 1582537406
BEFORE file ID for SNMP test: 1582537409

ls -la before/ntp/
-rw-r--r--  1 federicoolivieri  staff   916 24 Feb 09:47 1582537406.json

example - AFTER a network config change for NTP server:

pyateos -i eos_inventory.ini -n lf4 -t mgmt -A
AFTER file ID for NTP test: 1582537612
AFTER file ID for SNMP test: 1582537614

ls -la after/ntp/
-rw-r--r--  1 federicoolivieri  staff  1246 24 Feb 10:43 1582537612.json

diff example of the aboves for NTP.

pyateos -i eos_inventory.ini -n lf4 -t ntp -C -F 1582537612 1582537406
DIFF file ID for NTP test: 6

ls -la diff/ntp/
-rw-r--r--  1 federicoolivieri  staff     2 24 Feb 10:43 6_ntp_lf4.json

Even thugh before and after test can be run using groups, every diff must be run for every test. More improovements will come (keep on eye to issue repo)

TEST SUPPORTED

All test supported are available under plugins folder. Those are:

acl
as_path
bgp_evpn
bgp_ipv4
interface
ip_route
mlag
ntp
prefix_list
route_map
snmp
stp
vlan
vrf
vxlan

Some of the test are grouped together like mgmt: ntp, snmp, routing: bgp_evpn, bgp_ipv4, ip_route, layer2: stp, vlan, vxlan, ctrl: acl, as_path, prefix_list, route_map and all running all test availables under plugins. New plugins can be easily created and added still, under plugins/ folder.