From 8e58fa9a792f8853f17588719205da2a76355f2b Mon Sep 17 00:00:00 2001
From: Ben Pfaff <blp@nicira.com>
Date: Mon, 14 Sep 2009 11:28:57 -0700
Subject: [PATCH] ovs-vsctl: Add test suite, documentation for br-to-vlan,
 br-to-parent.

CC: Ian Campbell <Ian.Campbell@citrix.com>
---
 tests/ovs-vsctl.at       | 54 ++++++++++++++++++++++++++--------------
 utilities/ovs-vsctl.8.in |  8 ++++++
 2 files changed, 43 insertions(+), 19 deletions(-)

diff --git a/tests/ovs-vsctl.at b/tests/ovs-vsctl.at
index aa3dab73f..dcf6d209f 100644
--- a/tests/ovs-vsctl.at
+++ b/tests/ovs-vsctl.at
@@ -1,5 +1,3 @@
-AT_BANNER([ovs-vsctl unit tests -- real bridges])
-
 dnl RUN_OVS_VSCTL(COMMAND, ...)
 dnl
 dnl Executes each ovs-vsctl COMMAND on a file named "conf" in the
@@ -9,18 +7,32 @@ m4_define([RUN_OVS_VSCTL],
 m4_foreach([command], [$@], [ovs-vsctl --no-reload --config=conf command
 ])])
 
-dnl CHECK_BRIDGES(BRIDGE, ...)
+dnl CHECK_BRIDGES([BRIDGE, PARENT, VLAN], ...)
 dnl
 dnl Verifies that "ovs-vsctl list-br" prints the specified list of bridges,
-dnl which must be in alphabetical order.
+dnl which must be in alphabetical order.  Also checks that each BRIDGE has the
+dnl specified PARENT and is on the given VLAN.
+m4_define([_CHECK_BRIDGE],
+  [AT_CHECK([RUN_OVS_VSCTL([br-to-parent $1])], [0], [$2
+])
+   AT_CHECK([RUN_OVS_VSCTL([br-to-vlan $1])], [0], [$3
+])])
 m4_define([CHECK_BRIDGES],
-  [AT_CHECK(
+  [dnl Check that the bridges appear on list-br.
+   AT_CHECK(
      [RUN_OVS_VSCTL([list-br])],
      [0],
-     [m4_foreach([port], [$@], [port
+     [m4_foreach([brinfo], [$@], [m4_car(brinfo)
 ])])
-   m4_foreach([port], [$@], [AT_CHECK([RUN_OVS_VSCTL([br-exists port])])])
-   AT_CHECK([RUN_OVS_VSCTL([br-exists nonexistent])], [2])])
+
+   dnl Check that each bridge exists according to br-exists and that
+   dnl a bridge that should not exist does not.
+   m4_foreach([brinfo], [$@], 
+              [AT_CHECK([RUN_OVS_VSCTL([br-exists m4_car(brinfo)])])])
+   AT_CHECK([RUN_OVS_VSCTL([br-exists nonexistent])], [2])
+
+   dnl Check that each bridge has the expected parent and VLAN.
+   m4_map([_CHECK_BRIDGE], [$@])])
 
 dnl CHECK_PORTS(BRIDGE, PORT[, PORT...])
 dnl
@@ -60,13 +72,16 @@ m4_define([CHECK_IFACES],
      [AT_CHECK([RUN_OVS_VSCTL([[iface-to-br] iface])], [0], [$1
 ])])])
 
+dnl ----------------------------------------------------------------------
+AT_BANNER([ovs-vsctl unit tests -- real bridges])
+
 AT_SETUP([add-br a])
 AT_KEYWORDS([ovs-vsctl])
 AT_CHECK([RUN_OVS_VSCTL([add-br a])])
 AT_CHECK([cat conf], [0], [dnl
 bridge.a.port=a
 ])
-CHECK_BRIDGES([a])
+CHECK_BRIDGES([a, a, 0])
 CHECK_PORTS([a])
 CHECK_IFACES([a])
 AT_CLEANUP
@@ -78,7 +93,7 @@ AT_CHECK([cat conf], [0], [dnl
 bridge.a.port=a
 bridge.b.port=b
 ])
-CHECK_BRIDGES([a], [b])
+CHECK_BRIDGES([a, a, 0], [b, b, 0])
 CHECK_PORTS([a])
 CHECK_IFACES([a])
 CHECK_PORTS([b])
@@ -91,7 +106,7 @@ AT_CHECK([RUN_OVS_VSCTL([add-br a], [add-br b], [del-br a])])
 AT_CHECK([cat conf], [0], [dnl
 bridge.b.port=b
 ])
-CHECK_BRIDGES([b])
+CHECK_BRIDGES([b, b, 0])
 CHECK_PORTS([b])
 CHECK_IFACES([b])
 AT_CLEANUP
@@ -108,7 +123,7 @@ AT_CHECK([cat conf], [0],
   [bridge.b.port=b
 bridge.b.port=b1
 ])
-CHECK_BRIDGES([b])
+CHECK_BRIDGES([b, b, 0])
 CHECK_PORTS([b], [b1])
 CHECK_IFACES([b], [b1])
 AT_CLEANUP
@@ -125,7 +140,7 @@ bonding.bond0.slave=a3
 bridge.a.port=a
 bridge.a.port=bond0
 ])
