1 ASAN_OPTIONS?=verify_asan_link_order=0:detect_leaks=0:abort_on_error=1:unmap_shadow_on_exit=1:disable_coredump=0
7 $(error WS_ROOT is not set)
10 $(error BR is not set)
13 $(error TEST_DIR is not set)
16 export TEST_BR = $(TEST_DIR)
17 FAILED_DIR=/tmp/vpp-failed-unittests/
18 VPP_TEST_DIRS=$(shell ls -d $(TEST_DIR) $(EXTERN_TESTS))
23 else ifeq ($(DEBUG),gdbserver)
25 else ifeq ($(DEBUG),gdb-all)
27 else ifeq ($(DEBUG),gdbserver-all)
29 else ifeq ($(DEBUG),core)
31 else ifeq ($(DEBUG),attach)
34 else ifeq ($(STEP),yes)
45 PROFILE_OUTPUT_OPTS=-o $(PROFILE_OUTPUT)
48 ifndef PROFILE_SORT_BY
49 PROFILE_SORT_BY=cumtime
53 PYTHON_OPTS="-m cProfile $(PROFILE_OUTPUT_OPTS) -s $(PROFILE_SORT_BY)"
57 VENV_BR_DIR=$(BR)/test
58 VENV_PATH=$(VENV_BR_DIR)/venv
60 ifeq ($(TEST_DEBUG),1)
61 VENV_RUN_DIR:=$(VENV_PATH)/run-debug
63 VENV_RUN_DIR:=$(VENV_PATH)/run
69 PYTHON_INTERP=$(PYTHON)
76 PYTHON_VERSION=$(shell $(PYTHON_INTERP) -c 'import sys; print(sys.version_info.major)')
78 # Keep in sync with requirements.txt
79 PIP_TOOLS_VERSION=7.3.0
80 PIP_SETUPTOOLS_VERSION=68.1.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
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__
95 $(PIP_TOOLS_INSTALL_DONE):
97 @mkdir -p $(VENV_RUN_DIR)
98 @$(PYTHON_INTERP) -m venv $(VENV_PATH)
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)"
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 $@"
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)"
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 ; \
125 [ $$retCode -gt 1 ] && exit $$retCode; \
129 $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
130 @bash -c "source $(VENV_PATH)/bin/activate && python3 -m pip install -e $(PAPI_PYTHON_SRC_DIR)"
134 refresh-deps: clean-deps $(PIP_INSTALL_DONE) $(PYTHON_DEPENDS)
138 @rm -f $(PYTHON_DEPENDS)
140 INTERN_PLUGIN_SRC_DIR=$(WS_ROOT)/src/plugins
141 ifneq ($(EXTERN_PLUGIN_SRC_DIR),)
142 PLUGIN_SRC_DIR=$(EXTERN_PLUGIN_SRC_DIR)
144 PLUGIN_SRC_DIR=$(INTERN_PLUGIN_SRC_DIR)
152 else ifeq ($(FORCE_FOREGROUND),0)
154 else ifneq ($(findstring $(TEST_JOBS),1 auto),)
164 ifneq ($(findstring $(SANITY),0 n no),)
165 SANITY_IMPORT_VPP_PAPI_CMD=true
168 SANITY_IMPORT_VPP_PAPI_CMD=source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) sanity_import_vpp_papi.py
173 ifneq ($(findstring $(FAILFAST),1 y yes),)
178 ifneq ($(findstring $(EXTENDED_TESTS),1 y yes),)
183 ifneq ($(EXTERN_TESTS),)
184 ARG3=--test-src-dir $(EXTERN_TESTS)
188 ifneq ($(findstring $(FORCE_FOREGROUND),1 y yes),)
189 ARG4=--force-foreground
193 ifneq ($(findstring $(COREDUMP_COMPRESS),1 y yes),)
198 ifneq ($(findstring $(STEP),1 y yes),)
203 ifneq ($(findstring $(TEST_GCOV),1 y yes),)
208 ifneq ($(EXTERN_PLUGINS),)
209 ARG8=--extern-plugin-dir=$(EXTERN_PLUGINS)
214 ARG9=--debug=$(DEBUG)
218 ifneq ($(COREDUMP_SIZE),)
219 ARG10=--coredump-size=$(COREDUMP_SIZE)
224 ARG11=--variant=$(VARIANT)
227 ARG12=--cache-vpp-output
228 ifneq ($(findstring $(CACHE_OUTPUT),0 n no),)
233 ifneq ($(MAX_VPP_CPUS),)
234 ARG13=--max-vpp-cpus=$(MAX_VPP_CPUS)
239 ARG14=--timeout=$(TIMEOUT)
243 ifneq ($(findstring $(TEST_DEBUG),1 y yes),)
244 ARG15=--debug-framework
248 ifneq ($(findstring $(API_FUZZ),1 y yes),)
253 ifneq ($(EXTERN_APIDIR),)
254 ARG17=--extern-apidir=$(EXTERN_APIDIR)
258 ifneq ($(VPP_EXCLUDED_PLUGINS),)
259 # convert the comma-separated list into N invocations of the argument to exclude a plugin
260 EXC_PLUGINS_ARG=$(shell echo "${VPP_EXCLUDED_PLUGINS}" | sed 's/\([^,]*\)/--excluded-plugin=\1/g; s/,/ /g')
265 EXTRA_ARGS=$(ARG0) $(ARG1) $(ARG2) $(ARG3) $(ARG4) $(ARG5) $(ARG6) $(ARG7) $(ARG8) $(ARG9) $(ARG10) $(ARG11) $(ARG12) $(ARG13) $(ARG14) $(ARG15) $(ARG16) $(ARG17)
267 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)
268 RUN_SCRIPT_ARGS=--python-opts=$(PYTHON_OPTS)
271 @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
275 @bash -c "test $(PARALLEL_ILLEGAL) -eq 0 ||\
276 (echo \"*******************************************************************\" &&\
277 echo \"* Sanity check failed, TEST_JOBS is not 1 or 'auto' and DEBUG, STEP or PROFILE is set\" &&\
278 echo \"*******************************************************************\" &&\
280 @bash -c "$(SANITY_IMPORT_VPP_PAPI_CMD) ||\
281 (echo \"*******************************************************************\" &&\
282 echo \"* Sanity check failed, cannot import vpp_papi\" &&\
283 echo \"* to debug: \" &&\
284 echo \"* 1. enter test shell: make test-shell\" &&\
285 echo \"* 2. execute debugger: gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
286 echo \"*******************************************************************\" &&\
293 test-dep: $(PAPI_INSTALL_DONE) $(FAILED_DIR)
296 test: test-dep sanity
300 retest: verify-env sanity $(FAILED_DIR)
305 @echo "source $(VENV_PATH)/bin/activate;\
306 export RND_SEED=$(RND_SEED);\
308 echo PYTHONPATH=$(PYTHONPATH);\
309 echo RND_SEED=$(RND_SEED);\
310 echo VPP_BUILD_DIR=$(VPP_BUILD_DIR);\
311 echo VPP_PLUGIN_PATH=$(VPP_PLUGIN_PATH);\
312 echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\
313 echo VPP_INSTALL_PATH=$(VPP_INSTALL_PATH);\
314 echo EXTERN_TESTS=$(EXTERN_TESTS);\
315 echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\
316 echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\
317 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
319 exec </dev/tty" | bash -i
323 @rm -f /dev/shm/vpp-unittest-*
324 @if [ $(FORCE_NO_WIPE) -eq "0" ] ; then rm -rf /tmp/vpp-unittest-*; fi
325 @rm -f /tmp/api_post_mortem.*
326 @rm -rf $(FAILED_DIR)
327 @rm -rf /tmp/vpp-vm-tests
331 @rm -rf $(VENV_BR_DIR)
332 @rm -rf $(patsubst %,%/__pycache__, $(VPP_TEST_DIRS))
339 @lcov --zerocounters --directory $(VPP_BUILD_DIR)
340 @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
343 cov-post: wipe-cov $(BUILD_COV_DIR)
345 --directory $(VPP_BUILD_DIR) \
346 --output-file $(BUILD_COV_DIR)/coverage.info
347 @test -z "$(EXTERN_COV_DIR)" || \
349 --directory $(EXTERN_COV_DIR) \
350 --output-file $(BUILD_COV_DIR)/extern-coverage.info
351 @lcov --remove $(BUILD_COV_DIR)/coverage.info \
352 "/usr/include/*" "*/build-root/*" "/opt/*" "/usr/lib/*" \
353 "*_test.*" "*vat*" "*rdma*" "*/vpp-api/client/*" "*/plugins/af_packet/*" \
354 "*/plugins/af_xdp/*" "*/plugins/avf/*" "*/plugins/dma_intel/*" \
355 "*/plugins/hs_apps/*" "*/plugins/vmxnet3/*" "*/vnet/devices/virtio/*" \
356 -o $(BUILD_COV_DIR)/coverage-filtered.info
357 @genhtml $(BUILD_COV_DIR)/coverage-filtered.info \
358 --output-directory $(BUILD_COV_DIR)/html
359 @test -z "$(EXTERN_COV_DIR)" || \
360 genhtml $(BUILD_COV_DIR)/extern-coverage.info \
361 --output-directory $(BUILD_COV_DIR)/extern-html
363 @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
364 @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
368 make -C . cov-prep test cov-post
372 @rm -rf $(BUILD_COV_DIR)
376 @rm -rf $(PAPI_INSTALL_DONE) $(PAPI_WIPE_DIST)
379 wipe-all: wipe wipe-papi wipe-cov
384 @bash -c "source $(VENV_PATH)/bin/activate && python3 -c 'from debug import start_vpp_in_gdb; start_vpp_in_gdb()' $(RUN_TESTS_ARGS)"
386 .PHONY: checkstyle-python-all
387 checkstyle-python-all: $(PIP_INSTALL_DONE)
388 @bash -c "source $(VENV_PATH)/bin/activate &&\
389 black -t py39 --check --diff $(WS_ROOT) ||\
390 (echo \"*************************************************************************\" &&\
391 echo \"* Test framework PEP8 compliance check FAILED (maybe: make fixstyle-python)\" &&\
392 echo \"*************************************************************************\" &&\
394 @echo "*******************************************************************"
395 @echo "* Test framework PEP8 compliance check passed"
396 @echo "*******************************************************************"
399 checkstyle: checkstyle-python-all
401 .PHONY: fixstyle-python-all
402 fixstyle-python-all: $(PIP_INSTALL_DONE)
403 @bash -c "source $(VENV_PATH)/bin/activate &&\
404 black -t py39 $(WS_ROOT) ||\
405 (echo \"*************************************************************************\" &&\
406 echo \"* Test framework PEP8 compliance check FAILED (maybe: make fixstyle-python)\" &&\
407 echo \"*************************************************************************\" &&\
409 @echo "*******************************************************************"
410 @echo "* Test framework PEP8 compliance check passed"
411 @echo "*******************************************************************"
415 @echo "Running tests:"
417 @echo " test - build and run (basic) functional tests"
418 @echo " test-debug - build and run (basic) functional tests (debug build)"
419 @echo " test-cov - generate code coverage report for functional tests"
420 @echo " test-cov-prep - coverage phase #1 : prepare lcov"
421 @echo " test-cov-build - coverage phase #2 : build gcov image & run tests against it (use TEST=)"
422 @echo " test-cov-post - coverage phase #3 : generate lcov html report"
423 @echo " test-all - build and run functional and extended tests"
424 @echo " test-all-debug - build and run functional and extended tests (debug build)"
425 @echo " test-all-cov - generate code coverage report for functional and extended tests"
426 @echo " retest - run functional tests"
427 @echo " retest-debug - run functional tests (debug build)"
428 @echo " retest-all - run functional and extended tests"
429 @echo " retest-all-debug - run functional and extended tests (debug build)"
430 @echo " test-wipe - wipe (temporary) files generated by unit tests"
431 @echo " test-wipe-cov - wipe code coverage report for test framework"
432 @echo " test-wipe-papi - rebuild vpp_papi sources"
433 @echo " test-wipe-all - wipe (temporary) files generated by unit tests, and coverage"
434 @echo " test-shell - enter shell with test environment"
435 @echo " test-shell-debug - enter shell with test environment (debug build)"
436 @echo " test-refresh-deps - refresh the Python dependencies for the tests"
438 @echo "Environment variables controlling test runs:"
441 @echo " set test verbosity level: 0=ERROR, 1=INFO, 2=DEBUG"
443 @echo " TEST_JOBS=[<n>|auto]"
444 @echo " use at most <n> parallel python processes for test"
445 @echo " execution, if auto, set to number of available cpus"
446 @echo " (default: 1)"
448 @echo " MAX_VPP_CPUS=[<n>|auto]"
449 @echo " use at most <n> cpus for running vpp"
450 @echo " 'auto' sets to number of available cpus"
451 @echo " (default: auto)"
453 @echo " CACHE_OUTPUT=[0|n|no]"
454 @echo " disable caching VPP stdout/stderr and logging it"
455 @echo " as one block after test finishes"
456 @echo " (default: yes)"
458 @echo " FAILFAST=[1|y|yes]"
459 @echo " if enabled, stop running tests on first failure"
460 @echo " otherwise finish running whole suite"
461 @echo " (default: no)"
463 @echo " TIMEOUT=<timeout>"
464 @echo " fail test suite if any single test takes longer"
465 @echo " than <timeout> (in seconds) to finish"
466 @echo " (default: 600)"
469 @echo " retry failed tests <n> times"
470 @echo " (default: 0)"
472 @echo " DEBUG=<type>"
473 @echo " configure VPP debugging:"
475 @echo " detect coredump and load it in gdb on crash"
478 @echo " print VPP PID and wait for user input before"
479 @echo " running and tearing down a testcase, allowing"
480 @echo " easy gdb attach"
482 @echo " DEBUG=gdbserver"
483 @echo " same as above, but run gdb inside a gdb server"
485 @echo " DEBUG=attach"
486 @echo " attach to existing vpp in running in gdb"
487 @echo " (see test-start-vpp-in-gdb)"
488 @echo " (default: none)"
490 @echo " STEP=[1|y|yes]"
491 @echo " enable stepping through a testcase"
492 @echo " (default: no)"
494 @echo " SANITY=[0|n|no]"
495 @echo " disable sanity import of vpp-api/vpp sanity"
496 @echo " run before running tests"
497 @echo " (default: yes)"
499 @echo " EXTENDED_TESTS=[1|y|yes]"
500 @echo " run extended tests"
501 @echo " (default: no)"
503 @echo " TEST=<filter>,[<filter>],..."
504 @echo " only run tests matching one or more comma-delimited"
505 @echo " filter expressions"
507 @echo " simple filter:"
508 @echo " file name or file suffix select all tests from a file"
510 @echo " TEST=test_bfd"
512 @echo " equivalent expressions selecting all"
513 @echo " tests defined in test_bfd.py"
515 @echo " wildcard filter:"
516 @echo " advanced filtering based on test file, test class"
517 @echo " and test function"
518 @echo " each filter expression is in the form of"
519 @echo " <file>.<class>.<test function>"
520 @echo " each of the tokens can be left empty or replaced"
521 @echo " with '*' to select all objects available"
523 @echo " TEST=test_bfd.*.*"
524 @echo " TEST=test_bfd.."
525 @echo " TEST=bfd.*.*"
527 @echo " select all tests defined in test_bfd.py"
528 @echo " TEST=bfd.BFDAPITestCase.*"
529 @echo " TEST=bfd.BFDAPITestCase."
530 @echo " select all tests from test_bfd.py"
531 @echo " which are part of BFDAPITestCase class"
532 @echo " TEST=bfd.BFDAPITestCase.test_add_bfd"
533 @echo " select a single test named test_add_bfd"
534 @echo " from test_bfd.py/BFDAPITestCase"
535 @echo " TEST=..test_add_bfd"
536 @echo " TEST=*.*.test_add_bfd"
537 @echo " select all test functions named test_add_bfd"
538 @echo " from all files/classes"
539 @echo " TEST=bfd,ip4,..test_icmp_error"
540 @echo " select all test functions in test_bfd.py,"
541 @echo " test_ip4.py and all test functions named"
542 @echo " 'test_icmp_error' in all files"
543 @echo " (default: '')"
545 @echo " VARIANT=<variant>"
546 @echo " specify which march node variant to unit test"
547 @echo " e.g. VARIANT=skx test the skx march variants"
548 @echo " e.g. VARIANT=icl test the icl march variants"
549 @echo " (default: '')"
551 @echo " COREDUMP_SIZE=<size>"
552 @echo " pass <size> as unix { coredump-size <size> } argument"
553 @echo " to vpp, e.g. COREDUMP_SIZE=4g or COREDUMP_SIZE=unlimited"
554 @echo " (default: '')"
556 @echo " COREDUMP_COMPRESS=[1|y|yes]"
557 @echo " if no debug option is set, compress any core files"
558 @echo " (default: no)"
560 @echo " EXTERN_TESTS=<path>"
561 @echo " include out-of-tree test_*.py files under <path>"
562 @echo " (default: '')"
564 @echo " EXTERN_PLUGINS=<path>"
565 @echo " load out-of-tree vpp plugins in <path>"
566 @echo " (default: '')"
568 @echo " EXTERN_COV_DIR=<path>"
569 @echo " path to out-of-tree prefix, where source, object"
570 @echo " and .gcda files can be found for coverage report"
571 @echo " (default: '')"
573 @echo " PROFILE=[1|y|yes]"
574 @echo " enable profiling of test framework via cProfile module"
575 @echo " (default: no)"
577 @echo " PROFILE_SORT_BY=opt"
578 @echo " sort profiling report by opt - see cProfile documentation"
579 @echo " for possible values"
580 @echo " (default: cumtime)"
582 @echo " PROFILE_OUTPUT=file"
583 @echo " output profiling info to file - use absolute path"
584 @echo " (default: stdout)"
586 @echo " TEST_DEBUG=[1|y|yes]"
587 @echo " enable debugging of the test framework itself (expert)"
588 @echo " (default: no)"
590 @echo " TEST_GCOV=[1|y|yes]"
591 @echo " enable tests specifically designed soley for code coverage"
592 @echo " (default: no)"
594 @echo " API_FUZZ=[1|y|yes]"
595 @echo " enable VPP api fuzz testing"
596 @echo " (default: no)"
598 @echo " RND_SEED=<seed>"
599 @echo " random seed used by test framework"
600 @echo " (default: time.time())"
602 @echo "Starting VPP in GDB for use with DEBUG=attach:"
604 @echo " test-start-vpp-in-gdb - start VPP in gdb (release)"
605 @echo " test-start-vpp-debug-in-gdb - start VPP in gdb (debug)"