]> git.proxmox.com Git - ovs.git/blame - tests/ofproto-macros.at
tests: Convert ovsdb-monitor-sort utility from Perl to Python.
[ovs.git] / tests / ofproto-macros.at
CommitLineData
254750ce
BP
1m4_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.
5ofctl_strip () {
6 sed '
7s/ (xid=0x[0-9a-fA-F]*)//
8s/ duration=[0-9.]*s,//
9s/ cookie=0x0,//
10s/ table=0,//
11s/ n_packets=0,//
12s/ n_bytes=0,//
b9718b7b
BP
13s/ idle_age=[0-9]*,//
14s/ hard_age=[0-9]*,//
e2167cb7
AZ
15s/dp_hash=0x[0-9a-f]*\//dp_hash=0x0\//
16s/recirc_id=0x[0-9a-f]*,/recirc_id=0x0,/
25070e04
JR
17s/[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]T[0-9][0-9]:[0-9][0-9]:[0-9][0-9]Z|//
18s/dir\/[0-9]*\/br0.mgmt/dir\/XXXX\/br0.mgmt/
254750ce 19'
1e04fcc8
BP
20}
21
db5076ee 22# Filter (multiline) vconn debug messages from ovs-vswitchd.log.
12e2ba2e 23# Use with vconn_sub() and ofctl_strip()
db5076ee
JR
24print_vconn_debug () { awk -F\| < ovs-vswitchd.log '
25BEGIN { prt=0 }
26/\|vconn\|DBG\|/ { sub(/[ \t]*$/, ""); print $3 "|" $4 "|" $5; prt=1; next }
27$4 != "" { prt=0; next }
28prt==1 { sub(/[ \t]*$/, ""); print $0 }
29'
30}
31
12e2ba2e 32vconn_sub() {
7da07bce
GS
33 sed '
34s/tcp:127.0.0.1:[0-9][0-9]*:/unix:/
7da07bce
GS
35'
36}
fb28ef2d 37]
7da07bce 38
fb28ef2d 39# PARSE_LISTENING_PORT LOGFILE VARIABLE
1e04fcc8 40#
fb28ef2d
BP
41# Parses the TCP or SSL port on which a server is listening from
42# LOGFILE, given that the server was told to listen on a kernel-chosen
43# port, and assigns the port number to shell VARIABLE. You should
44# specify the listening remote as ptcp:0:127.0.0.1 or
e731d71b 45# pssl:0:127.0.0.1, or the equivalent with [::1] instead of 127.0.0.1.
1e04fcc8
BP
46#
47# Here's an example of how to use this with ovsdb-server:
48#
1e04fcc8 49# ovsdb-server --log-file --remote=ptcp:0:127.0.0.1 ...
fb28ef2d
BP
50# PARSE_LISTENING_PORT([ovsdb-server.log], [TCP_PORT])
51# # Now $TCP_PORT holds the listening port.
52m4_define([PARSE_LISTENING_PORT],
53 [OVS_WAIT_UNTIL([$2=`sed -n 's/.*0:.*: listening on port \([[0-9]]*\)$/\1/p' "$1"` && test X != X"[$]$2"])])
f295c17b
BP
54
55start_daemon () {
56 "$@" -vconsole:off --detach --no-chdir --pidfile --log-file
57 pid=`cat "$OVS_RUNDIR"/$1.pid`
58 on_exit "kill $pid"
59}
60
61# sim_add SANDBOX
62#
63# Starts a new simulated Open vSwitch instance named SANDBOX. Files related to
64# the instance, such as logs, databases, sockets, and pidfiles, are created in
65# a subdirectory of the main test directory also named SANDBOX. Afterward, the
66# "as" command (see below) can be used to run Open vSwitch utilities in the
67# context of the new sandbox.
68#
69# The new sandbox starts out without any bridges. Use ovs-vsctl in the context
70# of the new sandbox to create a bridge, e.g.:
71#
72# sim_add hv0 # Create sandbox hv0.
73# as hv0 # Set hv0 as default sandbox.
74# ovs-vsctl add-br br0 # Add bridge br0 inside hv0.
75#
76# or:
77#
78# sim_add hv0
79# as hv0 ovs-vsctl add-br br0
80sims=
81sim_add () {
82 echo "adding simulator '$1'"
83
84 sims="$sims $1"
85
86 # Create sandbox.
87 local d="$ovs_base"/$1
88 mkdir "$d" || return 1
89 ovs_setenv $1
90
91 # Create database and start ovsdb-server.
92 : > "$d"/.conf.db.~lock~
93 as $1 ovsdb-tool create "$d"/conf.db "$abs_top_srcdir"/vswitchd/vswitch.ovsschema || return 1
94 as $1 start_daemon ovsdb-server --remote=punix:"$d"/db.sock || return 1
95
96 # Initialize database.
97 as $1 ovs-vsctl --no-wait -- init || return 1
98
99 # Start ovs-vswitchd
bb338451 100 as $1 start_daemon ovs-vswitchd --enable-dummy=system -vvconn -vofproto_dpif -vunixctl
f295c17b
BP
101}
102
103# "as $1" sets the OVS_*DIR environment variables to point to $ovs_base/$1.
104#
105# "as $1 COMMAND..." sets those variables in a subshell and invokes COMMAND
106# there.
107as() {
5074bfc4 108 if test "X$2" != X; then
dc5a1213 109 (ovs_setenv $1; shift; "$@")
f295c17b
BP
110 else
111 ovs_setenv $1
112 fi
113}
114
7a8f15e0
LR
115# OVN_CLEANUP_VSWITCH(sim)
116#
117# Gracefully terminate vswitch daemons in the
118# specified sandbox.
119m4_define([OVN_CLEANUP_VSWITCH],[
120 as $1
121 OVS_APP_EXIT_AND_WAIT([ovs-vswitchd])
122 OVS_APP_EXIT_AND_WAIT([ovsdb-server])
123])
124
125# OVN_CLEANUP_SBOX(sbox)
126#
127# Gracefully terminate OVN daemons in the specified
128# sandbox instance. The sandbox name "vtep" is treated
129# as a special case, and is assumed to have ovn-controller-vtep
130# and ovs-vtep daemons running instead of ovn-controller.
131m4_define([OVN_CLEANUP_SBOX],[
132 as $1
133 if test "$1" = "vtep"; then
134 OVS_APP_EXIT_AND_WAIT([ovn-controller-vtep])
135 OVS_APP_EXIT_AND_WAIT([ovs-vtep])
136 else
137 OVS_APP_EXIT_AND_WAIT([ovn-controller])
138 fi
139 OVN_CLEANUP_VSWITCH([$1])
140])
141
142# OVN_CLEANUP(sim [, sim ...])
143#
144# Gracefully terminate all OVN daemons, including those in the
145# specified sandbox instances.
146m4_define([OVN_CLEANUP],[
147 m4_foreach([sbox], [$@], [
148 OVN_CLEANUP_SBOX([sbox])
149 ])
150 as ovn-sb
151 OVS_APP_EXIT_AND_WAIT([ovsdb-server])
152
153 as ovn-nb
154 OVS_APP_EXIT_AND_WAIT([ovsdb-server])
155
156 as northd
157 OVS_APP_EXIT_AND_WAIT([ovn-northd])
158
46a54ce7
RB
159 as northd-backup
160 OVS_APP_EXIT_AND_WAIT([ovn-northd])
161
7a8f15e0
LR
162 OVN_CLEANUP_VSWITCH([main])
163])
164
4b2b1a5e
BP
165# ovn_init_db DATABASE
166#
cce9c163
BP
167# Creates and initializes the given DATABASE (one of "ovn-sb" or "ovn-nb"),
168# starts its ovsdb-server instance, and sets the appropriate environment
169# variable (OVN_SB_DB or OVN_NB_DB) so that ovn-sbctl or ovn-nbctl uses the
170# database by default.
4b2b1a5e
BP
171#
172# Usually invoked from ovn_start.
173ovn_init_db () {
174 echo "creating $1 database"
175 local d=$ovs_base/$1
176 mkdir "$d" || return 1
177 : > "$d"/.$1.db.~lock~
178 as $1 ovsdb-tool create "$d"/$1.db "$abs_top_srcdir"/ovn/$1.ovsschema
179 as $1 start_daemon ovsdb-server --remote=punix:"$d"/$1.sock "$d"/$1.db
cce9c163
BP
180 local var=`echo $1_db | tr a-z- A-Z_`
181 AS_VAR_SET([$var], [unix:$ovs_base/$1/$1.sock]); export $var
4b2b1a5e
BP
182}
183
f295c17b
BP
184# ovn_start
185#
186# Creates and initializes ovn-sb and ovn-nb databases and starts their
cce9c163
BP
187# ovsdb-server instance, sets appropriate environment variables so that
188# ovn-sbctl and ovn-nbctl use them by default, and starts ovn-northd running
189# against them.
f295c17b 190ovn_start () {
fa183acc
BP
191 ovn_init_db ovn-sb; ovn-sbctl init
192 ovn_init_db ovn-nb; ovn-nbctl init
f295c17b 193
f295c17b
BP
194 echo "starting ovn-northd"
195 mkdir "$ovs_base"/northd
196 as northd start_daemon ovn-northd \
197 --ovnnb-db=unix:"$ovs_base"/ovn-nb/ovn-nb.sock \
198 --ovnsb-db=unix:"$ovs_base"/ovn-sb/ovn-sb.sock
46a54ce7
RB
199
200 echo "starting backup ovn-northd"
201 mkdir "$ovs_base"/northd-backup
202 as northd-backup start_daemon ovn-northd \
203 --ovnnb-db=unix:"$ovs_base"/ovn-nb/ovn-nb.sock \
204 --ovnsb-db=unix:"$ovs_base"/ovn-sb/ovn-sb.sock
f295c17b
BP
205}
206
207# Interconnection networks.
208#
209# When multiple sandboxed Open vSwitch instances exist, one will inevitably
210# want to connect them together. These commands allow for that. Conceptually,
211# an interconnection network is a switch for which these functions make it easy
212# to plug into other switches in other sandboxed Open vSwitch instances.
213# Interconnection networks are implemented as bridges in a switch named "main",
214# so to use interconnection networks please avoid working with that switch
215# directly.
216
217# net_add NETWORK
218#
219# Creates a new interconnection network named NETWORK.
220net_add () {
221 test -d "$ovs_base"/main || sim_add main || return 1
222 as main ovs-vsctl add-br "$1"
223}
224
225# net_attach NETWORK BRIDGE
226#
227# Adds a new port to BRIDGE in the default sandbox (as set with as()) and plugs
228# it into the NETWORK interconnection network. NETWORK must already have been
229# created by a previous invocation of net_add. The default sandbox must not be
230# "main".
231net_attach () {
232 local net=$1 bridge=$2
233
234 local port=${sandbox}_$bridge
235 as main ovs-vsctl \
236 -- add-port $net $port \
237 -- set Interface $port options:pstream="punix:$ovs_base/main/$port.sock" options:rxq_pcap="$ovs_base/main/$port-rx.pcap" options:tx_pcap="$ovs_base/main/$port-tx.pcap" \
238 || return 1
239
240 ovs-vsctl \
241 -- set Interface $bridge options:tx_pcap="$ovs_base/$sandbox/$bridge-tx.pcap" options:rxq_pcap="$ovs_base/$sandbox/$bridge-rx.pcap" \
242 -- add-port $bridge ${bridge}_$net \
243 -- set Interface ${bridge}_$net options:stream="unix:$ovs_base/main/$port.sock" options:rxq_pcap="$ovs_base/$sandbox/${bridge}_$net-rx.pcap" options:tx_pcap="$ovs_base/$sandbox/${bridge}_$net-tx.pcap" \
244 || return 1
245}
246
247# ovn_attach NETWORK BRIDGE IP [MASKLEN]
248#
249# First, this command attaches BRIDGE to interconnection network NETWORK, just
250# like "net_attach NETWORK BRIDGE". Second, it configures (simulated) IP
251# address IP (with network mask length MASKLEN, which defaults to 24) on
252# BRIDGE. Finally, it configures the Open vSwitch database to work with OVN
253# and starts ovn-controller.
254ovn_attach() {
255 local net=$1 bridge=$2 ip=$3 masklen=${4-24}
256 net_attach $net $bridge || return 1
257
258 mac=`ovs-vsctl get Interface $bridge mac_in_use | sed s/\"//g`
259 arp_table="$arp_table $sandbox,$bridge,$ip,$mac"
260 ovs-appctl netdev-dummy/ip4addr $bridge $ip/$masklen >/dev/null || return 1
261 ovs-appctl ovs/route/add $ip/$masklen $bridge >/dev/null || return 1
262 ovs-vsctl \
263 -- set Open_vSwitch . external-ids:system-id=$sandbox \
264 -- set Open_vSwitch . external-ids:ovn-remote=unix:$ovs_base/ovn-sb/ovn-sb.sock \
eb6b08eb 265 -- set Open_vSwitch . external-ids:ovn-encap-type=geneve,vxlan \
f295c17b
BP
266 -- set Open_vSwitch . external-ids:ovn-encap-ip=$ip \
267 -- add-br br-int \
268 -- set bridge br-int fail-mode=secure other-config:disable-in-band=true \
269 || return 1
270 start_daemon ovn-controller || return 1
271}
272
273# ovn_populate_arp
274#
275# This pre-populates the ARP tables of all of the OVN instances that have been
276# started with ovn_attach(). That means that packets sent from one hypervisor
277# to another never get dropped or delayed by ARP resolution, which makes
278# testing easier.
279ovn_populate_arp() {
280 for e1 in $arp_table; do
281 set `echo $e1 | sed 's/,/ /g'`; sb1=$1 br1=$2 ip=$3 mac=$4
282 for e2 in $arp_table; do
283 set `echo $e2 | sed 's/,/ /g'`; sb2=$1 br2=$2
284 if test $sb1,$br1 != $sb2,$br2; then
53902038 285 as $sb2 ovs-appctl tnl/neigh/set $br2 $ip $mac
f295c17b
BP
286 fi
287 done
288 done
289}
8a32aaa5
BP
290
291# Strips 'xid=0x1234' from ovs-ofctl output.
292strip_xids () {
293 sed 's/ (xid=0x[[0-9a-fA-F]]*)//'
294}
3a18d0c2
BP
295
296# Changes all 'used:...' to say 'used:0.0', to make output easier to compare.
297strip_used () {
298 sed 's/used:[[0-9]]\.[[0-9]]*/used:0.0/'
299}
300
301# Strips 'ufid:...' from output, to make it easier to compare.
302# (ufids are random.)
303strip_ufid () {
304 sed 's/ufid:[[-0-9a-f]]* //'
305}
254750ce
BP
306m4_divert_pop([PREPARE_TESTS])
307
01b389b1 308m4_define([TESTABLE_LOG], [-vPATTERN:ANY:'%c|%p|%m'])
0fbc9f11 309
02e6f2f7 310# _OVS_VSWITCHD_START([vswitchd-aux-args])
9da5b93a 311#
02e6f2f7
AZ
312# Creates an empty database and starts ovsdb-server.
313# Starts ovs-vswitchd, with additional arguments 'vswitchd-aux-args'.
1c3e353d 314#
02e6f2f7 315m4_define([_OVS_VSWITCHD_START],
6132b241 316 [dnl Create database.
fda1672c 317 touch .conf.db.~lock~
f973f2af 318 AT_CHECK([ovsdb-tool create conf.db $abs_top_srcdir/vswitchd/vswitch.ovsschema])
04c956fc
BP
319
320 dnl Start ovsdb-server.
77a922c7 321 AT_CHECK([ovsdb-server --detach --no-chdir --pidfile --log-file --remote=punix:$OVS_RUNDIR/db.sock], [0], [], [stderr])
53eb8cb8 322 on_exit "kill `cat ovsdb-server.pid`"
08b9b190
EJ
323 AT_CHECK([[sed < stderr '
324/vlog|INFO|opened log file/d
325/ovsdb_server|INFO|ovsdb-server (Open vSwitch)/d']])
04c956fc
BP
326 AT_CAPTURE_FILE([ovsdb-server.log])
327
328 dnl Initialize database.
fe5ca4a7 329 AT_CHECK([ovs-vsctl --no-wait init $2])
04c956fc
BP
330
331 dnl Start ovs-vswitchd.
bb338451 332 AT_CHECK([ovs-vswitchd $1 --detach --no-chdir --pidfile --log-file -vvconn -vofproto_dpif -vunixctl], [0], [], [stderr])
04c956fc 333 AT_CAPTURE_FILE([ovs-vswitchd.log])
7689bcf0 334 on_exit "kill_ovs_vswitchd `cat ovs-vswitchd.pid`"
04c956fc 335 AT_CHECK([[sed < stderr '
7c5a3bbf 336/ovs_numa|INFO|Discovered /d
04c956fc 337/vlog|INFO|opened log file/d
08b9b190 338/vswitchd|INFO|ovs-vswitchd (Open vSwitch)/d
04c956fc 339/reconnect|INFO|/d
04c956fc 340/ofproto|INFO|using datapath ID/d
c9697f35 341/netdev_linux|INFO|.*device has unknown hardware address family/d
bab69409 342/ofproto|INFO|datapath ID changed to fedcba9876543210/d
fe5ca4a7
PB
343/dpdk|INFO|DPDK Disabled - Use other_config:dpdk-init to enable/d
344/netdev: Flow API/d
345/tc: Using policy/d']])
02e6f2f7
AZ
346])
347
f7cfe5c2
DDP
348# OVS_VSWITCHD_START([vsctl-args], [vsctl-output], [=override],
349# [vswitchd-aux-args])
02e6f2f7
AZ
350#
351# Creates a database and starts ovsdb-server, starts ovs-vswitchd
352# connected to that database, calls ovs-vsctl to create a bridge named
353# br0 with predictable settings, passing 'vsctl-args' as additional
354# commands to ovs-vsctl. If 'vsctl-args' causes ovs-vsctl to provide
355# output (e.g. because it includes "create" commands) then 'vsctl-output'
c724bd67 356# specifies the expected output after filtering through uuidfilt.
02e6f2f7
AZ
357#
358# If a test needs to use "system" devices (as dummies), then specify
359# =override (literally) as the third argument. Otherwise, system devices
360# won't work at all (which makes sense because tests should not access a
361# system's real Ethernet devices).
f7cfe5c2
DDP
362#
363# 'vswitchd-aux-args' provides a way to pass extra command line arguments
364# to ovs-vswitchd
02e6f2f7 365m4_define([OVS_VSWITCHD_START],
f7cfe5c2 366 [_OVS_VSWITCHD_START([--enable-dummy$3 --disable-system $4])
c724bd67 367 AT_CHECK([add_of_br 0 $1 m4_if([$2], [], [], [| uuidfilt])], [0], [$2])
04c956fc
BP
368])
369
cadf7ec9
AW
370# check_logs scans through all *.log files (except '*.log' and testsuite.log)
371# and reports all WARN, ERR, EMER log entries. User can add custom sed filters
372# in $1.
6e1fb7e1
BP
373m4_divert_push([PREPARE_TESTS])
374check_logs () {
cadf7ec9
AW
375 local logs
376 for log in *.log; do
377 case ${log} in # (
378 '*.log'|testsuite.log) ;; # (
379 *) logs="${logs} ${log}" ;;
380 esac
381 done
382
6e1fb7e1 383 sed -n "$1
98b07853
BP
384/timeval.*Unreasonably long [[0-9]]*ms poll interval/d
385/timeval.*faults: [[0-9]]* minor, [[0-9]]* major/d
386/timeval.*disk: [[0-9]]* reads, [[0-9]]* writes/d
387/timeval.*context switches: [[0-9]]* voluntary, [[0-9]]* involuntary/d
e45d584e 388/ovs_rcu.*blocked [[0-9]]* ms waiting for .* to quiesce/d
6e1fb7e1
BP
389/|WARN|/p
390/|ERR|/p
cadf7ec9 391/|EMER|/p" ${logs}
6e1fb7e1 392}
ca5792f0 393
77ab5fd2
BP
394# add_of_br BRNUM [ARG...]
395add_of_br () {
396 local brnum=$1; shift
397 local br=br$brnum
398 local dpid=fedcba987654321$brnum
399 local mac=aa:55:aa:55:00:0$brnum
7ae1f322 400 ovs-vsctl --timeout=20 \
77ab5fd2
BP
401 -- add-br $br \
402 -- set bridge $br datapath-type=dummy \
403 fail-mode=secure \
404 other-config:datapath-id=$dpid \
405 other-config:hwaddr=$mac \
406 protocols="[[OpenFlow10,OpenFlow11,OpenFlow12,\
b79d45a1
BP
407 OpenFlow13,OpenFlow14,OpenFlow15,\
408 OpenFlow16]]" \
77ab5fd2
BP
409 -- "$@"
410}
411
e539ba87 412# add_of_ports__ PORT_TYPE [--pcap] BRIDGE PNUM...
ca5792f0 413#
e539ba87 414# Creates PORT_TYPE interfaces in BRIDGE named pPNUM, OpenFlow port number
ca5792f0
BP
415# PNUM, and datapath port number PNUM (the latter is a consequence of
416# the dummy implementation, which tries to assign datapath port
417# numbers based on port names).
77ab5fd2
BP
418#
419# If --pcap is supplied then packets received from the interface will
420# be written to $port-rx.pcap and those sent to it to $port-tx.pcap.
e539ba87 421add_of_ports__ () {
ca5792f0 422 local args
77ab5fd2 423 local pcap=false
e539ba87
IM
424 local ptype=$1
425 shift
77ab5fd2
BP
426 if test "$1" = --pcap; then
427 pcap=:
e539ba87 428 shift
77ab5fd2 429 fi
ca5792f0 430 local br=$1; shift
31a6d029 431 for pnum; do
e539ba87
IM
432 AS_VAR_APPEND([args], [" -- add-port $br p$pnum -- set Interface p$pnum type=$ptype ofport_request=$pnum"])
433 if $pcap; then
434 AS_VAR_APPEND([args], [" -- set Interface p$pnum options:rxq_pcap=p$pnum-rx.pcap options:tx_pcap=p$pnum-tx.pcap"])
435 fi
ca5792f0 436 done
77ab5fd2 437 echo ovs-vsctl $args
ca5792f0
BP
438 ovs-vsctl $args
439}
e539ba87
IM
440
441# add_of_ports [--pcap] BRIDGE PNUM...
442#
443add_of_ports () {
444 add_of_ports__ dummy $@
445}
446
447# add_pmd_of_ports [--pcap] BRIDGE PNUM...
448#
449add_pmd_of_ports () {
450 add_of_ports__ dummy-pmd $@
451}
452
6e1fb7e1
BP
453m4_divert_pop([PREPARE_TESTS])
454
455# OVS_VSWITCHD_STOP([WHITELIST])
456#
457# Gracefully stops ovs-vswitchd and ovsdb-server, checking their log files
458# for messages with severity WARN or higher and signaling an error if any
459# is present. The optional WHITELIST may contain shell-quoted "sed"
460# commands to delete any warnings that are actually expected, e.g.:
461#
462# OVS_VSWITCHD_STOP(["/expected error/d"])
04c956fc 463m4_define([OVS_VSWITCHD_STOP],
6e1fb7e1 464 [AT_CHECK([check_logs $1])
d9c8c57c
LR
465 OVS_APP_EXIT_AND_WAIT([ovs-vswitchd])
466 OVS_APP_EXIT_AND_WAIT([ovsdb-server])])
f7b8e494 467
a36de779 468m4_define([OVS_VSWITCHD_DISABLE_TUNNEL_PUSH_POP],
80dc5c84
AZ
469 [AT_CHECK([ovs-appctl dpif/set-dp-features br0 tnl_push_pop false], [0])
470])
a36de779 471
76c22ad5
AZ
472# WAIT_FOR_DUMMY_PORTS(NETDEV_DUMMY_PORT[, NETDEV_DUMMY_PORT...])
473#
474# Wait until the netdev dummy ports are connected to each other
475m4_define([WAIT_FOR_DUMMY_PORTS], \
476 [m4_foreach([dummy_port], [$@],
477 [ \
478 OVS_WAIT_WHILE([ovs-appctl netdev-dummy/conn-state dummy_port \
479 | grep 'unknown\|disconnected'])])])
ca3574d5 480
ca3574d5 481