Add Honeycomb interface management tests (ipv4, ipv6, ethernet, routing)

 - add test cases for managing ipv4, ipv6, ethernet and routing
 configuration on VPP interface
 - add keywords used in these tests to set and verify configuration
 - add method and vat template for dumping an interface's
configured IP addresses
 - add method for converting between ipv4 netmasks and
   network prefixes
 - clean up documentation of older Honeycomb keywords

Note: Test cases are tagged with a placeholder tag to allow manual
test runs locally. It should be replaced with the appropriate
environment tags once Honeycomb service is deployed on virl.

Change-Id: I99ce1e72c8550f520f8c35ef4a93eaebb530db78
Signed-off-by: selias <samelias@cisco.com>
Signed-off-by: Matej Klotton <mklotton@cisco.com>

2 files changed, 281 insertions, 33 deletions

diff --git a/resources/libraries/robot/honeycomb/honeycomb.robot b/resources/libraries/robot/honeycomb/honeycomb.robot
index 741807877d..54aff2febf 100644
--- a/resources/libraries/robot/honeycomb/honeycomb.robot
+++ b/resources/libraries/robot/honeycomb/honeycomb.robot
@@ -18,7 +18,7 @@
 
 *** Keywords ***
 | Setup Honeycomb service on DUTs
-| | [Documentation] | *Setup environment for honeycomb testing*
+| | [Documentation] | *Setup environment for honeycomb testing.*
 | | ...
 | | ... | _Setup steps:_
 | | ... | - 1. Login to each honeycomb node using ssh
@@ -28,10 +28,12 @@
 | | ... | connection refused -> 404 -> 401 -> 503 or 500 -> 200 (pass)
 | | ... | - 4. Configure honeycomb nodes using HTTP PUT request
 | | ...
+| | ... | _Arguments:_
+| | ... | - ${duts} - list of nodes to setup Honeycomb on
+| | ...
 | | ... | _Used global constants and variables:_
 | | ... | - RESOURCES_TPL_HC - path to honeycomb templates directory
 | | ... | - HTTPCodes - HTTP protocol status codes
-| | ... | - ${nodes} - dictionary of all nodes in topology.YAML file
 | | ...
 | | [Arguments] | @{duts}
 | | Start honeycomb on DUTs | @{duts}
@@ -39,7 +41,7 @@
 | | ... | Check honeycomb startup state | @{duts}
 
 | Stop honeycomb service on DUTs
-| | [Documentation] | *Cleanup environment after honeycomb testing*
+| | [Documentation] | *Cleanup environment after honeycomb testing.*
 | | ...
 | | ... | _Teardown steps:_
 | | ... | - 1. Login to each honeycomb node using ssh
@@ -48,10 +50,12 @@
 | | ... | Expected sequence of HTTP replies:
 | | ... | 200 -> 404 -> connection refused (pass)
 | | ...
+| | ... | _Arguments:_
+| | ... | - ${duts} - list of nodes to stop Honeycomb on
+| | ...
 | | ... | _Used global constants and variables:_
 | | ... | - RESOURCES_TPL_HC - path to honeycomb templates directory
 | | ... | - HTTPCodes - HTTP protocol status codes
-| | ... | - ${nodes} - dictionary of all nodes in topology.YAML file
 | | ...
 | | [Arguments] | @{duts}
 | | Stop honeycomb on DUTs | @{duts}
diff --git a/resources/libraries/robot/honeycomb/interfaces.robot b/resources/libraries/robot/honeycomb/interfaces.robot
index 338c3cfc24..0768fd3021 100644
--- a/resources/libraries/robot/honeycomb/interfaces.robot
+++ b/resources/libraries/robot/honeycomb/interfaces.robot
@@ -14,63 +14,307 @@
 *** Settings ***
 | Library | resources/libraries/python/HoneycombUtil.py
 | Library | resources.libraries.python.InterfaceUtil
-| ... | WITH NAME | InterfaceCLI
-| Library | resources.libraries.python.HoneycombAPIKeywords.InterfaceKeywords
-| ... | WITH NAME | interfaceAPI
+| ... | WITH NAME | interfaceCLI
+| Library | resources.libraries.python.HcAPIKwInterfaces.InterfaceKeywords
+| ... | WITH NAME | InterfaceAPI
 
 *** Keywords ***
