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)
16 verify-no-running-vpp:
17 @if [ "$(VPP_PIDS)" != "" ]; then \
19 echo "*** Existing vpp processes detected (PID(s): $(VPP_PIDS)). Running tests under these conditions is not supported. ***"; \
27 UNITTEST_FAILFAST_OPTS=
30 UNITTEST_EXTRA_OPTS=-f
33 ifneq ($(EXTERN_TESTS),)
34 UNITTEST_EXTRA_OPTS=$(UNITTEST_FAILFAST_OPTS) -d $(EXTERN_TESTS)
37 PYTHON_VENV_PATH=$(VPP_PYTHON_PREFIX)/virtualenv
38 PYTHON_DEPENDS=faulthandler six scapy==2.3.3 pexpect subprocess32 cffi git+https://github.com/klement/py-lispnetworking@setup
39 SCAPY_SOURCE=$(shell find $(PYTHON_VENV_PATH) -name site-packages)
40 BUILD_COV_DIR=$(BR)/test-cov
42 GET_PIP_SCRIPT=$(VPP_PYTHON_PREFIX)/get-pip.py
43 PIP_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/pip-install.done
44 PIP_PATCH_DONE=$(VPP_PYTHON_PREFIX)/pip-patch.done
45 PAPI_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/papi-install.done
47 PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE)
50 PYTHON_INTERP=python2.7
52 PYTHON_INTERP=$(PYTHON)
56 @mkdir -p $(VPP_PYTHON_PREFIX)
57 @bash -c "cd $(VPP_PYTHON_PREFIX) && curl -O https://bootstrap.pypa.io/get-pip.py"
59 $(PIP_INSTALL_DONE): $(GET_PIP_SCRIPT)
60 @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
61 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python $(GET_PIP_SCRIPT)"
62 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install $(PYTHON_DEPENDS)"
65 $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
66 @echo --- patching ---
67 @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
68 for f in $(CURDIR)/patches/scapy-2.3.3/*.patch ; do \
69 echo Applying patch: $$(basename $$f) ; \
70 patch -p1 -d $(SCAPY_SOURCE) < $$f ; \
74 $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
75 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && cd $(WS_ROOT)/src/vpp-api/python && python setup.py install"
79 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && setsid scripts/run_with_cleanup.sh python run_tests.py -d $(TEST_DIR) $(UNITTEST_EXTRA_OPTS)"
84 sanity: verify-no-running-vpp
85 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python sanity_import_vpp_papi.py ||\
86 (echo \"*******************************************************************\" &&\
87 echo \"* Sanity check failed, cannot import vpp_papi\" &&\
88 echo \"* to debug: \" &&\
89 echo \"* 1. enter test shell: make test-shell\" &&\
90 echo \"* 2. execute debugger: gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
91 echo \"*******************************************************************\" &&\
93 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python sanity_run_vpp.py ||\
94 (echo \"*******************************************************************\" &&\
95 echo \"* Sanity check failed, cannot run vpp\" &&\
96 echo \"*******************************************************************\" &&\
99 test: verify-python-path $(PAPI_INSTALL_DONE) sanity reset
102 retest: verify-python-path sanity reset
105 shell: verify-python-path $(PAPI_INSTALL_DONE)
106 @echo "source $(PYTHON_VENV_PATH)/bin/activate;\
108 echo VPP_TEST_BUILD_DIR=$(VPP_TEST_BUILD_DIR);\
109 echo VPP_TEST_BIN=$(VPP_TEST_BIN);\
110 echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\
111 echo VPP_TEST_INSTALL_PATH=$(VPP_TEST_INSTALL_PATH);\
112 echo EXTERN_TESTS=$(EXTERN_TESTS);\
113 echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\
114 echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\
115 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
117 exec </dev/tty" | bash -i
122 @rm -f /dev/shm/vpp-unittest-*
123 @rm -rf /tmp/vpp-unittest-*
126 @rm -rf $(PYTHON_VENV_PATH)
127 @rm -f $(PAPI_INSTALL_FLAGS)
129 doc: verify-python-path $(PIP_PATCH_DONE)
130 @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
131 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install sphinx sphinx-rtd-theme"
132 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && make -C doc WS_ROOT=$(WS_ROOT) BR=$(BR) NO_VPP_PAPI=1 html"
137 @make -C doc wipe BR=$(BR)
139 cov: wipe-cov reset verify-python-path $(PAPI_INSTALL_DONE)
140 @lcov --zerocounters --directory $(VPP_TEST_BUILD_DIR)
141 @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
143 @mkdir $(BUILD_COV_DIR)
144 @lcov --capture --directory $(VPP_TEST_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
145 @test -z "$(EXTERN_COV_DIR)" || lcov --capture --directory $(EXTERN_COV_DIR) --output-file $(BUILD_COV_DIR)/extern-coverage.info
146 @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
147 @test -z "$(EXTERN_COV_DIR)" || genhtml $(BUILD_COV_DIR)/extern-coverage.info --output-directory $(BUILD_COV_DIR)/extern-html
149 @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
150 @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
155 @rm -rf $(BUILD_COV_DIR)
158 checkstyle: verify-python-path
159 @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
160 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install pep8"
161 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate &&\
162 pep8 --show-source -v $(WS_ROOT)/test/*.py ||\
163 (echo \"*******************************************************************\" &&\
164 echo \"* Test framework PEP8 compliance check FAILED \" &&\
165 echo \"*******************************************************************\" &&\
167 @echo "*******************************************************************"
168 @echo "* Test framework PEP8 compliance check passed"
169 @echo "*******************************************************************"
172 @echo "Running tests:"
174 @echo " test - build and run (basic) functional tests"
175 @echo " test-debug - build and run (basic) functional tests (debug build)"
176 @echo " test-all - build and run (all) functional tests"
177 @echo " test-all-debug - build and run (all) functional tests (debug build)"
178 @echo " retest - run functional tests"
179 @echo " retest-debug - run functional tests (debug build)"
180 @echo " test-wipe - wipe (temporary) files generated by unit tests"
181 @echo " test-shell - enter shell with test environment"
182 @echo " test-shell-debug - enter shell with test environment (debug build)"
184 @echo "Arguments controlling test runs:"
185 @echo " V=[0|1|2] - set test verbosity level"
186 @echo " FAILFAST=[0|1] - fail fast if 1, complete all tests if 0"
187 @echo " DEBUG=<type> - set VPP debugging kind"
188 @echo " DEBUG=core - detect coredump and load it in gdb on crash"
189 @echo " DEBUG=gdb - allow easy debugging by printing VPP PID "
190 @echo " and waiting for user input before running "
191 @echo " and tearing down a testcase"
192 @echo " DEBUG=gdbserver - run gdb inside a gdb server, otherwise "
193 @echo " same as above"
194 @echo " STEP=[yes|no] - ease debugging by stepping through a testcase "
195 @echo " TEST=<filter> - filter the set of tests:"
196 @echo " by file-name - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py"
197 @echo " by file-suffix - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py"
198 @echo " by wildcard - wildcard filter is <file>.<class>.<test function>, each can be replaced by '*'"
199 @echo " e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name"
200 @echo " TEST='bfd.*.*' is equivalent to above example of filter by file-suffix"
201 @echo " TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class"
202 @echo " TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase"
203 @echo " TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes"
205 @echo " VPP_ZOMBIE_NOCHECK=1 - skip checking for vpp (zombie) processes (CAUTION)"
206 @echo " COREDUMP_SIZE=<size> - pass <size> as unix { coredump-size <size> } argument to vpp"
207 @echo " e.g. COREDUMP_SIZE=4g"
208 @echo " COREDUMP_SIZE=unlimited"
209 @echo " EXTERN_TESTS=<path> - path to out-of-tree test_<name>.py files containing test cases"
210 @echo " EXTERN_PLUGINS=<path>- path to out-of-tree plugins to be loaded by vpp under test"
211 @echo " EXTERN_COV_DIR=<path>- path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report"
213 @echo "Creating test documentation"
214 @echo " test-doc - generate documentation for test framework"
215 @echo " test-wipe-doc - wipe documentation for test framework"
217 @echo "Creating test code coverage report"
218 @echo " test-cov - generate code coverage report for test framework"
219 @echo " test-wipe-cov - wipe code coverage report for test framework"
221 @echo "Verifying code-style"
222 @echo " test-checkstyle - check PEP8 compliance"