Merge pull request #710 from kernelkit/fix-test-texts

test: Update topologies and test texts
kernelkit · Oct 16, 2024 · 90bda1b · 90bda1b
2 parents 1583071 + 34cb229
commit 90bda1b
Show file tree

Hide file tree

Showing 75 changed files with 433 additions and 294 deletions.
diff --git a/test/case/ietf_hardware/usb/Readme.adoc b/test/case/ietf_hardware/usb/Readme.adoc
@@ -23,7 +23,7 @@ image::topology.png[USB configuration topology]
 endif::testgroup[]
 endif::topdoc[]
 ==== Test sequence
-. Initialize
+. Set up topology and attach to target DUT
 . Unlock all USB ports
 . Verify that all USB ports are unlocked
 . Lock all USB ports

diff --git a/test/case/ietf_hardware/usb/test.py b/test/case/ietf_hardware/usb/test.py
@@ -20,7 +20,7 @@
 from infamy.util import until, wait_boot
 
 with infamy.Test() as test:
-    with test.step("Initialize"):
+    with test.step("Set up topology and attach to target DUT"):
         env = infamy.Env()
         target = env.attach("target", "mgmt")
         available = usb.get_usb_ports(target)

diff --git a/test/case/ietf_hardware/usb/topology.png b/test/case/ietf_hardware/usb/topology.png
diff --git a/test/case/ietf_hardware/usb_two_ports/Readme.adoc b/test/case/ietf_hardware/usb_two_ports/Readme.adoc
@@ -16,8 +16,8 @@ image::topology.png[USB configuration with two USB ports topology]
 endif::testgroup[]
 endif::topdoc[]
 ==== Test sequence
-. Initialize
-. Lock the first  USB port, and unlock the second USB port
+. Set up topology and attach to target DUTs
+. Lock the first USB port and unlock the second USB port
 . Verify that the correct port is locked and the correct one is unlocked
 . Unlock the first USB port, and lock the second USB port
 . Verify that the correct port is locked and the correct one is unlocked

diff --git a/test/case/ietf_hardware/usb_two_ports/test.py b/test/case/ietf_hardware/usb_two_ports/test.py
@@ -13,15 +13,15 @@
 from infamy.util import until,wait_boot
 
 with infamy.Test() as test:
-    with test.step("Initialize"):
+    with test.step("Set up topology and attach to target DUTs"):
         env = infamy.Env()
         target = env.attach("target", "mgmt")
         available=usb.get_usb_ports(target)
 
         if len(available) < 2:
             test.skip()
 
-    with test.step("Lock the first  USB port, and unlock the second USB port"):
+    with test.step("Lock the first USB port and unlock the second USB port"):
         components = []
         component = {
             "name": available[0],

diff --git a/test/case/ietf_hardware/usb_two_ports/topology.png b/test/case/ietf_hardware/usb_two_ports/topology.png
diff --git a/test/case/ietf_interfaces/bridge_basic/topology.dot b/test/case/ietf_interfaces/bridge_basic/topology.dot
@@ -13,12 +13,12 @@ graph "1x2" {
 	];
 
         target [
-	    label="{ <mgmt> mgmt | <data> data } | target",
+	    label="{ <mgmt> mgmt | <data> data } | target\n10.0.0.2/24 (br0)",
 	    pos="10,12!",
 
 	    kind="infix",
 	];
 
-	host:mgmt -- target:mgmt [kind=mgmt, color=lightgrey]
+	host:mgmt -- target:mgmt  [kind=mgmt, color="lightgray"]
 	host:data -- target:data [color=black, fontcolor=black, taillabel="10.0.0.1/24"]
 }
diff --git a/test/case/ietf_interfaces/bridge_basic/topology.png b/test/case/ietf_interfaces/bridge_basic/topology.png
diff --git a/test/case/ietf_interfaces/bridge_fwd_dual_dut/Readme.adoc b/test/case/ietf_interfaces/bridge_fwd_dual_dut/Readme.adoc
@@ -4,21 +4,20 @@ Ping through two bridges on two different DUTs.
 
 ....
 