-| Honeycomb sets interface state
+| Interface state is
+| | [Documentation] | Uses VPP binary API to ensure that the interface under\
+| | ... | test is in the specified admin state.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - interface - name of an interface on the specified node. Type: string
+| | ... | - state - state to set on interface. Type:string
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Interface state is \| ${nodes['DUT1']} \| GigabitEthernet0/8/0 \
+| | ... | \| up \|
 | | [Arguments] | ${node} | ${interface} | ${state}
-| | [Documentation] | Uses Honeycomb API to change the admin state
+| | interfaceCLI.Set interface state | ${node} | ${interface} | ${state}
+
+| Honeycomb sets interface state
+| | [Documentation] | Uses Honeycomb API to change the admin state\
 | | ... | of the specified interface.
 | | ...
 | | ... | *Arguments:*
-| | ... | - state - state to set on interface
-| | ... | - node - dictionary of information about a DUT node
-| | ... | - interface - name of an interface on the specified node
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - interface - name of an interface on the specified node. Type: string
+| | ... | - state - state to set on interface. Type:string
 | | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Honeycomb sets interface state \| ${nodes['DUT1']} \
+| | ... | \| GigabitEthernet0/8/0 \| up \|
+| | [Arguments] | ${node} | ${interface} | ${state}
 | | interfaceAPI.Set interface state | ${node} | ${interface} | ${state}
 
 | Interface state from Honeycomb should be
-| | [Arguments] | ${node} | ${interface} | ${state}
-| | [Documentation] | Retrieves interface admin state through Honeycomb and
-| | ... | compares with state supplied in argument
+| | [Documentation] | Retrieves interface admin state through Honeycomb and\
+| | ... | compares with state supplied in argument.
 | | ...
 | | ... | *Arguments:*
-| | ... | - state - expected interface state
-| | ... | - node - dictionary of information about a DUT node
-| | ... | - interface - name of an interface on the specified node
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - interface - name of an interface on the specified node. Type: string
+| | ... | - state - expected interface state. Type: string
+| | ...
+| | ... | *Example:*
 | | ...
-| | ${api_data}= | interfaceAPI.Get interface oper info | ${node} | ${interface}
+| | ... | \| Interface state from Honeycomb should be \| ${nodes['DUT1']} \
+| | ... | \| GigabitEthernet0/8/0 \| up \|
+| | [Arguments] | ${node} | ${interface} | ${state}
+| | ${api_data}= | interfaceAPI.Get interface oper data | ${node} | ${interface}
 | | ${api_state}= | Set Variable | ${api_data['admin-status']}
 | | Should be equal | ${api_state} | ${state}
 
 | Interface state from VAT should be
-| | [Arguments] | ${node} | ${interface} | ${state}
-| | [Documentation] | Retrieves interface admin state through VAT and compares
-| | ... | with state supplied in argument
+| | [Documentation] | Retrieves interface admin state through VAT and compares\
+| | ... | with state supplied in argument.
 | | ...
 | | ... | *Arguments:*
-| | ... | - state - expected interface state
-| | ... | - node - dictionary of information about a DUT node
-| | ... | - interface - name of an interface on the specified node
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - interface - name of an interface on the specified node. Type: string
+| | ... | - state - expected interface state. Type: string
 | | ...
 | | ... | _NOTE:_ Vat returns state as int (1/0) instead of string (up/down).
 | | ... | This keyword also handles translation.
 | | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Interface state from VAT should be \| ${nodes['DUT1']} \
+| | ... | \| GigabitEthernet0/8/0 \| up \|
+| | [Arguments] | ${node} | ${interface} | ${state}
 | | ${vat_data}= | InterfaceCLI.VPP get interface data | ${node} | ${interface}
 | | ${vat_state}= | Set Variable if
 | | ... | ${vat_data['admin_up_down']} == 1 | up | down
 | | Should be equal | ${vat_state} | ${state}
 
