SECURITY.md: LTS branches triggers version release
[cascardo/ovs.git] / tests / ofproto-macros.at
1 m4_divert_push([PREPARE_TESTS])
2 [
3 # Strips out uninteresting parts of ovs-ofctl output, as well as parts
4 # that vary from one run to another.
5 ofctl_strip () {
6     sed '
7 s/ (xid=0x[0-9a-fA-F]*)//
8 s/ duration=[0-9.]*s,//
9 s/ cookie=0x0,//
10 s/ table=0,//
11 s/ n_packets=0,//
12 s/ n_bytes=0,//
13 s/ idle_age=[0-9]*,//
14 s/ hard_age=[0-9]*,//
15 '
16 }
17
18 # parse_listening_port [SERVER]
19 #
20 # Parses the TCP or SSL port on which a server is listening from the
21 # log, given that the server was told to listen on a kernel-chosen
22 # port, file provided on stdin, and prints the port number on stdout.
23 # You should specify the listening remote as ptcp:0:127.0.0.1 or
24 # pssl:0:127.0.0.1, or the equivalent with [::1] instead of 127.0.0.1.
25 #
26 # Here's an example of how to use this with ovsdb-server:
27 #
28 #    OVS_LOGDIR=`pwd`; export OVS_LOGDIR
29 #    ovsdb-server --log-file --remote=ptcp:0:127.0.0.1 ...
30 #    TCP_PORT=`parse_listening_port < ovsdb-server.log`
31 parse_listening_port () {
32     sed -n 's/.*0:.*: listening on port \([0-9]*\)$/\1/p'
33 }]
34 m4_divert_pop([PREPARE_TESTS])
35
36 m4_define([STRIP_XIDS], [[sed 's/ (xid=0x[0-9a-fA-F]*)//']])
37 m4_define([STRIP_DURATION], [[sed 's/\bduration=[0-9.]*s/duration=?s/']])
38 m4_define([STRIP_USED], [[sed 's/used:[0-9]\.[0-9]*/used:0.0/']])
39 m4_define([STRIP_UFID], [[sed 's/ufid:[0-9a-f]* //']])
40 m4_define([TESTABLE_LOG], [-vPATTERN:ANY:'%c|%p|%m'])
41
42 # OVS_VSWITCHD_START([vsctl-args], [vsctl-output], [=override])
43 #
44 # Creates a database and starts ovsdb-server, starts ovs-vswitchd
45 # connected to that database, calls ovs-vsctl to create a bridge named
46 # br0 with predictable settings, passing 'vsctl-args' as additional
47 # commands to ovs-vsctl.  If 'vsctl-args' causes ovs-vsctl to provide
48 # output (e.g. because it includes "create" commands) then 'vsctl-output'
49 # specifies the expected output after filtering through uuidfilt.pl.
50 #
51 # If a test needs to use "system" devices (as dummies), then specify
52 # =override (literally) as the third argument.  Otherwise, system devices
53 # won't work at all (which makes sense because tests should not access a
54 # system's real Ethernet devices).
55 m4_define([OVS_VSWITCHD_START],
56   [OVS_RUNDIR=`pwd`; export OVS_RUNDIR
57    OVS_LOGDIR=`pwd`; export OVS_LOGDIR
58    OVS_DBDIR=`pwd`; export OVS_DBDIR
59    OVS_SYSCONFDIR=`pwd`; export OVS_SYSCONFDIR
60    ON_EXIT([kill `cat ovsdb-server.pid ovs-vswitchd.pid`])
61
62    dnl Create database.
63    touch .conf.db.~lock~
64    AT_CHECK([ovsdb-tool create conf.db $abs_top_srcdir/vswitchd/vswitch.ovsschema])
65
66    dnl Start ovsdb-server.
67    AT_CHECK([ovsdb-server --detach --no-chdir --pidfile --log-file --remote=punix:$OVS_RUNDIR/db.sock], [0], [], [stderr])
68    AT_CHECK([[sed < stderr '
69 /vlog|INFO|opened log file/d
70 /ovsdb_server|INFO|ovsdb-server (Open vSwitch)/d']])
71    AT_CAPTURE_FILE([ovsdb-server.log])
72
73    dnl Initialize database.
74    AT_CHECK([ovs-vsctl --no-wait init])
75
76    dnl Start ovs-vswitchd.
77    AT_CHECK([ovs-vswitchd --detach --no-chdir --pidfile --enable-dummy$3 --disable-system --log-file -vvconn -vofproto_dpif], [0], [], [stderr])
78    AT_CAPTURE_FILE([ovs-vswitchd.log])
79    AT_CHECK([[sed < stderr '
80 /ovs_numa|INFO|Discovered /d
81 /vlog|INFO|opened log file/d
82 /vswitchd|INFO|ovs-vswitchd (Open vSwitch)/d
83 /reconnect|INFO|/d
84 /ofproto|INFO|using datapath ID/d
85 /ofproto|INFO|datapath ID changed to fedcba9876543210/d']])
86
87    dnl Add bridges, ports, etc.
88    AT_CHECK([ovs-vsctl -- add-br br0 -- set bridge br0 datapath-type=dummy other-config:datapath-id=fedcba9876543210 other-config:hwaddr=aa:55:aa:55:00:00 protocols=[[OpenFlow10,OpenFlow11,OpenFlow12,OpenFlow13,OpenFlow14,OpenFlow15]] fail-mode=secure -- $1 m4_if([$2], [], [], [| ${PERL} $srcdir/uuidfilt.pl])], [0], [$2])
89 ])
90
91 m4_divert_push([PREPARE_TESTS])
92 check_logs () {
93     sed -n "$1
94 /timeval.*Unreasonably long [[0-9]]*ms poll interval/d
95 /timeval.*faults: [[0-9]]* minor, [[0-9]]* major/d
96 /timeval.*disk: [[0-9]]* reads, [[0-9]]* writes/d
97 /timeval.*context switches: [[0-9]]* voluntary, [[0-9]]* involuntary/d
98 /ovs_rcu.*blocked [[0-9]]* ms waiting for .* to quiesce/d
99 /|WARN|/p
100 /|ERR|/p
101 /|EMER|/p" ovs-vswitchd.log ovsdb-server.log
102 }
103 m4_divert_pop([PREPARE_TESTS])
104
105 # OVS_VSWITCHD_STOP([WHITELIST])
106 #
107 # Gracefully stops ovs-vswitchd and ovsdb-server, checking their log files
108 # for messages with severity WARN or higher and signaling an error if any
109 # is present.  The optional WHITELIST may contain shell-quoted "sed"
110 # commands to delete any warnings that are actually expected, e.g.:
111 #
112 #   OVS_VSWITCHD_STOP(["/expected error/d"])
113 m4_define([OVS_VSWITCHD_STOP],
114   [AT_CHECK([check_logs $1])
115    AT_CHECK([ovs-appctl -t ovs-vswitchd exit])
116    AT_CHECK([ovs-appctl -t ovsdb-server exit])])
117
118 m4_define([OVS_VSWITCHD_DISABLE_TUNNEL_PUSH_POP],
119   [AT_CHECK([ovs-appctl ofproto/tnl-push-pop off], [0], [dnl
120 Tunnel push-pop off
121 ])])
122
123   [AT_CHECK([ovs-appctl ofproto/tnl-push-pop off])])
124
125 # ADD_OF_PORTS(BRIDGE, OF_PORT[, OF_PORT...])
126 #
127 # Creates a dummy interface with an OpenFlow port number of OF_PORT and
128 # name of p{OF_PORT}.  The dummy implementation will treat the OF_PORT
129 # as the datapath port number, which as the effect of making the
130 # OpenFlow and datapath numbers the same.
131 m4_define([ADD_OF_PORTS],
132  [ovs-vsctl m4_foreach([of_port], m4_cdr($@),
133     [ \
134     -- add-port $1 p[]of_port -- set Interface p[]of_port type=dummy ofport_request=of_port])])
135
136 # WAIT_FOR_DUMMY_PORTS(NETDEV_DUMMY_PORT[, NETDEV_DUMMY_PORT...])
137 #
138 # Wait until the netdev dummy ports are connected to each other
139 m4_define([WAIT_FOR_DUMMY_PORTS], \
140   [m4_foreach([dummy_port], [$@],
141       [  \
142          OVS_WAIT_WHILE([ovs-appctl netdev-dummy/conn-state dummy_port \
143                   | grep 'unknown\|disconnected'])])])