VPP 测试框架之使用示例及参数说明

def setUpConstants(cls):
    ...
    ...
    cls.vpp_cmdline = [
        config.vpp,
        "unix",
        "{",
        "nodaemon",
        debug_cli,
        "full-coredump",
        coredump_size,
        "runtime-dir",
        ...
    ]
    ...

class TestXXX(VppTestCase):
    extra_vpp_config = [
        "buffers { buffers-per-numa 4096}",
    ]
    ...
如果想开启/关闭某个插件，可以使用extra_vpp_plugin_config修改：
class TestXXX(VppTestCase):
    ...
    extra_vpp_plugin_config = [
        "plugin dtls_decoder_plugin.so {enable}",
        "plugin session_manager_plugin.so {enable}",
    ]
    ...

class TestXXX(VppTestCase):
    ...
    vpp_worker_count = 4
    ...

# 编译运行
make test-debug

# 重新运行失败的单元测试
make retest-debug

make test-debug TEST=handoff

# 测试handoff，同时gdb attach
make retest-debug TEST=handoff DEBUG=gdb

Running tests in foreground in the current process
==============================================================================
Spawned VPP with PID: 1116506
------------------------------------------------------------------------------
You can debug VPP using:
sudo gdb /data/code/vpp/build-root/install-vpp_debug-native/vpp/bin/vpp -ex 'attach 1116506'
Now is the time to attach gdb by running the above command and set up breakpoints etc., then resume VPP from within gdb by issuing the 'continue' command
------------------------------------------------------------------------------
Press ENTER to continue running the testcase...

gdb -p 1116506
(gdb) c
Continuing.

Handoff test [4 worker threads]
==============================================================================
Handoff test [CLI]                                                  17.44 ERROR [ temp dir used by test case: /tmp/vpp-unittest-TestHandoff ]
Handoff test [CLI]                                                  14.97 ERROR [ temp dir used by test case: /tmp/vpp-unittest-TestHandoff ]
test_handoff_symmetrical_l4_innermost_from_pcaps (test_handoff.TestHandoff) 16.19 ERROR [ temp dir used by test case: /tmp/vpp-unittest-TestHandoff ]
test_handoff_symmetrical_l4_outermost_from_pcaps (test_handoff.TestHandoff) 14.38 ERROR [ temp dir used by test case: /tmp/vpp-unittest-TestHandoff ]


# ls /tmp/vpp-unittest-TestHandoff -l
total 556
srwxrwxr-x. 1 root root      0 May 22 10:11  api.sock
-rw-r--r--. 1 root root 183287 May 22 10:21  log.txt
-rw-r--r--. 1 root root   8356 May 22 10:20  pcap-decode-suiteTestHandoff.txt
srwxrwxr-x. 1 root root      0 May 22 10:11  snort.sock
srwxrwxr-x. 1 root root      0 May 22 10:11  stats.sock
-rw-r--r--. 1 root root     82 May 22 10:20 'suiteTestHandoff.[timestamp:1747880421.73528147].pg0-inp-0000.pg0_in.pcap'
-rw-r--r--. 1 root root     82 May 22 10:20 'suiteTestHandoff.[timestamp:1747880421.77663755].pg0-out-0000.pg0_out.pcap'
-rw-r--r--. 1 root root     82 May 22 10:20 'suiteTestHandoff.[timestamp:1747880421.78589582].pg1-inp-0000.pg1_in.pcap'
-rw-r--r--. 1 root root     82 May 22 10:20 'suiteTestHandoff.[timestamp:1747880421.81018996].pg1-out-0000.pg1_out.pcap'
-rw-r--r--. 1 root root  85414 May 22 10:20  vpp_api_trace.test_handoff_cli.1116506.log
-rw-r--r--. 1 root root  86036 May 22 10:20  vpp_api_trace.test_handoff_symmetrical_cli.1116506.log
-rw-r--r--. 1 root root  86691 May 22 10:21  vpp_api_trace.test_handoff_symmetrical_l4_innermost_from_pcaps.1116506.log
-rw-r--r--. 1 root root  87346 May 22 10:21  vpp_api_trace.test_handoff_symmetrical_l4_outermost_from_pcaps.1116506.log

root@localhost vpp# source build-root/test/venv/bin/activate

(venv) root@localhost venv (modify-name) # python -m scapy
WARNING: No alternative Python interpreters found ! Using standard Python shell instead.
INFO: Using the default Python shell: History is disabled.
                                      
                     aSPY//YASa       
             apyyyyCY//////////YCa       |
            sY//////YSpcs  scpCY//Pp     | Welcome to Scapy
 ayp ayyyyyyySCP//Pp           syY//C    | Version 2.6.1	

root@localhost vpp# cat ./test/requirements.txt

