1 .PHONY: verify-python-path
3 VPP_TEST_FAILED_DIR=/tmp/vpp-failed-unittests/
6 ifndef VPP_PYTHON_PREFIX
7 $(error VPP_PYTHON_PREFIX 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)
29 PROFILE_OUTPUT_OPTS=-o $(PROFILE_OUTPUT)
32 ifndef PROFILE_SORT_BY
33 PROFILE_SORT_BY=cumtime
37 PYTHON_PROFILE_OPTS=-m cProfile $(PROFILE_OUTPUT_OPTS) -s $(PROFILE_SORT_BY)
41 verify-no-running-vpp:
42 @if [ "$(VPP_PIDS)" != "" ]; then \
44 echo "*** Existing vpp processes detected (PID(s): $(VPP_PIDS)). Running tests under these conditions is not supported. ***"; \
52 UNITTEST_FAILFAST_OPTS=
55 UNITTEST_EXTRA_OPTS=-f
58 ifneq ($(EXTERN_TESTS),)
59 UNITTEST_EXTRA_OPTS=$(UNITTEST_FAILFAST_OPTS) -d $(EXTERN_TESTS)
62 ifeq ($(TEST_DEBUG),1)
63 VPP_PYTHON_PREFIX:=$(VPP_PYTHON_PREFIX)/debug
64 PYTHON_EXTRA_DEPENDS=objgraph pympler
69 PYTHON_VENV_PATH=$(VPP_PYTHON_PREFIX)/virtualenv
70 PYTHON_DEPENDS=$(PYTHON_EXTRA_DEPENDS) faulthandler six scapy==2.4.0 pexpect cryptography subprocess32 cffi git+https://github.com/vpp-dev/py-lispnetworking
71 SCAPY_SOURCE=$(shell find $(PYTHON_VENV_PATH) -name site-packages)
72 BUILD_COV_DIR=$(BR)/test-cov
74 GET_PIP_SCRIPT=$(VPP_PYTHON_PREFIX)/get-pip.py
75 PIP_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/pip-install.done
76 PIP_PATCH_DONE=$(VPP_PYTHON_PREFIX)/pip-patch.done
77 PAPI_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/papi-install.done
79 PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE)
82 PYTHON_INTERP=python2.7
84 PYTHON_INTERP=$(PYTHON)
88 @mkdir -p $(VPP_PYTHON_PREFIX)
89 @bash -c "cd $(VPP_PYTHON_PREFIX) && curl -O https://bootstrap.pypa.io/get-pip.py"
91 $(PIP_INSTALL_DONE): $(GET_PIP_SCRIPT)
92 @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
93 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python $(GET_PIP_SCRIPT)"
94 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install $(PYTHON_DEPENDS)"
97 $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
98 @echo --- patching ---
99 @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
100 for f in $(CURDIR)/patches/scapy-2.4/*.patch ; do \
101 echo Applying patch: $$(basename $$f) ; \
102 patch -p1 -d $(SCAPY_SOURCE) < $$f ; \
106 $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
107 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && cd $(WS_ROOT)/src/vpp-api/python && python setup.py install"
111 @env FORCE_FOREGROUND=$(FORCE_FOREGROUND) VPP_TEST_FAILED_DIR=$(VPP_TEST_FAILED_DIR) scripts/setsid_wrapper.sh $(FORCE_FOREGROUND) $(PYTHON_VENV_PATH)/bin/activate python $(PYTHON_PROFILE_OPTS) run_tests.py -d $(TEST_DIR) $(UNITTEST_EXTRA_OPTS) || env VPP_TEST_FAILED_DIR=$(VPP_TEST_FAILED_DIR) COMPRESS_FAILED_TEST_LOGS=$(COMPRESS_FAILED_TEST_LOGS) scripts/compress_failed.sh
117 SANITY_IMPORT_VPP_PAPI_CMD=true
118 SANITY_RUN_VPP_CMD=true
120 SANITY_IMPORT_VPP_PAPI_CMD=source $(PYTHON_VENV_PATH)/bin/activate && python sanity_import_vpp_papi.py
121 SANITY_RUN_VPP_CMD=source $(PYTHON_VENV_PATH)/bin/activate && python sanity_run_vpp.py
124 sanity: verify-no-running-vpp
125 @sys_req/dev_shm_size.sh
126 @bash -c "$(SANITY_IMPORT_VPP_PAPI_CMD) ||\
127 (echo \"*******************************************************************\" &&\
128 echo \"* Sanity check failed, cannot import vpp_papi\" &&\
129 echo \"* to debug: \" &&\
130 echo \"* 1. enter test shell: make test-shell\" &&\
131 echo \"* 2. execute debugger: gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
132 echo \"*******************************************************************\" &&\
134 @bash -c "$(SANITY_RUN_VPP_CMD) ||\
135 (echo \"*******************************************************************\" &&\
136 echo \"* Sanity check failed, cannot run vpp\" &&\
137 echo \"*******************************************************************\" &&\
144 test-dep: verify-python-path $(PAPI_INSTALL_DONE)
146 test: verify-python-path $(PAPI_INSTALL_DONE) ext sanity reset
149 retest: verify-python-path sanity reset
152 shell: verify-python-path $(PAPI_INSTALL_DONE)
153 @echo "source $(PYTHON_VENV_PATH)/bin/activate;\
155 echo VPP_TEST_BUILD_DIR=$(VPP_TEST_BUILD_DIR);\
156 echo VPP_TEST_BIN=$(VPP_TEST_BIN);\
157 echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\
158 echo VPP_TEST_INSTALL_PATH=$(VPP_TEST_INSTALL_PATH);\
159 echo EXTERN_TESTS=$(EXTERN_TESTS);\
160 echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\
161 echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\
162 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
164 exec </dev/tty" | bash -i
169 @rm -f /dev/shm/vpp-unittest-*
170 @rm -rf /tmp/vpp-unittest-*
171 @rm -rf $(VPP_TEST_FAILED_DIR)
172 @mkdir $(VPP_TEST_FAILED_DIR)
176 @rm -rf $(PYTHON_VENV_PATH)
177 @rm -f $(PAPI_INSTALL_FLAGS)
179 doc: verify-python-path $(PIP_PATCH_DONE)
180 @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
181 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install sphinx sphinx-rtd-theme"
182 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && make -C doc WS_ROOT=$(WS_ROOT) BR=$(BR) NO_VPP_PAPI=1 html"
187 @make -C doc wipe BR=$(BR)
189 cov: wipe-cov reset ext verify-python-path $(PAPI_INSTALL_DONE)
190 @lcov --zerocounters --directory $(VPP_TEST_BUILD_DIR)
191 @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
193 @mkdir $(BUILD_COV_DIR)
194 @lcov --capture --directory $(VPP_TEST_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
195 @test -z "$(EXTERN_COV_DIR)" || lcov --capture --directory $(EXTERN_COV_DIR) --output-file $(BUILD_COV_DIR)/extern-coverage.info
196 @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
197 @test -z "$(EXTERN_COV_DIR)" || genhtml $(BUILD_COV_DIR)/extern-coverage.info --output-directory $(BUILD_COV_DIR)/extern-html
199 @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
200 @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
205 @rm -rf $(BUILD_COV_DIR)
208 checkstyle: verify-python-path
209 @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
210 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install pycodestyle"
211 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate &&\
212 pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 -v $(WS_ROOT)/test/*.py ||\
213 (echo \"*******************************************************************\" &&\
214 echo \"* Test framework PEP8 compliance check FAILED \" &&\
215 echo \"*******************************************************************\" &&\
217 @echo "*******************************************************************"
218 @echo "* Test framework PEP8 compliance check passed"
219 @echo "*******************************************************************"
222 @echo "Running tests:"
224 @echo " test - build and run (basic) functional tests"
225 @echo " test-debug - build and run (basic) functional tests (debug build)"
226 @echo " test-all - build and run (all) functional tests"
227 @echo " test-all-debug - build and run (all) functional tests (debug build)"
228 @echo " retest - run functional tests"
229 @echo " retest-debug - run functional tests (debug build)"
230 @echo " test-wipe - wipe (temporary) files generated by unit tests"
231 @echo " test-shell - enter shell with test environment"
232 @echo " test-shell-debug - enter shell with test environment (debug build)"
234 @echo "Arguments controlling test runs:"
235 @echo " V=[0|1|2] - set test verbosity level"
236 @echo " CACHE_OUTPUT=[0|1] - cache VPP stdout/stderr and log as one block after test finishes (default: 1)"
237 @echo " FAILFAST=[0|1] - fail fast if 1, complete all tests if 0"
238 @echo " TIMEOUT=<timeout> - fail test suite if any single test takes longer than <timeout> (in seconds) to finish"
239 @echo " RETRIES=<n> - retry failed tests <n> times"
240 @echo " DEBUG=<type> - set VPP debugging kind"
241 @echo " DEBUG=core - detect coredump and load it in gdb on crash"
242 @echo " DEBUG=gdb - allow easy debugging by printing VPP PID "
243 @echo " and waiting for user input before running "
244 @echo " and tearing down a testcase"
245 @echo " DEBUG=gdbserver - run gdb inside a gdb server, otherwise "
246 @echo " same as above"
247 @echo " STEP=[yes|no] - ease debugging by stepping through a testcase "
248 @echo " SANITY=[yes|no] - perform sanity import of vpp-api/sanity vpp run before running tests (default: yes)"
249 @echo " EXTENDED_TESTS=[1|y] - run extended tests"
250 @echo " TEST=<filter> - filter the set of tests:"
251 @echo " by file-name - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py"
252 @echo " by file-suffix - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py"
253 @echo " by wildcard - wildcard filter is <file>.<class>.<test function>, each can be replaced by '*'"
254 @echo " e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name"
255 @echo " TEST='bfd.*.*' is equivalent to above example of filter by file-suffix"
256 @echo " TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class"
257 @echo " TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase"
258 @echo " TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes"
260 @echo " VPP_ZOMBIE_NOCHECK=1 - skip checking for vpp (zombie) processes (CAUTION)"
261 @echo " COREDUMP_SIZE=<size> - pass <size> as unix { coredump-size <size> } argument to vpp"
262 @echo " e.g. COREDUMP_SIZE=4g"
263 @echo " COREDUMP_SIZE=unlimited"
264 @echo " EXTERN_TESTS=<path> - path to out-of-tree test_<name>.py files containing test cases"
265 @echo " EXTERN_PLUGINS=<path>- path to out-of-tree plugins to be loaded by vpp under test"
266 @echo " EXTERN_COV_DIR=<path>- path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report"
268 @echo " PROFILE=1 - enable profiling of test framework via cProfile module"
269 @echo " PROFILE_SORT_BY=opt - sort profiling report by opt - consult cProfile documentation for possible values (default: cumtime)"
270 @echo " PROFILE_OUTPUT=file - output profiling info to file - use absolute path (default: stdout)"
272 @echo " TEST_DEBUG=1 - turn on debugging of the test framework itself (expert)"
274 @echo "Creating test documentation"
275 @echo " test-doc - generate documentation for test framework"
276 @echo " test-wipe-doc - wipe documentation for test framework"
278 @echo "Creating test code coverage report"
279 @echo " test-cov - generate code coverage report for test framework"
280 @echo " test-wipe-cov - wipe code coverage report for test framework"
282 @echo "Verifying code-style"
283 @echo " test-checkstyle - check PEP8 compliance"