-   ,-------------------------------------,       ,-------------------------------------,
-   |                          dut1:link  |       | dut2:link                           |
-   |                      br0  ----------|-------|---------  br0                       |
-   |                     /               |       |          /   \                      |
-   |dut1:mgmt       dut1:data1           |       | dut2:data1    dut2:data2  dut2:mgmt |
-   '-------------------------------------'       '-------------------------------------'
-       |                |                                  |     |                 |
-       |                |                                  |     |                 |
-,-----------------------------------------------------------------------------------------,
-|  host:mgmt1    host:data11                      host:data21    host:data22   host:mgmt2 |
-|                [10.0.0.2]                       [10.0.0.3]     [10.0.0.4]               |
-|                  (ns11)                           (ns20)         (ns21)                 |
-|                                                                                         |
-|                                        [ HOST ]                                         |
-'-----------------------------------------------------------------------------------------'
+  ,-------------------------------------,   ,-------------------------------------,
+  |                          dut1:link  |   | dut2:link                           |
+  |                      br0  ----------|---|---------  br0                       |
+  |                     /               |   |          /   \                      |
+  |dut1:mgmt       dut1:data1           |   | dut2:data1    dut2:data2  dut2:mgmt |
+  '-------------------------------------'   '-------------------------------------'
+      |                |                             |     |                 |
+      |                |                             |     |                 |
+,-----------------------------------------------------------------------------------,
+| host:mgmt1    host:data11                 host:data21    host:data22   host:mgmt2 |
+|               [10.0.0.2]                       [10.0.0.3]     [10.0.0.4]          |
+|                 (ns11)                           (ns20)         (ns21)            |
+|                                       [ HOST ]                                    |
+'-----------------------------------------------------------------------------------'
 
 ....
 

diff --git a/test/case/ietf_interfaces/bridge_fwd_dual_dut/test.py b/test/case/ietf_interfaces/bridge_fwd_dual_dut/test.py
@@ -6,21 +6,20 @@
 
 ....
 
-   ,-------------------------------------,       ,-------------------------------------,
-   |                          dut1:link  |       | dut2:link                           |
-   |                      br0  ----------|-------|---------  br0                       |
-   |                     /               |       |          /   \                      |
-   |dut1:mgmt       dut1:data1           |       | dut2:data1    dut2:data2  dut2:mgmt |
-   '-------------------------------------'       '-------------------------------------'
-       |                |                                  |     |                 |
-       |                |                                  |     |                 |
-,-----------------------------------------------------------------------------------------,
-|  host:mgmt1    host:data11                      host:data21    host:data22   host:mgmt2 |
-|                [10.0.0.2]                       [10.0.0.3]     [10.0.0.4]               |
-|                  (ns11)                           (ns20)         (ns21)                 |
-|                                                                                         |
-|                                        [ HOST ]                                         |
-'-----------------------------------------------------------------------------------------'
+  ,-------------------------------------,   ,-------------------------------------,
+  |                          dut1:link  |   | dut2:link                           |
+  |                      br0  ----------|---|---------  br0                       |
+  |                     /               |   |          /   \                      |
+  |dut1:mgmt       dut1:data1           |   | dut2:data1    dut2:data2  dut2:mgmt |
+  '-------------------------------------'   '-------------------------------------'
+      |                |                             |     |                 |
+      |                |                             |     |                 |
+,-----------------------------------------------------------------------------------,
+| host:mgmt1    host:data11                 host:data21    host:data22   host:mgmt2 |
+|               [10.0.0.2]                       [10.0.0.3]     [10.0.0.4]          |
+|                 (ns11)                           (ns20)         (ns21)            |
+|                                       [ HOST ]                                    |
+'-----------------------------------------------------------------------------------'
 
 ....
 

diff --git a/test/case/ietf_interfaces/bridge_fwd_dual_dut/topology.png b/test/case/ietf_interfaces/bridge_fwd_dual_dut/topology.png
diff --git a/test/case/ietf_interfaces/bridge_veth/Readme.adoc b/test/case/ietf_interfaces/bridge_veth/Readme.adoc
@@ -3,6 +3,15 @@
 This tests the possibility to add software added interfaces, in this case
 VETH and bridge it with a physical interface
 
+....
+
+PING -->      br0
+             /   \
+ PC- target:data  veth0a -- veth0b
+     10.0.0.1               10.0.0.2
+
+....
+
 ==== Topology
 ifdef::topdoc[]
 image::../../test/case/ietf_interfaces/bridge_veth/topology.png[Bridge with a physical port and a veth topology]
@@ -16,7 +25,7 @@ image::topology.png[Bridge with a physical port and a veth topology]
 endif::testgroup[]
 endif::topdoc[]
 ==== Test sequence
-. Initialize
+. Set up topology and attach to target DUT
 . Configure bridged eth port and veth pair with IP 10.0.0.2
 . Verify ping from host:data to 10.0.0.2
 

diff --git a/test/case/ietf_interfaces/bridge_veth/test.py b/test/case/ietf_interfaces/bridge_veth/test.py
@@ -1,19 +1,25 @@
 #!/usr/bin/env python3
