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 export TEST_DOC_BR = $(TEST_DIR)/doc/build
18 FAILED_DIR=/tmp/vpp-failed-unittests/
19 VPP_TEST_DIRS=$(shell ls -d $(TEST_DIR) $(EXTERN_TESTS))
24 else ifeq ($(DEBUG),gdbserver)
26 else ifeq ($(DEBUG),gdb-all)
28 else ifeq ($(DEBUG),gdbserver-all)
30 else ifeq ($(DEBUG),core)
32 else ifeq ($(DEBUG),attach)
35 else ifeq ($(STEP),yes)
46 PROFILE_OUTPUT_OPTS=-o $(PROFILE_OUTPUT)
49 ifndef PROFILE_SORT_BY
50 PROFILE_SORT_BY=cumtime
54 PYTHON_PROFILE_OPTS=-m cProfile $(PROFILE_OUTPUT_OPTS) -s $(PROFILE_SORT_BY)
59 UNITTEST_FAILFAST_OPTS=
62 UNITTEST_EXTRA_OPTS=-f
65 ifneq ($(EXTERN_TESTS),)
66 UNITTEST_EXTRA_OPTS=$(UNITTEST_FAILFAST_OPTS) -d $(EXTERN_TESTS)
69 VENV_PATH=$(TEST_DIR)/venv
71 ifeq ($(TEST_DEBUG),1)
72 VENV_RUN_DIR:=$(VENV_PATH)/run-debug
74 VENV_RUN_DIR:=$(VENV_PATH)/run
80 PYTHON_INTERP=$(PYTHON)
83 PYTHON_VERSION=$(shell $(PYTHON_INTERP) -c 'import sys; print(sys.version_info.major)')
85 # Keep in sync with requirements.txt
86 PIP_TOOLS_VERSION=6.2.0
87 PYTHON_DEPENDS=requirements-$(PYTHON_VERSION).txt
88 SCAPY_SOURCE=$(shell find $(VENV_PATH)/lib/python* -name site-packages)
89 BUILD_COV_DIR=$(TEST_BR)/coverage
91 PIP_TOOLS_INSTALL_DONE=$(VENV_RUN_DIR)/pip-tools-install-$(PYTHON_VERSION)-$(PIP_TOOLS_VERSION).done
92 PIP_INSTALL_DONE=$(VENV_RUN_DIR)/pip-install-$(PYTHON_VERSION)-$(PIP_VERSION).done
93 PIP_PATCH_DONE=$(VENV_RUN_DIR)/pip-patch-$(PYTHON_VERSION).done
94 PAPI_INSTALL_DONE=$(VENV_RUN_DIR)/papi-install-$(PYTHON_VERSION).done
95 PAPI_PYTHON_SRC_DIR=$(WS_ROOT)/src/vpp-api/python
96 PAPI_WIPE_DIST=$(WS_ROOT)/src/vpp-api/vapi/__pycache__ \
97 $(PAPI_PYTHON_SRC_DIR)/build \
98 $(PAPI_PYTHON_SRC_DIR)/vpp_papi.egg-info \
99 $(PAPI_PYTHON_SRC_DIR)/vpp_papi/__pycache__
101 $(PIP_TOOLS_INSTALL_DONE):
103 @mkdir -p $(VENV_RUN_DIR)
104 @$(PYTHON_INTERP) -m venv $(VENV_PATH)
105 # pip version pinning
106 @bash -c "source $(VENV_PATH)/bin/activate && \
107 $(PYTHON_INTERP) -m pip install pip===$(PIP_VERSION)"
108 @bash -c "source $(VENV_PATH)/bin/activate && \
109 $(PYTHON_INTERP) -m pip install pip-tools===$(PIP_TOOLS_VERSION)"
112 $(PYTHON_DEPENDS): requirements.txt
113 @bash -c "source $(VENV_PATH)/bin/activate && \
114 CUSTOM_COMPILE_COMMAND='make test-refresh-deps (or update requirements.txt)' \
115 $(PYTHON_INTERP) -m piptools compile -q --generate-hashes requirements.txt --output-file $@"
117 $(PIP_INSTALL_DONE): $(PIP_TOOLS_INSTALL_DONE) $(PYTHON_DEPENDS)
118 @bash -c "source $(VENV_PATH)/bin/activate && \
119 $(PYTHON_INTERP) -m piptools sync $(PYTHON_DEPENDS)"
122 $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
123 @echo --- patching ---
124 @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
125 for f in $(CURDIR)/patches/scapy-2.4.3/*.patch ; do \
126 echo Applying patch: $$(basename $$f) ; \
127 patch --forward -p1 -d $(SCAPY_SOURCE) < $$f ; \
129 [ $$retCode -gt 1 ] && exit $$retCode; \
133 $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
134 @bash -c "source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) -m pip install -e $(PAPI_PYTHON_SRC_DIR)"
138 refresh-deps: clean-deps $(PYTHON_DEPENDS)
142 @rm -f $(PYTHON_DEPENDS)
144 INTERN_PLUGIN_SRC_DIR=$(WS_ROOT)/src/plugins
145 ifneq ($(EXTERN_PLUGIN_SRC_DIR),)
146 PLUGIN_SRC_DIR=$(EXTERN_PLUGIN_SRC_DIR)
148 PLUGIN_SRC_DIR=$(INTERN_PLUGIN_SRC_DIR)
152 @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) run_tests.py -d $(TEST_DIR) $(UNITTEST_EXTRA_OPTS) || env FAILED_DIR=$(FAILED_DIR) COMPRESS_FAILED_TEST_LOGS=$(COMPRESS_FAILED_TEST_LOGS) scripts/compress_failed.sh
158 SANITY_IMPORT_VPP_PAPI_CMD=true
159 SANITY_RUN_VPP_CMD=true
161 SANITY_IMPORT_VPP_PAPI_CMD=source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) sanity_import_vpp_papi.py
162 SANITY_RUN_VPP_CMD=source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) sanity_run_vpp.py
167 else ifeq ($(FORCE_FOREGROUND),0)
169 else ifeq ($(TEST_JOBS),auto)
171 else ifeq ($(TEST_JOBS),1)
178 @bash -c "test $(PARALLEL_ILLEGAL) -eq 0 ||\
179 (echo \"*******************************************************************\" &&\
180 echo \"* Sanity check failed, TEST_JOBS is not 1 or 'auto' and DEBUG, STEP or PROFILE is set\" &&\
181 echo \"*******************************************************************\" &&\
183 @bash -c "$(SANITY_IMPORT_VPP_PAPI_CMD) ||\
184 (echo \"*******************************************************************\" &&\
185 echo \"* Sanity check failed, cannot import vpp_papi\" &&\
186 echo \"* to debug: \" &&\
187 echo \"* 1. enter test shell: make test-shell\" &&\
188 echo \"* 2. execute debugger: gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
189 echo \"*******************************************************************\" &&\
191 @bash -c "$(SANITY_RUN_VPP_CMD) ||\
192 (echo \"*******************************************************************\" &&\
193 echo \"* Sanity check failed, cannot run vpp\" &&\
194 echo \"*******************************************************************\" &&\
201 test-dep: $(PAPI_INSTALL_DONE) $(FAILED_DIR)
204 test: test-dep sanity
208 retest: verify-env sanity $(FAILED_DIR)
213 @echo "source $(VENV_PATH)/bin/activate;\
214 export RND_SEED=$(RND_SEED);\
216 echo PYTHONPATH=$(PYTHONPATH);\
217 echo RND_SEED=$(RND_SEED);\
218 echo VPP_BUILD_DIR=$(VPP_BUILD_DIR);\
219 echo VPP_BIN=$(VPP_BIN);\
220 echo VPP_PLUGIN_PATH=$(VPP_PLUGIN_PATH);\
221 echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\
222 echo VPP_INSTALL_PATH=$(VPP_INSTALL_PATH);\
223 echo EXTERN_TESTS=$(EXTERN_TESTS);\
224 echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\
225 echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\
226 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
228 exec </dev/tty" | bash -i
232 @rm -f /dev/shm/vpp-unittest-*
233 @if [ $(FORCE_NO_WIPE) -eq "0" ] ; then rm -rf /tmp/vpp-unittest-*; fi
234 @rm -f /tmp/api_post_mortem.*
235 @rm -rf $(FAILED_DIR)
240 @rm -rf $(patsubst %,%/__pycache__, $(VPP_TEST_DIRS))
242 $(TEST_DOC_BR): $(PIP_INSTALL_DONE)
244 @bash -c "source $(VENV_PATH)/bin/activate && make -C doc html"
247 doc: $(PIP_PATCH_DONE) $(TEST_DOC_BR)
249 @echo "Test Documentation URL: $(TEST_DOC_BR)/html/index.html"
250 @echo "Run 'make test-wipe-doc test-doc' to rebuild the test docs"
255 @rm -rf $(TEST_DOC_BR)
261 cov: wipe-cov test-dep ext $(BUILD_COV_DIR)
262 @lcov --zerocounters --directory $(VPP_BUILD_DIR)
263 @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
265 @lcov --capture --directory $(VPP_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
266 @test -z "$(EXTERN_COV_DIR)" || lcov --capture --directory $(EXTERN_COV_DIR) --output-file $(BUILD_COV_DIR)/extern-coverage.info
267 @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
268 @test -z "$(EXTERN_COV_DIR)" || genhtml $(BUILD_COV_DIR)/extern-coverage.info --output-directory $(BUILD_COV_DIR)/extern-html
270 @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
271 @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
275 @rm -rf $(BUILD_COV_DIR)
279 @rm -rf $(PAPI_INSTALL_DONE) $(PAPI_WIPE_DIST)
282 wipe-all: wipe wipe-papi wipe-doc wipe-cov
285 .PHONY: checkstyle-diff
286 checkstyle-diff: $(PIP_INSTALL_DONE)
287 @bash -c "source $(VENV_PATH)/bin/activate &&\
288 $(PYTHON_INTERP) -m pip install pycodestyle"
289 @bash -c "source $(VENV_PATH)/bin/activate &&\
290 cd $(WS_ROOT) && git diff --name-only --no-color --relative HEAD~1 ':!*.patch' | grep '.py$$' | xargs -n 1 -I XXX \
291 pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 -v XXX ||\
292 (echo \"*********************************************************************\" &&\
293 echo \"* Test framework PEP8 compliance check FAILED (checked changed files)\" &&\
294 echo \"*********************************************************************\" &&\
296 @echo "*********************************************************************"
297 @echo "* Test framework PEP8 compliance check passed (checked changed files)"
298 @echo "*********************************************************************"
303 $(eval FORCE_FOREGROUND=1)
307 checkstyle: $(PIP_INSTALL_DONE)
308 @bash -c "source $(VENV_PATH)/bin/activate &&\
309 $(PYTHON_INTERP) -m pip install pycodestyle"
310 @bash -c "source $(VENV_PATH)/bin/activate &&\
311 pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 -v *.py ||\
312 (echo \"*******************************************************************\" &&\
313 echo \"* Test framework PEP8 compliance check FAILED (checked all files)\" &&\
314 echo \"*******************************************************************\" &&\
316 @echo "*******************************************************************"
317 @echo "* Test framework PEP8 compliance check passed (checked all files)"
318 @echo "*******************************************************************"
322 @echo "Running tests:"
324 @echo " test - build and run (basic) functional tests"
325 @echo " test-debug - build and run (basic) functional tests (debug build)"
326 @echo " test-all - build and run functional and extended tests"
327 @echo " test-all-debug - build and run functional and extended tests (debug build)"
328 @echo " retest - run functional tests"
329 @echo " retest-debug - run functional tests (debug build)"
330 @echo " retest-all - run functional and extended tests"
331 @echo " retest-all-debug - run functional and extended tests (debug build)"
332 @echo " test-cov - generate code coverage report for test framework"
333 @echo " test-gcov - build and run functional tests (gcov build)"
334 @echo " test-wipe - wipe (temporary) files generated by unit tests"
335 @echo " test-wipe-cov - wipe code coverage report for test framework"
336 @echo " test-wipe-doc - wipe documentation for test framework"
337 @echo " test-wipe-papi - rebuild vpp_papi sources"
338 @echo " test-wipe-all - wipe (temporary) files generated by unit tests, docs, and coverage"
339 @echo " test-shell - enter shell with test environment"
340 @echo " test-shell-debug - enter shell with test environment (debug build)"
341 @echo " test-checkstyle - check PEP8 compliance for test framework"
342 @echo " test-refresh-deps - refresh the Python dependencies for the tests"
344 @echo "Arguments controlling test runs:"
345 @echo " V=[0|1|2] - set test verbosity level"
346 @echo " 0=ERROR, 1=INFO, 2=DEBUG"
347 @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)"
348 @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)"
349 @echo " CACHE_OUTPUT=[0|1] - cache VPP stdout/stderr and log as one block after test finishes (default: 1)"
350 @echo " FAILFAST=[0|1] - fail fast if 1, complete all tests if 0"
351 @echo " TIMEOUT=<timeout> - fail test suite if any single test takes longer than <timeout> (in seconds) to finish (default: 600)"
352 @echo " RETRIES=<n> - retry failed tests <n> times"
353 @echo " DEBUG=<type> - set VPP debugging kind"
354 @echo " DEBUG=core - detect coredump and load it in gdb on crash"
355 @echo " DEBUG=gdb - allow easy debugging by printing VPP PID"
356 @echo " and waiting for user input before running"
357 @echo " and tearing down a testcase"
358 @echo " DEBUG=gdbserver - run gdb inside a gdb server, otherwise"
359 @echo " same as above"
360 @echo " DEBUG=attach - attach test case to already running vpp in gdb (see test-start-vpp-in-gdb)"
362 @echo " STEP=[yes|no] - ease debugging by stepping through a testcase"
363 @echo " SANITY=[yes|no] - perform sanity import of vpp-api/sanity vpp run before running tests (default: yes)"
364 @echo " EXTENDED_TESTS=[1|y] - used by '[re]test-all' & '[re]test-all-debug' to run extended tests"
365 @echo " TEST=<filter> - filter the set of tests:"
366 @echo " by file-name - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py"
367 @echo " by file-suffix - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py"
368 @echo " by wildcard - wildcard filter is <file>.<class>.<test function>, each can be replaced by '*'"
369 @echo " e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name"
370 @echo " TEST='bfd.*.*' is equivalent to above example of filter by file-suffix"
371 @echo " TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class"
372 @echo " TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase"
373 @echo " TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes"
375 @echo " VARIANT=<variant> - specify which march node variant to unit test"
376 @echo " e.g. VARIANT=skx test the skx march variants"
377 @echo " e.g. VARIANT=icl test the icl march variants"
379 @echo " COREDUMP_SIZE=<size> - pass <size> as unix { coredump-size <size> } argument to vpp"
380 @echo " e.g. COREDUMP_SIZE=4g"
381 @echo " COREDUMP_SIZE=unlimited"
382 @echo " COREDUMP_COMPRESS=1 - compress core files if not debugging them"
383 @echo " EXTERN_TESTS=<path> - path to out-of-tree test_<name>.py files containing test cases"
384 @echo " EXTERN_PLUGINS=<path> - path to out-of-tree plugins to be loaded by vpp under test"
385 @echo " EXTERN_COV_DIR=<path> - path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report"
387 @echo " PROFILE=1 - enable profiling of test framework via cProfile module"
388 @echo " PROFILE_SORT_BY=opt - sort profiling report by opt - consult cProfile documentation for possible values (default: cumtime)"
389 @echo " PROFILE_OUTPUT=file - output profiling info to file - use absolute path (default: stdout)"
391 @echo " TEST_DEBUG=1 - turn on debugging of the test framework itself (expert)"
393 @echo " SKIP_AARCH64=1 - skip tests that are failing on the ARM platorm in FD.io CI"
395 @echo " RND_SEED=seed - Seed RND with given seed"
397 @echo "Starting VPP in GDB for use with DEBUG=attach:"
399 @echo " test-start-vpp-in-gdb - start VPP in gdb (release)"
400 @echo " test-start-vpp-debug-in-gdb - start VPP in gdb (debug)"
402 @echo "Arguments controlling VPP in GDB runs:"
404 @echo " VPP_IN_GDB_TMP_DIR - specify directory to run VPP IN (default: /tmp/unittest-attach-gdb)"
405 @echo " VPP_IN_GDB_NO_RMDIR=0 - don't remove existing tmp dir but fail instead"
406 @echo " VPP_IN_GDB_CMDLINE=1 - add 'interactive' to VPP arguments to run with command line"
408 @echo "Creating test documentation"
409 @echo " test-doc - generate documentation for test framework"
410 @echo " test-wipe-doc - wipe documentation for test framework"
412 @echo "Creating test code coverage report"
413 @echo " test-cov - generate code coverage report for test framework"
414 @echo " test-wipe-cov - wipe code coverage report for test framework"
416 @echo "Verifying code-style"
417 @echo " test-checkstyle - check PEP8 compliance"