-CHECK_BRIDGES([a])
+CHECK_BRIDGES([a, a, 0])
 CHECK_PORTS([a], [bond0])
 CHECK_IFACES([a], [a1], [a2], [a3])
 AT_CLEANUP
@@ -143,7 +158,7 @@ bridge.a.port=a
 bridge.b.port=b
 bridge.b.port=b1
 ])
-CHECK_BRIDGES([a], [b])
+CHECK_BRIDGES([a, a, 0], [b, b, 0])
 CHECK_PORTS([a])
 CHECK_IFACES([a])
 CHECK_PORTS([b], [b1])
@@ -159,10 +174,11 @@ AT_CHECK([RUN_OVS_VSCTL(
 AT_CHECK([cat conf], [0], [dnl
 bridge.a.port=a
 ])
-CHECK_BRIDGES([a])
+CHECK_BRIDGES([a, a, 0])
 CHECK_PORTS([a])
 AT_CLEANUP
 
+dnl ----------------------------------------------------------------------
 AT_BANNER([ovs-vsctl unit tests -- fake bridges])
 
 m4_define([SIMPLE_FAKE_CONF], [dnl
@@ -184,7 +200,7 @@ AT_CHECK([RUN_OVS_VSCTL(
   [add-br xapi1 xenbr0 9],
   [add-port xapi1 eth0.9])])
 AT_CHECK([cat conf], [0], [SIMPLE_FAKE_CONF])
-CHECK_BRIDGES([xenbr0], [xapi1])
+CHECK_BRIDGES([xenbr0, xenbr0, 0], [xapi1, xenbr0, 9])
 CHECK_PORTS([xenbr0], [eth0])
 CHECK_IFACES([xenbr0], [eth0])
 CHECK_PORTS([xapi1], [eth0.9])
@@ -199,7 +215,7 @@ AT_CHECK([cat conf], [0], [dnl
 bridge.xenbr0.port=eth0
 bridge.xenbr0.port=xenbr0
 ])
-CHECK_BRIDGES([xenbr0])
+CHECK_BRIDGES([xenbr0, xenbr0, 0])
 CHECK_PORTS([xenbr0], [eth0])
 CHECK_IFACES([xenbr0], [eth0])
 AT_CLEANUP
@@ -233,7 +249,7 @@ AT_CHECK([RUN_OVS_VSCTL(
   [add-br xapi2 xapi1 11],
   [add-port xapi2 bond0.11])])
 AT_CHECK([cat conf], [0], [BOND_FAKE_CONF])
-CHECK_BRIDGES([xapi1], [xapi2])
+CHECK_BRIDGES([xapi1, xapi1, 0], [xapi2, xapi1, 11])
 CHECK_PORTS([xapi1], [bond0])
 CHECK_IFACES([xapi1], [eth0], [eth1])
 CHECK_PORTS([xapi2], [bond0.11])
@@ -244,7 +260,7 @@ AT_SETUP([fake bridge on bond + del-br fake bridge])
 AT_KEYWORDS([ovs-vsctl fake-bridge])
 AT_DATA([conf], [BOND_FAKE_CONF])
 AT_CHECK([RUN_OVS_VSCTL([del-br xapi2])])
-CHECK_BRIDGES([xapi1])
+CHECK_BRIDGES([xapi1, xapi1, 0])
 CHECK_PORTS([xapi1], [bond0])
 CHECK_IFACES([xapi1], [eth0], [eth1])
 AT_CLEANUP
diff --git a/utilities/ovs-vsctl.8.in b/utilities/ovs-vsctl.8.in
index de78a642e..b70f6c8d7 100644
--- a/utilities/ovs-vsctl.8.in
+++ b/utilities/ovs-vsctl.8.in
@@ -126,6 +126,14 @@ Tests whether \fIbridge\fR exists as a real or fake bridge.  If so,
 \fBovs\-vsctl\fR exits successfully with exit code 0.  If not,
 \fBovs\-vsctl\fR exits unsuccessfully with exit code 2.
 .
+.IP "\fBbr\-to\-vlan \fIbridge\fR"
+If \fIbridge\fR is a fake bridge, prints the bridge's 802.1Q VLAN as a
+decimal integer.  If \fIbridge\fR is a real bridge, prints 0.
+.
+.IP "\fBbr\-to\-parent \fIbridge\fR"
+If \fIbridge\fR is a fake bridge, prints the name of its parent
+bridge.  If \fIbridge\fR is a real bridge, print \fIbridge\fR.
+.
 .SS "Port Commands"
 .
 These commands examine and manipulate Open vSwitch ports.  These
-- 
2.43.0