-#
-# PING -->     br0
-#             /   \
-#   PC ---- e0     veth 10.0.0.2
-#
 """
 Bridge with a physical port and a veth
 
 This tests the possibility to add software added interfaces, in this case
 VETH and bridge it with a physical interface
+
+....
+
+PING -->      br0
+             /   \\
+ PC- target:data  veth0a -- veth0b
+     10.0.0.1               10.0.0.2
+
+....
+
+
 """
 import infamy
 
 with infamy.Test() as test:
-    with test.step("Initialize"):
+    with test.step("Set up topology and attach to target DUT"):
         env = infamy.Env()
         target = env.attach("target", "mgmt")
 

diff --git a/test/case/ietf_interfaces/bridge_veth/topology.dot b/test/case/ietf_interfaces/bridge_veth/topology.dot
@@ -7,7 +7,7 @@ graph "1x2" {
 	edge [color="cornflowerblue", penwidth="2"];
 
 	host [
-	    label="host | { <tgt> tgt | <data> data }",
+	    label="host | { <mgmt> mgmt | <data> data }",
 	    pos="0,12!",
 	    kind="controller",
 	];
@@ -19,6 +19,6 @@ graph "1x2" {
 	    kind="infix",
 	];
 
-	host:tgt -- target:mgmt [kind=mgmt]
+	host:mgmt -- target:mgmt [kind=mgmt, color="lightgray"]
 	host:data -- target:data [color=black, fontcolor=black, taillabel="10.0.0.1/24"]
 }
diff --git a/test/case/ietf_interfaces/bridge_veth/topology.png b/test/case/ietf_interfaces/bridge_veth/topology.png
diff --git a/test/case/ietf_interfaces/bridge_vlan/Readme.adoc b/test/case/ietf_interfaces/bridge_vlan/Readme.adoc
@@ -1,6 +1,15 @@
 === Bridge VLAN
 ==== Description
-Basic test of VLAN functionality in a bridge
+Basic test of VLAN functionality in a bridge, tagged/untagged traffic and a VLAN interface in the bridge.
+....
+           ¦                              ¦
+           ¦       vlan10 IP:10.0.0.2     ¦        br0  IP:10.0.0.3
+           ¦       /                      ¦       /
+           ¦     br0  <-- VLAN filtering  ¦   link.10
+           ¦   u/  \t                     ¦    /
+   PC ------data    link -----------------|-- link
+           ¦    dut1                      ¦   dut2
+....
 
 ==== Topology
 ifdef::topdoc[]
@@ -15,8 +24,9 @@ image::topology.png[Bridge VLAN topology]
 endif::testgroup[]
 endif::topdoc[]
 ==== Test sequence
+. Set up topology and attach to target DUT
 . Configure DUTs
-. Verify ping from host:data1 to 10.0.0.2 and 10.0.0.3
+. Verify ping from host:data to 10.0.0.2 and 10.0.0.3
 
 
 <<<

diff --git a/test/case/ietf_interfaces/bridge_vlan/test.py b/test/case/ietf_interfaces/bridge_vlan/test.py
@@ -1,29 +1,33 @@
 #!/usr/bin/env python3
-#           ¦                              ¦
-#           ¦       vlan10 IP:10.0.0.2     ¦        br0  IP:10.0.0.3
-#           ¦       /                      ¦       /
-#           ¦     br0  <-- VLAN filtering  ¦     e0.10
-#           ¦   u/  \t                     ¦    /
-#   PC ------- e0    e1 ---------------------- e0
-# PING -->  ¦             dut1             ¦            dut2
-#
+
 """
 Bridge VLAN
 
-Basic test of VLAN functionality in a bridge
+Basic test of VLAN functionality in a bridge, tagged/untagged traffic and a VLAN interface in the bridge.
+....
+           ¦                              ¦
+           ¦       vlan10 IP:10.0.0.2     ¦        br0  IP:10.0.0.3
+           ¦       /                      ¦       /
+           ¦     br0  <-- VLAN filtering  ¦   link.10
+           ¦   u/  \\t                     ¦    /
+   PC ------data    link -----------------|-- link
+           ¦    dut1                      ¦   dut2
+....
+
 """
 import infamy
 
 with infamy.Test() as test:
-    with test.step("Configure DUTs"):
+    with test.step("Set up topology and attach to target DUT"):
         env  = infamy.Env()
         dut1 = env.attach("dut1", "mgmt")
         dut2 = env.attach("dut2", "mgmt")
 
         _, dut1_e0 = env.ltop.xlate("dut1", "data")
