Integration tests
=================

VSPERF includes a set of integration tests defined in conf/integration.
These tests can be run by specifying --run-integration as a parameter to vsperf.
Current tests in conf/integration are Overlay tests.


Executing Tunnel encapsulation tests
------------------------------------

VSPERF supports VXLAN, GRE and GENEVE tunneling protocols.
Testing of these protocols is limited to unidirectional traffic and
P2P (Physical to Physical scenarios).

The VXLAN OVS DPDK encapsulation tests requires IPs, MAC addresses,
bridge names and WHITELIST_NICS for DPDK.

Default values are already provided. To customize for your environment, override
the following variables in you user_settings.py file:

# Variables defined in conf/integration/02_vswitch.conf
# Tunnel endpoint for Overlay P2P deployment scenario
# used for br0
VTEP_IP1 = '192.168.0.1/24'

# Used as remote_ip in adding OVS tunnel port and
# to set ARP entry in OVS (e.g. tnl/arp/set br-ext 192.168.240.10 02:00:00:00:00:02
VTEP_IP2 = '192.168.240.10'

# Network to use when adding a route for inner frame data
VTEP_IP2_SUBNET = '192.168.240.0/24'

# Bridge names
TUNNEL_INTEGRATION_BRIDGE = 'br0'
TUNNEL_EXTERNAL_BRIDGE = 'br-ext'

# IP of br-ext
TUNNEL_EXTERNAL_BRIDGE_IP = '192.168.240.1/24'

# vxlan|gre|geneve
TUNNEL_TYPE = 'vxlan'

# Variables defined conf/integration/03_traffic.conf
# For OP2P deployment scenario
TRAFFICGEN_PORT1_MAC = '02:00:00:00:00:01'
TRAFFICGEN_PORT2_MAC = '02:00:00:00:00:02'
TRAFFICGEN_PORT1_IP = '1.1.1.1'
TRAFFICGEN_PORT2_IP = '192.168.240.10'


To run VXLAN encapsulation tests:

  .. code-block:: console

     ./vsperf --conf-file user_settings.py --run-integration --test-param 'tunnel_type=vxlan' overlay_p2p_tput

To run GRE encapsulation tests:

  .. code-block:: console

     ./vsperf --conf-file user_settings.py --run-integration --test-param 'tunnel_type=gre' overlay_p2p_tput

To run GENEVE encapsulation tests:

  .. code-block:: console

     ./vsperf --conf-file user_settings.py --run-integration --test-param 'tunnel_type=geneve' overlay_p2p_tput

To run OVS NATIVE tunnel tests (VXLAN/GRE/GENEVE):

1. Install the OVS kernel modules

  .. code:: console

     cd src/ovs/ovs
     sudo -E make modules_install

2. Set the following variables:

  .. code-block:: console

   VSWITCH = 'OvsVanilla'
   VSWITCH_VANILLA_PHY_PORT_NAMES = ['nic1name', 'nic2name']
   # Specify vport_* kernel module to test.
   VSWITCH_VANILLA_KERNEL_MODULES = ['vport_vxlan',
                                     'vport_gre',
                                     'vport_geneve',
                                     os.path.join(OVS_DIR_VANILLA, 'datapath/linux/openvswitch.ko')]

3. Run tests:

  .. code-block:: console

     ./vsperf --conf-file user_settings.py --run-integration --test-param 'tunnel_type=vxlan' overlay_p2p_tput


Executing VXLAN decapsulation tests
------------------------------------

To run VXLAN decapsulation tests:

1. Set the variables used in "Executing Tunnel encapsulation tests"

2. Set IXNET_TCL_SCRIPT, VXLAN_FRAME_L2, VLXAN_FRAME_L3 and DUT_NIC1_MAC of your settings file to:

  .. code-block:: console

   IXNET_TCL_SCRIPT='ixnetrfc2544v2.tcl'

   VXLAN_FRAME_L2 = {'srcmac':
                     '01:02:03:04:05:06',
                     'dstmac':
                     '<DUT's NIC1 MAC>',
                    }

   VXLAN_FRAME_L3 = {'proto': 'udp',
                     'packetsize': 64,
                     'srcip': '1.1.1.1',
                     'dstip': '192.168.240.1',
                    }

   VXLAN_FRAME_L4 = {'srcport': 4789,
                     'dstport': 4789,
                     'vni': VXLAN_VNI,
                     'inner_srcmac': '01:02:03:04:05:06',
                     'inner_dstmac': '06:05:04:03:02:01',
                     'inner_srcip': '192.168.0.10',
                     'inner_dstip': '192.168.240.9',
                     'inner_proto': 'udp',
                     'inner_srcport': 3000,
                     'inner_dstport': 3001,
                    }

    # The receiving NIC of VXLAN traffic
    DUT_NIC1_MAC = '<mac address>'

3. Run test:

  .. code-block:: console

     ./vsperf --conf-file user_settings.py --run-integration overlay_p2p_decap_cont