Skip to content

Latest commit

 

History

History
159 lines (119 loc) · 4.39 KB

readme.md

File metadata and controls

159 lines (119 loc) · 4.39 KB
Raw

Open Traffic Generator Conformance Tests

This repository hosts equivalent Go and Python tests written using snappi against a back-to-back connected ixia-c topology.

Prerequisites

  • Recommended OS is Ubuntu LTS release.
  • At least 2 CPU cores
  • At least 6GB RAM
  • At least 10GB Free Hard Disk Space
  • Go 1.17+ or Python 3.6+ (with pip)
  • Docker Engine (Community Edition)
  • License:
    • Test(s) in this repository which contain only 'flows' or 'bgp' would not require license with ixia-c.
    • License of ixia-c would be required for test(s) which use other control-plane protocols e.g. 'isis', 'lacp', "ospfv2" etc.
    • For further details, please refer to ixia-c licensing documentation or contact ixia-c support.

Usage:

  1. Clone this repository

    git clone https://github.com/open-traffic-generator/conformance.git && cd conformance

  2. Deploy topology

    # use DP-only distribution of ixia-c
./do.sh topo new dp

# use CP/DP distribution of ixia-c
# enter GITHUB PAT instead of password when prompted for credentials
./do.sh topo new cpdp

    Once deployment is done, test-config.yaml is automatically generated in present working directory and can be used to customize test run

  3. Setup and run Go tests

    # run all feature tests against DP-only distribution of ixia-c
./do.sh gotest -tags="dp" ./feature/b2b/...
# run all feature tests against CP/DP distribution of ixia-c
./do.sh gotest -tags="all" ./feature/b2b/...

# run single test
./do.sh gotest ./feature/b2b/packet/udp/udp_port_value_test.go

  4. Setup and run Python tests

    # setup test requirements
./do.sh prepytest

# run all tests against DP-only distribution of ixia-c
./do.sh pytest -m dp ./feature/b2b/
# run all tests against CP/DP distribution of ixia-c
./do.sh pytest ./feature/b2b/

# run single test
./do.sh pytest ./feature/b2b/packet/udp/test_udp_port_value.py

  5. Teardown topology

    # remove DP-only distribution of ixia-c
./do.sh topo rm dp

# remove CP/DP distribution of ixia-c
./do.sh topo rm cpdp

Advanced Usage:

  1. Format python code

    Note that if you submit any code which does not follow proper python format the CI will fail

    # to format python code
./do.sh pylint

# to format python code for a specific path
./do.sh pylint features

  2. Format go code

    Note that if you submit any code which does not follow proper go format the CI will fail

    # to format go code
./do.sh golint

# to format go code for a specific path
./do.sh golint helpers

  3. Run perf tests in Go

    # run single perf test
./do.sh gotest ./performance/b2b/udp_mesh_flows_perf_test.go
# run single perf test with lesser number of iterations (default=100)
OTG_ITERATIONS=2 ./do.sh gotest ./performance/b2b/udp_mesh_flows_perf_test.go

  4. Run tests against ixia-c B2B deployed on K8S cluster using eth0 as test interface

    # setup K8S cluster
./do.sh new_k8s_cluster
# create topology
./do.sh topo new k8seth0
# run single test
./do.sh gotest ./feature/b2b/packet/udp/udp_port_value_eth0_test.go
# delete topology
./do.sh topo rm k8seth0
# delete K8S cluster
./do.sh rm_k8s_cluster

  5. Run tests against KNE cluster (Back-To-Back)

    # setup KNE cluster
./do.sh new_k8s_cluster kne
# create KNE topology
./do.sh topo new kneb2b
# run all back-to-back feature tests
./do.sh gotest -tags="all" ./feature/b2b/...
# delete KNE topology
./do.sh topo rm kneb2b
# delete KNE cluster
./do.sh rm_k8s_cluster kne

  6. Run tests against KNE cluster (Port-Dut-Port)

    # setup KNE cluster
./do.sh new_k8s_cluster kne arista
# create KNE topology
./do.sh topo new knepdp arista
# run all port-dut-port feature tests
./do.sh gotest -tags="all" ./feature/pdp/...
# delete KNE topology
./do.sh topo rm knepdp arista
# delete KNE cluster
./do.sh rm_k8s_cluster kne arista