-        _, dut1_e1 = env.ltop.xlate("dut1", "to_dut2")
-        _, dut2_e0 = env.ltop.xlate("dut2", "to_dut1")
+        _, dut1_e1 = env.ltop.xlate("dut1", "link")
+        _, dut2_e0 = env.ltop.xlate("dut2", "link")
 
+    with test.step("Configure DUTs"):
         dut1.put_config_dict("ietf-interfaces", {
             "interfaces": {
                 "interface": [
@@ -117,8 +121,8 @@
             }
         })
 
-    with test.step("Verify ping from host:data1 to 10.0.0.2 and 10.0.0.3"):
-        _, hport = env.ltop.xlate("host", "data1")
+    with test.step("Verify ping from host:data to 10.0.0.2 and 10.0.0.3"):
+        _, hport = env.ltop.xlate("host", "data")
 
         with infamy.IsolatedMacVlan(hport) as ns:
             ns.addip("10.0.0.1")

diff --git a/test/case/ietf_interfaces/bridge_vlan/topology.dot b/test/case/ietf_interfaces/bridge_vlan/topology.dot
@@ -7,26 +7,26 @@ graph "2x2" {
 	edge [color="cornflowerblue", penwidth="2"];
 
 	host [
-	    label="host | { <mgmt1> mgmt1 | <data1> data1 | <mgmt2> mgmt2 }",
+	    label="host | { <mgmt1> mgmt1 | <data> data | <mgmt2> mgmt2 }",
 	    pos="0,16!",
 	    kind="controller",
 	];
 
         dut1 [
-	    label="{ <mgmt> mgmt | <data> data | <to_dut2> to_dut2} | dut1\n(10.0.0.2) ",
+	    label="{ <mgmt> mgmt | <data> data | <link> link} | dut1\n(10.0.0.2) ",
 	    pos="10,16!",
 
 	    kind="infix",
 	];
 	dut2 [
-	    label="{ <to_dut1> to_dut1 | <mgmt> mgmt } | dut2\n(10.0.0.3)",
+	    label="{ <link> link | <mgmt> mgmt } | dut2\n(10.0.0.3)",
 	    pos="10,12!",
 
 	    kind="infix",
 	];
-	host:mgmt1 -- dut1:mgmt [kind=mgmt]
-        host:mgmt2 -- dut2:mgmt [kind=mgmt]
-	host:data1 -- dut1:data [color=black]
+	host:mgmt1 -- dut1:mgmt [kind=mgmt, color="lightgray"]
+        host:mgmt2 -- dut2:mgmt [kind=mgmt, color="lightgray"]
+	host:data -- dut1:data [color=black]
 
-	dut1:to_dut2 -- dut2:to_dut1
+	dut1:link -- dut2:link [color=black]
 }
diff --git a/test/case/ietf_interfaces/bridge_vlan/topology.png b/test/case/ietf_interfaces/bridge_vlan/topology.png
diff --git a/test/case/ietf_interfaces/bridge_vlan_separation/Readme.adoc b/test/case/ietf_interfaces/bridge_vlan_separation/Readme.adoc
@@ -2,6 +2,25 @@
 ==== Description
 Test that two VLANs are correctly separated in the bridge
 
+....
+    ,-----------------------------------,   ,----------------------------------,
+    |                         dut1:link |   | dut2:link                        |
+    |                      br0  --------|---|---------  br0                    |
+    |                     / \           |   |          / \                     |
+    |dut1:mgmt  dut1:data1   dut1:data2 |   | dut2:data1  dut2:data2 dut2:mgmt |
+    '-----------------------------------'   '----------------------------------'
+        |             |        |                  |            |         |
+        |             |        |                  |            |         |
+ ,------------------------------------------------------------------------------,
+ |  host:mgmt0 host:data10 host:data11    host:data20  host:data21  host:mgmt1  |
+ |             [10.0.0.1]   [10.0.0.2]     [10.0.0.3]     [10.0.0.4]            |
+ |              (ns10)         (ns11)          (s20)         (ns21)             |
+ |                                                                              |
+ |                                        [ HOST ]                              |
+ '------------------------------------------------------------------------------'
+
+....
+
 ==== Topology
 ifdef::topdoc[]
 image::../../test/case/ietf_interfaces/bridge_vlan_separation/topology.png[Bridge VLAN separation topology]
@@ -15,7 +34,7 @@ image::topology.png[Bridge VLAN separation topology]
 endif::testgroup[]
 endif::topdoc[]
 ==== Test sequence
-. Initialize
+. Set up topology and attach to target DUT
 . Configure DUTs
 . Verify ping 10.0.0.3 from host:data10
 . Verify ping 10.0.0.4 from host:data11