1 .PHONY: verify-test-dir
3 FAILED_DIR=/tmp/vpp-failed-unittests/
7 $(error TEST_DIR is not set)
10 .PHONY: verify-no-running-vpp
12 ifdef VPP_ZOMBIE_NOCHECK
15 VPP_PIDS=$(shell pgrep -d, -x vpp_main)
20 else ifeq ($(DEBUG),gdbserver)
22 else ifeq ($(DEBUG),core)
24 else ifeq ($(STEP),yes)
35 PROFILE_OUTPUT_OPTS=-o $(PROFILE_OUTPUT)
38 ifndef PROFILE_SORT_BY
39 PROFILE_SORT_BY=cumtime
43 PYTHON_PROFILE_OPTS=-m cProfile $(PROFILE_OUTPUT_OPTS) -s $(PROFILE_SORT_BY)
47 verify-no-running-vpp:
48 @if [ "$(VPP_PIDS)" != "" ]; then \
50 echo "*** Existing vpp processes detected (PID(s): $(VPP_PIDS)). Running tests under these conditions is not supported. ***"; \
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)/run/venv
70 ifeq ($(TEST_DEBUG),1)
71 TEST_RUN_DIR:=$(VENV_PATH)/run-debug
73 TEST_RUN_DIR:=$(VENV_PATH)/run
77 PYTHON_INTERP=python2.7
79 PYTHON_INTERP=$(PYTHON)
82 PYTHON_VERSION=$(shell $(PYTHON_INTERP) -c 'import sys; print(sys.version_info.major)')
83 PIP_TOOLS_VERSION=3.8.0 # Keep in sync with requirements.txt
84 PYTHON_DEPENDS=requirements-$(PYTHON_VERSION).txt
85 SCAPY_SOURCE=$(shell find $(VENV_PATH)/lib/$(PYTHON_INTERP) -name site-packages)
86 BUILD_COV_DIR=$(TEST_DIR)/coverage
88 PIP_TOOLS_INSTALL_DONE=$(TEST_RUN_DIR)/pip-tools-install-$(PYTHON_VERSION).done
89 PIP_INSTALL_DONE=$(TEST_RUN_DIR)/pip-install-$(PYTHON_VERSION).done
90 PIP_PATCH_DONE=$(TEST_RUN_DIR)/pip-patch-$(PYTHON_VERSION).done
91 PAPI_INSTALL_DONE=$(TEST_RUN_DIR)/papi-install-$(PYTHON_VERSION).done
93 PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE)
95 $(PIP_TOOLS_INSTALL_DONE):
97 @mkdir -p $(TEST_RUN_DIR)
98 @virtualenv $(VENV_PATH) -p $(PYTHON_INTERP)
99 @bash -c "source $(VENV_PATH)/bin/activate && \
100 $(PYTHON_INTERP) -m pip install pip-tools===$(PIP_TOOLS_VERSION)"
103 $(PYTHON_DEPENDS): $(PIP_TOOLS_INSTALL_DONE) requirements.txt
104 @bash -c "source $(VENV_PATH)/bin/activate && \
105 CUSTOM_COMPILE_COMMAND='make test-refresh-deps (or update requirements.txt)' \
106 $(PYTHON_INTERP) -m piptools compile -q --generate-hashes requirements.txt --output-file $@"
108 $(PIP_INSTALL_DONE): $(PYTHON_DEPENDS)
109 @bash -c "source $(VENV_PATH)/bin/activate && \
110 $(PYTHON_INTERP) -m piptools sync $(PYTHON_DEPENDS)"
113 $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
114 @echo --- patching ---
115 @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
116 for f in $(CURDIR)/patches/scapy-2.4/*.patch ; do \
117 echo Applying patch: $$(basename $$f) ; \
118 patch --forward -p1 -d $(SCAPY_SOURCE) < $$f ; \
120 [ $$retCode -gt 1 ] && exit $$retCode; \
124 $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
125 @bash -c "source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) -m pip install -e $(WS_ROOT)/src/vpp-api/python"
128 .PHONY: update-deps clear-deps
129 refresh-deps: clean-deps $(PYTHON_DEPENDS)
132 @rm -f $(PYTHON_DEPENDS)
135 @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) 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
141 SANITY_IMPORT_VPP_PAPI_CMD=true
142 SANITY_RUN_VPP_CMD=true
144 SANITY_IMPORT_VPP_PAPI_CMD=source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) sanity_import_vpp_papi.py
145 SANITY_RUN_VPP_CMD=source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) sanity_run_vpp.py
150 else ifeq ($(FORCE_FOREGROUND),0)
152 else ifeq ($(TEST_JOBS),auto)
154 else ifeq ($(TEST_JOBS),1)
160 sanity: verify-no-running-vpp
161 @sys_req/dev_shm_size.sh
162 @bash -c "test $(PARALLEL_ILLEGAL) -eq 0 ||\
163 (echo \"*******************************************************************\" &&\
164 echo \"* Sanity check failed, TEST_JOBS is not 1 or 'auto' and DEBUG, STEP or PROFILE is set\" &&\
165 echo \"*******************************************************************\" &&\
167 @bash -c "$(SANITY_IMPORT_VPP_PAPI_CMD) ||\
168 (echo \"*******************************************************************\" &&\
169 echo \"* Sanity check failed, cannot import vpp_papi\" &&\
170 echo \"* to debug: \" &&\
171 echo \"* 1. enter test shell: make test-shell\" &&\
172 echo \"* 2. execute debugger: gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
173 echo \"*******************************************************************\" &&\
175 @bash -c "$(SANITY_RUN_VPP_CMD) ||\
176 (echo \"*******************************************************************\" &&\
177 echo \"* Sanity check failed, cannot run vpp\" &&\
178 echo \"*******************************************************************\" &&\
183 @if [ "$(EXTENDED_TESTS)" = "yes" ]; then\
187 test-dep: verify-test-dir $(PAPI_INSTALL_DONE)
189 test: verify-test-dir $(PAPI_INSTALL_DONE) ext sanity reset
192 retest: verify-test-dir sanity reset
195 shell: verify-test-dir $(PAPI_INSTALL_DONE)
196 @echo "source $(VENV_PATH)/bin/activate;\
198 echo VPP_BUILD_DIR=$(VPP_BUILD_DIR);\
199 echo VPP_BIN=$(VPP_BIN);\
200 echo VPP_PLUGIN_PATH=$(VPP_PLUGIN_PATH);\
201 echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\
202 echo VPP_INSTALL_PATH=$(VPP_INSTALL_PATH);\
203 echo EXTERN_TESTS=$(EXTERN_TESTS);\
204 echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\
205 echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\
206 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
208 exec </dev/tty" | bash -i
213 @rm -f /dev/shm/vpp-unittest-*
214 @rm -rf /tmp/vpp-unittest-*
215 @rm -rf $(FAILED_DIR)
221 @rm -f $(PAPI_INSTALL_FLAGS)
223 doc: verify-test-dir $(PIP_PATCH_DONE)
224 @virtualenv $(VENV_PATH) -p python3
225 @bash -c "source $(VENV_PATH)/bin/activate && python3 -m pip install sphinx sphinx-rtd-theme"
226 @bash -c "source $(VENV_PATH)/bin/activate && make -C doc WS_ROOT=$(WS_ROOT) BR=$(BR) html"
231 @make -C doc wipe BR=$(BR)
233 cov: wipe-cov reset ext verify-test-dir $(PAPI_INSTALL_DONE)
234 @lcov --zerocounters --directory $(VPP_BUILD_DIR)
235 @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
237 @mkdir $(BUILD_COV_DIR)
238 @lcov --capture --directory $(VPP_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
239 @test -z "$(EXTERN_COV_DIR)" || lcov --capture --directory $(EXTERN_COV_DIR) --output-file $(BUILD_COV_DIR)/extern-coverage.info
240 @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
241 @test -z "$(EXTERN_COV_DIR)" || genhtml $(BUILD_COV_DIR)/extern-coverage.info --output-directory $(BUILD_COV_DIR)/extern-html
243 @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
244 @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
249 @rm -rf $(BUILD_COV_DIR)
252 checkstyle: verify-test-dir
253 @virtualenv $(VENV_PATH) -p python3
254 @bash -c "source $(VENV_PATH)/bin/activate && python3 -m pip install pycodestyle"
255 @bash -c "source $(VENV_PATH)/bin/activate &&\
256 pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 --exclude=$(WS_ROOT)/test/_*.py -v $(WS_ROOT)/test/*.py ||\
257 (echo \"*******************************************************************\" &&\
258 echo \"* Test framework PEP8 compliance check FAILED \" &&\
259 echo \"*******************************************************************\" &&\
261 @echo "*******************************************************************"
262 @echo "* Test framework PEP8 compliance check passed"
263 @echo "*******************************************************************"
266 @echo "Running tests:"
268 @echo " test - build and run (basic) functional tests"
269 @echo " test-debug - build and run (basic) functional tests (debug build)"
270 @echo " test-all - build and run (all) functional tests"
271 @echo " test-all-debug - build and run (all) functional tests (debug build)"
272 @echo " retest - run functional tests"
273 @echo " retest-debug - run functional tests (debug build)"
274 @echo " test-wipe - wipe (temporary) files generated by unit tests"
275 @echo " test-shell - enter shell with test environment"
276 @echo " test-shell-debug - enter shell with test environment (debug build)"
278 @echo "Arguments controlling test runs:"
279 @echo " V=[0|1|2] - set test verbosity level"
280 @echo " 0=ERROR, 1=INFO, 2=DEBUG"
281 @echo " TEST_JOBS=[<n>|auto] - use <n> parallel processes for test execution or automatic discovery of maximum acceptable processes (default: 1)"
282 @echo " CACHE_OUTPUT=[0|1] - cache VPP stdout/stderr and log as one block after test finishes (default: 1)"
283 @echo " FAILFAST=[0|1] - fail fast if 1, complete all tests if 0"
284 @echo " TIMEOUT=<timeout> - fail test suite if any single test takes longer than <timeout> (in seconds) to finish (default: 600)"
285 @echo " RETRIES=<n> - retry failed tests <n> times"
286 @echo " DEBUG=<type> - set VPP debugging kind"
287 @echo " DEBUG=core - detect coredump and load it in gdb on crash"
288 @echo " DEBUG=gdb - allow easy debugging by printing VPP PID"
289 @echo " and waiting for user input before running"
290 @echo " and tearing down a testcase"
291 @echo " DEBUG=gdbserver - run gdb inside a gdb server, otherwise"
292 @echo " same as above"
293 @echo " STEP=[yes|no] - ease debugging by stepping through a testcase"
294 @echo " SANITY=[yes|no] - perform sanity import of vpp-api/sanity vpp run before running tests (default: yes)"
295 @echo " EXTENDED_TESTS=[1|y] - run extended tests"
296 @echo " TEST=<filter> - filter the set of tests:"
297 @echo " by file-name - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py"
298 @echo " by file-suffix - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py"
299 @echo " by wildcard - wildcard filter is <file>.<class>.<test function>, each can be replaced by '*'"
300 @echo " e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name"
301 @echo " TEST='bfd.*.*' is equivalent to above example of filter by file-suffix"
302 @echo " TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class"
303 @echo " TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase"
304 @echo " TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes"
306 @echo " VPP_ZOMBIE_NOCHECK=1 - skip checking for vpp (zombie) processes (CAUTION)"
307 @echo " COREDUMP_SIZE=<size> - pass <size> as unix { coredump-size <size> } argument to vpp"
308 @echo " e.g. COREDUMP_SIZE=4g"
309 @echo " COREDUMP_SIZE=unlimited"
310 @echo " COREDUMP_COMPRESS=1 - compress core files if not debugging them"
311 @echo " EXTERN_TESTS=<path> - path to out-of-tree test_<name>.py files containing test cases"
312 @echo " EXTERN_PLUGINS=<path>- path to out-of-tree plugins to be loaded by vpp under test"
313 @echo " EXTERN_COV_DIR=<path>- path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report"
315 @echo " PROFILE=1 - enable profiling of test framework via cProfile module"
316 @echo " PROFILE_SORT_BY=opt - sort profiling report by opt - consult cProfile documentation for possible values (default: cumtime)"
317 @echo " PROFILE_OUTPUT=file - output profiling info to file - use absolute path (default: stdout)"
319 @echo " TEST_DEBUG=1 - turn on debugging of the test framework itself (expert)"
321 @echo " SKIP_AARCH64=1 - skip tests that are failing on the ARM platorm in FD.io CI"
323 @echo " SOCKET=1 - Communicate with VPP over Unix domain socket instead of SHM"
325 @echo "Creating test documentation"
326 @echo " test-doc - generate documentation for test framework"
327 @echo " test-wipe-doc - wipe documentation for test framework"
329 @echo "Creating test code coverage report"
330 @echo " test-cov - generate code coverage report for test framework"
331 @echo " test-wipe-cov - wipe code coverage report for test framework"
333 @echo "Verifying code-style"
334 @echo " test-checkstyle - check PEP8 compliance"