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_PROFILE_OPTS=-m cProfile $(PROFILE_OUTPUT_OPTS) -s $(PROFILE_SORT_BY)
58 UNITTEST_FAILFAST_OPTS=
61 UNITTEST_EXTRA_OPTS=-f
64 ifneq ($(EXTERN_TESTS),)
65 UNITTEST_EXTRA_OPTS=$(UNITTEST_FAILFAST_OPTS) -d $(EXTERN_TESTS)
68 VENV_PATH=$(TEST_DIR)/venv
70 ifeq ($(TEST_DEBUG),1)
71 VENV_RUN_DIR:=$(VENV_PATH)/run-debug
73 VENV_RUN_DIR:=$(VENV_PATH)/run
79 PYTHON_INTERP=$(PYTHON)
82 PYTHON_VERSION=$(shell $(PYTHON_INTERP) -c 'import sys; print(sys.version_info.major)')
84 # Keep in sync with requirements.txt
85 PIP_TOOLS_VERSION=6.5.0
86 PIP_SETUPTOOLS_VERSION=60.7.1
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 python3 -m pip install pip===$(PIP_VERSION)"
108 @bash -c "source $(VENV_PATH)/bin/activate && \
109 python3 -m pip install pip-tools===$(PIP_TOOLS_VERSION)"
110 @bash -c "source $(VENV_PATH)/bin/activate && \
111 python3 -m pip install setuptools===$(PIP_SETUPTOOLS_VERSION)"
114 $(PYTHON_DEPENDS): requirements.txt
115 @bash -c "source $(VENV_PATH)/bin/activate && \
116 CUSTOM_COMPILE_COMMAND='make test-refresh-deps (or update requirements.txt)' \
117 python3 -m piptools compile -q --generate-hashes requirements.txt --output-file $@"
119 $(PIP_INSTALL_DONE): $(PIP_TOOLS_INSTALL_DONE) $(PYTHON_DEPENDS)
120 @bash -c "source $(VENV_PATH)/bin/activate && \
121 python3 -m piptools sync $(PYTHON_DEPENDS)"
124 $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
125 @echo --- patching ---
126 @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
127 for f in $(CURDIR)/patches/scapy-2.4.3/*.patch ; do \
128 echo Applying patch: $$(basename $$f) ; \
129 patch --forward -p1 -d $(SCAPY_SOURCE) < $$f ; \
131 [ $$retCode -gt 1 ] && exit $$retCode; \
135 $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
136 @bash -c "source $(VENV_PATH)/bin/activate && python3 -m pip install -e $(PAPI_PYTHON_SRC_DIR)"
140 refresh-deps: clean-deps $(PYTHON_DEPENDS)
144 @rm -f $(PYTHON_DEPENDS)
146 INTERN_PLUGIN_SRC_DIR=$(WS_ROOT)/src/plugins
147 ifneq ($(EXTERN_PLUGIN_SRC_DIR),)
148 PLUGIN_SRC_DIR=$(EXTERN_PLUGIN_SRC_DIR)
150 PLUGIN_SRC_DIR=$(INTERN_PLUGIN_SRC_DIR)
154 @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
160 SANITY_IMPORT_VPP_PAPI_CMD=true
161 SANITY_RUN_VPP_CMD=true
163 SANITY_IMPORT_VPP_PAPI_CMD=source $(VENV_PATH)/bin/activate && python3 sanity_import_vpp_papi.py
164 SANITY_RUN_VPP_CMD=source $(VENV_PATH)/bin/activate && python3 sanity_run_vpp.py
169 else ifeq ($(FORCE_FOREGROUND),0)
171 else ifeq ($(TEST_JOBS),auto)
173 else ifeq ($(TEST_JOBS),1)
180 @bash -c "test $(PARALLEL_ILLEGAL) -eq 0 ||\
181 (echo \"*******************************************************************\" &&\
182 echo \"* Sanity check failed, TEST_JOBS is not 1 or 'auto' and DEBUG, STEP or PROFILE is set\" &&\
183 echo \"*******************************************************************\" &&\
185 @bash -c "$(SANITY_IMPORT_VPP_PAPI_CMD) ||\
186 (echo \"*******************************************************************\" &&\
187 echo \"* Sanity check failed, cannot import vpp_papi\" &&\
188 echo \"* to debug: \" &&\
189 echo \"* 1. enter test shell: make test-shell\" &&\
190 echo \"* 2. execute debugger: gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
191 echo \"*******************************************************************\" &&\
193 @bash -c "$(SANITY_RUN_VPP_CMD) ||\
194 (echo \"*******************************************************************\" &&\
195 echo \"* Sanity check failed, cannot run vpp\" &&\
196 echo \"*******************************************************************\" &&\
203 test-dep: $(PAPI_INSTALL_DONE) $(FAILED_DIR)
206 test: test-dep sanity
210 retest: verify-env sanity $(FAILED_DIR)
215 @echo "source $(VENV_PATH)/bin/activate;\
216 export RND_SEED=$(RND_SEED);\
218 echo PYTHONPATH=$(PYTHONPATH);\
219 echo RND_SEED=$(RND_SEED);\
220 echo VPP_BUILD_DIR=$(VPP_BUILD_DIR);\
221 echo VPP_BIN=$(VPP_BIN);\
222 echo VPP_PLUGIN_PATH=$(VPP_PLUGIN_PATH);\
223 echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\
224 echo VPP_INSTALL_PATH=$(VPP_INSTALL_PATH);\
225 echo EXTERN_TESTS=$(EXTERN_TESTS);\
226 echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\
227 echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\
228 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
230 exec </dev/tty" | bash -i
234 @rm -f /dev/shm/vpp-unittest-*
235 @if [ $(FORCE_NO_WIPE) -eq "0" ] ; then rm -rf /tmp/vpp-unittest-*; fi
236 @rm -f /tmp/api_post_mortem.*
237 @rm -rf $(FAILED_DIR)
242 @rm -rf $(patsubst %,%/__pycache__, $(VPP_TEST_DIRS))
248 cov: wipe-cov test-dep ext $(BUILD_COV_DIR)
249 @lcov --zerocounters --directory $(VPP_BUILD_DIR)
250 @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
252 @lcov --capture --directory $(VPP_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
253 @test -z "$(EXTERN_COV_DIR)" || lcov --capture --directory $(EXTERN_COV_DIR) --output-file $(BUILD_COV_DIR)/extern-coverage.info
254 @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
255 @test -z "$(EXTERN_COV_DIR)" || genhtml $(BUILD_COV_DIR)/extern-coverage.info --output-directory $(BUILD_COV_DIR)/extern-html
257 @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
258 @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
262 @rm -rf $(BUILD_COV_DIR)
266 @rm -rf $(PAPI_INSTALL_DONE) $(PAPI_WIPE_DIST)
269 wipe-all: wipe wipe-papi wipe-cov
272 .PHONY: checkstyle-diff
273 checkstyle-diff: $(PIP_INSTALL_DONE)
274 @bash -c "source $(VENV_PATH)/bin/activate &&\
275 python3 -m pip install pycodestyle"
276 @bash -c "source $(VENV_PATH)/bin/activate &&\
277 cd $(WS_ROOT) && git diff --name-only --no-color --relative HEAD~1 ':!*.patch' | grep '.py$$' | xargs -I XXX \
278 pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 -v XXX ||\
279 (echo \"*********************************************************************\" &&\
280 echo \"* Test framework PEP8 compliance check FAILED (checked changed files)\" &&\
281 echo \"*********************************************************************\" &&\
283 @echo "*********************************************************************"
284 @echo "* Test framework PEP8 compliance check passed (checked changed files)"
285 @echo "*********************************************************************"
290 $(eval FORCE_FOREGROUND=1)
294 checkstyle: $(PIP_INSTALL_DONE)
295 @bash -c "source $(VENV_PATH)/bin/activate &&\
296 python3 -m pip install pycodestyle"
297 @bash -c "source $(VENV_PATH)/bin/activate &&\
298 pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 -v *.py ||\
299 (echo \"*******************************************************************\" &&\
300 echo \"* Test framework PEP8 compliance check FAILED (checked all files)\" &&\
301 echo \"*******************************************************************\" &&\
303 @echo "*******************************************************************"
304 @echo "* Test framework PEP8 compliance check passed (checked all files)"
305 @echo "*******************************************************************"
309 @echo "Running tests:"
311 @echo " test - build and run (basic) functional tests"
312 @echo " test-debug - build and run (basic) functional tests (debug build)"
313 @echo " test-all - build and run functional and extended tests"
314 @echo " test-all-debug - build and run functional and extended tests (debug build)"
315 @echo " retest - run functional tests"
316 @echo " retest-debug - run functional tests (debug build)"
317 @echo " retest-all - run functional and extended tests"
318 @echo " retest-all-debug - run functional and extended tests (debug build)"
319 @echo " test-cov - generate code coverage report for test framework"
320 @echo " test-gcov - build and run functional tests (gcov build)"
321 @echo " test-wipe - wipe (temporary) files generated by unit tests"
322 @echo " test-wipe-cov - wipe code coverage report for test framework"
323 @echo " test-wipe-papi - rebuild vpp_papi sources"
324 @echo " test-wipe-all - wipe (temporary) files generated by unit tests, and coverage"
325 @echo " test-shell - enter shell with test environment"
326 @echo " test-shell-debug - enter shell with test environment (debug build)"
327 @echo " test-checkstyle - check PEP8 compliance for test framework"
328 @echo " test-refresh-deps - refresh the Python dependencies for the tests"
330 @echo "Arguments controlling test runs:"
331 @echo " V=[0|1|2] - set test verbosity level"
332 @echo " 0=ERROR, 1=INFO, 2=DEBUG"
333 @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)"
334 @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)"
335 @echo " CACHE_OUTPUT=[0|1] - cache VPP stdout/stderr and log as one block after test finishes (default: 1)"
336 @echo " FAILFAST=[0|1] - fail fast if 1, complete all tests if 0"
337 @echo " TIMEOUT=<timeout> - fail test suite if any single test takes longer than <timeout> (in seconds) to finish (default: 600)"
338 @echo " RETRIES=<n> - retry failed tests <n> times"
339 @echo " DEBUG=<type> - set VPP debugging kind"
340 @echo " DEBUG=core - detect coredump and load it in gdb on crash"
341 @echo " DEBUG=gdb - allow easy debugging by printing VPP PID"
342 @echo " and waiting for user input before running"
343 @echo " and tearing down a testcase"
344 @echo " DEBUG=gdbserver - run gdb inside a gdb server, otherwise"
345 @echo " same as above"
346 @echo " DEBUG=attach - attach test case to already running vpp in gdb (see test-start-vpp-in-gdb)"
348 @echo " STEP=[yes|no] - ease debugging by stepping through a testcase"
349 @echo " SANITY=[yes|no] - perform sanity import of vpp-api/sanity vpp run before running tests (default: yes)"
350 @echo " EXTENDED_TESTS=[1|y] - used by '[re]test-all' & '[re]test-all-debug' to run extended tests"
351 @echo " TEST=<filter> - filter the set of tests:"
352 @echo " by file-name - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py"
353 @echo " by file-suffix - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py"
354 @echo " by wildcard - wildcard filter is <file>.<class>.<test function>, each can be replaced by '*'"
355 @echo " e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name"
356 @echo " TEST='bfd.*.*' is equivalent to above example of filter by file-suffix"
357 @echo " TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class"
358 @echo " TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase"
359 @echo " TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes"
361 @echo " VARIANT=<variant> - specify which march node variant to unit test"
362 @echo " e.g. VARIANT=skx test the skx march variants"
363 @echo " e.g. VARIANT=icl test the icl march variants"
365 @echo " COREDUMP_SIZE=<size> - pass <size> as unix { coredump-size <size> } argument to vpp"
366 @echo " e.g. COREDUMP_SIZE=4g"
367 @echo " COREDUMP_SIZE=unlimited"
368 @echo " COREDUMP_COMPRESS=1 - compress core files if not debugging them"
369 @echo " EXTERN_TESTS=<path> - path to out-of-tree test_<name>.py files containing test cases"
370 @echo " EXTERN_PLUGINS=<path> - path to out-of-tree plugins to be loaded by vpp under test"
371 @echo " EXTERN_COV_DIR=<path> - path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report"
373 @echo " PROFILE=1 - enable profiling of test framework via cProfile module"
374 @echo " PROFILE_SORT_BY=opt - sort profiling report by opt - consult cProfile documentation for possible values (default: cumtime)"
375 @echo " PROFILE_OUTPUT=file - output profiling info to file - use absolute path (default: stdout)"
377 @echo " TEST_DEBUG=1 - turn on debugging of the test framework itself (expert)"
379 @echo " SKIP_AARCH64=1 - skip tests that are failing on the ARM platorm in FD.io CI"
381 @echo " RND_SEED=seed - Seed RND with given seed"
383 @echo "Starting VPP in GDB for use with DEBUG=attach:"
385 @echo " test-start-vpp-in-gdb - start VPP in gdb (release)"
386 @echo " test-start-vpp-debug-in-gdb - start VPP in gdb (debug)"
388 @echo "Arguments controlling VPP in GDB runs:"
390 @echo " VPP_IN_GDB_TMP_DIR - specify directory to run VPP IN (default: /tmp/unittest-attach-gdb)"
391 @echo " VPP_IN_GDB_NO_RMDIR=0 - don't remove existing tmp dir but fail instead"
392 @echo " VPP_IN_GDB_CMDLINE=1 - add 'interactive' to VPP arguments to run with command line"
394 @echo "Creating test code coverage report"
395 @echo " test-cov - generate code coverage report for test framework"
396 @echo " test-wipe-cov - wipe code coverage report for test framework"
398 @echo "Verifying code-style"
399 @echo " test-checkstyle - check PEP8 compliance"