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
72 PYTHON_EXTRA_DEPENDS=objgraph pympler
74 TEST_RUN_DIR:=$(VENV_PATH)/run
78 PYTHON_DEPENDS=$(PYTHON_EXTRA_DEPENDS) -r requirements.txt
79 SCAPY_SOURCE=$(shell find $(VENV_PATH) -name site-packages)
80 BUILD_COV_DIR=$(TEST_DIR)/coverage
82 GET_PIP_SCRIPT=$(TEST_RUN_DIR)/get-pip.py
83 PIP_INSTALL_DONE=$(TEST_RUN_DIR)/pip-install.done
84 PIP_PATCH_DONE=$(TEST_RUN_DIR)/pip-patch.done
85 PAPI_INSTALL_DONE=$(TEST_RUN_DIR)/papi-install.done
87 PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE)
90 PYTHON_INTERP=python2.7
92 PYTHON_INTERP=$(PYTHON)
96 @mkdir -p $(TEST_RUN_DIR)
97 @bash -c "cd $(TEST_RUN_DIR) && curl -O https://bootstrap.pypa.io/get-pip.py"
99 $(PIP_INSTALL_DONE): $(GET_PIP_SCRIPT)
100 @virtualenv $(VENV_PATH) -p $(PYTHON_INTERP)
101 @bash -c "source $(VENV_PATH)/bin/activate && python $(GET_PIP_SCRIPT)"
102 @bash -c "source $(VENV_PATH)/bin/activate && pip install $(PYTHON_DEPENDS)"
105 $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
106 @echo --- patching ---
107 @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
108 for f in $(CURDIR)/patches/scapy-2.4/*.patch ; do \
109 echo Applying patch: $$(basename $$f) ; \
110 patch -p1 -d $(SCAPY_SOURCE) < $$f ; \
114 $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
115 @bash -c "source $(VENV_PATH)/bin/activate && cd $(WS_ROOT)/src/vpp-api/python && python setup.py install"
119 @env FORCE_FOREGROUND=$(FORCE_FOREGROUND) FAILED_DIR=$(FAILED_DIR) VENV_PATH=$(VENV_PATH) scripts/setsid_wrapper.sh $(FORCE_FOREGROUND) $(VENV_PATH)/bin/activate python $(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
125 SANITY_IMPORT_VPP_PAPI_CMD=true
126 SANITY_RUN_VPP_CMD=true
128 SANITY_IMPORT_VPP_PAPI_CMD=source $(VENV_PATH)/bin/activate && python sanity_import_vpp_papi.py
129 SANITY_RUN_VPP_CMD=source $(VENV_PATH)/bin/activate && python sanity_run_vpp.py
134 else ifeq ($(FORCE_FOREGROUND),0)
136 else ifeq ($(TEST_JOBS),auto)
138 else ifeq ($(TEST_JOBS),1)
144 sanity: verify-no-running-vpp
145 @sys_req/dev_shm_size.sh
146 @bash -c "test $(PARALLEL_ILLEGAL) -eq 0 ||\
147 (echo \"*******************************************************************\" &&\
148 echo \"* Sanity check failed, TEST_JOBS is not 1 or 'auto' and DEBUG, STEP or PROFILE is set\" &&\
149 echo \"*******************************************************************\" &&\
151 @bash -c "$(SANITY_IMPORT_VPP_PAPI_CMD) ||\
152 (echo \"*******************************************************************\" &&\
153 echo \"* Sanity check failed, cannot import vpp_papi\" &&\
154 echo \"* to debug: \" &&\
155 echo \"* 1. enter test shell: make test-shell\" &&\
156 echo \"* 2. execute debugger: gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
157 echo \"*******************************************************************\" &&\
159 @bash -c "$(SANITY_RUN_VPP_CMD) ||\
160 (echo \"*******************************************************************\" &&\
161 echo \"* Sanity check failed, cannot run vpp\" &&\
162 echo \"*******************************************************************\" &&\
167 @if [ "$(EXTENDED_TESTS)" = "yes" ]; then\
171 test-dep: verify-test-dir $(PAPI_INSTALL_DONE)
173 test: verify-test-dir $(PAPI_INSTALL_DONE) ext sanity reset
176 retest: verify-test-dir sanity reset
179 shell: verify-test-dir $(PAPI_INSTALL_DONE)
180 @echo "source $(VENV_PATH)/bin/activate;\
182 echo _BUILD_DIR=$(VPP_BUILD_DIR);\
183 echo _BIN=$(VPP_BIN);\
184 echo _PLUGIN_PATH=$(VPP_PLUGIN_PATH);\
185 echo _INSTALL_PATH=$(VPP_INSTALL_PATH);\
186 echo EXTERN_TESTS=$(EXTERN_TESTS);\
187 echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\
188 echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\
189 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
191 exec </dev/tty" | bash -i
196 @rm -f /dev/shm/vpp-unittest-*
197 @rm -rf /tmp/vpp-unittest-*
198 @rm -rf $(FAILED_DIR)
204 @rm -f $(PAPI_INSTALL_FLAGS)
206 doc: verify-test-dir $(PIP_PATCH_DONE)
207 @virtualenv $(VENV_PATH) -p $(PYTHON_INTERP)
208 @bash -c "source $(VENV_PATH)/bin/activate && pip install sphinx sphinx-rtd-theme"
209 @bash -c "source $(VENV_PATH)/bin/activate && make -C doc WS_ROOT=$(WS_ROOT) BR=$(BR) NO_VPP_PAPI=1 html"
214 @make -C doc wipe BR=$(BR)
216 cov: wipe-cov reset ext verify-test-dir $(PAPI_INSTALL_DONE)
217 @lcov --zerocounters --directory $(_BUILD_DIR)
218 @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
220 @mkdir $(BUILD_COV_DIR)
221 @lcov --capture --directory $(_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
222 @test -z "$(EXTERN_COV_DIR)" || lcov --capture --directory $(EXTERN_COV_DIR) --output-file $(BUILD_COV_DIR)/extern-coverage.info
223 @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
224 @test -z "$(EXTERN_COV_DIR)" || genhtml $(BUILD_COV_DIR)/extern-coverage.info --output-directory $(BUILD_COV_DIR)/extern-html
226 @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
227 @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
232 @rm -rf $(BUILD_COV_DIR)
235 checkstyle: verify-test-dir
236 @virtualenv $(VENV_PATH) -p $(PYTHON_INTERP)
237 @bash -c "source $(VENV_PATH)/bin/activate && pip install pycodestyle"
238 @bash -c "source $(VENV_PATH)/bin/activate &&\
239 pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 -v $(WS_ROOT)/test/*.py ||\
240 (echo \"*******************************************************************\" &&\
241 echo \"* Test framework PEP8 compliance check FAILED \" &&\
242 echo \"*******************************************************************\" &&\
244 @echo "*******************************************************************"
245 @echo "* Test framework PEP8 compliance check passed"
246 @echo "*******************************************************************"
249 @echo "Running tests:"
251 @echo " test - build and run (basic) functional tests"
252 @echo " test-debug - build and run (basic) functional tests (debug build)"
253 @echo " test-all - build and run (all) functional tests"
254 @echo " test-all-debug - build and run (all) functional tests (debug build)"
255 @echo " retest - run functional tests"
256 @echo " retest-debug - run functional tests (debug build)"
257 @echo " test-wipe - wipe (temporary) files generated by unit tests"
258 @echo " test-shell - enter shell with test environment"
259 @echo " test-shell-debug - enter shell with test environment (debug build)"
261 @echo "Arguments controlling test runs:"
262 @echo " V=[0|1|2] - set test verbosity level"
263 @echo " TEST_JOBS=[<n>|auto] - use <n> parallel processes for test execution or automatic discovery of maximum acceptable processes (default: 1)"
264 @echo " CACHE_OUTPUT=[0|1] - cache VPP stdout/stderr and log as one block after test finishes (default: 1)"
265 @echo " FAILFAST=[0|1] - fail fast if 1, complete all tests if 0"
266 @echo " TIMEOUT=<timeout> - fail test suite if any single test takes longer than <timeout> (in seconds) to finish (default: 600)"
267 @echo " RETRIES=<n> - retry failed tests <n> times"
268 @echo " DEBUG=<type> - set VPP debugging kind"
269 @echo " DEBUG=core - detect coredump and load it in gdb on crash"
270 @echo " DEBUG=gdb - allow easy debugging by printing VPP PID"
271 @echo " and waiting for user input before running"
272 @echo " and tearing down a testcase"
273 @echo " DEBUG=gdbserver - run gdb inside a gdb server, otherwise"
274 @echo " same as above"
275 @echo " STEP=[yes|no] - ease debugging by stepping through a testcase"
276 @echo " SANITY=[yes|no] - perform sanity import of vpp-api/sanity vpp run before running tests (default: yes)"
277 @echo " EXTENDED_TESTS=[1|y] - run extended tests"
278 @echo " TEST=<filter> - filter the set of tests:"
279 @echo " by file-name - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py"
280 @echo " by file-suffix - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py"
281 @echo " by wildcard - wildcard filter is <file>.<class>.<test function>, each can be replaced by '*'"
282 @echo " e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name"
283 @echo " TEST='bfd.*.*' is equivalent to above example of filter by file-suffix"
284 @echo " TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class"
285 @echo " TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase"
286 @echo " TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes"
288 @echo " VPP_ZOMBIE_NOCHECK=1 - skip checking for vpp (zombie) processes (CAUTION)"
289 @echo " COREDUMP_SIZE=<size> - pass <size> as unix { coredump-size <size> } argument to vpp"
290 @echo " e.g. COREDUMP_SIZE=4g"
291 @echo " COREDUMP_SIZE=unlimited"
292 @echo " EXTERN_TESTS=<path> - path to out-of-tree test_<name>.py files containing test cases"
293 @echo " EXTERN_PLUGINS=<path>- path to out-of-tree plugins to be loaded by vpp under test"
294 @echo " EXTERN_COV_DIR=<path>- path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report"
296 @echo " PROFILE=1 - enable profiling of test framework via cProfile module"
297 @echo " PROFILE_SORT_BY=opt - sort profiling report by opt - consult cProfile documentation for possible values (default: cumtime)"
298 @echo " PROFILE_OUTPUT=file - output profiling info to file - use absolute path (default: stdout)"
300 @echo " TEST_DEBUG=1 - turn on debugging of the test framework itself (expert)"
302 @echo "Creating test documentation"
303 @echo " test-doc - generate documentation for test framework"
304 @echo " test-wipe-doc - wipe documentation for test framework"
306 @echo "Creating test code coverage report"
307 @echo " test-cov - generate code coverage report for test framework"
308 @echo " test-wipe-cov - wipe code coverage report for test framework"
310 @echo "Verifying code-style"
311 @echo " test-checkstyle - check PEP8 compliance"