...
scapy==2.4.3; python_version >= '2.7' or python_version >= '3.4'
...

ImportError: cannot import name 'ERSPAN' from 'scapy.layers.l2' (/usr/local/lib/python3.9/site-packages/scapy/layers/l2.py)
Killing possible remaining process IDs:  1020374 1020376
No symlinks to failed tests' temporary directories found in /tmp/vpp-failed-unittests/.
make[1]: *** [Makefile:306: test] Error 1
make[1]: Leaving directory '/data/code/vpp/test'
make: *** [Makefile:505: test-debug] Error 2

  File "<frozen importlib._bootstrap_external>", line 850, in exec_module
  File "<frozen importlib._bootstrap>", line 228, in _call_with_frames_removed
  File "/data/code/vpp/test/test_bfd.py", line 23, in <module>
    from bfd import (
  File "/data/code/vpp/test/bfd.py", line 114, in <module>
    class BFD(Packet):
  File "/usr/local/lib/python3.9/site-packages/scapy/base_classes.py", line 339, in __new__
    dct["__signature__"] = inspect.Signature([
  File "/usr/lib64/python3.9/inspect.py", line 2826, in __init__
    raise ValueError(msg)
ValueError: duplicate parameter name: 'auth_key_hash'

  File "/usr/local/lib/python3.9/site-packages/scapy/arch/__init__.py", line 27, in <module>
    from scapy.arch.bpf.core import get_if_raw_addr
  File "/usr/local/lib/python3.9/site-packages/scapy/arch/bpf/core.py", line 30, in <module>
    LIBC = cdll.LoadLibrary(find_library("libc"))
  File "/usr/lib64/python3.9/ctypes/util.py", line 330, in find_library
    _get_soname(_findLib_gcc(name)) or _get_soname(_findLib_ld(name))
  File "/usr/lib64/python3.9/ctypes/util.py", line 147, in _findLib_gcc
    if not _is_elf(file):
  File "/usr/lib64/python3.9/ctypes/util.py", line 99, in _is_elf
    with open(filename, 'br') as thefile:
FileNotFoundError: [Errno 2] No such file or directory: b'liblibc.a'

root@localhost vpp (dev-5.0) # cat /usr/local/lib/python3.9/site-packages/scapy/arch/bpf/core.py|grep lib
from ctypes.util import find_library
LIBC = cdll.LoadLibrary(find_library("libc"))

# 修改这行代码
# from scapy.layers.l2 import Ether, GRE, ERSPAN

from scapy.layers.l2 import Ether, GRE
try:
    from scapy.layers.l2 import ERSPAN
except ImportError:
    from scapy.contrib.erspan import ERSPAN

pip3 install scapy==2.4.5

pip3 uninstall weasel
pip3 uninstall pydantic
pip3 uninstall typing-extensions

==============================================================================
Allow/Deny Plugin Unit Test Cases [main thread only]
==============================================================================
Plugin API Test                                                     6.47 OK
==============================================================================
API Internal client Test Cases [main thread only]
==============================================================================
Internal API client                                                 3.56 OK
==============================================================================
JSON API trace related tests [main thread only]
...

root@localhost vpp # make test-help
make[1]: Entering directory '/data/code/vpp/test'
Running tests:

 test                   - build and run (basic) functional tests
 test-debug             - build and run (basic) functional tests (debug build)
 test-cov               - generate code coverage report for functional tests
 test-cov-prep          - coverage phase #1 : prepare lcov
 test-cov-build         - coverage phase #2 : build gcov image & run tests against it (use TEST=)
 test-cov-post          - coverage phase #3 : generate lcov html report
 test-cov-both          - generate and merge code coverage report for Python and Golang tests
 test-all               - build and run functional and extended tests
 test-all-debug         - build and run functional and extended tests (debug build)
 test-all-cov           - generate code coverage report for functional and extended tests
 retest                 - run functional tests
 retest-debug           - run functional tests (debug build)
 retest-all             - run functional and extended tests
 retest-all-debug       - run functional and extended tests (debug build)
 test-wipe              - wipe (temporary) files generated by unit tests
 test-wipe-cov          - wipe code coverage report for test framework
 test-wipe-papi         - rebuild vpp_papi sources
 test-wipe-all          - wipe (temporary) files generated by unit tests, and coverage
 test-shell             - enter shell with test environment
 test-shell-debug       - enter shell with test environment (debug build)
 test-refresh-deps      - refresh the Python dependencies for the tests

Environment variables controlling test runs:

   V=[0|1|2]
              set test verbosity level: 0=ERROR, 1=INFO, 2=DEBUG

   TEST_JOBS=[<n>|auto]
       use at most <n> parallel python processes for test
       execution, if auto, set to number of available cpus
       (default: 1)

   MAX_VPP_CPUS=[<n>|auto]
       use at most <n> cpus for running vpp
       'auto' sets to number of available cpus
       (default: auto)

   CACHE_OUTPUT=[0|n|no]
       disable caching VPP stdout/stderr and logging it
       as one block after test finishes
       (default: yes)

   FAILFAST=[1|y|yes]
       if enabled, stop running tests on first failure
       otherwise finish running whole suite
       (default: no)

   TIMEOUT=<timeout>
       fail test suite if any single test takes longer
       than <timeout> (in seconds) to finish
       (default: 600)

   RETRIES=<n>
       retry failed tests <n> times
       (default: 0)

   DEBUG=<type>
       configure VPP debugging:
       DEBUG=core
           detect coredump and load it in gdb on crash

       DEBUG=gdb
           print VPP PID and wait for user input before
           running and tearing down a testcase, allowing
           easy gdb attach

       DEBUG=gdbserver
           same as above, but run gdb inside a gdb server

       DEBUG=attach
           attach to existing vpp in running in gdb
           (see test-start-vpp-in-gdb)
       (default: none)

   STEP=[1|y|yes]
       enable stepping through a testcase
       (default: no)

   SANITY=[0|n|no]
       disable sanity import of vpp-api/vpp sanity
       run before running tests
       (default: yes)

   EXTENDED_TESTS=[1|y|yes]
       run extended tests
       (default: no)

   TEST=<filter>,[<filter>],...
       only run tests matching one or more comma-delimited
       filter expressions

       simple filter:
           file name or file suffix select all tests from a file
           examples:
               TEST=test_bfd
               TEST=bfd
                    equivalent expressions selecting all
                    tests defined in test_bfd.py

       wildcard filter:
           advanced filtering based on test file, test class
           and test function
           each filter expression is in the form of
               <file>.<class>.<test function>
           each of the tokens can be left empty or replaced
           with '*' to select all objects available
           examples:
               TEST=test_bfd.*.*
               TEST=test_bfd..
               TEST=bfd.*.*
               TEST=bfd..
                    select all tests defined in test_bfd.py
               TEST=bfd.BFDAPITestCase.*
               TEST=bfd.BFDAPITestCase.
                    select all tests from test_bfd.py
                    which are part of BFDAPITestCase class
               TEST=bfd.BFDAPITestCase.test_add_bfd
                    select a single test named test_add_bfd
                    from test_bfd.py/BFDAPITestCase
               TEST=..test_add_bfd
               TEST=*.*.test_add_bfd
                    select all test functions named test_add_bfd
                    from all files/classes
               TEST=bfd,ip4,..test_icmp_error
                    select all test functions in test_bfd.py,
                    test_ip4.py and all test functions named
                    'test_icmp_error' in all files
       (default: '')

   VARIANT=<variant>
       specify which march node variant to unit test
           e.g. VARIANT=skx test the skx march variants
           e.g. VARIANT=icl test the icl march variants
       (default: '')

   COREDUMP_SIZE=<size>
       pass <size> as unix { coredump-size <size> } argument
       to vpp, e.g. COREDUMP_SIZE=4g or COREDUMP_SIZE=unlimited
       (default: '')

   COREDUMP_COMPRESS=[1|y|yes]
       if no debug option is set, compress any core files
       (default: no)

   EXTERN_TESTS=<path>
       include out-of-tree test_*.py files under <path>
       (default: '')

   EXTERN_PLUGINS=<path>
       load out-of-tree vpp plugins in <path>
       (default: '')

   EXTERN_COV_DIR=<path>
       path to out-of-tree prefix, where source, object
       and .gcda files can be found for coverage report
       (default: '')

   PROFILE=[1|y|yes]
       enable profiling of test framework via cProfile module
       (default: no)

   PROFILE_SORT_BY=opt
       sort profiling report by opt - see cProfile documentation
       for possible values
       (default: cumtime)

   PROFILE_OUTPUT=file
       output profiling info to file - use absolute path
       (default: stdout)

   TEST_DEBUG=[1|y|yes]
       enable debugging of the test framework itself (expert)
       (default: no)

   TEST_GCOV=[1|y|yes]
       enable tests specifically designed soley for code coverage
       (default: no)

   API_FUZZ=[1|y|yes]
       enable VPP api fuzz testing
       (default: no)

   RND_SEED=<seed>
       random seed used by test framework
       (default: time.time())

   DECODE_PCAPS=[all|failed|none]
       decode pcap files using tshark - all, only failed or none
       (default: failed)

Starting VPP in GDB for use with DEBUG=attach:

 test-start-vpp-in-gdb       - start VPP in gdb (release)
 test-start-vpp-debug-in-gdb - start VPP in gdb (debug)