-| Interface state is
-| | [Arguments] | ${node} | ${interface} | ${state}
-| | [Documentation] | Uses VPP binary API to ensure that the interface under
-| | ... | test is in the specified admin state.
+| Honeycomb sets interface ipv4 configuration
+| | [Documentation] | Uses Honeycomb API to change ipv4 configuration\
+| | ... | of the specified interface.
 | | ...
 | | ... | *Arguments:*
-| | ... | - state - state to set on interface
-| | ... | - node - dictionary of information about a DUT node
-| | ... | - interface - name of an interface on the specified node
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - interface - name of an interface on the specified node. Type: string
+| | ... | - address - IP address to set. Type: string
+| | ... | - netmask - subnet mask to set. Type: string
+| | ... | - fib_address - IP address to add to fib table. Type: string
+| | ... | - fib_mac - MAC address to add to fib table. Type: string
+| | ... | - settings - ipv4 interface settings. Type: dictionary
 | | ...
-| | interfaceAPI.Set interface state | ${node} | ${interface} | ${state}
+| | ... | *Example:*
+| | ...
+| | ... | \| Honeycomb sets interface ipv4 configuration \| ${nodes['DUT1']} \
+| | ... | \| GigabitEthernet0/8/0 \| 192.168.0.2 \| 255.255.255.0 \
+| | ... | \| 192.168.0.3 \| 08:00:27:c0:5d:37 \
+| | ... | \| ${{'enabled': True, 'mtu': 1500}} \|
+| | [Arguments] | ${node} | ${interface} | ${address} | ${netmask}
+| | ... | ${fib_address} | ${fib_mac} | ${settings}
+| | interfaceAPI.Add first ipv4 address
+| | ... | ${node} | ${interface} | ${address} | ${netmask}
+| | interfaceAPI.Add first ipv4 neighbor
+| | ... | ${node} | ${interface} | ${fib_address} | ${fib_mac}
+| | :FOR | ${key} | IN | @{settings.keys()}
+| | | interfaceAPI.Configure interface ipv4
+| | | ... | ${node} | ${interface} | ${key} | ${settings['${key}']}
+
+| IPv4 config from Honeycomb should be
+| | [Documentation] | Retrieves interface ipv4 configuration through Honeycomb\
+| | ... | and compares with state supplied in argument.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - interface - name of an interface on the specified node. Type: string
+| | ... | - address - IP address to expect. Type: string
+| | ... | - netmask - subnet mask to expect. Type: string
+| | ... | - fib_address - IP address to expect in fib table. Type: string
+| | ... | - fib_mac - MAC address to expect in fib table. Type: string
+| | ... | - settings - ipv4 interface settings to expect. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| IPv4 config from Honeycomb should be \| ${nodes['DUT1']} \
+| | ... | \| GigabitEthernet0/8/0 \| 192.168.0.2 \| 255.255.255.0 \
+| | ... | \| 192.168.0.3 \| 08:00:27:c0:5d:37 \
+| | ... | \| ${{'enabled': True, 'mtu': 1500}} \|
+| | [Arguments] | ${node} | ${interface} | ${address} | ${netmask}
+| | ... | ${fib_address} | ${fib_mac} | ${settings}
+| | ${api_data}= | interfaceAPI.Get interface oper data | ${node} | ${interface}
+| | Should be equal | ${address}
+| | ... | ${api_data['ietf-ip:ipv4']['address'][0]['ip']}
+| | Should be equal | ${netmask}
+| | ... | ${api_data['ietf-ip:ipv4']['address'][0]['netmask']}
+| | Should be equal | ${fib_address}
+| | ... | ${api_data['ietf-ip:ipv4']['neighbor'][0]['ip']
+| | Should be equal | ${fib_mac}
+| | ... | ${api_data['ietf-ip:ipv4']['neighbor'][0]['link-layer-address']
+| | :FOR | ${key} | IN | @{settings.keys()}
+| | | Should be equal
+| | | ... | ${settings['{key']} | ${api_data['ietf-ip:ipv4']['{$key}']}
+
+| IPv4 config from VAT should be
+| | [Documentation] | Retrieves interface ipv4 configuration through VAT and\
+| | ... | compares with state supplied in argument.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - interface - name of an interface on the specified node. Type: string
+| | ... | - address - IP address to expect. Type: string
+| | ... | - netmask - subnet mask to expect. Type: string
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| IPv4 config from VAT should be \| ${nodes['DUT1']} \
+| | ... | \| GigabitEthernet0/8/0 \| 192.168.0.2 \| 255.255.255.0 \|
+| | [Arguments] | ${node} | ${interface} | ${address} | ${netmask}
+| | ${vpp_data}= | interfaceCLI.VPP get interface ip addresses
+| | ... | ${node} | ${interface} | ipv4
+| | Should be equal | ${vpp_data[0]['ip']} | ${address}
+| | Should be equal | ${vpp_data[0]['netmask']} | ${netmask}
+
+| Honeycomb sets interface ipv6 configuration
+| | [Documentation] | Uses Honeycomb API to change ipv6 configuration\
+| | ... | of the specified interface.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - interface - name of an interface on the specified node. Type: string
+| | ... | - address - IP address to set. Type: string
+| | ... | - prefix - length of subnet prefix to set. Type: string
+| | ... | - fib_address - IP address to add to fib table. Type: string
+| | ... | - fib_mac - MAC address to add to fib table. Type: string
+| | ... | - settings - ipv6 interface settings. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Honeycomb sets interface ipv6 configuration \| ${nodes['DUT1']} \
+| | ... | \| GigabitEthernet0/8/0 \| 10::10 \| 64 \
+| | ... | \| 10::11 \| 08:00:27:c0:5d:37 \| ${{'enabled': True, 'mtu': 1500}} \|
+| | [Arguments] | ${node} | ${interface} | ${address} | ${prefix}
+| | ... | ${fib_address} | ${fib_mac} | ${settings}
+| | interfaceAPI.Add first ipv6 address
+| | ... | ${node} | ${interface} | ${address} | ${prefix}
+| | interfaceAPI.Add first ipv6 neighbor
+| | ... | ${node} | ${interface} | ${fib_address} | ${fib_mac}
+| | :FOR | ${key} | IN | @{settings.keys()}
+| | | interfaceAPI.Configure interface ipv6
+| | | ... | ${node} | ${interface} | ${key} | ${settings['${key}']}
+
+| IPv6 config from Honeycomb should be
+| | [Documentation] | Retrieves interface ipv6 configuration through Honeycomb\
+| | ... | and compares with state supplied in argument.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - interface - name of an interface on the specified node. Type: string
+| | ... | - address - IP address to expect. Type: string
+| | ... | - prefix - length of subnet prefix to expect. Type: string
+| | ... | - fib_address - IP address to expect in fib table. Type: string
+| | ... | - fib_mac - MAC address to expect in fib table. Type: string
+| | ... | - settings - ipv6 interface settings to expect. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| IPv6 config from Honeycomb should be \| ${nodes['DUT1']} \
+| | ... | \| GigabitEthernet0/8/0 \| 10::10 \| 64 \
+| | ... | \| 10::11 \| 08:00:27:c0:5d:37 \| ${{'enabled': True, 'mtu': 1500}} \|
+| | [Arguments] | ${node} | ${interface} | ${address} | ${prefix}
+| | ... | ${fib_address} | ${fib_mac} | ${settings}
+| | ${api_data}= | interfaceAPI.Get interface oper data | ${node} | ${interface}
+| | Should be equal | ${address}
+| | ... | ${api_data['ietf-ip:ipv6']['address'][0]['ip']}
+| | Should be equal | ${prefix}
+| | ... | ${api_data['ietf-ip:ipv6']['address'][0]['prefix-length']}
+| | Should be equal | ${fib_address}
+| | ... | ${api_data['ietf-ip:ipv6']['neighbor'][0]['ip']
+| | Should be equal | ${fib_mac}
+| | ... | ${api_data['ietf-ip:ipv6']['neighbor'][0]['link-layer-address']
+| | :FOR | ${key} | IN | @{settings.keys()}
+| | | Should be equal
+| | ... | ${settings['{key']} | ${api_data['ietf-ip:ipv6']['{$key}']}
+
+| IPv6 config from VAT should be
+| | [Documentation] | Retrieves interface ipv6 configuration through VAT and\
+| | ... | compares with state supplied in argument.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - interface - name of an interface on the specified node. Type: string
+| | ... | - address - IP address to expect. Type: string
+| | ... | - prefix - length of subnet prefix to expect. Type: string
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| IPv6 config from VAT should be \| ${nodes['DUT1']} \
+| | ... | \| GigabitEthernet0/8/0 \| 10::10 \| 64 \|
+| | [Arguments] | ${node} | ${interface} | ${address} | ${prefix}
+| | ${vpp_data}= | interfaceCLI.VPP get interface ip addresses
+| | ... | ${node} | ${interface} | ipv6
+| | Should be equal | ${vpp_data[0]['ip']} | ${address}
+| | Should be equal | ${vpp_data[0]['prefix-length']} | ${prefix}
+
+| Honeycomb sets interface ethernet and routing configuration
+| | [Documentation] | Uses Honeycomb API to change interface configuration.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - interface - name of an interface on the specified node. Type: string
+| | ... | - ethernet - interface ethernet settings. Type: dictionary
+| | ... | - routing - interface routing settings. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Honeycomb sets interface ethernet and routing configuration \
+| | ... | \| ${nodes['DUT1']} \| GigabitEthernet0/8/0 \| ${{'mtu': 1500}} \
+| | ... | \| ${{'vrf-if': 2}} \|
+| | [Arguments] | ${node} | ${interface} | ${ethernet} | ${routing}
+| | :FOR | ${key} | IN | @{ethernet.keys()}
+| | | interfaceAPI.Configure interface ethernet
+| | | ... | ${node} | ${interface} | ${key} | ${ethernet['${key}']}
+| | :FOR | ${key} | IN | @{routing.keys()}
+| | | interfaceAPI.Configure interface routing
+| | | ... | ${node} | ${interface} | ${key} | ${routing['${key}']}
+
+| Interface ethernet and routing configuration from Honeycomb should be
+| | [Documentation] | Retrieves interface routing and ethernet configuration\
+| | ... | through Honeycomb and compares with settings supplied in arguments.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - interface - name of an interface on the specified node. Type: string
+| | ... | - ethernet - interface ethernet settings. Type: dictionary
+| | ... | - routing - interface routing settings. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Interface ethernet and routing configuration from Honeycomb \
+| | ... | should be \| ${nodes['DUT1']} \| GigabitEthernet0/8/0 \
+| | ... | \| ${{'mtu': 1500}} \| ${{'vrf-id': 2}} \|
+| | [Arguments] | ${node} | ${interface} | ${ethernet} | ${routing}
+| | ${api_data}= | interfaceAPI.Get interface oper data | ${node} | ${interface}
+| | :FOR | ${key} | IN | @{ethernet.keys()}
+| | | Should be equal | ${api_data['${key}']} | ${ethernet['${key}']}
+| | :FOR | ${key} | IN | @{routing.keys()}
+| | | Should be equal | ${api_data['${key}']} | ${routing['${key}']}
+
+| Interface ethernet and routing configuration from VAT should be
+| | [Documentation] | Retrieves interface routing and ethernet configuration\
+| | ... | through VAT and compares with settings supplied in arguments.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - interface - name of an interface on the specified node. Type: string
+| | ... | - mtu - value of maximum transmission unit expected. Type: integer
+| | ... | - vrf-id - ID number of a VPN expected on interface. Type: integer
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Interface ethernet and routing configuration from VAT \
+| | ... | should be \| ${nodes['DUT1']} \| GigabitEthernet0/8/0 \| ${1500} \
+| | ... | \| ${2} \|
+| | [Arguments] | ${node} | ${interface} | ${mtu} | ${vrf-id}
+| | ${vat_data}= | InterfaceCLI.VPP get interface data | ${node} | ${interface}
+| | Should be equal | ${vat_data['mtu']} | ${mtu}
+| | Should be equal | ${vat_data['sub_inner_vlan_id']} | ${vrf-id}