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=scapy==2.3.3 pexpect subprocess32 cffi git+https://github.com/klement/py-lispnetworking@setup
39 SCAPY_SOURCE=$(PYTHON_VENV_PATH)/lib/python2.7/site-packages/
40 BUILD_COV_DIR = $(BR)/test-cov
42 PIP_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/pip-install.done
43 PIP_PATCH_DONE=$(VPP_PYTHON_PREFIX)/pip-patch.done
44 PAPI_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/papi-install.done
46 PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE)
49 @virtualenv $(PYTHON_VENV_PATH) -p python2.7
50 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install $(PYTHON_DEPENDS)"
53 $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
54 @echo --- patching ---
55 @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
56 for f in $(CURDIR)/patches/scapy-2.3.3/*.patch ; do \
57 echo Applying patch: $$(basename $$f) ; \
58 patch -p1 -d $(SCAPY_SOURCE) < $$f ; \
62 $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
63 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && cd $(WS_ROOT)/src/vpp-api/python && python setup.py install"
67 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python run_tests.py -d $(TEST_DIR) $(UNITTEST_EXTRA_OPTS)"
72 sanity: verify-no-running-vpp
73 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python sanity_import_vpp_papi.py ||\
74 (echo \"*******************************************************************\" &&\
75 echo \"* Sanity check failed, cannot import vpp_papi\" &&\
76 echo \"* to debug: \" &&\
77 echo \"* 1. enter test shell: make test-shell\" &&\
78 echo \"* 2. execute debugger: gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
79 echo \"*******************************************************************\" &&\
82 test: verify-python-path $(PAPI_INSTALL_DONE) sanity reset
85 retest: verify-python-path sanity reset
88 shell: verify-python-path $(PAPI_INSTALL_DONE)
89 @echo "source $(PYTHON_VENV_PATH)/bin/activate;\
91 echo VPP_TEST_BUILD_DIR=$(VPP_TEST_BUILD_DIR);\
92 echo VPP_TEST_BIN=$(VPP_TEST_BIN);\
93 echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\
94 echo VPP_TEST_INSTALL_PATH=$(VPP_TEST_INSTALL_PATH);\
95 echo EXTERN_TESTS=$(EXTERN_TESTS);\
96 echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\
97 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
99 exec </dev/tty" | bash -i
104 @rm -f /dev/shm/vpp-unittest-*
105 @rm -rf /tmp/vpp-unittest-*
108 @rm -rf $(PYTHON_VENV_PATH)
109 @rm -f $(PAPI_INSTALL_FLAGS)
111 doc: verify-python-path $(PIP_PATCH_DONE)
112 @virtualenv $(PYTHON_VENV_PATH) -p python2.7
113 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install sphinx sphinx-rtd-theme"
114 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && make -C doc WS_ROOT=$(WS_ROOT) BR=$(BR) NO_VPP_PAPI=1 html"
119 @make -C doc wipe BR=$(BR)
121 cov: wipe-cov reset verify-python-path $(PAPI_INSTALL_DONE)
122 @lcov --zerocounters --directory $(VPP_TEST_BUILD_DIR)
124 @mkdir $(BUILD_COV_DIR)
125 @lcov --capture --directory $(VPP_TEST_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
126 @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
128 @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
133 @rm -rf $(BUILD_COV_DIR)
136 checkstyle: verify-python-path
137 @virtualenv $(PYTHON_VENV_PATH) -p python2.7
138 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install pep8"
139 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate &&\
140 pep8 --show-source -v $(WS_ROOT)/test/*.py ||\
141 (echo \"*******************************************************************\" &&\
142 echo \"* Test framework PEP8 compliance check FAILED \" &&\
143 echo \"*******************************************************************\" &&\
145 @echo "*******************************************************************"
146 @echo "* Test framework PEP8 compliance check passed"
147 @echo "*******************************************************************"
150 @echo "Running tests:"
152 @echo " test - build and run (basic) functional tests"
153 @echo " test-debug - build and run (basic) functional tests (debug build)"
154 @echo " test-all - build and run (all) functional tests"
155 @echo " test-all-debug - build and run (all) functional tests (debug build)"
156 @echo " retest - run functional tests"
157 @echo " retest-debug - run functional tests (debug build)"
158 @echo " test-wipe - wipe (temporary) files generated by unit tests"
159 @echo " test-shell - enter shell with test environment"
160 @echo " test-shell-debug - enter shell with test environment (debug build)"
162 @echo "Arguments controlling test runs:"
163 @echo " V=[0|1|2] - set test verbosity level"
164 @echo " FAILFAST=[0|1] - fail fast if 1, complete all tests if 0"
165 @echo " DEBUG=<type> - set VPP debugging kind"
166 @echo " DEBUG=core - detect coredump and load it in gdb on crash"
167 @echo " DEBUG=gdb - allow easy debugging by printing VPP PID "
168 @echo " and waiting for user input before running "
169 @echo " and tearing down a testcase"
170 @echo " DEBUG=gdbserver - run gdb inside a gdb server, otherwise "
171 @echo " same as above"
172 @echo " STEP=[yes|no] - ease debugging by stepping through a testcase "
173 @echo " TEST=<filter> - filter the set of tests:"
174 @echo " by file-name - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py"
175 @echo " by file-suffix - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py"
176 @echo " by wildcard - wildcard filter is <file>.<class>.<test function>, each can be replaced by '*'"
177 @echo " e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name"
178 @echo " TEST='bfd.*.*' is equivalent to above example of filter by file-suffix"
179 @echo " TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class"
180 @echo " TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase"
181 @echo " TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes"
183 @echo " VPP_ZOMBIE_NOCHECK=1 - skip checking for vpp (zombie) processes (CAUTION)"
184 @echo " COREDUMP_SIZE=<size> - pass <size> as unix { coredump-size <size> } argument to vpp"
185 @echo " e.g. COREDUMP_SIZE=4g"
186 @echo " COREDUMP_SIZE=unlimited"
187 @echo " EXTERN_TESTS=<path> - path to out-of-tree test_<name>.py files containing test cases"
188 @echo " EXTERN_PLUGINS=<path>- path to out-of-tree plugins to be loaded by vpp under test"
190 @echo "Creating test documentation"
191 @echo " test-doc - generate documentation for test framework"
192 @echo " test-wipe-doc - wipe documentation for test framework"
194 @echo "Creating test code coverage report"
195 @echo " test-cov - generate code coverage report for test framework"
196 @echo " test-wipe-cov - wipe code coverage report for test framework"
198 @echo "Verifying code-style"
199 @echo " test-checkstyle - check PEP8 compliance"