test/Makefile

   1 ASAN_OPTIONS?=verify_asan_link_order=0:detect_leaks=0:abort_on_error=1:unmap_shadow_on_exit=1:disable_coredump=0
   2 export ASAN_OPTIONS
   3
   4 .PHONY: verify-env
   5 verify-env:
   6 ifndef WS_ROOT
   7         $(error WS_ROOT is not set)
   8 endif
   9 ifndef BR
  10         $(error BR is not set)
  11 endif
  12 ifndef TEST_DIR
  13         $(error TEST_DIR is not set)
  14 endif
  15
  16 export TEST_BR = $(BR)/build-test
  17 export TEST_DOC_BR = $(TEST_BR)/doc
  18 export BUILD_TEST_SRC = $(TEST_BR)/src
  19 FAILED_DIR=/tmp/vpp-failed-unittests/
  20 PLUGIN_TEST_DIRS=$(shell find $(PLUGIN_SRC_DIR) -type d -name test -exec echo -n " -d {}" \;)
  21 CORE_TEST_DIRS=$(shell find $(WS_ROOT)/src -not \( -path $(INTERN_PLUGIN_SRC_DIR) -prune \) -type d -name test -exec echo -n " -d {}" \;)
  22 VPP_TEST_DIRS=$(shell ls -d $(TEST_DIR)$(PLUGIN_TEST_DIRS)$(CORE_TEST_DIRS) $(EXTERN_TESTS))
  23 VPP_TEST_SRC=$(shell for dir in $(VPP_TEST_DIRS) ; do ls $$dir/*.py 2>/dev/null; done)
  24
  25 FORCE_NO_WIPE=0
  26 ifeq ($(DEBUG),gdb)
  27 FORCE_FOREGROUND=1
  28 else ifeq ($(DEBUG),gdbserver)
  29 FORCE_FOREGROUND=1
  30 else ifeq ($(DEBUG),gdb-all)
  31 FORCE_FOREGROUND=1
  32 else ifeq ($(DEBUG),gdbserver-all)
  33 FORCE_FOREGROUND=1
  34 else ifeq ($(DEBUG),core)
  35 FORCE_FOREGROUND=1
  36 else ifeq ($(DEBUG),attach)
  37 FORCE_FOREGROUND=1
  38 FORCE_NO_WIPE=1
  39 else ifeq ($(STEP),yes)
  40 FORCE_FOREGROUND=1
  41 else ifeq ($(STEP),y)
  42 FORCE_FOREGROUND=1
  43 else ifeq ($(STEP),1)
  44 FORCE_FOREGROUND=1
  45 else
  46 FORCE_FOREGROUND=0
  47 endif
  48
  49 ifdef PROFILE_OUTPUT
  50 PROFILE_OUTPUT_OPTS=-o $(PROFILE_OUTPUT)
  51 endif
  52
  53 ifndef PROFILE_SORT_BY
  54 PROFILE_SORT_BY=cumtime
  55 endif
  56
  57 ifeq ($(PROFILE),1)
  58 PYTHON_PROFILE_OPTS=-m cProfile $(PROFILE_OUTPUT_OPTS) -s $(PROFILE_SORT_BY)
  59 FORCE_FOREGROUND=1
  60 endif
  61
  62 UNITTEST_EXTRA_OPTS=
  63 UNITTEST_FAILFAST_OPTS=
  64
  65 ifeq ($(FAILFAST),1)
  66 UNITTEST_EXTRA_OPTS=-f
  67 endif
  68
  69 ifneq ($(EXTERN_TESTS),)
  70 UNITTEST_EXTRA_OPTS=$(UNITTEST_FAILFAST_OPTS) -d $(EXTERN_TESTS)
  71 endif
  72
  73 VENV_PATH=$(TEST_BR)/venv
  74
  75 ifeq ($(TEST_DEBUG),1)
  76 VENV_RUN_DIR:=$(VENV_PATH)/run-debug
  77 else
  78 VENV_RUN_DIR:=$(VENV_PATH)/run
  79 endif
  80
  81 ifeq ($(PYTHON),)
  82 PYTHON_INTERP=python3
  83 else
  84 PYTHON_INTERP=$(PYTHON)
  85 endif
  86
  87 empty:=
  88 space:= $(empty) $(empty)
  89 export PYTHONPATH=$(subst $(space),:,$(VPP_TEST_DIRS))
  90 export PYTHONPYCACHEPREFIX=$(TEST_BR)/pycache
  91
  92 PYTHON_VERSION=$(shell $(PYTHON_INTERP) -c 'import sys; print(sys.version_info.major)')
  93 PIP_VERSION=20.1.1
  94 # Keep in sync with requirements.txt
  95 PIP_TOOLS_VERSION=5.1.2
  96 PYTHON_DEPENDS=requirements-$(PYTHON_VERSION).txt
  97 SCAPY_SOURCE=$(shell find $(VENV_PATH)/lib/python* -name site-packages)
  98 BUILD_COV_DIR=$(TEST_BR)/coverage
  99
 100 PIP_TOOLS_INSTALL_DONE=$(VENV_RUN_DIR)/pip-tools-install-$(PYTHON_VERSION)-$(PIP_TOOLS_VERSION).done
 101 PIP_INSTALL_DONE=$(VENV_RUN_DIR)/pip-install-$(PYTHON_VERSION)-$(PIP_VERSION).done
 102 PIP_PATCH_DONE=$(VENV_RUN_DIR)/pip-patch-$(PYTHON_VERSION).done
 103 PAPI_INSTALL_DONE=$(VENV_RUN_DIR)/papi-install-$(PYTHON_VERSION).done
 104 PAPI_PYTHON_SRC_DIR=$(WS_ROOT)/src/vpp-api/python
 105 PAPI_WIPE_DIST=$(WS_ROOT)/src/vpp-api/vapi/__pycache__ \
 106         $(PAPI_PYTHON_SRC_DIR)/build \
 107         $(PAPI_PYTHON_SRC_DIR)/vpp_papi.egg-info \
 108         $(PAPI_PYTHON_SRC_DIR)/vpp_papi/__pycache__
 109
 110 $(PIP_TOOLS_INSTALL_DONE):
 111         @rm -rf $(VENV_PATH)
 112         @mkdir -p $(VENV_RUN_DIR)
 113         @$(PYTHON_INTERP) -m venv $(VENV_PATH)
 114         # pip version pinning
 115         @bash -c "source $(VENV_PATH)/bin/activate && \
 116                   $(PYTHON_INTERP) -m pip install pip===$(PIP_VERSION)"
 117         @bash -c "source $(VENV_PATH)/bin/activate && \
 118                   $(PYTHON_INTERP) -m pip install pip-tools===$(PIP_TOOLS_VERSION)"
 119         @touch $@
 120
 121 $(PYTHON_DEPENDS): requirements.txt
 122         @bash -c "source $(VENV_PATH)/bin/activate && \
 123                   CUSTOM_COMPILE_COMMAND='make test-refresh-deps (or update requirements.txt)' \
 124                   $(PYTHON_INTERP) -m piptools compile -q --generate-hashes requirements.txt --output-file $@"
 125
 126 $(PIP_INSTALL_DONE): $(PIP_TOOLS_INSTALL_DONE) $(PYTHON_DEPENDS)
 127         @bash -c "source $(VENV_PATH)/bin/activate && \
 128                   $(PYTHON_INTERP) -m piptools sync $(PYTHON_DEPENDS)"
 129         @touch $@
 130
 131 $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
 132         @echo --- patching ---
 133         @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
 134         for f in $(CURDIR)/patches/scapy-2.4.3/*.patch ; do \
 135                 echo Applying patch: $$(basename $$f) ; \
 136                 patch --forward -p1 -d $(SCAPY_SOURCE) < $$f ; \
 137                 retCode=$$?; \
 138                 [ $$retCode -gt 1 ] && exit $$retCode; \
 139         done; \
 140         touch $@
 141
 142 $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
 143         @bash -c "source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) -m pip install -e $(PAPI_PYTHON_SRC_DIR)"
 144         @touch $@
 145
 146 .PHONY: refresh-deps
 147 refresh-deps: clean-deps $(PYTHON_DEPENDS)
 148
 149 .PHONY: clean-deps
 150 clean-deps:
 151         @rm -f $(PYTHON_DEPENDS)
 152
 153 INTERN_PLUGIN_SRC_DIR=$(WS_ROOT)/src/plugins
 154 ifneq ($(EXTERN_PLUGIN_SRC_DIR),)
 155 PLUGIN_SRC_DIR=$(EXTERN_PLUGIN_SRC_DIR)
 156 else
 157 PLUGIN_SRC_DIR=$(INTERN_PLUGIN_SRC_DIR)
 158 endif
 159
 160 define retest-func
 161 @env VPP_IN_GDB=$(VPP_IN_GDB) FORCE_FOREGROUND=$(FORCE_FOREGROUND) FAILED_DIR=$(FAILED_DIR) VENV_PATH=$(VENV_PATH) scripts/setsid_wrapper.sh $(FORCE_FOREGROUND) $(VENV_PATH)/bin/activate $(PYTHON_INTERP) $(PYTHON_PROFILE_OPTS) $(BUILD_TEST_SRC)/run_tests.py -d $(BUILD_TEST_SRC) $(UNITTEST_EXTRA_OPTS) || env FAILED_DIR=$(FAILED_DIR) COMPRESS_FAILED_TEST_LOGS=$(COMPRESS_FAILED_TEST_LOGS) scripts/compress_failed.sh
 162 endef
 163
 164 .PHONY: sanity
 165
 166 ifeq ($(SANITY),no)
 167 SANITY_IMPORT_VPP_PAPI_CMD=true
 168 SANITY_RUN_VPP_CMD=true
 169 else
 170 SANITY_IMPORT_VPP_PAPI_CMD=source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) $(BUILD_TEST_SRC)/sanity_import_vpp_papi.py
 171 SANITY_RUN_VPP_CMD=source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) $(BUILD_TEST_SRC)/sanity_run_vpp.py
 172 endif
 173
 174 ifndef TEST_JOBS
 175 PARALLEL_ILLEGAL=0
 176 else ifeq ($(FORCE_FOREGROUND),0)
 177 PARALLEL_ILLEGAL=0
 178 else ifeq ($(TEST_JOBS),auto)
 179 PARALLEL_ILLEGAL=0
 180 else ifeq ($(TEST_JOBS),1)
 181 PARALLEL_ILLEGAL=0
 182 else
 183 PARALLEL_ILLEGAL=1
 184 endif
 185
 186 sanity: test-dep
 187         @bash -c "test $(PARALLEL_ILLEGAL) -eq 0 ||\
 188             (echo \"*******************************************************************\" &&\
 189                  echo \"* Sanity check failed, TEST_JOBS is not 1 or 'auto' and DEBUG, STEP or PROFILE is set\" &&\
 190                  echo \"*******************************************************************\" &&\
 191                  false)"
 192         @bash -c "$(SANITY_IMPORT_VPP_PAPI_CMD) ||\
 193                 (echo \"*******************************************************************\" &&\
 194                  echo \"* Sanity check failed, cannot import vpp_papi\" &&\
 195                  echo \"* to debug: \" &&\
 196                  echo \"* 1. enter test shell:   make test-shell\" &&\
 197                  echo \"* 2. execute debugger:   gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
 198                  echo \"*******************************************************************\" &&\
 199                  false)"
 200         @bash -c "$(SANITY_RUN_VPP_CMD) ||\
 201                 (echo \"*******************************************************************\" &&\
 202                  echo \"* Sanity check failed, cannot run vpp\" &&\
 203                  echo \"*******************************************************************\" &&\
 204                  false)"
 205
 206 .PHONY: ext-test-apps
 207 ext-test-apps:
 208         make -C ext test-apps
 209
 210 $(BUILD_TEST_SRC): verify-env
 211         @rm -rf $@
 212         @mkdir -p $@
 213         @for file in $(VPP_TEST_SRC); do if [ ! -L $$file ] && [ ! -e $(BUILD_TEST_SRC)/$$(basename $$file) ] ; then ln -s $$file $(BUILD_TEST_SRC) ; fi ; done
 214
 215 $(FAILED_DIR): reset
 216         @mkdir -p $@
 217
 218 .PHONY: test-dep
 219 test-dep: $(BUILD_TEST_SRC) $(PAPI_INSTALL_DONE) $(FAILED_DIR)
 220
 221 .PHONY: test
 222 test: test-dep ext-test-apps sanity
 223         $(call retest-func)
 224
 225 .PHONY: retest
 226 retest: verify-env sanity $(FAILED_DIR)
 227         $(call retest-func)
 228
 229 .PHONY: shell
 230 shell: test-dep
 231         @echo "source $(VENV_PATH)/bin/activate;\
 232                 cd $(BUILD_TEST_SRC);\
 233                 export PYTHONPATH=$(PYTHONPATH);\
 234                 export RND_SEED=$(RND_SEED);\
 235                 echo '***';\
 236                 echo PYTHONPATH=$(PYTHONPATH);\
 237                 echo RND_SEED=$(RND_SEED);\
 238                 echo VPP_BUILD_DIR=$(VPP_BUILD_DIR);\
 239                 echo VPP_BIN=$(VPP_BIN);\
 240                 echo VPP_PLUGIN_PATH=$(VPP_PLUGIN_PATH);\
 241                 echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\
 242                 echo VPP_INSTALL_PATH=$(VPP_INSTALL_PATH);\
 243                 echo EXTERN_TESTS=$(EXTERN_TESTS);\
 244                 echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\
 245                 echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\
 246                 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
 247                 echo '***';\
 248                 exec </dev/tty" | bash -i
 249
 250 .PHONY: reset
 251 reset:
 252         @rm -f /dev/shm/vpp-unittest-*
 253         @if [ $(FORCE_NO_WIPE) -eq "0" ] ; then rm -rf /tmp/vpp-unittest-*;  fi
 254         @rm -f /tmp/api_post_mortem.*
 255         @rm -rf $(FAILED_DIR)
 256
 257 .PHONY: wipe
 258 wipe: reset
 259         @make -C ext clean
 260         @rm -rf $(VENV_PATH)
 261         @rm -rf $(patsubst %,%/__pycache__, $(VPP_TEST_DIRS))
 262         @rm -rf  $(BUILD_TEST_SRC)
 263
 264 $(TEST_DOC_BR): $(PIP_INSTALL_DONE)
 265         @mkdir -p $@
 266         @bash -c "source $(VENV_PATH)/bin/activate && make -C doc html"
 267
 268 .PHONY: doc
 269 doc: $(BUILD_TEST_SRC) $(PIP_PATCH_DONE) $(TEST_DOC_BR)
 270         @echo
 271         @echo "Test Documentation URL: $(TEST_DOC_BR)/html/index.html"
 272         @echo "Run 'make test-wipe-doc test-doc' to rebuild the test docs"
 273         @echo
 274
 275 .PHONY: wipe-doc
 276 wipe-doc:
 277         @rm -rf $(TEST_DOC_BR)
 278
 279 $(BUILD_COV_DIR):
 280         @mkdir -p $@
 281
 282 .PHONY: cov
 283 cov: wipe-cov test-dep ext $(BUILD_COV_DIR)
 284         @lcov --zerocounters --directory $(VPP_BUILD_DIR)
 285         @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
 286         $(call retest-func)
 287         @lcov --capture --directory $(VPP_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
 288         @test -z "$(EXTERN_COV_DIR)" || lcov --capture --directory $(EXTERN_COV_DIR) --output-file $(BUILD_COV_DIR)/extern-coverage.info
 289         @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
 290         @test -z "$(EXTERN_COV_DIR)" || genhtml $(BUILD_COV_DIR)/extern-coverage.info --output-directory $(BUILD_COV_DIR)/extern-html
 291         @echo
 292         @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
 293         @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
 294
 295 .PHONY: wipe-cov
 296 wipe-cov: wipe
 297         @rm -rf $(BUILD_COV_DIR)
 298
 299 .PHONY: wipe-papi
 300 wipe-papi:
 301         @rm -rf $(PAPI_INSTALL_DONE) $(PAPI_WIPE_DIST)
 302
 303 .PHONY: wipe-all
 304 wipe-all: wipe wipe-papi wipe-doc wipe-cov
 305         @rm -rf $(TEST_BR)
 306
 307 .PHONY: checkstyle-diff
 308 checkstyle-diff: $(BUILD_TEST_SRC) $(PIP_INSTALL_DONE)
 309         @bash -c "source $(VENV_PATH)/bin/activate &&\
 310                   $(PYTHON_INTERP) -m pip install pycodestyle"
 311         @bash -c "source $(VENV_PATH)/bin/activate &&\
 312                 cd $(WS_ROOT) && git diff --name-only --no-color --relative HEAD~1 ':!*.patch' | grep '.py$$' | xargs -n 1 -I XXX \
 313                 pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 -v XXX ||\
 314                 (echo \"*********************************************************************\" &&\
 315                  echo \"* Test framework PEP8 compliance check FAILED (checked changed files)\" &&\
 316                  echo \"*********************************************************************\" &&\
 317                  false)"
 318         @echo "*********************************************************************"
 319         @echo "* Test framework PEP8 compliance check passed (checked changed files)"
 320         @echo "*********************************************************************"
 321
 322 .PHONY: start-gdb
 323 start-gdb: sanity
 324         $(eval VPP_IN_GDB=1)
 325         $(eval FORCE_FOREGROUND=1)
 326         $(call retest-func)
 327
 328 .PHONY: checkstyle
 329 checkstyle: $(BUILD_TEST_SRC) $(PIP_INSTALL_DONE)
 330         @bash -c "source $(VENV_PATH)/bin/activate &&\
 331                   $(PYTHON_INTERP) -m pip install pycodestyle"
 332         @bash -c "source $(VENV_PATH)/bin/activate &&\
 333                 pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 -v $(BUILD_TEST_SRC)/*.py ||\
 334                 (echo \"*******************************************************************\" &&\
 335                  echo \"* Test framework PEP8 compliance check FAILED (checked all files)\" &&\
 336                  echo \"*******************************************************************\" &&\
 337                  false)"
 338         @echo "*******************************************************************"
 339         @echo "* Test framework PEP8 compliance check passed (checked all files)"
 340         @echo "*******************************************************************"
 341
 342 .PHONY: help
 343 help:
 344         @echo "Running tests:"
 345         @echo ""
 346         @echo " test                   - build and run (basic) functional tests"
 347         @echo " test-debug             - build and run (basic) functional tests (debug build)"
 348         @echo " test-all               - build and run functional and extended tests"
 349         @echo " test-all-debug         - build and run functional and extended tests (debug build)"
 350         @echo " retest                 - run functional tests"
 351         @echo " retest-debug           - run functional tests (debug build)"
 352         @echo " retest-all             - run functional and extended tests"
 353         @echo " retest-all-debug       - run functional and extended tests (debug build)"
 354         @echo " test-cov               - generate code coverage report for test framework"
 355         @echo " test-gcov                      - build and run functional tests (gcov build)"
 356         @echo " test-wipe              - wipe (temporary) files generated by unit tests"
 357         @echo " test-wipe-cov          - wipe code coverage report for test framework"
 358         @echo " test-wipe-doc          - wipe documentation for test framework"
 359         @echo " test-wipe-papi         - rebuild vpp_papi sources"
 360         @echo " test-wipe-all          - wipe (temporary) files generated by unit tests, docs, and coverage"
 361         @echo " test-shell             - enter shell with test environment"
 362         @echo " test-shell-debug       - enter shell with test environment (debug build)"
 363         @echo " test-checkstyle        - check PEP8 compliance for test framework"
 364         @echo " test-refresh-deps      - refresh the Python dependencies for the tests"
 365         @echo ""
 366         @echo "Arguments controlling test runs:"
 367         @echo " V=[0|1|2]              - set test verbosity level"
 368         @echo "                          0=ERROR, 1=INFO, 2=DEBUG"
 369         @echo " TEST_JOBS=[<n>|auto]   - use at most <n> parallel python processes for test execution, if auto, set to number of available cpus (default: 1)"
 370         @echo " MAX_VPP_CPUS=[<n>|auto]- use at most <n> cpus for running vpp main and worker threads, if auto, set to number of available cpus (default: auto)"
 371         @echo " CACHE_OUTPUT=[0|1]     - cache VPP stdout/stderr and log as one block after test finishes (default: 1)"
 372         @echo " FAILFAST=[0|1]         - fail fast if 1, complete all tests if 0"
 373         @echo " TIMEOUT=<timeout>      - fail test suite if any single test takes longer than <timeout> (in seconds) to finish (default: 600)"
 374         @echo " RETRIES=<n>            - retry failed tests <n> times"
 375         @echo " DEBUG=<type>           - set VPP debugging kind"
 376         @echo "    DEBUG=core          - detect coredump and load it in gdb on crash"
 377         @echo "    DEBUG=gdb           - allow easy debugging by printing VPP PID"
 378         @echo "                          and waiting for user input before running"
 379         @echo "                          and tearing down a testcase"
 380         @echo "    DEBUG=gdbserver     - run gdb inside a gdb server, otherwise"
 381         @echo "                          same as above"
 382         @echo "    DEBUG=attach        - attach test case to already running vpp in gdb (see test-start-vpp-in-gdb)"
 383         @echo ""
 384         @echo " STEP=[yes|no]          - ease debugging by stepping through a testcase"
 385         @echo " SANITY=[yes|no]        - perform sanity import of vpp-api/sanity vpp run before running tests (default: yes)"
 386         @echo " EXTENDED_TESTS=[1|y]   - used by '[re]test-all' & '[re]test-all-debug' to run extended tests"
 387         @echo " TEST=<filter>          - filter the set of tests:"
 388         @echo "    by file-name        - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py"
 389         @echo "    by file-suffix      - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py"
 390         @echo "    by wildcard         - wildcard filter is <file>.<class>.<test function>, each can be replaced by '*'"
 391         @echo "                          e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name"
 392         @echo "                               TEST='bfd.*.*' is equivalent to above example of filter by file-suffix"
 393         @echo "                               TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class"
 394         @echo "                               TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase"
 395         @echo "                               TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes"
 396         @echo ""
 397         @echo " VARIANT=<variant>      - specify which march node variant to unit test"
 398         @echo "                          e.g. VARIANT=skx test the skx march variants"
 399         @echo "                          e.g. VARIANT=icl test the icl march variants"
 400         @echo ""
 401         @echo " COREDUMP_SIZE=<size>   - pass <size> as unix { coredump-size <size> } argument to vpp"
 402         @echo "                          e.g. COREDUMP_SIZE=4g"
 403         @echo "                               COREDUMP_SIZE=unlimited"
 404         @echo " COREDUMP_COMPRESS=1    - compress core files if not debugging them"
 405         @echo " EXTERN_TESTS=<path>    - path to out-of-tree test_<name>.py files containing test cases"
 406         @echo " EXTERN_PLUGINS=<path>  - path to out-of-tree plugins to be loaded by vpp under test"
 407         @echo " EXTERN_COV_DIR=<path>  - path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report"
 408         @echo ""
 409         @echo " PROFILE=1              - enable profiling of test framework via cProfile module"
 410         @echo " PROFILE_SORT_BY=opt    - sort profiling report by opt - consult cProfile documentation for possible values (default: cumtime)"
 411         @echo " PROFILE_OUTPUT=file    - output profiling info to file - use absolute path (default: stdout)"
 412         @echo ""
 413         @echo " TEST_DEBUG=1           - turn on debugging of the test framework itself (expert)"
 414         @echo ""
 415         @echo " SKIP_AARCH64=1         - skip tests that are failing on the ARM platorm in FD.io CI"
 416         @echo ""
 417         @echo " RND_SEED=seed          - Seed RND with given seed"
 418         @echo ""
 419         @echo "Starting VPP in GDB for use with DEBUG=attach:"
 420         @echo ""
 421         @echo " test-start-vpp-in-gdb       - start VPP in gdb (release)"
 422         @echo " test-start-vpp-debug-in-gdb - start VPP in gdb (debug)"
 423         @echo ""
 424         @echo "Arguments controlling VPP in GDB runs:"
 425         @echo " "
 426         @echo " VPP_IN_GDB_TMP_DIR     - specify directory to run VPP IN (default: /tmp/unittest-attach-gdb)"
 427         @echo " VPP_IN_GDB_NO_RMDIR=0  - don't remove existing tmp dir but fail instead"
 428         @echo " VPP_IN_GDB_CMDLINE=1   - add 'interactive' to VPP arguments to run with command line"
 429         @echo ""
 430         @echo "Creating test documentation"
 431         @echo " test-doc               - generate documentation for test framework"
 432         @echo " test-wipe-doc          - wipe documentation for test framework"
 433         @echo ""
 434         @echo "Creating test code coverage report"
 435         @echo " test-cov               - generate code coverage report for test framework"
 436         @echo " test-wipe-cov          - wipe code coverage report for test framework"
 437         @echo ""
 438         @echo "Verifying code-style"
 439         @echo " test-checkstyle        - check PEP8 compliance"
 440         @echo ""