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 = $(TEST_DIR)
  17 FAILED_DIR=/tmp/vpp-failed-unittests/
  18 VPP_TEST_DIRS=$(shell ls -d $(TEST_DIR) $(EXTERN_TESTS))
  19
  20 FORCE_NO_WIPE=0
  21 ifeq ($(DEBUG),gdb)
  22 FORCE_FOREGROUND=1
  23 else ifeq ($(DEBUG),gdbserver)
  24 FORCE_FOREGROUND=1
  25 else ifeq ($(DEBUG),gdb-all)
  26 FORCE_FOREGROUND=1
  27 else ifeq ($(DEBUG),gdbserver-all)
  28 FORCE_FOREGROUND=1
  29 else ifeq ($(DEBUG),core)
  30 FORCE_FOREGROUND=1
  31 else ifeq ($(DEBUG),attach)
  32 FORCE_FOREGROUND=1
  33 FORCE_NO_WIPE=1
  34 else ifeq ($(STEP),yes)
  35 FORCE_FOREGROUND=1
  36 else ifeq ($(STEP),y)
  37 FORCE_FOREGROUND=1
  38 else ifeq ($(STEP),1)
  39 FORCE_FOREGROUND=1
  40 else
  41 FORCE_FOREGROUND=0
  42 endif
  43
  44 ifdef PROFILE_OUTPUT
  45 PROFILE_OUTPUT_OPTS=-o $(PROFILE_OUTPUT)
  46 endif
  47
  48 ifndef PROFILE_SORT_BY
  49 PROFILE_SORT_BY=cumtime
  50 endif
  51
  52 ifeq ($(PROFILE),1)
  53 PYTHON_OPTS="-m cProfile $(PROFILE_OUTPUT_OPTS) -s $(PROFILE_SORT_BY)"
  54 FORCE_FOREGROUND=1
  55 endif
  56
  57 VENV_BR_DIR=$(BR)/test
  58 VENV_PATH=$(VENV_BR_DIR)/venv
  59
  60 ifeq ($(TEST_DEBUG),1)
  61 VENV_RUN_DIR:=$(VENV_PATH)/run-debug
  62 else
  63 VENV_RUN_DIR:=$(VENV_PATH)/run
  64 endif
  65
  66 ifeq ($(PYTHON),)
  67 PYTHON_INTERP=python3
  68 else
  69 PYTHON_INTERP=$(PYTHON)
  70 endif
  71
  72 ifeq ($(V),)
  73 V=0
  74 endif
  75
  76 PYTHON_VERSION=$(shell $(PYTHON_INTERP) -c 'import sys; print(sys.version_info.major)')
  77 PIP_VERSION=24.0
  78 # Keep in sync with requirements.txt
  79 PIP_TOOLS_VERSION=7.4.1
  80 PIP_SETUPTOOLS_VERSION=69.2.0
  81 PYTHON_DEPENDS=requirements-$(PYTHON_VERSION).txt
  82 SCAPY_SOURCE=$(shell find $(VENV_PATH)/lib/python* -name site-packages)
  83 BUILD_COV_DIR=$(BR)/test-coverage
  84
  85 PIP_TOOLS_INSTALL_DONE=$(VENV_RUN_DIR)/pip-tools-install-$(PYTHON_VERSION)-$(PIP_TOOLS_VERSION).done
  86 PIP_INSTALL_DONE=$(VENV_RUN_DIR)/pip-install-$(PYTHON_VERSION)-$(PIP_VERSION).done
  87 PIP_PATCH_DONE=$(VENV_RUN_DIR)/pip-patch-$(PYTHON_VERSION).done
  88 PAPI_INSTALL_DONE=$(VENV_RUN_DIR)/papi-install-$(PYTHON_VERSION).done
  89 PAPI_PYTHON_SRC_DIR=$(WS_ROOT)/src/vpp-api/python
  90 PAPI_WIPE_DIST=$(WS_ROOT)/src/vpp-api/vapi/__pycache__ \
  91         $(PAPI_PYTHON_SRC_DIR)/build \
  92         $(PAPI_PYTHON_SRC_DIR)/vpp_papi.egg-info \
  93         $(PAPI_PYTHON_SRC_DIR)/vpp_papi/__pycache__
  94
  95 $(PIP_TOOLS_INSTALL_DONE):
  96         @rm -rf $(VENV_PATH)
  97         @mkdir -p $(VENV_RUN_DIR)
  98         @$(PYTHON_INTERP) -m venv $(VENV_PATH)
  99         # pip version pinning
 100         @bash -c "source $(VENV_PATH)/bin/activate && \
 101                   python3 -m pip install pip===$(PIP_VERSION)"
 102         @bash -c "source $(VENV_PATH)/bin/activate && \
 103                   python3 -m pip install pip-tools===$(PIP_TOOLS_VERSION)"
 104         @bash -c "source $(VENV_PATH)/bin/activate && \
 105                   python3 -m pip install setuptools===$(PIP_SETUPTOOLS_VERSION)"
 106         @touch $@
 107
 108 $(PYTHON_DEPENDS): requirements.txt
 109         @bash -c "source $(VENV_PATH)/bin/activate && \
 110                   CUSTOM_COMPILE_COMMAND='$(MAKE) test-refresh-deps (or update requirements.txt)' \
 111                   python3 -m piptools compile -q --generate-hashes requirements.txt --output-file $@"
 112
 113 $(PIP_INSTALL_DONE): $(PIP_TOOLS_INSTALL_DONE) $(PYTHON_DEPENDS)
 114         @bash -c "source $(VENV_PATH)/bin/activate && \
 115                   python3 -m piptools sync $(PYTHON_DEPENDS)"
 116         @touch $@
 117
 118 $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
 119         @echo --- patching ---
 120         @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
 121         for f in $(CURDIR)/patches/scapy-2.4.3/*.patch ; do \
 122                 echo Applying patch: $$(basename $$f) ; \
 123                 patch --forward -p1 -d $(SCAPY_SOURCE) < $$f ; \
 124                 retCode=$$?; \
 125                 [ $$retCode -gt 1 ] && exit $$retCode; \
 126         done; \
 127         touch $@
 128
 129 $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
 130         @bash -c "source $(VENV_PATH)/bin/activate && python3 -m pip install -e $(PAPI_PYTHON_SRC_DIR)"
 131         @touch $@
 132
 133 .PHONY: refresh-deps
 134 refresh-deps: clean-deps $(PIP_INSTALL_DONE) $(PYTHON_DEPENDS)
 135
 136 .PHONY: clean-deps
 137 clean-deps:
 138         @rm -f $(PYTHON_DEPENDS)
 139
 140 INTERN_PLUGIN_SRC_DIR=$(WS_ROOT)/src/plugins
 141 ifneq ($(EXTERN_PLUGIN_SRC_DIR),)
 142 PLUGIN_SRC_DIR=$(EXTERN_PLUGIN_SRC_DIR)
 143 else
 144 PLUGIN_SRC_DIR=$(INTERN_PLUGIN_SRC_DIR)
 145 endif
 146
 147 .PHONY: sanity
 148
 149 ifndef TEST_JOBS
 150 PARALLEL_ILLEGAL=0
 151 TEST_JOBS=1
 152 else ifeq ($(FORCE_FOREGROUND),0)
 153 PARALLEL_ILLEGAL=0
 154 else ifneq ($(findstring $(TEST_JOBS),1 auto),)
 155 PARALLEL_ILLEGAL=0
 156 else
 157 PARALLEL_ILLEGAL=1
 158 endif
 159
 160 ifneq ($(DEBUG),)
 161 SANITY=no
 162 endif
 163
 164 ifneq ($(findstring $(SANITY),0 n no),)
 165 SANITY_IMPORT_VPP_PAPI_CMD=true
 166 ARG0=
 167 else
 168 SANITY_IMPORT_VPP_PAPI_CMD=source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) sanity_import_vpp_papi.py
 169 ARG0=--sanity
 170 endif
 171
 172 ARG1=
 173 ifneq ($(findstring $(FAILFAST),1 y yes),)
 174 ARG1=--failfast
 175 endif
 176
 177 ARG2=
 178 ifneq ($(findstring $(EXTENDED_TESTS),1 y yes),)
 179 ARG2=--extended
 180 endif
 181
 182 ARG3=
 183 ifneq ($(EXTERN_TESTS),)
 184 ARG3=--test-src-dir $(EXTERN_TESTS)
 185 endif
 186
 187 ARG4=
 188 ifneq ($(findstring $(FORCE_FOREGROUND),1 y yes),)
 189 ARG4=--force-foreground
 190 endif
 191
 192 ARG5=
 193 ifneq ($(findstring $(COREDUMP_COMPRESS),1 y yes),)
 194 ARG5=--compress-core
 195 endif
 196
 197 ARG6=
 198 ifneq ($(findstring $(STEP),1 y yes),)
 199 ARG6=--step
 200 endif
 201
 202 ARG7=
 203 ifneq ($(findstring $(TEST_GCOV),1 y yes),)
 204 ARG7=--gcov
 205 endif
 206
 207 ARG8=
 208 ifneq ($(EXTERN_PLUGINS),)
 209 ARG8=--extern-plugin-dir=$(EXTERN_PLUGINS)
 210 endif
 211
 212 ARG9=
 213 ifneq ($(DEBUG),)
 214 ARG9=--debug=$(DEBUG)
 215 endif
 216
 217 ARG10=
 218 ifneq ($(COREDUMP_SIZE),)
 219 ARG10=--coredump-size=$(COREDUMP_SIZE)
 220 endif
 221
 222 ARG11=
 223 ifneq ($(VARIANT),)
 224 ARG11=--variant=$(VARIANT)
 225 endif
 226
 227 ARG12=--cache-vpp-output
 228 ifneq ($(findstring $(CACHE_OUTPUT),0 n no),)
 229 ARG12=
 230 endif
 231
 232 ARG13=
 233 ifneq ($(MAX_VPP_CPUS),)
 234 ARG13=--max-vpp-cpus=$(MAX_VPP_CPUS)
 235 endif
 236
 237 ARG14=
 238 ifneq ($(TIMEOUT),)
 239 ARG14=--timeout=$(TIMEOUT)
 240 endif
 241
 242 ARG15=
 243 ifneq ($(findstring $(TEST_DEBUG),1 y yes),)
 244 ARG15=--debug-framework
 245 endif
 246
 247 ARG16=
 248 ifneq ($(findstring $(API_FUZZ),1 y yes),)
 249 ARG16=--api-fuzz=on
 250 endif
 251
 252 ARG17=
 253 ifneq ($(EXTERN_APIDIR),)
 254 ARG17=--extern-apidir=$(EXTERN_APIDIR)
 255 endif
 256
 257 ARG18=
 258 ifneq ($(findstring $(DECODE_PCAPS),1 y yes),)
 259 ARG18=--decode-pcaps
 260 endif
 261
 262 ifneq ($(findstring $(API_PRELOAD),1 y yes),)
 263 ARG19=--api-preload
 264 else
 265 ARG19=
 266 endif
 267
 268 EXC_PLUGINS_ARG=
 269 ifneq ($(VPP_EXCLUDED_PLUGINS),)
 270 # convert the comma-separated list into N invocations of the argument to exclude a plugin
 271 EXC_PLUGINS_ARG=$(shell echo "${VPP_EXCLUDED_PLUGINS}" | sed 's/\([^,]*\)/--excluded-plugin=\1/g; s/,/ /g')
 272 endif
 273
 274
 275
 276 EXTRA_ARGS=$(ARG0) $(ARG1) $(ARG2) $(ARG3) $(ARG4) $(ARG5) $(ARG6) $(ARG7) $(ARG8) $(ARG9) $(ARG10) $(ARG11) $(ARG12) $(ARG13) $(ARG14) $(ARG15) $(ARG16) $(ARG17) $(ARG18) $(ARG19)
 277
 278 RUN_TESTS_ARGS=--failed-dir=$(FAILED_DIR) --verbose=$(V) --jobs=$(TEST_JOBS) --filter=$(TEST) --retries=$(RETRIES) --venv-dir=$(VENV_PATH) --vpp-ws-dir=$(WS_ROOT) --vpp-tag=$(TAG) --rnd-seed=$(RND_SEED) --vpp-worker-count="$(VPP_WORKER_COUNT)" --keep-pcaps $(PLUGIN_PATH_ARGS) $(EXC_PLUGINS_ARG) $(TEST_PLUGIN_PATH_ARGS) $(EXTRA_ARGS)
 279 RUN_SCRIPT_ARGS=--python-opts=$(PYTHON_OPTS)
 280
 281 define retest-func
 282 @scripts/run.sh $(RUN_SCRIPT_ARGS) $(RUN_TESTS_ARGS) || env FAILED_DIR=$(FAILED_DIR) COMPRESS_FAILED_TEST_LOGS=$(COMPRESS_FAILED_TEST_LOGS) scripts/compress_failed.sh
 283 endef
 284
 285 sanity: test-dep
 286         @bash -c "test $(PARALLEL_ILLEGAL) -eq 0 ||\
 287             (echo \"*******************************************************************\" &&\
 288                  echo \"* Sanity check failed, TEST_JOBS is not 1 or 'auto' and DEBUG, STEP or PROFILE is set\" &&\
 289                  echo \"*******************************************************************\" &&\
 290                  false)"
 291         @bash -c "$(SANITY_IMPORT_VPP_PAPI_CMD) ||\
 292                 (echo \"*******************************************************************\" &&\
 293                  echo \"* Sanity check failed, cannot import vpp_papi\" &&\
 294                  echo \"* to debug: \" &&\
 295                  echo \"* 1. enter test shell:   make test-shell\" &&\
 296                  echo \"* 2. execute debugger:   gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
 297                  echo \"*******************************************************************\" &&\
 298                  false)"
 299
 300 $(FAILED_DIR): reset
 301         @mkdir -p $@
 302
 303 .PHONY: test-dep
 304 test-dep: $(PAPI_INSTALL_DONE) $(FAILED_DIR)
 305
 306 .PHONY: test
 307 test: test-dep sanity
 308         $(call retest-func)
 309
 310 .PHONY: retest
 311 retest: verify-env sanity $(FAILED_DIR)
 312         $(call retest-func)
 313
 314 .PHONY: shell
 315 shell: test-dep
 316         @echo "source $(VENV_PATH)/bin/activate;\
 317                 export RND_SEED=$(RND_SEED);\
 318                 echo '***';\
 319                 echo PYTHONPATH=$(PYTHONPATH);\
 320                 echo RND_SEED=$(RND_SEED);\
 321                 echo VPP_BUILD_DIR=$(VPP_BUILD_DIR);\
 322                 echo VPP_PLUGIN_PATH=$(VPP_PLUGIN_PATH);\
 323                 echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\
 324                 echo VPP_INSTALL_PATH=$(VPP_INSTALL_PATH);\
 325                 echo EXTERN_TESTS=$(EXTERN_TESTS);\
 326                 echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\
 327         echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\
 328                 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
 329                 echo '***';\
 330                 exec </dev/tty" | bash -i
 331
 332 .PHONY: reset
 333 reset:
 334         @rm -f /dev/shm/vpp-unittest-*
 335         @if [ $(FORCE_NO_WIPE) -eq "0" ] ; then rm -rf /tmp/vpp-unittest-*;  fi
 336         @rm -f /tmp/api_post_mortem.*
 337         @rm -rf $(FAILED_DIR)
 338         @rm -rf /tmp/vpp-vm-tests
 339
 340 .PHONY: wipe
 341 wipe: reset
 342         @rm -rf $(VENV_BR_DIR)
 343         @rm -rf $(patsubst %,%/__pycache__, $(VPP_TEST_DIRS))
 344
 345 $(BUILD_COV_DIR):
 346         @mkdir -p $@
 347
 348 .PHONY: cov-prep
 349 cov-prep: test-dep
 350         @lcov --zerocounters --directory $(VPP_BUILD_DIR)
 351         @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
 352
 353 COV_REM_NOT_CODE="/usr/include/*" "*/build-root/*" "/opt/*" "/usr/lib/*" \
 354                                  "*_test.*" "*test_*" "*vat*"  "*/vnet/unix/gdb_funcs.c" \
 355                                  "*pg.c"
 356
 357 COV_REM_DRIVERS="*rdma*" "*/plugins/af_packet/*" "*/plugins/af_xdp/*" \
 358                                 "*/plugins/avf/*" "*/plugins/dma_intel/*" "*/vlib/pci/*" \
 359                                 "*/vnet/devices/*" "*/vlib/dma/*" "*/plugins/vmxnet3/*" \
 360                                 "*/vnet/devices/virtio/*" "*/plugins/perfmon/arm*" \
 361                                 "*/plugins/perfmon/intel/*" "*/vlib/vmbus/*" \
 362                                 "*/vnet/dev/*" "*/plugins/dev_ena/*" "*/plugins/dev_iavf/*"
 363
 364 COV_REM_UNUSED_FEAT="*/plugins/ioam/analyse/*" "*/plugins/ioam/lib-*/*" \
 365                                     "*/plugins/ioam/export-common/*" "*/vnet/srp/*" \
 366                                         "*/lawful-intercept/*" "*/lisp/*" "*/vnet/osi/*" \
 367                                         "*/plugins/nsh/*"
 368
 369 COV_REM_TODO_NO_TEST="*/vpp-api/client/*" "*/plugins/prom/*" \
 370                                          "*/plugins/tlspicotls/*" "*/plugins/tlsmbedtls/*" \
 371                                          "*/vppinfra/perfmon/*" "*/plugins/ila/*" \
 372                                          "*/vlib/linux/*" "*/vnet/util/radix.c" "*/vapi/vapi.hpp" \
 373                                          "*/vpp/api/types.c" "*/vpp/api/json_format.c" \
 374                                          "*/plugins/ioam/*/*.h" "*/linux/netns.c" "*/vnet/flow/*" \
 375                                          "*/vppinfra/random.c" "*/vppinfra/ring.h" \
 376                                          "*/vppinfra/bihash_vec8_8.h" "*/vppinfra/maplog.c" \
 377                                          "*/vppinfra/format_table.c" "*/vppinfra/timing_wheel.c" \
 378                                          "*/vppinfra/macros.c" "*/vppinfra/valloc.c" \
 379                                          "*/vppinfra/jsonformat.c" "*/vppinfra/vector/array_mask.h" \
 380                                          "*/vppinfra/vector/toeplitz.c" "*/plugins/vrrp/vrrp_packet.h" \
 381                                          "*/vnet/srv6/sr.h" "*/vlibapi/api_format.c" \
 382                                          "*/vlibapi/node_serialize.c" "*/plugins/quic/error.c" \
 383                                          "*/vnet/ipfix-export/flow_report_classify.h" \
 384                                          "*/vnet/ip/ip6_ll_types.c" "*/vnet/ip/ip_psh_cksum.h" \
 385                                          "*/vnet/ip/ip6_hop_by_hop.h" "*/vnet/ip/ip_format_fns.h" \
 386                                          "*/vnet/dpo/classify_dpo.h" "*/vnet/dpo/l3_proxy_dpo.h" \
 387                                          "*/vnet/ipsec/esp_format.c" "*/vnet/ethernet/sfp.c" \
 388                                          "*/vnet/ethernet/ethernet_format_fns.h" \
 389                                          "*/plugins/ikev2/ikev2_format.c" "*/vnet/bier/bier_types.c"
 390
 391 COV_REM_ALT_TEST="*/plugins/hs_apps/*" "*/plugins/builtinurl/*" \
 392                                  "*/plugins/http/*.h"
 393 .PHONY: cov-post
 394 cov-post: wipe-cov $(BUILD_COV_DIR)
 395         @lcov --capture \
 396                 --directory $(VPP_BUILD_DIR) \
 397                 --output-file $(BUILD_COV_DIR)/coverage$(HS_TEST).info
 398         @test -z "$(EXTERN_COV_DIR)" || \
 399                 lcov --capture \
 400                 --directory $(EXTERN_COV_DIR) \
 401                 --output-file $(BUILD_COV_DIR)/extern-coverage$(HS_TEST).info
 402         @lcov --remove $(BUILD_COV_DIR)/coverage$(HS_TEST).info \
 403                 $(COV_REM_NOT_CODE) \
 404                 $(COV_REM_DRIVERS)  \
 405                 $(COV_REM_TODO_NO_TEST) \
 406                 $(COV_REM_UNUSED_FEAT) \
 407                 $(COV_REM_ALT_TEST) \
 408                 -o $(BUILD_COV_DIR)/coverage-filtered$(HS_TEST).info
 409         @genhtml $(BUILD_COV_DIR)/coverage-filtered$(HS_TEST).info \
 410                 --output-directory $(BUILD_COV_DIR)/html
 411         @test -z "$(EXTERN_COV_DIR)" || \
 412                 genhtml $(BUILD_COV_DIR)/extern-coverage$(HS_TEST).info \
 413                         --output-directory $(BUILD_COV_DIR)/extern-html
 414         @echo
 415         @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
 416         @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
 417         @mkdir -p $(BR)/test-coverage-merged
 418         @cp -f $(BUILD_COV_DIR)/coverage-filtered$(HS_TEST).info $(BR)/test-coverage-merged
 419
 420 .PHONY: cov
 421 cov:
 422         $(MAKE) -C . cov-prep test cov-post
 423
 424 .PHONY: wipe-cov
 425 wipe-cov: wipe
 426         @rm -rf $(BUILD_COV_DIR)
 427
 428 .PHONY: wipe-papi
 429 wipe-papi:
 430         @rm -rf $(PAPI_INSTALL_DONE) $(PAPI_WIPE_DIST)
 431
 432 .PHONY: wipe-all
 433 wipe-all: wipe wipe-papi wipe-cov
 434         @rm -rf $(TEST_BR)
 435
 436 .PHONY: start-gdb
 437 start-gdb: sanity
 438         @bash -c "source $(VENV_PATH)/bin/activate && python3 -c 'from debug import start_vpp_in_gdb; start_vpp_in_gdb()' $(RUN_TESTS_ARGS)"
 439
 440 .PHONY: checkstyle-python-all
 441 checkstyle-python-all: $(PIP_INSTALL_DONE)
 442         @bash -c "source $(VENV_PATH)/bin/activate &&\
 443                 black -t py39 --check --diff $(WS_ROOT) ||\
 444                 (echo \"*************************************************************************\" &&\
 445                 echo \"* Test framework PEP8 compliance check FAILED (maybe: make fixstyle-python)\" &&\
 446                 echo \"*************************************************************************\" &&\
 447                 false)"
 448         @echo "*******************************************************************"
 449         @echo "* Test framework PEP8 compliance check passed"
 450         @echo "*******************************************************************"
 451
 452 .PHONY: checkstyle
 453 checkstyle: checkstyle-python-all
 454
 455 .PHONY: fixstyle-python-all
 456 fixstyle-python-all: $(PIP_INSTALL_DONE)
 457         @bash -c "source $(VENV_PATH)/bin/activate &&\
 458                 black -t py39 $(WS_ROOT) ||\
 459                 (echo \"*************************************************************************\" &&\
 460                 echo \"* Test framework PEP8 compliance check FAILED (maybe: make fixstyle-python)\" &&\
 461                 echo \"*************************************************************************\" &&\
 462                 false)"
 463         @echo "*******************************************************************"
 464         @echo "* Test framework PEP8 compliance check passed"
 465         @echo "*******************************************************************"
 466
 467 .PHONY: help
 468 help:
 469         @echo "Running tests:"
 470         @echo ""
 471         @echo " test                   - build and run (basic) functional tests"
 472         @echo " test-debug             - build and run (basic) functional tests (debug build)"
 473         @echo " test-cov               - generate code coverage report for functional tests"
 474         @echo " test-cov-prep          - coverage phase #1 : prepare lcov"
 475         @echo " test-cov-build         - coverage phase #2 : build gcov image & run tests against it (use TEST=)"
 476         @echo " test-cov-post          - coverage phase #3 : generate lcov html report"
 477         @echo " test-cov-both          - generate and merge code coverage report for Python and Golang tests"
 478         @echo " test-all               - build and run functional and extended tests"
 479         @echo " test-all-debug         - build and run functional and extended tests (debug build)"
 480         @echo " test-all-cov           - generate code coverage report for functional and extended tests"
 481         @echo " retest                 - run functional tests"
 482         @echo " retest-debug           - run functional tests (debug build)"
 483         @echo " retest-all             - run functional and extended tests"
 484         @echo " retest-all-debug       - run functional and extended tests (debug build)"
 485         @echo " test-wipe              - wipe (temporary) files generated by unit tests"
 486         @echo " test-wipe-cov          - wipe code coverage report for test framework"
 487         @echo " test-wipe-papi         - rebuild vpp_papi sources"
 488         @echo " test-wipe-all          - wipe (temporary) files generated by unit tests, and coverage"
 489         @echo " test-shell             - enter shell with test environment"
 490         @echo " test-shell-debug       - enter shell with test environment (debug build)"
 491         @echo " test-refresh-deps      - refresh the Python dependencies for the tests"
 492         @echo ""
 493         @echo "Environment variables controlling test runs:"
 494         @echo ""
 495         @echo "   V=[0|1|2]"
 496         @echo "       set test verbosity level: 0=ERROR, 1=INFO, 2=DEBUG"
 497         @echo ""
 498         @echo "   TEST_JOBS=[<n>|auto]"
 499         @echo "       use at most <n> parallel python processes for test"
 500         @echo "       execution, if auto, set to number of available cpus"
 501         @echo "       (default: 1)"
 502         @echo ""
 503         @echo "   MAX_VPP_CPUS=[<n>|auto]"
 504         @echo "       use at most <n> cpus for running vpp"
 505         @echo "       'auto' sets to number of available cpus"
 506         @echo "       (default: auto)"
 507         @echo ""
 508         @echo "   CACHE_OUTPUT=[0|n|no]"
 509         @echo "       disable caching VPP stdout/stderr and logging it"
 510         @echo "       as one block after test finishes"
 511         @echo "       (default: yes)"
 512         @echo ""
 513         @echo "   FAILFAST=[1|y|yes]"
 514         @echo "       if enabled, stop running tests on first failure"
 515         @echo "       otherwise finish running whole suite"
 516         @echo "       (default: no)"
 517         @echo ""
 518         @echo "   TIMEOUT=<timeout>"
 519         @echo "       fail test suite if any single test takes longer"
 520         @echo "       than <timeout> (in seconds) to finish"
 521         @echo "       (default: 600)"
 522         @echo ""
 523         @echo "   RETRIES=<n>"
 524         @echo "       retry failed tests <n> times"
 525         @echo "       (default: 0)"
 526         @echo ""
 527         @echo "   DEBUG=<type>"
 528         @echo "       configure VPP debugging:"
 529         @echo "       DEBUG=core"
 530         @echo "           detect coredump and load it in gdb on crash"
 531         @echo ""
 532         @echo "       DEBUG=gdb"
 533         @echo "           print VPP PID and wait for user input before"
 534         @echo "           running and tearing down a testcase, allowing"
 535         @echo "           easy gdb attach"
 536         @echo ""
 537         @echo "       DEBUG=gdbserver"
 538         @echo "           same as above, but run gdb inside a gdb server"
 539         @echo ""
 540         @echo "       DEBUG=attach"
 541         @echo "           attach to existing vpp in running in gdb"
 542         @echo "           (see test-start-vpp-in-gdb)"
 543         @echo "       (default: none)"
 544         @echo ""
 545         @echo "   STEP=[1|y|yes]"
 546         @echo "       enable stepping through a testcase"
 547         @echo "       (default: no)"
 548         @echo ""
 549         @echo "   SANITY=[0|n|no]"
 550         @echo "       disable sanity import of vpp-api/vpp sanity"
 551         @echo "       run before running tests"
 552         @echo "       (default: yes)"
 553         @echo ""
 554         @echo "   EXTENDED_TESTS=[1|y|yes]"
 555         @echo "       run extended tests"
 556         @echo "       (default: no)"
 557         @echo ""
 558         @echo "   TEST=<filter>,[<filter>],..."
 559         @echo "       only run tests matching one or more comma-delimited"
 560         @echo "       filter expressions"
 561         @echo ""
 562         @echo "       simple filter:"
 563         @echo "           file name or file suffix select all tests from a file"
 564         @echo "           examples:"
 565         @echo "               TEST=test_bfd"
 566         @echo "               TEST=bfd"
 567         @echo "                    equivalent expressions selecting all"
 568         @echo "                    tests defined in test_bfd.py"
 569         @echo ""
 570         @echo "       wildcard filter:"
 571         @echo "           advanced filtering based on test file, test class"
 572         @echo "           and test function"
 573         @echo "           each filter expression is in the form of"
 574         @echo "               <file>.<class>.<test function>"
 575         @echo "           each of the tokens can be left empty or replaced"
 576         @echo "           with '*' to select all objects available"
 577         @echo "           examples:"
 578         @echo "               TEST=test_bfd.*.*"
 579         @echo "               TEST=test_bfd.."
 580         @echo "               TEST=bfd.*.*"
 581         @echo "               TEST=bfd.."
 582         @echo "                    select all tests defined in test_bfd.py"
 583         @echo "               TEST=bfd.BFDAPITestCase.*"
 584         @echo "               TEST=bfd.BFDAPITestCase."
 585         @echo "                    select all tests from test_bfd.py"
 586         @echo "                    which are part of BFDAPITestCase class"
 587         @echo "               TEST=bfd.BFDAPITestCase.test_add_bfd"
 588         @echo "                    select a single test named test_add_bfd"
 589         @echo "                    from test_bfd.py/BFDAPITestCase"
 590         @echo "               TEST=..test_add_bfd"
 591         @echo "               TEST=*.*.test_add_bfd"
 592         @echo "                    select all test functions named test_add_bfd"
 593         @echo "                    from all files/classes"
 594         @echo "               TEST=bfd,ip4,..test_icmp_error"
 595         @echo "                    select all test functions in test_bfd.py,"
 596         @echo "                    test_ip4.py and all test functions named"
 597         @echo "                    'test_icmp_error' in all files"
 598         @echo "       (default: '')"
 599         @echo ""
 600         @echo "   VARIANT=<variant>"
 601         @echo "       specify which march node variant to unit test"
 602         @echo "           e.g. VARIANT=skx test the skx march variants"
 603         @echo "           e.g. VARIANT=icl test the icl march variants"
 604         @echo "       (default: '')"
 605         @echo ""
 606         @echo "   COREDUMP_SIZE=<size>"
 607         @echo "       pass <size> as unix { coredump-size <size> } argument"
 608         @echo "       to vpp, e.g. COREDUMP_SIZE=4g or COREDUMP_SIZE=unlimited"
 609         @echo "       (default: '')"
 610         @echo ""
 611         @echo "   COREDUMP_COMPRESS=[1|y|yes]"
 612         @echo "       if no debug option is set, compress any core files"
 613         @echo "       (default: no)"
 614         @echo ""
 615         @echo "   EXTERN_TESTS=<path>"
 616         @echo "       include out-of-tree test_*.py files under <path>"
 617         @echo "       (default: '')"
 618         @echo ""
 619         @echo "   EXTERN_PLUGINS=<path>"
 620         @echo "       load out-of-tree vpp plugins in <path>"
 621         @echo "       (default: '')"
 622         @echo ""
 623         @echo "   EXTERN_COV_DIR=<path>"
 624         @echo "       path to out-of-tree prefix, where source, object"
 625         @echo "       and .gcda files can be found for coverage report"
 626         @echo "       (default: '')"
 627         @echo ""
 628         @echo "   PROFILE=[1|y|yes]"
 629         @echo "       enable profiling of test framework via cProfile module"
 630         @echo "       (default: no)"
 631         @echo ""
 632         @echo "   PROFILE_SORT_BY=opt"
 633         @echo "       sort profiling report by opt - see cProfile documentation"
 634         @echo "       for possible values"
 635         @echo "       (default: cumtime)"
 636         @echo ""
 637         @echo "   PROFILE_OUTPUT=file"
 638         @echo "       output profiling info to file - use absolute path"
 639         @echo "       (default: stdout)"
 640         @echo ""
 641         @echo "   TEST_DEBUG=[1|y|yes]"
 642         @echo "       enable debugging of the test framework itself (expert)"
 643         @echo "       (default: no)"
 644         @echo ""
 645         @echo "   TEST_GCOV=[1|y|yes]"
 646         @echo "       enable tests specifically designed soley for code coverage"
 647         @echo "       (default: no)"
 648         @echo ""
 649         @echo "   API_FUZZ=[1|y|yes]"
 650         @echo "       enable VPP api fuzz testing"
 651         @echo "       (default: no)"
 652         @echo ""
 653         @echo "   RND_SEED=<seed>"
 654         @echo "       random seed used by test framework"
 655         @echo "       (default: time.time())"
 656         @echo ""
 657         @echo "Starting VPP in GDB for use with DEBUG=attach:"
 658         @echo ""
 659         @echo " test-start-vpp-in-gdb       - start VPP in gdb (release)"
 660         @echo " test-start-vpp-debug-in-gdb - start VPP in gdb (debug)"
 661         @echo ""