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 # Filter (multiline) vconn debug messages from ovs-vswitchd.log.
  19 # Use with vconn_windows_sub() and ofctl_strip()
  20 print_vconn_debug () { awk -F\| < ovs-vswitchd.log '
  21 BEGIN { prt=0 }
  22 /\|vconn\|DBG\|/ { sub(/[ \t]*$/, ""); print $3 "|" $4 "|" $5; prt=1; next }
  23 $4 != "" { prt=0; next }
  24 prt==1 { sub(/[ \t]*$/, ""); print $0 }
  25 '
  26 }
  27
  28 vconn_windows_sub() {
  29     sed '
  30 s/tcp:127.0.0.1:[0-9][0-9]*:/unix:/
  31 s/No error/Success/
  32 '
  33 }
  34
  35 # parse_listening_port [SERVER]
  36 #
  37 # Parses the TCP or SSL port on which a server is listening from the
  38 # log, given that the server was told to listen on a kernel-chosen
  39 # port, file provided on stdin, and prints the port number on stdout.
  40 # You should specify the listening remote as ptcp:0:127.0.0.1 or
  41 # pssl:0:127.0.0.1, or the equivalent with [::1] instead of 127.0.0.1.
  42 #
  43 # Here's an example of how to use this with ovsdb-server:
  44 #
  45 #    ovsdb-server --log-file --remote=ptcp:0:127.0.0.1 ...
  46 #    TCP_PORT=`parse_listening_port < ovsdb-server.log`
  47 parse_listening_port () {
  48     sed -n 's/.*0:.*: listening on port \([0-9]*\)$/\1/p'
  49 }]
  50 m4_divert_pop([PREPARE_TESTS])
  51
  52 m4_define([STRIP_XIDS], [[sed 's/ (xid=0x[0-9a-fA-F]*)//']])
  53 m4_define([STRIP_DURATION], [[sed 's/\bduration=[0-9.]*s/duration=?s/']])
  54 m4_define([STRIP_USED], [[sed 's/used:[0-9]\.[0-9]*/used:0.0/']])
  55 m4_define([STRIP_UFID], [[sed 's/ufid:[-0-9a-f]* //']])
  56 m4_define([TESTABLE_LOG], [-vPATTERN:ANY:'%c|%p|%m'])
  57
  58 # _OVS_VSWITCHD_START([vswitchd-aux-args])
  59 #
  60 # Creates an empty database and starts ovsdb-server.
  61 # Starts ovs-vswitchd, with additional arguments 'vswitchd-aux-args'.
  62 #
  63 m4_define([_OVS_VSWITCHD_START],
  64   [dnl Create database.
  65    touch .conf.db.~lock~
  66    AT_CHECK([ovsdb-tool create conf.db $abs_top_srcdir/vswitchd/vswitch.ovsschema])
  67
  68    dnl Start ovsdb-server.
  69    AT_CHECK([ovsdb-server --detach --no-chdir --pidfile --log-file --remote=punix:$OVS_RUNDIR/db.sock], [0], [], [stderr])
  70     ON_EXIT_UNQUOTED([kill `cat ovsdb-server.pid`])
  71    AT_CHECK([[sed < stderr '
  72 /vlog|INFO|opened log file/d
  73 /ovsdb_server|INFO|ovsdb-server (Open vSwitch)/d']])
  74    AT_CAPTURE_FILE([ovsdb-server.log])
  75
  76    dnl Initialize database.
  77    AT_CHECK([ovs-vsctl --no-wait init])
  78
  79    dnl Start ovs-vswitchd.
  80    AT_CHECK([ovs-vswitchd $1 --detach --no-chdir --pidfile --log-file -vvconn -vofproto_dpif], [0], [], [stderr])
  81    AT_CAPTURE_FILE([ovs-vswitchd.log])
  82    ON_EXIT_UNQUOTED([kill `cat ovs-vswitchd.pid`])
  83    AT_CHECK([[sed < stderr '
  84 /ovs_numa|INFO|Discovered /d
  85 /vlog|INFO|opened log file/d
  86 /vswitchd|INFO|ovs-vswitchd (Open vSwitch)/d
  87 /reconnect|INFO|/d
  88 /ofproto|INFO|using datapath ID/d
  89 /ofproto|INFO|datapath ID changed to fedcba9876543210/d']])
  90 ])
  91
  92 # OVS_VSWITCHD_START([vsctl-args], [vsctl-output], [=override])
  93 #
  94 # Creates a database and starts ovsdb-server, starts ovs-vswitchd
  95 # connected to that database, calls ovs-vsctl to create a bridge named
  96 # br0 with predictable settings, passing 'vsctl-args' as additional
  97 # commands to ovs-vsctl.  If 'vsctl-args' causes ovs-vsctl to provide
  98 # output (e.g. because it includes "create" commands) then 'vsctl-output'
  99 # specifies the expected output after filtering through uuidfilt.pl.
 100 #
 101 # If a test needs to use "system" devices (as dummies), then specify
 102 # =override (literally) as the third argument.  Otherwise, system devices
 103 # won't work at all (which makes sense because tests should not access a
 104 # system's real Ethernet devices).
 105 m4_define([OVS_VSWITCHD_START],
 106   [_OVS_VSWITCHD_START([--enable-dummy$3 --disable-system])
 107
 108    dnl Add bridges, ports, etc.
 109    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])
 110 ])
 111
 112 # check_logs scans through all *.log files (except '*.log' and testsuite.log)
 113 # and reports all WARN, ERR, EMER log entries.  User can add custom sed filters
 114 # in $1.
 115 m4_divert_push([PREPARE_TESTS])
 116 check_logs () {
 117     local logs
 118     for log in *.log; do
 119         case ${log} in # (
 120             '*.log'|testsuite.log) ;; # (
 121             *) logs="${logs} ${log}" ;;
 122         esac
 123     done
 124
 125     sed -n "$1
 126 /timeval.*Unreasonably long [[0-9]]*ms poll interval/d
 127 /timeval.*faults: [[0-9]]* minor, [[0-9]]* major/d
 128 /timeval.*disk: [[0-9]]* reads, [[0-9]]* writes/d
 129 /timeval.*context switches: [[0-9]]* voluntary, [[0-9]]* involuntary/d
 130 /ovs_rcu.*blocked [[0-9]]* ms waiting for .* to quiesce/d
 131 /|WARN|/p
 132 /|ERR|/p
 133 /|EMER|/p" ${logs}
 134 }
 135 m4_divert_pop([PREPARE_TESTS])
 136
 137 # OVS_VSWITCHD_STOP([WHITELIST])
 138 #
 139 # Gracefully stops ovs-vswitchd and ovsdb-server, checking their log files
 140 # for messages with severity WARN or higher and signaling an error if any
 141 # is present.  The optional WHITELIST may contain shell-quoted "sed"
 142 # commands to delete any warnings that are actually expected, e.g.:
 143 #
 144 #   OVS_VSWITCHD_STOP(["/expected error/d"])
 145 m4_define([OVS_VSWITCHD_STOP],
 146   [AT_CHECK([check_logs $1])
 147    AT_CHECK([ovs-appctl -t ovs-vswitchd exit])
 148    AT_CHECK([ovs-appctl -t ovsdb-server exit])])
 149
 150 m4_define([OVS_VSWITCHD_DISABLE_TUNNEL_PUSH_POP],
 151   [AT_CHECK([ovs-appctl ofproto/tnl-push-pop off], [0], [dnl
 152 Tunnel push-pop off
 153 ])])
 154
 155 # ADD_OF_PORTS(BRIDGE, OF_PORT[, OF_PORT...])
 156 #
 157 # Creates a dummy interface with an OpenFlow port number of OF_PORT and
 158 # name of p{OF_PORT}.  The dummy implementation will treat the OF_PORT
 159 # as the datapath port number, which as the effect of making the
 160 # OpenFlow and datapath numbers the same.
 161 m4_define([ADD_OF_PORTS],
 162  [ovs-vsctl m4_foreach([of_port], m4_cdr($@),
 163     [ \
 164     -- add-port $1 p[]of_port -- set Interface p[]of_port type=dummy ofport_request=of_port])])
 165
 166 # WAIT_FOR_DUMMY_PORTS(NETDEV_DUMMY_PORT[, NETDEV_DUMMY_PORT...])
 167 #
 168 # Wait until the netdev dummy ports are connected to each other
 169 m4_define([WAIT_FOR_DUMMY_PORTS], \
 170   [m4_foreach([dummy_port], [$@],
 171       [  \
 172          OVS_WAIT_WHILE([ovs-appctl netdev-dummy/conn-state dummy_port \
 173                   | grep 'unknown\|disconnected'])])])