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 ($(findstring $(DECODE_PCAPS),1 y yes),)
262 ifneq ($(findstring $(API_PRELOAD),1 y yes),)
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')
276 EXTRA_ARGS=$(ARG0) $(ARG1) $(ARG2) $(ARG3) $(ARG4) $(ARG5) $(ARG6) $(ARG7) $(ARG8) $(ARG9) $(ARG10) $(ARG11) $(ARG12) $(ARG13) $(ARG14) $(ARG15) $(ARG16) $(ARG17) $(ARG18) $(ARG19)
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)
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
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 \"*******************************************************************\" &&\
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 \"*******************************************************************\" &&\
304 test-dep: $(PAPI_INSTALL_DONE) $(FAILED_DIR)
307 test: test-dep sanity
311 retest: verify-env sanity $(FAILED_DIR)
316 @echo "source $(VENV_PATH)/bin/activate;\
317 export RND_SEED=$(RND_SEED);\
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);\
330 exec </dev/tty" | bash -i
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
342 @rm -rf $(VENV_BR_DIR)
343 @rm -rf $(patsubst %,%/__pycache__, $(VPP_TEST_DIRS))
350 @lcov --zerocounters --directory $(VPP_BUILD_DIR)
351 @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
354 cov-post: wipe-cov $(BUILD_COV_DIR)
356 --directory $(VPP_BUILD_DIR) \
357 --output-file $(BUILD_COV_DIR)/coverage.info
358 @test -z "$(EXTERN_COV_DIR)" || \
360 --directory $(EXTERN_COV_DIR) \
361 --output-file $(BUILD_COV_DIR)/extern-coverage.info
362 @lcov --remove $(BUILD_COV_DIR)/coverage.info \
363 "/usr/include/*" "*/build-root/*" "/opt/*" "/usr/lib/*" \
364 "*_test.*" "*vat*" "*rdma*" "*/vpp-api/client/*" "*/plugins/af_packet/*" \
365 "*/plugins/af_xdp/*" "*/plugins/avf/*" "*/plugins/dma_intel/*" \
366 "*/plugins/hs_apps/*" "*/plugins/vmxnet3/*" "*/vnet/devices/virtio/*" \
367 "*/plugins/perfmon/arm*" "*/plugins/perfmon/intel/*" "*/vlib/vmbus/*" \
368 "*/vnet/dev/*" "*/plugins/dev_ena/*" "*/plugins/builtinurl/*" "*/vnet/flow/*" \
369 "*/plugins/http_static/builtinurl/*" "*/plugins/dev_iavf/*" \
370 -o $(BUILD_COV_DIR)/coverage-filtered.info
371 @genhtml $(BUILD_COV_DIR)/coverage-filtered.info \
372 --output-directory $(BUILD_COV_DIR)/html
373 @test -z "$(EXTERN_COV_DIR)" || \
374 genhtml $(BUILD_COV_DIR)/extern-coverage.info \
375 --output-directory $(BUILD_COV_DIR)/extern-html
377 @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
378 @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
382 $(MAKE) -C . cov-prep test cov-post
386 @rm -rf $(BUILD_COV_DIR)
390 @rm -rf $(PAPI_INSTALL_DONE) $(PAPI_WIPE_DIST)
393 wipe-all: wipe wipe-papi wipe-cov
398 @bash -c "source $(VENV_PATH)/bin/activate && python3 -c 'from debug import start_vpp_in_gdb; start_vpp_in_gdb()' $(RUN_TESTS_ARGS)"
400 .PHONY: checkstyle-python-all
401 checkstyle-python-all: $(PIP_INSTALL_DONE)
402 @bash -c "source $(VENV_PATH)/bin/activate &&\
403 black -t py39 --check --diff $(WS_ROOT) ||\
404 (echo \"*************************************************************************\" &&\
405 echo \"* Test framework PEP8 compliance check FAILED (maybe: make fixstyle-python)\" &&\
406 echo \"*************************************************************************\" &&\
408 @echo "*******************************************************************"
409 @echo "* Test framework PEP8 compliance check passed"
410 @echo "*******************************************************************"
413 checkstyle: checkstyle-python-all
415 .PHONY: fixstyle-python-all
416 fixstyle-python-all: $(PIP_INSTALL_DONE)
417 @bash -c "source $(VENV_PATH)/bin/activate &&\
418 black -t py39 $(WS_ROOT) ||\
419 (echo \"*************************************************************************\" &&\
420 echo \"* Test framework PEP8 compliance check FAILED (maybe: make fixstyle-python)\" &&\
421 echo \"*************************************************************************\" &&\
423 @echo "*******************************************************************"
424 @echo "* Test framework PEP8 compliance check passed"
425 @echo "*******************************************************************"
429 @echo "Running tests:"
431 @echo " test - build and run (basic) functional tests"
432 @echo " test-debug - build and run (basic) functional tests (debug build)"
433 @echo " test-cov - generate code coverage report for functional tests"
434 @echo " test-cov-prep - coverage phase #1 : prepare lcov"
435 @echo " test-cov-build - coverage phase #2 : build gcov image & run tests against it (use TEST=)"
436 @echo " test-cov-post - coverage phase #3 : generate lcov html report"
437 @echo " test-all - build and run functional and extended tests"
438 @echo " test-all-debug - build and run functional and extended tests (debug build)"
439 @echo " test-all-cov - generate code coverage report for functional and extended tests"
440 @echo " retest - run functional tests"
441 @echo " retest-debug - run functional tests (debug build)"
442 @echo " retest-all - run functional and extended tests"
443 @echo " retest-all-debug - run functional and extended tests (debug build)"
444 @echo " test-wipe - wipe (temporary) files generated by unit tests"
445 @echo " test-wipe-cov - wipe code coverage report for test framework"
446 @echo " test-wipe-papi - rebuild vpp_papi sources"
447 @echo " test-wipe-all - wipe (temporary) files generated by unit tests, and coverage"
448 @echo " test-shell - enter shell with test environment"
449 @echo " test-shell-debug - enter shell with test environment (debug build)"
450 @echo " test-refresh-deps - refresh the Python dependencies for the tests"
452 @echo "Environment variables controlling test runs:"
455 @echo " set test verbosity level: 0=ERROR, 1=INFO, 2=DEBUG"
457 @echo " TEST_JOBS=[<n>|auto]"
458 @echo " use at most <n> parallel python processes for test"
459 @echo " execution, if auto, set to number of available cpus"
460 @echo " (default: 1)"
462 @echo " MAX_VPP_CPUS=[<n>|auto]"
463 @echo " use at most <n> cpus for running vpp"
464 @echo " 'auto' sets to number of available cpus"
465 @echo " (default: auto)"
467 @echo " CACHE_OUTPUT=[0|n|no]"
468 @echo " disable caching VPP stdout/stderr and logging it"
469 @echo " as one block after test finishes"
470 @echo " (default: yes)"
472 @echo " FAILFAST=[1|y|yes]"
473 @echo " if enabled, stop running tests on first failure"
474 @echo " otherwise finish running whole suite"
475 @echo " (default: no)"
477 @echo " TIMEOUT=<timeout>"
478 @echo " fail test suite if any single test takes longer"
479 @echo " than <timeout> (in seconds) to finish"
480 @echo " (default: 600)"
483 @echo " retry failed tests <n> times"
484 @echo " (default: 0)"
486 @echo " DEBUG=<type>"
487 @echo " configure VPP debugging:"
489 @echo " detect coredump and load it in gdb on crash"
492 @echo " print VPP PID and wait for user input before"
493 @echo " running and tearing down a testcase, allowing"
494 @echo " easy gdb attach"
496 @echo " DEBUG=gdbserver"
497 @echo " same as above, but run gdb inside a gdb server"
499 @echo " DEBUG=attach"
500 @echo " attach to existing vpp in running in gdb"
501 @echo " (see test-start-vpp-in-gdb)"
502 @echo " (default: none)"
504 @echo " STEP=[1|y|yes]"
505 @echo " enable stepping through a testcase"
506 @echo " (default: no)"
508 @echo " SANITY=[0|n|no]"
509 @echo " disable sanity import of vpp-api/vpp sanity"
510 @echo " run before running tests"
511 @echo " (default: yes)"
513 @echo " EXTENDED_TESTS=[1|y|yes]"
514 @echo " run extended tests"
515 @echo " (default: no)"
517 @echo " TEST=<filter>,[<filter>],..."
518 @echo " only run tests matching one or more comma-delimited"
519 @echo " filter expressions"
521 @echo " simple filter:"
522 @echo " file name or file suffix select all tests from a file"
524 @echo " TEST=test_bfd"
526 @echo " equivalent expressions selecting all"
527 @echo " tests defined in test_bfd.py"
529 @echo " wildcard filter:"
530 @echo " advanced filtering based on test file, test class"
531 @echo " and test function"
532 @echo " each filter expression is in the form of"
533 @echo " <file>.<class>.<test function>"
534 @echo " each of the tokens can be left empty or replaced"
535 @echo " with '*' to select all objects available"
537 @echo " TEST=test_bfd.*.*"
538 @echo " TEST=test_bfd.."
539 @echo " TEST=bfd.*.*"
541 @echo " select all tests defined in test_bfd.py"
542 @echo " TEST=bfd.BFDAPITestCase.*"
543 @echo " TEST=bfd.BFDAPITestCase."
544 @echo " select all tests from test_bfd.py"
545 @echo " which are part of BFDAPITestCase class"
546 @echo " TEST=bfd.BFDAPITestCase.test_add_bfd"
547 @echo " select a single test named test_add_bfd"
548 @echo " from test_bfd.py/BFDAPITestCase"
549 @echo " TEST=..test_add_bfd"
550 @echo " TEST=*.*.test_add_bfd"
551 @echo " select all test functions named test_add_bfd"
552 @echo " from all files/classes"
553 @echo " TEST=bfd,ip4,..test_icmp_error"
554 @echo " select all test functions in test_bfd.py,"
555 @echo " test_ip4.py and all test functions named"
556 @echo " 'test_icmp_error' in all files"
557 @echo " (default: '')"
559 @echo " VARIANT=<variant>"
560 @echo " specify which march node variant to unit test"
561 @echo " e.g. VARIANT=skx test the skx march variants"
562 @echo " e.g. VARIANT=icl test the icl march variants"
563 @echo " (default: '')"
565 @echo " COREDUMP_SIZE=<size>"
566 @echo " pass <size> as unix { coredump-size <size> } argument"
567 @echo " to vpp, e.g. COREDUMP_SIZE=4g or COREDUMP_SIZE=unlimited"
568 @echo " (default: '')"
570 @echo " COREDUMP_COMPRESS=[1|y|yes]"
571 @echo " if no debug option is set, compress any core files"
572 @echo " (default: no)"
574 @echo " EXTERN_TESTS=<path>"
575 @echo " include out-of-tree test_*.py files under <path>"
576 @echo " (default: '')"
578 @echo " EXTERN_PLUGINS=<path>"
579 @echo " load out-of-tree vpp plugins in <path>"
580 @echo " (default: '')"
582 @echo " EXTERN_COV_DIR=<path>"
583 @echo " path to out-of-tree prefix, where source, object"
584 @echo " and .gcda files can be found for coverage report"
585 @echo " (default: '')"
587 @echo " PROFILE=[1|y|yes]"
588 @echo " enable profiling of test framework via cProfile module"
589 @echo " (default: no)"
591 @echo " PROFILE_SORT_BY=opt"
592 @echo " sort profiling report by opt - see cProfile documentation"
593 @echo " for possible values"
594 @echo " (default: cumtime)"
596 @echo " PROFILE_OUTPUT=file"
597 @echo " output profiling info to file - use absolute path"
598 @echo " (default: stdout)"
600 @echo " TEST_DEBUG=[1|y|yes]"
601 @echo " enable debugging of the test framework itself (expert)"
602 @echo " (default: no)"
604 @echo " TEST_GCOV=[1|y|yes]"
605 @echo " enable tests specifically designed soley for code coverage"
606 @echo " (default: no)"
608 @echo " API_FUZZ=[1|y|yes]"
609 @echo " enable VPP api fuzz testing"
610 @echo " (default: no)"
612 @echo " RND_SEED=<seed>"
613 @echo " random seed used by test framework"
614 @echo " (default: time.time())"
616 @echo "Starting VPP in GDB for use with DEBUG=attach:"
618 @echo " test-start-vpp-in-gdb - start VPP in gdb (release)"
619 @echo " test-start-vpp-debug-in-gdb - start VPP in gdb (debug)"