test/case: use 9pm 'name:' for all test names

To reduce the duplication of effort between 9pm and the Infamy framework
this change consolidates the move from local 'infamy: title:' extension
to 9pm 'name:'.

For the parameterized tunnel tests we leverage the 9pm dynamic test-spec
variable, which looks for a correspodning <case>.adoc instead of static
Readme.adoc, when generating the test report.

Each test documentation should cover all aspects of the test, much like
the usage text of a UNIX program.  To this end, the tunnel test docs are
now more spelled out, including all invariants.

Some refactoring of these tests were also necessary, e.g., replacing any
reserved Python keywords like 'type', and other PEP-8 fixes.

Signed-off-by: Joachim Wiberg <[email protected]>

Author: troglobit

test/case/all.yaml

@@ -14,38 +14,29 @@
   infamy:
     specification: False
 
-
 - name: Misc tests
   suite: misc/misc.yaml
 
-- name:  ietf-system
-  suite: ietf_system/ietf_system.yaml
-
 # Upgrade may leave wrong boot order
 - case: meta/bootorder.py
   infamy:
     specification: False
 
-- name:  ietf-syslog
+- name: "IETF System"
+  suite: ietf_system/ietf_system.yaml
+- name: "IETF Syslog"
   suite: ietf_syslog/ietf_syslog.yaml
-
-- name:  ietf-interfaces
+- name: "IETF Interfaces"
   suite: ietf_interfaces/ietf_interfaces.yaml
-
-- name:  ietf-routing
+- name: "IETF Routing"
   suite: ietf_routing/ietf_routing.yaml
-
-- name:  infix-containers
+- name: "Infix Containers"
   suite: infix_containers/infix_containers.yaml
-
-- name:  infix-dhcp
+- name: "Infix DHCP"
   suite: infix_dhcp/infix_dhcp.yaml
-
-- name:  ietf-hardware
+- name: "IETF Hardware"
   suite: ietf_hardware/ietf_hardware.yaml
-
-- name:  infix-services
+- name: "Infix Services"
   suite: infix_services/infix_services.yaml
-
-- name: use-cases
+- name: "Use Case Tests"
   suite: use_case/use_case.yml

test/case/ietf_hardware/ietf_hardware.yaml

@@ -1,6 +1,6 @@
 ---
-- name: usb
+- name: USB configuration
   case: usb/test.py
 
-- name: usb_two_ports
+- name: USB configuration with two USB ports
   case: usb_two_ports/test.py

test/case/ietf_interfaces/bridge.yaml

@@ -1,25 +1,25 @@
 ---
 
-- name: bridge_fwd_sgl_dut
+- name: Bridge forwarding single DUTs
   case: bridge_fwd_sgl_dut/test.py
 
-- name: bridge_fwd_dual_dut
+- name: Bridge forwarding dual DUTs
   case: bridge_fwd_dual_dut/test.py
 
-- name: bridge_stp_basic
+- name: Bridge STP Basic
   case: bridge_stp_basic/test.py
 
-- name: bridge_vlan_separation
+- name: Bridge VLAN separation
   case: bridge_vlan_separation/test.py
 
-- name: bridge_basic
+- name: Bridge basic
   case: bridge_basic/test.py
 
-- name: dual_bridge
+- name: Dual bridges on one device
   case: dual_bridge/test.py
 
-- name: bridge_veth
+- name: Bridge with a physical port and a veth
   case: bridge_veth/test.py
 
-- name: bridge_vlan
+- name: Bridge VLAN
   case: bridge_vlan/test.py

test/case/ietf_interfaces/ietf_interfaces.yaml

@@ -1,51 +1,51 @@
 ---
-- name: vlan_ping
+- name: VLAN ping connectivity
   case: vlan_ping/test.py
 
-- name: ipv4_address
+- name: Interface with IPv4
   case: ipv4_address/test.py
 
-- name: ipv6_address
+- name: Interface IPv6 autoconf for bridges
   case: ipv6_address/test.py
 
-- name: ifalias
+- name: Interface Description (ifAlias)
   case: ifalias/test.py
 
-- name: iface_phys_address
+- name: Custom MAC address on interface
   case: iface_phys_address/test.py
 
-- name: routing_basic
+- name: Routing basic
   case: routing_basic/test.py
 
