Nuts is a network unit testing system that automates tests in the network similar to unit tests you might know from programming. The project uses SaltStack and napalm to communicate with network devices. Regular Salt minions are used for Linux devices. This project is currently under heavy construction and we can't guarantee you that this code works. But we do our best. If you have any questions, feature request or use cases please reach out to us at https://github.com/HSRNetwork/Nuts or https://networktocode.slack.com/

Documentation: http://nuts.readthedocs.io/

Vagrant Project: https://github.com/HSRNetwork/vagrant-nuts

The following Python versions are supported:

• Python 2.7
• Python 3.6

• Salt master

  Because nuts is fully based on saltstack you have to install and configure a salt master first. For the full installation guide head over to the installation guide.

• Salt api

  To use nuts you also need salt-api which enables nuts to connect to the salt master over Http. For the installation guide visit cherrypy documentation.

• Napalm salt

  To create a connection from the salt master to your network device of choice there's a fantastic library called NAPALM which got an integration into saltstack. For the installation guide head to napalm-salt repository.

The recommended way to install nuts is using pip:

$ sudo pip install -U nuts

This will automatically install the latest version from the Python Package Index.

Get code:

$ git clone https://github.com/HSRNetwork/Nuts.git
$ cd Nuts

Install:

$ sudo python setup.py install

usage: nuts.py [-h] [-v] [-m ITERATIONS] [-r RETRIES] [-c CONFIG] testfile

positional arguments:

testfile Start with a Testfile

optional arguments:

-h, --help	show this help message and exit
-v, --validate	Validates Testfile
-m ITERATIONS, --iterations ITERATIONS
	Changes the number of iterations that nuts waits for a result
-r RETRIES, --retries RETRIES
	Set the max retries for failed tests
-c CONFIG, --config CONFIG
	Config file formatted as YAML. Settings will be merged with ENVVARs

The structure of the testfile has to be compliant with the testschema found in the folder nuts/src/service/testSchema.yaml. An example could be:

- name: example_arp
  command: arp
  devices: cisco.csr.1000v
  parameter: [192.168.16.128]
  operator: '='
  expected: '00:0C:29:EA:D1:68'

Please note that the devices attribute gets directly passed to the salt master which determines the targeted minions with so called globbing. For more information what's globbing head to saltstack globbing. If multiple minions are targeted each of them has to satisify the expected value for the test to pass.

The following commands are currently available with napalm-salt if this command is available on your device is also dependent on the availability of der underlying functions of napalm:

• connectivity - checks the connectivity to a certain IP address with a simple ping. Takes the target IP address as a parameter
• traceroute - checks the connectivity to a certain IP address with a traceroute. Takes the target IP address as a parameter
• interfacestatus - checks if a specific interface is available. Takes the interface name as a parameter
• interfacespeed - checks the speed of a specific interface. Takes the interface name as a parameter
• arp - checks the mac address of a specific IP address. Takes the IP address as a parameter
• checkversion - checks the version of the device. Takes no parameter
• checkuser - checks which users are available on the device. Takes no parameter

For more information about the availability visit napalm docs.

The following commands are currently available for debian systems:

• connectivity
• traceroute
• dnscheck
• dhcpcheck
• webresponse
• portresponse

There are the following operators available:

• =
• <
• >
• not

There are a few more examples of test files available in the example folder.

You can use a YAML formatted configuration file and/or set environment variables Configuration options:

• NUTS_SALT_REST_API_URL
• NUTS_SALT_REST_API_USERNAME
• NUTS_SALT_REST_API_PASSWORD
• NUTS_SALT_REST_API_EAUTN
• NUTS_MAX_RETRIES
• NUTS_WAIT_ITERATIONS
• NUTS_LOG_FILE_LEVEL
• NUTS_LOG_CONSOLE_LEVEL
• NUTS_LOG_FOLDER

config.yml example:

NUTS_SALT_REST_API_URL: 'http://salt-master.lab:8000'
NUTS_SALT_REST_API_USERNAME: 'myUser'
NUTS_SALT_REST_API_PASSWORD: 'myPassword'
NUTS_SALT_REST_API_EAUTH: 'pam'