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)
28 verify-no-running-vpp:
29 @if [ "$(VPP_PIDS)" != "" ]; then \
31 echo "*** Existing vpp processes detected (PID(s): $(VPP_PIDS)). Running tests under these conditions is not supported. ***"; \
39 UNITTEST_FAILFAST_OPTS=
42 UNITTEST_EXTRA_OPTS=-f
45 ifneq ($(EXTERN_TESTS),)
46 UNITTEST_EXTRA_OPTS=$(UNITTEST_FAILFAST_OPTS) -d $(EXTERN_TESTS)
49 PYTHON_VENV_PATH=$(VPP_PYTHON_PREFIX)/virtualenv
50 PYTHON_DEPENDS=faulthandler six scapy==2.3.3 pexpect pycrypto subprocess32 cffi git+https://github.com/klement/py-lispnetworking@setup
51 SCAPY_SOURCE=$(shell find $(PYTHON_VENV_PATH) -name site-packages)
52 BUILD_COV_DIR=$(BR)/test-cov
54 GET_PIP_SCRIPT=$(VPP_PYTHON_PREFIX)/get-pip.py
55 PIP_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/pip-install.done
56 PIP_PATCH_DONE=$(VPP_PYTHON_PREFIX)/pip-patch.done
57 PAPI_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/papi-install.done
59 PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE)
62 PYTHON_INTERP=python2.7
64 PYTHON_INTERP=$(PYTHON)
68 @mkdir -p $(VPP_PYTHON_PREFIX)
69 @bash -c "cd $(VPP_PYTHON_PREFIX) && curl -O https://bootstrap.pypa.io/get-pip.py"
71 $(PIP_INSTALL_DONE): $(GET_PIP_SCRIPT)
72 @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
73 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python $(GET_PIP_SCRIPT)"
74 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install $(PYTHON_DEPENDS)"
77 $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
78 @echo --- patching ---
79 @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
80 for f in $(CURDIR)/patches/scapy-2.3.3/*.patch ; do \
81 echo Applying patch: $$(basename $$f) ; \
82 patch -p1 -d $(SCAPY_SOURCE) < $$f ; \
86 $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
87 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && cd $(WS_ROOT)/src/vpp-api/python && python setup.py install"
91 @env VPP_TEST_FAILED_DIR=$(VPP_TEST_FAILED_DIR) scripts/setsid_wrapper.sh $(FORCE_FOREGROUND) $(PYTHON_VENV_PATH)/bin/activate python 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
97 SANITY_IMPORT_VPP_PAPI_CMD=true
98 SANITY_RUN_VPP_CMD=true
100 SANITY_IMPORT_VPP_PAPI_CMD=source $(PYTHON_VENV_PATH)/bin/activate && python sanity_import_vpp_papi.py
101 SANITY_RUN_VPP_CMD=source $(PYTHON_VENV_PATH)/bin/activate && python sanity_run_vpp.py
104 sanity: verify-no-running-vpp
105 @bash -c "$(SANITY_IMPORT_VPP_PAPI_CMD) ||\
106 (echo \"*******************************************************************\" &&\
107 echo \"* Sanity check failed, cannot import vpp_papi\" &&\
108 echo \"* to debug: \" &&\
109 echo \"* 1. enter test shell: make test-shell\" &&\
110 echo \"* 2. execute debugger: gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
111 echo \"*******************************************************************\" &&\
113 @bash -c "$(SANITY_RUN_VPP_CMD) ||\
114 (echo \"*******************************************************************\" &&\
115 echo \"* Sanity check failed, cannot run vpp\" &&\
116 echo \"*******************************************************************\" &&\
123 test: verify-python-path $(PAPI_INSTALL_DONE) ext sanity reset
126 retest: verify-python-path sanity reset
129 shell: verify-python-path $(PAPI_INSTALL_DONE)
130 @echo "source $(PYTHON_VENV_PATH)/bin/activate;\
132 echo VPP_TEST_BUILD_DIR=$(VPP_TEST_BUILD_DIR);\
133 echo VPP_TEST_BIN=$(VPP_TEST_BIN);\
134 echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\
135 echo VPP_TEST_INSTALL_PATH=$(VPP_TEST_INSTALL_PATH);\
136 echo EXTERN_TESTS=$(EXTERN_TESTS);\
137 echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\
138 echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\
139 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
141 exec </dev/tty" | bash -i
146 @rm -f /dev/shm/vpp-unittest-*
147 @rm -rf /tmp/vpp-unittest-*
148 @rm -rf $(VPP_TEST_FAILED_DIR)
149 @mkdir $(VPP_TEST_FAILED_DIR)
153 @rm -rf $(PYTHON_VENV_PATH)
154 @rm -f $(PAPI_INSTALL_FLAGS)
156 doc: verify-python-path $(PIP_PATCH_DONE)
157 @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
158 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install sphinx sphinx-rtd-theme"
159 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && make -C doc WS_ROOT=$(WS_ROOT) BR=$(BR) NO_VPP_PAPI=1 html"
164 @make -C doc wipe BR=$(BR)
166 cov: wipe-cov reset verify-python-path $(PAPI_INSTALL_DONE)
167 @lcov --zerocounters --directory $(VPP_TEST_BUILD_DIR)
168 @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
170 @mkdir $(BUILD_COV_DIR)
171 @lcov --capture --directory $(VPP_TEST_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
172 @test -z "$(EXTERN_COV_DIR)" || lcov --capture --directory $(EXTERN_COV_DIR) --output-file $(BUILD_COV_DIR)/extern-coverage.info
173 @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
174 @test -z "$(EXTERN_COV_DIR)" || genhtml $(BUILD_COV_DIR)/extern-coverage.info --output-directory $(BUILD_COV_DIR)/extern-html
176 @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
177 @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
182 @rm -rf $(BUILD_COV_DIR)
185 checkstyle: verify-python-path
186 @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
187 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install pep8"
188 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate &&\
189 pep8 --show-source -v $(WS_ROOT)/test/*.py ||\
190 (echo \"*******************************************************************\" &&\
191 echo \"* Test framework PEP8 compliance check FAILED \" &&\
192 echo \"*******************************************************************\" &&\
194 @echo "*******************************************************************"
195 @echo "* Test framework PEP8 compliance check passed"
196 @echo "*******************************************************************"
199 @echo "Running tests:"
201 @echo " test - build and run (basic) functional tests"
202 @echo " test-debug - build and run (basic) functional tests (debug build)"
203 @echo " test-all - build and run (all) functional tests"
204 @echo " test-all-debug - build and run (all) functional tests (debug build)"
205 @echo " retest - run functional tests"
206 @echo " retest-debug - run functional tests (debug build)"
207 @echo " test-wipe - wipe (temporary) files generated by unit tests"
208 @echo " test-shell - enter shell with test environment"
209 @echo " test-shell-debug - enter shell with test environment (debug build)"
211 @echo "Arguments controlling test runs:"
212 @echo " V=[0|1|2] - set test verbosity level"
213 @echo " CACHE_OUTPUT=[0|1] - cache VPP stdout/stderr and log as one block after test finishes (default: 1)"
214 @echo " FAILFAST=[0|1] - fail fast if 1, complete all tests if 0"
215 @echo " TIMEOUT=<timeout> - fail test suite if any single test takes longer than <timeout> to finish"
216 @echo " RETRIES=<n> - retry failed tests <n> times"
217 @echo " DEBUG=<type> - set VPP debugging kind"
218 @echo " DEBUG=core - detect coredump and load it in gdb on crash"
219 @echo " DEBUG=gdb - allow easy debugging by printing VPP PID "
220 @echo " and waiting for user input before running "
221 @echo " and tearing down a testcase"
222 @echo " DEBUG=gdbserver - run gdb inside a gdb server, otherwise "
223 @echo " same as above"
224 @echo " STEP=[yes|no] - ease debugging by stepping through a testcase "
225 @echo " SANITY=[yes|no] - perform sanity import of vpp-api/sanity vpp run before running tests (default: yes)"
226 @echo " TEST=<filter> - filter the set of tests:"
227 @echo " by file-name - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py"
228 @echo " by file-suffix - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py"
229 @echo " by wildcard - wildcard filter is <file>.<class>.<test function>, each can be replaced by '*'"
230 @echo " e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name"
231 @echo " TEST='bfd.*.*' is equivalent to above example of filter by file-suffix"
232 @echo " TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class"
233 @echo " TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase"
234 @echo " TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes"
236 @echo " VPP_ZOMBIE_NOCHECK=1 - skip checking for vpp (zombie) processes (CAUTION)"
237 @echo " COREDUMP_SIZE=<size> - pass <size> as unix { coredump-size <size> } argument to vpp"
238 @echo " e.g. COREDUMP_SIZE=4g"
239 @echo " COREDUMP_SIZE=unlimited"
240 @echo " EXTERN_TESTS=<path> - path to out-of-tree test_<name>.py files containing test cases"
241 @echo " EXTERN_PLUGINS=<path>- path to out-of-tree plugins to be loaded by vpp under test"
242 @echo " EXTERN_COV_DIR=<path>- path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report"
244 @echo "Creating test documentation"
245 @echo " test-doc - generate documentation for test framework"
246 @echo " test-wipe-doc - wipe documentation for test framework"
248 @echo "Creating test code coverage report"
249 @echo " test-cov - generate code coverage report for test framework"
250 @echo " test-wipe-cov - wipe code coverage report for test framework"
252 @echo "Verifying code-style"
253 @echo " test-checkstyle - check PEP8 compliance"