blob: b429ac9e6e202bdac9c79da0dfcb0e4b6f487297 [file] [log] [blame]
Klement Sekera277b89c2016-10-28 13:20:27 +02001.PHONY: verify-python-path
Damjan Marionf56b77a2016-10-03 19:44:57 +02002
Klement Sekeraf413bef2017-08-15 07:09:02 +02003VPP_TEST_FAILED_DIR=/tmp/vpp-failed-unittests/
4
Klement Sekera277b89c2016-10-28 13:20:27 +02005verify-python-path:
6ifndef VPP_PYTHON_PREFIX
7 $(error VPP_PYTHON_PREFIX is not set)
8endif
9
Klement Sekerab93d1422017-03-02 08:16:20 +010010.PHONY: verify-no-running-vpp
11
12ifdef VPP_ZOMBIE_NOCHECK
13VPP_PIDS=
14else
15VPP_PIDS=$(shell pgrep -d, -x vpp_main)
16endif
17
Klement Sekeradb4e84c2017-08-11 10:06:15 +020018ifeq ($(DEBUG),gdb)
19FORCE_FOREGROUND=1
20else ifeq ($(DEBUG),gdbserver)
21FORCE_FOREGROUND=1
Klement Sekerab90be672017-10-10 06:44:05 +020022else ifeq ($(DEBUG),core)
23FORCE_FOREGROUND=1
Klement Sekeradb4e84c2017-08-11 10:06:15 +020024else
25FORCE_FOREGROUND=0
26endif
27
Klement Sekerab93d1422017-03-02 08:16:20 +010028verify-no-running-vpp:
29 @if [ "$(VPP_PIDS)" != "" ]; then \
30 echo; \
31 echo "*** Existing vpp processes detected (PID(s): $(VPP_PIDS)). Running tests under these conditions is not supported. ***"; \
32 echo; \
33 ps -fp $(VPP_PIDS);\
34 echo; \
35 false; \
36 fi
37
Klement Sekera993e0ed2017-03-16 09:14:59 +010038UNITTEST_EXTRA_OPTS=
39UNITTEST_FAILFAST_OPTS=
Klement Sekeraacb9b8e2017-02-14 02:55:31 +010040
41ifeq ($(FAILFAST),1)
Klement Sekera993e0ed2017-03-16 09:14:59 +010042UNITTEST_EXTRA_OPTS=-f
43endif
44
45ifneq ($(EXTERN_TESTS),)
46UNITTEST_EXTRA_OPTS=$(UNITTEST_FAILFAST_OPTS) -d $(EXTERN_TESTS)
Klement Sekeraacb9b8e2017-02-14 02:55:31 +010047endif
48
Klement Sekera277b89c2016-10-28 13:20:27 +020049PYTHON_VENV_PATH=$(VPP_PYTHON_PREFIX)/virtualenv
Klement Sekera3658adc2017-06-07 08:19:47 +020050PYTHON_DEPENDS=faulthandler six scapy==2.3.3 pexpect subprocess32 cffi git+https://github.com/klement/py-lispnetworking@setup
vagrant937bf302017-04-07 01:48:47 +000051SCAPY_SOURCE=$(shell find $(PYTHON_VENV_PATH) -name site-packages)
52BUILD_COV_DIR=$(BR)/test-cov
Klement Sekera277b89c2016-10-28 13:20:27 +020053
vagrant937bf302017-04-07 01:48:47 +000054GET_PIP_SCRIPT=$(VPP_PYTHON_PREFIX)/get-pip.py
Klement Sekera9f9d07b2016-12-12 09:20:50 +010055PIP_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/pip-install.done
56PIP_PATCH_DONE=$(VPP_PYTHON_PREFIX)/pip-patch.done
57PAPI_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/papi-install.done
Neale Ranns177bbdc2016-11-15 09:46:51 +000058
Klement Sekera9f9d07b2016-12-12 09:20:50 +010059PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE)
60
vagrant937bf302017-04-07 01:48:47 +000061ifeq ($(PYTHON),)
62PYTHON_INTERP=python2.7
63else
64PYTHON_INTERP=$(PYTHON)
65endif
66
67$(GET_PIP_SCRIPT):
68 @mkdir -p $(VPP_PYTHON_PREFIX)
69 @bash -c "cd $(VPP_PYTHON_PREFIX) && curl -O https://bootstrap.pypa.io/get-pip.py"
70
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)"
Klement Sekera778c2762016-11-08 02:00:28 +010074 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install $(PYTHON_DEPENDS)"
Neale Ranns177bbdc2016-11-15 09:46:51 +000075 @touch $@
76
Klement Sekera9f9d07b2016-12-12 09:20:50 +010077$(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
Neale Ranns177bbdc2016-11-15 09:46:51 +000078 @echo --- patching ---
Dave Wallace6f692d62017-01-26 21:07:10 -050079 @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
Neale Ranns177bbdc2016-11-15 09:46:51 +000080 for f in $(CURDIR)/patches/scapy-2.3.3/*.patch ; do \
81 echo Applying patch: $$(basename $$f) ; \
82 patch -p1 -d $(SCAPY_SOURCE) < $$f ; \
83 done
84 @touch $@
85
Klement Sekera9f9d07b2016-12-12 09:20:50 +010086$(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
Damjan Marion37d77e92016-12-28 15:14:46 +010087 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && cd $(WS_ROOT)/src/vpp-api/python && python setup.py install"
Neale Ranns177bbdc2016-11-15 09:46:51 +000088 @touch $@
89
Juraj Sloboda0279b292016-11-16 19:50:24 +010090define retest-func
Dave Wallace25dc1672017-09-30 01:53:26 -040091 @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
Juraj Sloboda0279b292016-11-16 19:50:24 +010092endef
93
Klement Sekerac160ae02017-03-09 08:20:13 +010094.PHONY: sanity
95
Klement Sekera41a9e512017-10-17 07:59:31 +020096ifeq ($(SANITY),no)
97SANITY_IMPORT_VPP_PAPI_CMD=true
98SANITY_RUN_VPP_CMD=true
99else
100SANITY_IMPORT_VPP_PAPI_CMD=source $(PYTHON_VENV_PATH)/bin/activate && python sanity_import_vpp_papi.py
101SANITY_RUN_VPP_CMD=source $(PYTHON_VENV_PATH)/bin/activate && python sanity_run_vpp.py
102endif
103
Klement Sekerac160ae02017-03-09 08:20:13 +0100104sanity: verify-no-running-vpp
Klement Sekera41a9e512017-10-17 07:59:31 +0200105 @bash -c "$(SANITY_IMPORT_VPP_PAPI_CMD) ||\
Klement Sekerac160ae02017-03-09 08:20:13 +0100106 (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 \"*******************************************************************\" &&\
112 false)"
Klement Sekera41a9e512017-10-17 07:59:31 +0200113 @bash -c "$(SANITY_RUN_VPP_CMD) ||\
Klement Sekera3747c752017-04-10 06:30:17 +0200114 (echo \"*******************************************************************\" &&\
115 echo \"* Sanity check failed, cannot run vpp\" &&\
116 echo \"*******************************************************************\" &&\
117 false)"
Klement Sekerac160ae02017-03-09 08:20:13 +0100118
Klement Sekera8f2a4ea2017-05-04 06:15:18 +0200119.PHONY: ext
120ext:
121 make -C ext
122
123test: verify-python-path $(PAPI_INSTALL_DONE) ext sanity reset
Juraj Sloboda0279b292016-11-16 19:50:24 +0100124 $(call retest-func)
Klement Sekeraf62ae122016-10-11 11:47:09 +0200125
Klement Sekerac160ae02017-03-09 08:20:13 +0100126retest: verify-python-path sanity reset
Juraj Sloboda0279b292016-11-16 19:50:24 +0100127 $(call retest-func)
Klement Sekeraf62ae122016-10-11 11:47:09 +0200128
Klement Sekeraa86e2892017-03-09 08:01:52 +0100129shell: verify-python-path $(PAPI_INSTALL_DONE)
130 @echo "source $(PYTHON_VENV_PATH)/bin/activate;\
131 echo '***';\
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);\
Klement Sekera47e275b2017-03-21 08:21:25 +0100136 echo EXTERN_TESTS=$(EXTERN_TESTS);\
137 echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\
Klement Sekeracd6cb982017-05-11 06:55:32 +0200138 echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\
Klement Sekeraa86e2892017-03-09 08:01:52 +0100139 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
140 echo '***';\
141 exec </dev/tty" | bash -i
142
Klement Sekera277b89c2016-10-28 13:20:27 +0200143.PHONY: wipe doc
Klement Sekeraf62ae122016-10-11 11:47:09 +0200144
Neale Ranns177bbdc2016-11-15 09:46:51 +0000145reset:
Klement Sekeraf62ae122016-10-11 11:47:09 +0200146 @rm -f /dev/shm/vpp-unittest-*
147 @rm -rf /tmp/vpp-unittest-*
Klement Sekeraf413bef2017-08-15 07:09:02 +0200148 @rm -rf $(VPP_TEST_FAILED_DIR)
149 @mkdir $(VPP_TEST_FAILED_DIR)
Klement Sekeraf62ae122016-10-11 11:47:09 +0200150
Neale Ranns177bbdc2016-11-15 09:46:51 +0000151wipe: reset
Klement Sekeraa61d1252017-09-27 06:48:44 +0200152 @make -C ext clean
Klement Sekera9f9d07b2016-12-12 09:20:50 +0100153 @rm -rf $(PYTHON_VENV_PATH)
154 @rm -f $(PAPI_INSTALL_FLAGS)
Neale Ranns177bbdc2016-11-15 09:46:51 +0000155
Klement Sekera63205142017-02-03 08:18:53 +0100156doc: verify-python-path $(PIP_PATCH_DONE)
vagrant937bf302017-04-07 01:48:47 +0000157 @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
Klement Sekera63205142017-02-03 08:18:53 +0100158 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install sphinx sphinx-rtd-theme"
Klement Sekera277b89c2016-10-28 13:20:27 +0200159 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && make -C doc WS_ROOT=$(WS_ROOT) BR=$(BR) NO_VPP_PAPI=1 html"
160
Klement Sekera9f9d07b2016-12-12 09:20:50 +0100161.PHONY: wipe-doc
162
Klement Sekera277b89c2016-10-28 13:20:27 +0200163wipe-doc:
164 @make -C doc wipe BR=$(BR)
165
Klement Sekera9f9d07b2016-12-12 09:20:50 +0100166cov: wipe-cov reset verify-python-path $(PAPI_INSTALL_DONE)
Juraj Sloboda0279b292016-11-16 19:50:24 +0100167 @lcov --zerocounters --directory $(VPP_TEST_BUILD_DIR)
Klement Sekeracd6cb982017-05-11 06:55:32 +0200168 @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
Juraj Sloboda0279b292016-11-16 19:50:24 +0100169 $(call retest-func)
170 @mkdir $(BUILD_COV_DIR)
171 @lcov --capture --directory $(VPP_TEST_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
Klement Sekeracd6cb982017-05-11 06:55:32 +0200172 @test -z "$(EXTERN_COV_DIR)" || lcov --capture --directory $(EXTERN_COV_DIR) --output-file $(BUILD_COV_DIR)/extern-coverage.info
Juraj Sloboda0279b292016-11-16 19:50:24 +0100173 @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
Klement Sekeracd6cb982017-05-11 06:55:32 +0200174 @test -z "$(EXTERN_COV_DIR)" || genhtml $(BUILD_COV_DIR)/extern-coverage.info --output-directory $(BUILD_COV_DIR)/extern-html
Juraj Sloboda0279b292016-11-16 19:50:24 +0100175 @echo
176 @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
Klement Sekeracd6cb982017-05-11 06:55:32 +0200177 @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
Juraj Sloboda0279b292016-11-16 19:50:24 +0100178
Klement Sekera9f9d07b2016-12-12 09:20:50 +0100179.PHONY: wipe-cov
180
Juraj Sloboda0279b292016-11-16 19:50:24 +0100181wipe-cov: wipe
182 @rm -rf $(BUILD_COV_DIR)
183
Klement Sekera72715ee2017-01-17 10:37:05 +0100184.PHONY: checkstyle
185checkstyle: verify-python-path
vagrant937bf302017-04-07 01:48:47 +0000186 @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
Neale Rannsaaa396a2017-02-05 09:12:02 -0800187 @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install pep8"
Klement Sekera72715ee2017-01-17 10:37:05 +0100188 @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 \"*******************************************************************\" &&\
193 false)"
194 @echo "*******************************************************************"
195 @echo "* Test framework PEP8 compliance check passed"
196 @echo "*******************************************************************"
197
Klement Sekera277b89c2016-10-28 13:20:27 +0200198help:
199 @echo "Running tests:"
200 @echo ""
Klement Sekera87134932017-03-07 11:39:27 +0100201 @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)"
Klement Sekera277b89c2016-10-28 13:20:27 +0200205 @echo " retest - run functional tests"
206 @echo " retest-debug - run functional tests (debug build)"
Juraj Sloboda0279b292016-11-16 19:50:24 +0100207 @echo " test-wipe - wipe (temporary) files generated by unit tests"
Klement Sekeraa86e2892017-03-09 08:01:52 +0100208 @echo " test-shell - enter shell with test environment"
209 @echo " test-shell-debug - enter shell with test environment (debug build)"
Klement Sekera277b89c2016-10-28 13:20:27 +0200210 @echo ""
211 @echo "Arguments controlling test runs:"
212 @echo " V=[0|1|2] - set test verbosity level"
Klement Sekeraa3d933c2017-11-06 09:46:00 +0100213 @echo " CACHE_OUTPUT=[0|1] - cache VPP stdout/stderr and log as one block after test finishes (default: 1)"
Klement Sekeraacb9b8e2017-02-14 02:55:31 +0100214 @echo " FAILFAST=[0|1] - fail fast if 1, complete all tests if 0"
Klement Sekera909a6a12017-08-08 04:33:53 +0200215 @echo " TIMEOUT=<timeout> - fail test suite if any single test takes longer than <timeout> to finish"
Klement Sekeradf2b9802017-10-05 10:26:03 +0200216 @echo " RETRIES=<n> - retry failed tests <n> times"
Klement Sekera277b89c2016-10-28 13:20:27 +0200217 @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 "
Klement Sekera41a9e512017-10-17 07:59:31 +0200225 @echo " SANITY=[yes|no] - perform sanity import of vpp-api/sanity vpp run before running tests (default: yes)"
Klement Sekera104543f2017-02-03 07:29:43 +0100226 @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"
Klement Sekera277b89c2016-10-28 13:20:27 +0200235 @echo ""
Klement Sekerab93d1422017-03-02 08:16:20 +0100236 @echo " VPP_ZOMBIE_NOCHECK=1 - skip checking for vpp (zombie) processes (CAUTION)"
Klement Sekera80a7f0a2017-03-02 11:27:11 +0100237 @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"
Klement Sekera47e275b2017-03-21 08:21:25 +0100240 @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"
Klement Sekeracd6cb982017-05-11 06:55:32 +0200242 @echo " EXTERN_COV_DIR=<path>- path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report"
Klement Sekerab93d1422017-03-02 08:16:20 +0100243 @echo ""
Klement Sekera277b89c2016-10-28 13:20:27 +0200244 @echo "Creating test documentation"
245 @echo " test-doc - generate documentation for test framework"
Juraj Sloboda0279b292016-11-16 19:50:24 +0100246 @echo " test-wipe-doc - wipe documentation for test framework"
247 @echo ""
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"
Klement Sekera277b89c2016-10-28 13:20:27 +0200251 @echo ""
Klement Sekera72715ee2017-01-17 10:37:05 +0100252 @echo "Verifying code-style"
253 @echo " test-checkstyle - check PEP8 compliance"
254 @echo ""