README-OFTest

   1                  How to Use OFTest With Open vSwitch
   2                  ===================================
   3
   4 This document describes how to use the OFTest OpenFlow protocol
   5 testing suite with Open vSwitch in "dummy mode".  In this mode of
   6 testing, no packets travel across physical or virtual networks.
   7 Instead, Unix domain sockets stand in as simulated networks.  This
   8 simulation is imperfect, but it is much easier to set up, does not
   9 require extra physical or virtual hardware, and does not require
  10 supervisor privileges.
  11
  12 Prerequisites
  13 -------------
  14
  15 First, build Open vSwitch according to the instructions in INSTALL.
  16 You need not install it.
  17
  18 Second, obtain a copy of OFTest and install its prerequisites.  You
  19 need a copy of OFTest that includes commit 406614846c5 (make ovs-dummy
  20 platform work again).  This commit was merged into the OFTest
  21 repository on Feb 1, 2013, so any copy of OFTest more recent than that
  22 should work.
  23
  24 Testing OVS in dummy mode does not require root privilege, so you may
  25 ignore that requirement.
  26
  27 Optionally, add the top-level OFTest directory (containing the "oft"
  28 program) to your $PATH.  This slightly simplifies running OFTest later.
  29
  30 Running OFTest
  31 --------------
  32
  33 To run OFTest in dummy mode, run the following command from your Open
  34 vSwitch build directory:
  35
  36     make check-oftest OFT=<oft-binary>
  37
  38 where <oft-binary> is the absolute path to the "oft" program in
  39 OFTest.
  40
  41 If you added "oft" to your $PATH, you may omit the OFT variable
  42 assignment:
  43
  44     make check-oftest
  45
  46 By default, "check-oftest" passes "oft" just enough options to enable
  47 dummy mode.  You can use OFTFLAGS to pass additional options.  For
  48 example, to run just the basic.Echo test instead of all tests (the
  49 default) and enable verbose logging:
  50
  51     make check-oftest OFT=<oft-binary> OFTFLAGS='--verbose -T basic.Echo'
  52
  53 Interpreting OFTest Results
  54 ---------------------------
  55
  56 Please interpret OFTest results cautiously.  Open vSwitch can fail a
  57 given test in OFTest for many reasons, including bugs in Open vSwitch,
  58 bugs in OFTest, bugs in the "dummy mode" integration, and differing
  59 interpretations of the OpenFlow standard and other standards.
  60
  61 Open vSwitch has not been validated against OFTest.  Please do report
  62 test failures that you believe to represent bugs in Open vSwitch.
  63 Include the precise versions of Open vSwitch and OFTest in your bug
  64 report, plus any other information needed to reproduce the problem.
  65
  66 Contact
  67 -------
  68
  69 bugs@openvswitch.org
  70 http://openvswitch.org/