1 .PHONY: verify-python-path
4 ifndef VPP_PYTHON_PREFIX
5 $(error VPP_PYTHON_PREFIX is not set)
8 .PHONY: verify-no-running-vpp
10 ifdef VPP_ZOMBIE_NOCHECK
13 VPP_PIDS=$(shell pgrep -d, -x vpp_main)
18 else ifeq ($(DEBUG),gdbserver)
24 verify-no-running-vpp:
25 @if [ "$(VPP_PIDS)" != "" ]; then \
27 echo "*** Existing vpp processes detected (PID(s): $(VPP_PIDS)). Running tests under these conditions is not supported. ***"; \
35 UNITTEST_FAILFAST_OPTS=
38 UNITTEST_EXTRA_OPTS=-f
41 ifneq ($(EXTERN_TESTS),)
42 UNITTEST_EXTRA_OPTS=$(UNITTEST_FAILFAST_OPTS) -d $(EXTERN_TESTS)
45 PYTHON_VENV_PATH=$(VPP_PYTHON_PREFIX)/virtualenv
46 PYTHON_DEPENDS=faulthandler six scapy==2.3.3 pexpect subprocess32 cffi git+https://github.com/klement/py-lispnetworking@setup
47 SCAPY_SOURCE=$(shell find $(PYTHON_VENV_PATH) -name site-packages)
48 BUILD_COV_DIR=$(BR)/test-cov
50 GET_PIP_SCRIPT=$(VPP_PYTHON_PREFIX)/get-pip.py
51 PIP_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/pip-install.done
52 PIP_PATCH_DONE=$(VPP_PYTHON_PREFIX)/pip-patch.done
53 PAPI_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/papi-install.done
55 PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE)
58 PYTHON_INTERP=python2.7
60 PYTHON_INTERP=$(PYTHON)
64 @mkdir -p $(VPP_PYTHON_PREFIX)
65 @bash -c "cd $(VPP_PYTHON_PREFIX) && curl -O https://bootstrap.pypa.io/get-pip.py"
67 $(PIP_INSTALL_DONE): $(GET_PIP_SCRIPT)
68 @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
69 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python $(GET_PIP_SCRIPT)"
70 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install $(PYTHON_DEPENDS)"
73 $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
74 @echo --- patching ---
75 @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
76 for f in $(CURDIR)/patches/scapy-2.3.3/*.patch ; do \
77 echo Applying patch: $$(basename $$f) ; \
78 patch -p1 -d $(SCAPY_SOURCE) < $$f ; \
82 $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
83 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && cd $(WS_ROOT)/src/vpp-api/python && python setup.py install"
87 @scripts/setsid_wrapper.sh $(FORCE_FOREGROUND) $(PYTHON_VENV_PATH)/bin/activate python run_tests.py -d $(TEST_DIR) $(UNITTEST_EXTRA_OPTS)
92 sanity: verify-no-running-vpp
93 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python sanity_import_vpp_papi.py ||\
94 (echo \"*******************************************************************\" &&\
95 echo \"* Sanity check failed, cannot import vpp_papi\" &&\
96 echo \"* to debug: \" &&\
97 echo \"* 1. enter test shell: make test-shell\" &&\
98 echo \"* 2. execute debugger: gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
99 echo \"*******************************************************************\" &&\
101 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python sanity_run_vpp.py ||\
102 (echo \"*******************************************************************\" &&\
103 echo \"* Sanity check failed, cannot run vpp\" &&\
104 echo \"*******************************************************************\" &&\
107 test: verify-python-path $(PAPI_INSTALL_DONE) sanity reset
110 retest: verify-python-path sanity reset
113 shell: verify-python-path $(PAPI_INSTALL_DONE)
114 @echo "source $(PYTHON_VENV_PATH)/bin/activate;\
116 echo VPP_TEST_BUILD_DIR=$(VPP_TEST_BUILD_DIR);\
117 echo VPP_TEST_BIN=$(VPP_TEST_BIN);\
118 echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\
119 echo VPP_TEST_INSTALL_PATH=$(VPP_TEST_INSTALL_PATH);\
120 echo EXTERN_TESTS=$(EXTERN_TESTS);\
121 echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\
122 echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\
123 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
125 exec </dev/tty" | bash -i
130 @rm -f /dev/shm/vpp-unittest-*
131 @rm -rf /tmp/vpp-unittest-*
134 @rm -rf $(PYTHON_VENV_PATH)
135 @rm -f $(PAPI_INSTALL_FLAGS)
137 doc: verify-python-path $(PIP_PATCH_DONE)
138 @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
139 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install sphinx sphinx-rtd-theme"
140 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && make -C doc WS_ROOT=$(WS_ROOT) BR=$(BR) NO_VPP_PAPI=1 html"
145 @make -C doc wipe BR=$(BR)
147 cov: wipe-cov reset verify-python-path $(PAPI_INSTALL_DONE)
148 @lcov --zerocounters --directory $(VPP_TEST_BUILD_DIR)
149 @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
151 @mkdir $(BUILD_COV_DIR)
152 @lcov --capture --directory $(VPP_TEST_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
153 @test -z "$(EXTERN_COV_DIR)" || lcov --capture --directory $(EXTERN_COV_DIR) --output-file $(BUILD_COV_DIR)/extern-coverage.info
154 @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
155 @test -z "$(EXTERN_COV_DIR)" || genhtml $(BUILD_COV_DIR)/extern-coverage.info --output-directory $(BUILD_COV_DIR)/extern-html
157 @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
158 @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
163 @rm -rf $(BUILD_COV_DIR)
166 checkstyle: verify-python-path
167 @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
168 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install pep8"
169 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate &&\
170 pep8 --show-source -v $(WS_ROOT)/test/*.py ||\
171 (echo \"*******************************************************************\" &&\
172 echo \"* Test framework PEP8 compliance check FAILED \" &&\
173 echo \"*******************************************************************\" &&\
175 @echo "*******************************************************************"
176 @echo "* Test framework PEP8 compliance check passed"
177 @echo "*******************************************************************"
180 @echo "Running tests:"
182 @echo " test - build and run (basic) functional tests"
183 @echo " test-debug - build and run (basic) functional tests (debug build)"
184 @echo " test-all - build and run (all) functional tests"
185 @echo " test-all-debug - build and run (all) functional tests (debug build)"
186 @echo " retest - run functional tests"
187 @echo " retest-debug - run functional tests (debug build)"
188 @echo " test-wipe - wipe (temporary) files generated by unit tests"
189 @echo " test-shell - enter shell with test environment"
190 @echo " test-shell-debug - enter shell with test environment (debug build)"
192 @echo "Arguments controlling test runs:"
193 @echo " V=[0|1|2] - set test verbosity level"
194 @echo " FAILFAST=[0|1] - fail fast if 1, complete all tests if 0"
195 @echo " TIMEOUT=<timeout> - fail test suite if any single test takes longer than <timeout> to finish"
196 @echo " DEBUG=<type> - set VPP debugging kind"
197 @echo " DEBUG=core - detect coredump and load it in gdb on crash"
198 @echo " DEBUG=gdb - allow easy debugging by printing VPP PID "
199 @echo " and waiting for user input before running "
200 @echo " and tearing down a testcase"
201 @echo " DEBUG=gdbserver - run gdb inside a gdb server, otherwise "
202 @echo " same as above"
203 @echo " STEP=[yes|no] - ease debugging by stepping through a testcase "
204 @echo " TEST=<filter> - filter the set of tests:"
205 @echo " by file-name - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py"
206 @echo " by file-suffix - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py"
207 @echo " by wildcard - wildcard filter is <file>.<class>.<test function>, each can be replaced by '*'"
208 @echo " e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name"
209 @echo " TEST='bfd.*.*' is equivalent to above example of filter by file-suffix"
210 @echo " TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class"
211 @echo " TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase"
212 @echo " TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes"
214 @echo " VPP_ZOMBIE_NOCHECK=1 - skip checking for vpp (zombie) processes (CAUTION)"
215 @echo " COREDUMP_SIZE=<size> - pass <size> as unix { coredump-size <size> } argument to vpp"
216 @echo " e.g. COREDUMP_SIZE=4g"
217 @echo " COREDUMP_SIZE=unlimited"
218 @echo " EXTERN_TESTS=<path> - path to out-of-tree test_<name>.py files containing test cases"
219 @echo " EXTERN_PLUGINS=<path>- path to out-of-tree plugins to be loaded by vpp under test"
220 @echo " EXTERN_COV_DIR=<path>- path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report"
222 @echo "Creating test documentation"
223 @echo " test-doc - generate documentation for test framework"
224 @echo " test-wipe-doc - wipe documentation for test framework"
226 @echo "Creating test code coverage report"
227 @echo " test-cov - generate code coverage report for test framework"
228 @echo " test-wipe-cov - wipe code coverage report for test framework"
230 @echo "Verifying code-style"
231 @echo " test-checkstyle - check PEP8 compliance"