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 = $(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; done)
25 .PHONY: verify-no-running-vpp
27 ifdef VPP_ZOMBIE_NOCHECK
30 VPP_PIDS=$(shell pgrep -d, -x vpp_main)
35 else ifeq ($(DEBUG),gdbserver)
37 else ifeq ($(DEBUG),gdb-all)
39 else ifeq ($(DEBUG),gdbserver-all)
41 else ifeq ($(DEBUG),core)
43 else ifeq ($(STEP),yes)
54 PROFILE_OUTPUT_OPTS=-o $(PROFILE_OUTPUT)
57 ifndef PROFILE_SORT_BY
58 PROFILE_SORT_BY=cumtime
62 PYTHON_PROFILE_OPTS=-m cProfile $(PROFILE_OUTPUT_OPTS) -s $(PROFILE_SORT_BY)
66 verify-no-running-vpp:
67 @if [ "$(VPP_PIDS)" != "" ]; then \
69 echo "*** Existing vpp processes detected (PID(s): $(VPP_PIDS)). Running tests under these conditions is not supported. ***"; \
77 UNITTEST_FAILFAST_OPTS=
80 UNITTEST_EXTRA_OPTS=-f
83 ifneq ($(EXTERN_TESTS),)
84 UNITTEST_EXTRA_OPTS=$(UNITTEST_FAILFAST_OPTS) -d $(EXTERN_TESTS)
87 VENV_PATH=$(TEST_BR)/venv
89 ifeq ($(TEST_DEBUG),1)
90 VENV_RUN_DIR:=$(VENV_PATH)/run-debug
92 VENV_RUN_DIR:=$(VENV_PATH)/run
98 PYTHON_INTERP=$(PYTHON)
101 PYTHON_VERSION=$(shell $(PYTHON_INTERP) -c 'import sys; print(sys.version_info.major)')
103 PIP_TOOLS_VERSION=3.8.0 # Keep in sync with requirements.txt
104 PYTHON_DEPENDS=requirements-$(PYTHON_VERSION).txt
105 SCAPY_SOURCE=$(shell find $(VENV_PATH)/lib/python* -name site-packages)
106 BUILD_COV_DIR=$(TEST_BR)/coverage
108 PIP_TOOLS_INSTALL_DONE=$(VENV_RUN_DIR)/pip-tools-install-$(PYTHON_VERSION).done
109 PIP_INSTALL_DONE=$(VENV_RUN_DIR)/pip-install-$(PYTHON_VERSION).done
110 PIP_PATCH_DONE=$(VENV_RUN_DIR)/pip-patch-$(PYTHON_VERSION).done
111 PAPI_INSTALL_DONE=$(VENV_RUN_DIR)/papi-install-$(PYTHON_VERSION).done
112 PAPI_PYTHON_SRC_DIR=$(WS_ROOT)/src/vpp-api/python
113 PAPI_WIPE_DIST=$(WS_ROOT)/src/vpp-api/vapi/__pycache__ \
114 $(PAPI_PYTHON_SRC_DIR)/build \
115 $(PAPI_PYTHON_SRC_DIR)/vpp_papi.egg-info \
116 $(PAPI_PYTHON_SRC_DIR)/vpp_papi/__pycache__
118 PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE)
120 $(PIP_TOOLS_INSTALL_DONE):
122 @mkdir -p $(VENV_RUN_DIR)
123 @virtualenv $(VENV_PATH) -p $(PYTHON_INTERP)
124 # pip version pinning
125 @bash -c "source $(VENV_PATH)/bin/activate && \
126 $(PYTHON_INTERP) -m pip install pip===$(PIP_VERSION)"
127 @bash -c "source $(VENV_PATH)/bin/activate && \
128 $(PYTHON_INTERP) -m pip install pip-tools===$(PIP_TOOLS_VERSION)"
131 $(PYTHON_DEPENDS): $(PIP_TOOLS_INSTALL_DONE) requirements.txt
132 @bash -c "source $(VENV_PATH)/bin/activate && \
133 CUSTOM_COMPILE_COMMAND='make test-refresh-deps (or update requirements.txt)' \
134 $(PYTHON_INTERP) -m piptools compile -q --generate-hashes requirements.txt --output-file $@"
136 $(PIP_INSTALL_DONE): $(PYTHON_DEPENDS)
137 @bash -c "source $(VENV_PATH)/bin/activate && \
138 $(PYTHON_INTERP) -m piptools sync $(PYTHON_DEPENDS)"
141 $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
142 @echo --- patching ---
143 @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
144 for f in $(CURDIR)/patches/scapy-2.4.3/*.patch ; do \
145 echo Applying patch: $$(basename $$f) ; \
146 patch --forward -p1 -d $(SCAPY_SOURCE) < $$f ; \
148 [ $$retCode -gt 0 ] && exit $$retCode; \
152 $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
153 @bash -c "source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) -m pip install -e $(PAPI_PYTHON_SRC_DIR)"
157 refresh-deps: clean-deps $(PYTHON_DEPENDS)
161 @rm -f $(PYTHON_DEPENDS)
163 INTERN_PLUGIN_SRC_DIR=$(WS_ROOT)/src/plugins
164 ifneq ($(EXTERN_PLUGIN_SRC_DIR),)
165 PLUGIN_SRC_DIR=$(EXTERN_PLUGIN_SRC_DIR)
167 PLUGIN_SRC_DIR=$(INTERN_PLUGIN_SRC_DIR)
171 @env 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
177 SANITY_IMPORT_VPP_PAPI_CMD=true
178 SANITY_RUN_VPP_CMD=true
180 SANITY_IMPORT_VPP_PAPI_CMD=source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) $(BUILD_TEST_SRC)/sanity_import_vpp_papi.py
181 SANITY_RUN_VPP_CMD=source $(VENV_PATH)/bin/activate && PYTHONPATH=$(BUILD_TEST_SRC) $(PYTHON_INTERP) $(BUILD_TEST_SRC)/sanity_run_vpp.py
186 else ifeq ($(FORCE_FOREGROUND),0)
188 else ifeq ($(TEST_JOBS),auto)
190 else ifeq ($(TEST_JOBS),1)
196 sanity: test-dep verify-no-running-vpp
197 @sys_req/dev_shm_size.sh
198 @bash -c "test $(PARALLEL_ILLEGAL) -eq 0 ||\
199 (echo \"*******************************************************************\" &&\
200 echo \"* Sanity check failed, TEST_JOBS is not 1 or 'auto' and DEBUG, STEP or PROFILE is set\" &&\
201 echo \"*******************************************************************\" &&\
203 @bash -c "$(SANITY_IMPORT_VPP_PAPI_CMD) ||\
204 (echo \"*******************************************************************\" &&\
205 echo \"* Sanity check failed, cannot import vpp_papi\" &&\
206 echo \"* to debug: \" &&\
207 echo \"* 1. enter test shell: make test-shell\" &&\
208 echo \"* 2. execute debugger: gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
209 echo \"*******************************************************************\" &&\
211 @bash -c "$(SANITY_RUN_VPP_CMD) ||\
212 (echo \"*******************************************************************\" &&\
213 echo \"* Sanity check failed, cannot run vpp\" &&\
214 echo \"*******************************************************************\" &&\
217 .PHONY: ext-test-apps
219 make -C ext test-apps
221 $(BUILD_TEST_SRC): verify-env
223 @for file in $(VPP_TEST_SRC); do if [ ! -e $(BUILD_TEST_SRC)/$$(basename $$file) ] ; then ln -s $$file $(BUILD_TEST_SRC) ; fi ; done
229 test-dep: $(BUILD_TEST_SRC) $(PAPI_INSTALL_DONE) $(FAILED_DIR)
232 test: test-dep ext-test-apps sanity
236 retest: verify-env sanity $(FAILED_DIR)
241 @echo "source $(VENV_PATH)/bin/activate;\
242 cd $(BUILD_TEST_SRC);\
243 export PYTHONPATH=$(BUILD_TEST_SRC);\
244 export RND_SEED=$(RND_SEED);\
246 echo PYTHONPATH=$(BUILD_TEST_SRC);\
247 echo RND_SEED=$(RND_SEED);\
248 echo VPP_BUILD_DIR=$(VPP_BUILD_DIR);\
249 echo VPP_BIN=$(VPP_BIN);\
250 echo VPP_PLUGIN_PATH=$(VPP_PLUGIN_PATH);\
251 echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\
252 echo VPP_INSTALL_PATH=$(VPP_INSTALL_PATH);\
253 echo EXTERN_TESTS=$(EXTERN_TESTS);\
254 echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\
255 echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\
256 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
258 exec </dev/tty" | bash -i
262 @rm -f /dev/shm/vpp-unittest-*
263 @rm -rf /tmp/vpp-unittest-*
264 @rm -f /tmp/api_post_mortem.*
265 @rm -rf $(FAILED_DIR)
271 @rm -rf $(patsubst %,%/__pycache__, $(VPP_TEST_DIRS) $(BUILD_TEST_SRC))
275 @bash -c "source $(VENV_PATH)/bin/activate && \
276 $(PYTHON_INTERP) -m pip install sphinx sphinx-rtd-theme"
277 @bash -c "source $(VENV_PATH)/bin/activate && make -C doc html"
280 doc: $(BUILD_TEST_SRC) $(PIP_PATCH_DONE) $(TEST_DOC_BR)
282 @echo "Test Documentation URL: $(TEST_DOC_BR)/html/index.html"
283 @echo "Run 'make test-wipe-doc test-doc' to rebuild the test docs"
288 @rm -rf $(TEST_DOC_BR)
294 cov: wipe-cov test-dep ext $(BUILD_COV_DIR)
295 @lcov --zerocounters --directory $(VPP_BUILD_DIR)
296 @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
298 @lcov --capture --directory $(VPP_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
299 @test -z "$(EXTERN_COV_DIR)" || lcov --capture --directory $(EXTERN_COV_DIR) --output-file $(BUILD_COV_DIR)/extern-coverage.info
300 @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
301 @test -z "$(EXTERN_COV_DIR)" || genhtml $(BUILD_COV_DIR)/extern-coverage.info --output-directory $(BUILD_COV_DIR)/extern-html
303 @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
304 @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
308 @rm -rf $(BUILD_COV_DIR)
312 @rm -rf $(PAPI_INSTALL_DONE) $(PAPI_WIPE_DIST)
315 wipe-all: wipe wipe-papi wipe-doc wipe-cov
319 checkstyle: $(BUILD_TEST_SRC) $(PIP_INSTALL_DONE)
320 @bash -c "source $(VENV_PATH)/bin/activate &&\
321 $(PYTHON_INTERP) -m pip install pycodestyle"
322 @bash -c "source $(VENV_PATH)/bin/activate &&\
323 pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 -v $(BUILD_TEST_SRC)/*.py ||\
324 (echo \"*******************************************************************\" &&\
325 echo \"* Test framework PEP8 compliance check FAILED \" &&\
326 echo \"*******************************************************************\" &&\
328 @echo "*******************************************************************"
329 @echo "* Test framework PEP8 compliance check passed"
330 @echo "*******************************************************************"
334 @echo "Running tests:"
336 @echo " test - build and run (basic) functional tests"
337 @echo " test-debug - build and run (basic) functional tests (debug build)"
338 @echo " test-all - build and run functional and extended tests"
339 @echo " test-all-debug - build and run functional and extended tests (debug build)"
340 @echo " retest - run functional tests"
341 @echo " retest-debug - run functional tests (debug build)"
342 @echo " retest-all - run functional and extended tests"
343 @echo " retest-all-debug - run functional and extended tests (debug build)"
344 @echo " test-cov - generate code coverage report for test framework"
345 @echo " test-gcov - build and run functional tests (gcov build)"
347 @echo " test-wipe - wipe (temporary) files generated by unit tests"
348 @echo " test-wipe-cov - wipe code coverage report for test framework"
349 @echo " test-wipe-doc - wipe documentation for test framework"
350 @echo " test-wipe-papi - rebuild vpp_papi sources"
351 @echo " test-wipe-all - wipe (temporary) files generated by unit tests, docs, and coverage"
352 @echo " test-shell - enter shell with test environment"
353 @echo " test-shell-debug - enter shell with test environment (debug build)"
354 @echo " test-checkstyle - check PEP8 compliance for test framework"
355 @echo " test-refresh-deps - refresh the Python dependencies for the tests"
357 @echo "Arguments controlling test runs:"
358 @echo " V=[0|1|2] - set test verbosity level"
359 @echo " 0=ERROR, 1=INFO, 2=DEBUG"
360 @echo " TEST_JOBS=[<n>|auto] - use <n> parallel processes for test execution or automatic discovery of maximum acceptable processes (default: 1)"
361 @echo " CACHE_OUTPUT=[0|1] - cache VPP stdout/stderr and log as one block after test finishes (default: 1)"
362 @echo " FAILFAST=[0|1] - fail fast if 1, complete all tests if 0"
363 @echo " TIMEOUT=<timeout> - fail test suite if any single test takes longer than <timeout> (in seconds) to finish (default: 600)"
364 @echo " RETRIES=<n> - retry failed tests <n> times"
365 @echo " DEBUG=<type> - set VPP debugging kind"
366 @echo " DEBUG=core - detect coredump and load it in gdb on crash"
367 @echo " DEBUG=gdb - allow easy debugging by printing VPP PID"
368 @echo " and waiting for user input before running"
369 @echo " and tearing down a testcase"
370 @echo " DEBUG=gdbserver - run gdb inside a gdb server, otherwise"
371 @echo " same as above"
372 @echo " STEP=[yes|no] - ease debugging by stepping through a testcase"
373 @echo " SANITY=[yes|no] - perform sanity import of vpp-api/sanity vpp run before running tests (default: yes)"
374 @echo " EXTENDED_TESTS=[1|y] - used by '[re]test-all' & '[re]test-all-debug' to run extended tests"
375 @echo " TEST=<filter> - filter the set of tests:"
376 @echo " by file-name - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py"
377 @echo " by file-suffix - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py"
378 @echo " by wildcard - wildcard filter is <file>.<class>.<test function>, each can be replaced by '*'"
379 @echo " e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name"
380 @echo " TEST='bfd.*.*' is equivalent to above example of filter by file-suffix"
381 @echo " TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class"
382 @echo " TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase"
383 @echo " TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes"
385 @echo " VPP_ZOMBIE_NOCHECK=1 - skip checking for vpp (zombie) processes (CAUTION)"
386 @echo " COREDUMP_SIZE=<size> - pass <size> as unix { coredump-size <size> } argument to vpp"
387 @echo " e.g. COREDUMP_SIZE=4g"
388 @echo " COREDUMP_SIZE=unlimited"
389 @echo " COREDUMP_COMPRESS=1 - compress core files if not debugging them"
390 @echo " EXTERN_TESTS=<path> - path to out-of-tree test_<name>.py files containing test cases"
391 @echo " EXTERN_PLUGINS=<path> - path to out-of-tree plugins to be loaded by vpp under test"
392 @echo " EXTERN_COV_DIR=<path> - path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report"
394 @echo " PROFILE=1 - enable profiling of test framework via cProfile module"
395 @echo " PROFILE_SORT_BY=opt - sort profiling report by opt - consult cProfile documentation for possible values (default: cumtime)"
396 @echo " PROFILE_OUTPUT=file - output profiling info to file - use absolute path (default: stdout)"
398 @echo " TEST_DEBUG=1 - turn on debugging of the test framework itself (expert)"
400 @echo " SKIP_AARCH64=1 - skip tests that are failing on the ARM platorm in FD.io CI"
402 @echo " SOCKET=1 - Communicate with VPP over Unix domain socket instead of SHM"
404 @echo " RND_SEED=seed - Seed RND with given seed"
406 @echo "Creating test documentation"
407 @echo " test-doc - generate documentation for test framework"
408 @echo " test-wipe-doc - wipe documentation for test framework"
410 @echo "Creating test code coverage report"
411 @echo " test-cov - generate code coverage report for test framework"
412 @echo " test-wipe-cov - wipe code coverage report for test framework"
414 @echo "Verifying code-style"
415 @echo " test-checkstyle - check PEP8 compliance"