-- name: vlan_qos
+- name: VLAN Interface Ingress/Egress QoS
   case: vlan_qos/test.py
 
-- name: speed_duplex_copper
+- name: Interface Speed Duplex (Copper)
   case: speed_duplex_copper/test.py
 
-- name: verify_all_interface_types
+- name: Verify that all interface types can be created
   case: verify_all_interface_types/test.py
 
-- name: iface_enable_disable
+- name: Interface status
   case: iface_enable_disable/test.py
 
-- name: vlan_iface_termination
+- name: VLAN Interface Termination
   case: vlan_iface_termination/test.py
 
-- name: veth_delete
+- name: Verify that VETH pairs can be deleted
   case: veth_delete/test.py
 
-- name: ipv4_autoconf
+- name: IPv4 link-local
   case: ipv4_autoconf/test.py
 
-- name: bridge
+- name: Bridge interface tests
   suite: bridge.yaml
 
-- name: link_aggregation
+- name: Link aggregation tests
   suite: lag.yaml
 
-- name: igmp
+- name: Layer-2 multicast filtering tests
   suite: igmp.yaml
 
-- name: tunnels
+- name: Layer-2/3 tunnel tests
   suite: tunnels.yaml

test/case/ietf_interfaces/igmp.yaml

@@ -1,9 +1,9 @@
 ---
-- name: igmp_basic
+- name: IGMP basic
   case: igmp_basic/test.py
 
-- name: igmp_vlan
+- name: IGMP VLAN
   case: igmp_vlan/test.py
 
-- name: static_multicast_filters
+- name: Static multicast filters
   case: static_multicast_filters/test.py

test/case/ietf_interfaces/lag.yaml

@@ -1,5 +1,5 @@
 ---
-- name: lag_basic
+- name: Ling Aggregation Basic
   case: lag_basic/test.py
-- name: lag_failure
+- name: LACP Aggregate w/ Degraded Link
   case: lag_failure/test.py

test/case/ietf_interfaces/tunnel_basic/gre.adoc

@@ -0,0 +1,26 @@
+=== GRE point-to-point
+
+ifdef::topdoc[:imagesdir: {topdoc}../../test/case/ietf_interfaces/tunnel_basic]
+
+==== Description
+
+Set up a tunnel between two DUTs, host connected to the first DUT.  Enable
+IP forwarding on first DUT's interface to host and the tunnel interface to
+the second DUT.  On host, add route to IP network of second DUT and verify
+connectivity with the second DUT through the tunnel.
+
+- Tunnel types: GRE, GRETAP, and VxLAN
+- Connectivity: IPv4 and IPv6
+
+==== Topology
+
+image::topology.svg[GRE point-to-point topology, align=center, scaledwidth=75%]
+
+==== Sequence
+
+. Set up topology and attach to target DUTs
+. Configure DUTs with tunnel gre
+. Verify connectivity host:data to 10.0.0.2
+. Verify connectivity host:data to 2001:db8::c0a8:0a02
+
+

test/case/ietf_interfaces/tunnel_basic/gre.py

@@ -0,0 +1 @@
+test.py

test/case/ietf_interfaces/tunnel_basic/gretap.adoc

@@ -0,0 +1,26 @@
+=== GRETAP point-to-point
+
+ifdef::topdoc[:imagesdir: {topdoc}../../test/case/ietf_interfaces/tunnel_basic]
+
+==== Description
+
+Set up a tunnel between two DUTs, host connected to the first DUT.  Enable
+IP forwarding on first DUT's interface to host and the tunnel interface to
+the second DUT.  On host, add route to IP network of second DUT and verify
+connectivity with the second DUT through the tunnel.
+
+- Tunnel types: GRE, GRETAP, and VxLAN
+- Connectivity: IPv4 and IPv6
+
+==== Topology
+
+image::topology.svg[GRETAP point-to-point topology, align=center, scaledwidth=75%]
+
+==== Sequence
+
+. Set up topology and attach to target DUTs
+. Configure DUTs with tunnel gretap
+. Verify connectivity host:data to 10.0.0.2
+. Verify connectivity host:data to 2001:db8::c0a8:0a02
+
+

test/case/ietf_interfaces/tunnel_basic/gretap.py

@@ -0,0 +1 @@
+test.py