MAP: Convert from DPO to input feature.
[vpp.git] / test / Makefile
1 .PHONY: verify-test-dir
2
3 FAILED_DIR=/tmp/vpp-failed-unittests/
4
5 verify-test-dir:
6 ifndef TEST_DIR
7         $(error TEST_DIR is not set)
8 endif
9
10 .PHONY: verify-no-running-vpp
11
12 ifdef VPP_ZOMBIE_NOCHECK
13 VPP_PIDS=
14 else
15 VPP_PIDS=$(shell pgrep -d, -x vpp_main)
16 endif
17
18 ifeq ($(DEBUG),gdb)
19 FORCE_FOREGROUND=1
20 else ifeq ($(DEBUG),gdbserver)
21 FORCE_FOREGROUND=1
22 else ifeq ($(DEBUG),core)
23 FORCE_FOREGROUND=1
24 else ifeq ($(STEP),yes)
25 FORCE_FOREGROUND=1
26 else ifeq ($(STEP),y)
27 FORCE_FOREGROUND=1
28 else ifeq ($(STEP),1)
29 FORCE_FOREGROUND=1
30 else
31 FORCE_FOREGROUND=0
32 endif
33
34 ifdef PROFILE_OUTPUT
35 PROFILE_OUTPUT_OPTS=-o $(PROFILE_OUTPUT)
36 endif
37
38 ifndef PROFILE_SORT_BY
39 PROFILE_SORT_BY=cumtime
40 endif
41
42 ifeq ($(PROFILE),1)
43 PYTHON_PROFILE_OPTS=-m cProfile $(PROFILE_OUTPUT_OPTS) -s $(PROFILE_SORT_BY)
44 FORCE_FOREGROUND=1
45 endif
46
47 verify-no-running-vpp:
48         @if [ "$(VPP_PIDS)" != "" ]; then \
49                 echo; \
50                 echo "*** Existing vpp processes detected (PID(s): $(VPP_PIDS)). Running tests under these conditions is not supported. ***"; \
51                 echo; \
52                 ps -fp $(VPP_PIDS);\
53                 echo; \
54                 false; \
55         fi
56
57 UNITTEST_EXTRA_OPTS=
58 UNITTEST_FAILFAST_OPTS=
59
60 ifeq ($(FAILFAST),1)
61 UNITTEST_EXTRA_OPTS=-f
62 endif
63
64 ifneq ($(EXTERN_TESTS),)
65 UNITTEST_EXTRA_OPTS=$(UNITTEST_FAILFAST_OPTS) -d $(EXTERN_TESTS)
66 endif
67
68 VENV_PATH=$(TEST_DIR)/run/venv
69
70 ifeq ($(TEST_DEBUG),1)
71 TEST_RUN_DIR:=$(VENV_PATH)/run-debug
72 PYTHON_EXTRA_DEPENDS=objgraph pympler
73 else
74 TEST_RUN_DIR:=$(VENV_PATH)/run
75 PYTHON_EXTRA_DEPENDS=
76 endif
77
78 PYTHON_DEPENDS=$(PYTHON_EXTRA_DEPENDS) -r requirements.txt
79 SCAPY_SOURCE=$(shell find $(VENV_PATH) -name site-packages)
80 BUILD_COV_DIR=$(TEST_DIR)/coverage
81
82 GET_PIP_SCRIPT=$(TEST_RUN_DIR)/get-pip.py
83 PIP_INSTALL_DONE=$(TEST_RUN_DIR)/pip-install.done
84 PIP_PATCH_DONE=$(TEST_RUN_DIR)/pip-patch.done
85 PAPI_INSTALL_DONE=$(TEST_RUN_DIR)/papi-install.done
86
87 PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE)
88
89 ifeq ($(PYTHON),)
90 PYTHON_INTERP=python2.7
91 else
92 PYTHON_INTERP=$(PYTHON)
93 endif
94
95 $(GET_PIP_SCRIPT):
96         @mkdir -p $(TEST_RUN_DIR)
97         @bash -c "cd $(TEST_RUN_DIR) && curl -O https://bootstrap.pypa.io/get-pip.py"
98
99 $(PIP_INSTALL_DONE): $(GET_PIP_SCRIPT)
100         @virtualenv $(VENV_PATH) -p $(PYTHON_INTERP)
101         @bash -c "source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) $(GET_PIP_SCRIPT)"
102         @bash -c "source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) -m pip install $(PYTHON_DEPENDS)"
103         @touch $@
104
105 $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
106         @echo --- patching ---
107         @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
108         for f in $(CURDIR)/patches/scapy-2.4/*.patch ; do \
109                 echo Applying patch: $$(basename $$f) ; \
110                 patch -p1 -d $(SCAPY_SOURCE) < $$f ; \
111         done
112         @touch $@
113
114 $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
115         @bash -c "source $(VENV_PATH)/bin/activate && cd $(WS_ROOT)/src/vpp-api/python && $(PYTHON_INTERP) setup.py install"
116         @touch $@
117
118 define retest-func
119 @env FORCE_FOREGROUND=$(FORCE_FOREGROUND) FAILED_DIR=$(FAILED_DIR) VENV_PATH=$(VENV_PATH) scripts/setsid_wrapper.sh $(FORCE_FOREGROUND) $(VENV_PATH)/bin/activate $(PYTHON_INTERP) $(PYTHON_PROFILE_OPTS) run_tests.py -d $(TEST_DIR) $(UNITTEST_EXTRA_OPTS) || env FAILED_DIR=$(FAILED_DIR) COMPRESS_FAILED_TEST_LOGS=$(COMPRESS_FAILED_TEST_LOGS) scripts/compress_failed.sh
120 endef
121
122 .PHONY: sanity
123
124 ifeq ($(SANITY),no)
125 SANITY_IMPORT_VPP_PAPI_CMD=true
126 SANITY_RUN_VPP_CMD=true
127 else
128 SANITY_IMPORT_VPP_PAPI_CMD=source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) sanity_import_vpp_papi.py
129 SANITY_RUN_VPP_CMD=source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) sanity_run_vpp.py
130 endif
131
132 ifndef TEST_JOBS
133 PARALLEL_ILLEGAL=0
134 else ifeq ($(FORCE_FOREGROUND),0)
135 PARALLEL_ILLEGAL=0
136 else ifeq ($(TEST_JOBS),auto)
137 PARALLEL_ILLEGAL=0
138 else ifeq ($(TEST_JOBS),1)
139 PARALLEL_ILLEGAL=0
140 else
141 PARALLEL_ILLEGAL=1
142 endif
143
144 sanity: verify-no-running-vpp
145         @sys_req/dev_shm_size.sh
146         @bash -c "test $(PARALLEL_ILLEGAL) -eq 0 ||\
147             (echo \"*******************************************************************\" &&\
148                  echo \"* Sanity check failed, TEST_JOBS is not 1 or 'auto' and DEBUG, STEP or PROFILE is set\" &&\
149                  echo \"*******************************************************************\" &&\
150                  false)"
151         @bash -c "$(SANITY_IMPORT_VPP_PAPI_CMD) ||\
152                 (echo \"*******************************************************************\" &&\
153                  echo \"* Sanity check failed, cannot import vpp_papi\" &&\
154                  echo \"* to debug: \" &&\
155                  echo \"* 1. enter test shell:   make test-shell\" &&\
156                  echo \"* 2. execute debugger:   gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
157                  echo \"*******************************************************************\" &&\
158                  false)"
159         @bash -c "$(SANITY_RUN_VPP_CMD) ||\
160                 (echo \"*******************************************************************\" &&\
161                  echo \"* Sanity check failed, cannot run vpp\" &&\
162                  echo \"*******************************************************************\" &&\
163                  false)"
164
165 .PHONY: ext
166 ext:
167         @if [ "$(EXTENDED_TESTS)" = "yes" ]; then\
168                 make -C ext;\
169         fi
170
171 test-dep: verify-test-dir $(PAPI_INSTALL_DONE)
172
173 test: verify-test-dir $(PAPI_INSTALL_DONE) ext sanity reset
174         $(call retest-func)
175
176 retest: verify-test-dir sanity reset
177         $(call retest-func)
178
179 shell: verify-test-dir $(PAPI_INSTALL_DONE)
180         @echo "source $(VENV_PATH)/bin/activate;\
181                 echo '***';\
182                 echo _BUILD_DIR=$(VPP_BUILD_DIR);\
183                 echo _BIN=$(VPP_BIN);\
184                 echo _PLUGIN_PATH=$(VPP_PLUGIN_PATH);\
185                 echo _INSTALL_PATH=$(VPP_INSTALL_PATH);\
186                 echo EXTERN_TESTS=$(EXTERN_TESTS);\
187                 echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\
188                 echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\
189                 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
190                 echo '***';\
191                 exec </dev/tty" | bash -i
192
193 .PHONY: wipe doc
194
195 reset:
196         @rm -f /dev/shm/vpp-unittest-*
197         @rm -rf /tmp/vpp-unittest-*
198         @rm -rf $(FAILED_DIR)
199         @mkdir $(FAILED_DIR)
200
201 wipe: reset
202         @make -C ext clean
203         @rm -rf $(VENV_PATH)
204         @rm -f $(PAPI_INSTALL_FLAGS)
205
206 doc: verify-test-dir $(PIP_PATCH_DONE)
207         @virtualenv $(VENV_PATH) -p $(PYTHON_INTERP)
208         @bash -c "source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) -m pip install sphinx sphinx-rtd-theme"
209         @bash -c "source $(VENV_PATH)/bin/activate && make -C doc WS_ROOT=$(WS_ROOT) BR=$(BR) NO_VPP_PAPI=1 html"
210
211 .PHONY: wipe-doc
212
213 wipe-doc:
214         @make -C doc wipe BR=$(BR)
215
216 cov: wipe-cov reset ext verify-test-dir $(PAPI_INSTALL_DONE)
217         @lcov --zerocounters --directory $(_BUILD_DIR)
218         @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
219         $(call retest-func)
220         @mkdir $(BUILD_COV_DIR)
221         @lcov --capture --directory $(_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
222         @test -z "$(EXTERN_COV_DIR)" || lcov --capture --directory $(EXTERN_COV_DIR) --output-file $(BUILD_COV_DIR)/extern-coverage.info
223         @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
224         @test -z "$(EXTERN_COV_DIR)" || genhtml $(BUILD_COV_DIR)/extern-coverage.info --output-directory $(BUILD_COV_DIR)/extern-html
225         @echo
226         @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
227         @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
228
229 .PHONY: wipe-cov
230
231 wipe-cov: wipe
232         @rm -rf $(BUILD_COV_DIR)
233
234 .PHONY: checkstyle
235 checkstyle: verify-test-dir
236         @virtualenv $(VENV_PATH) -p $(PYTHON_INTERP)
237         @bash -c "source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) -m pip install pycodestyle"
238         @bash -c "source $(VENV_PATH)/bin/activate &&\
239                 pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 -v $(WS_ROOT)/test/*.py ||\
240                 (echo \"*******************************************************************\" &&\
241                  echo \"* Test framework PEP8 compliance check FAILED \" &&\
242                  echo \"*******************************************************************\" &&\
243                  false)"
244         @echo "*******************************************************************"
245         @echo "* Test framework PEP8 compliance check passed"
246         @echo "*******************************************************************"
247
248 help:
249         @echo "Running tests:"
250         @echo ""
251         @echo " test                - build and run (basic) functional tests"
252         @echo " test-debug          - build and run (basic) functional tests (debug build)"
253         @echo " test-all            - build and run (all) functional tests"
254         @echo " test-all-debug      - build and run (all) functional tests (debug build)"
255         @echo " retest              - run functional tests"
256         @echo " retest-debug        - run functional tests (debug build)"
257         @echo " test-wipe           - wipe (temporary) files generated by unit tests"
258         @echo " test-shell          - enter shell with test environment"
259         @echo " test-shell-debug    - enter shell with test environment (debug build)"
260         @echo ""
261         @echo "Arguments controlling test runs:"
262         @echo " V=[0|1|2]            - set test verbosity level"
263         @echo " TEST_JOBS=[<n>|auto] - use <n> parallel processes for test execution or automatic discovery of maximum acceptable processes (default: 1)"
264         @echo " CACHE_OUTPUT=[0|1]   - cache VPP stdout/stderr and log as one block after test finishes (default: 1)"
265         @echo " FAILFAST=[0|1]       - fail fast if 1, complete all tests if 0"
266         @echo " TIMEOUT=<timeout>    - fail test suite if any single test takes longer than <timeout> (in seconds) to finish (default: 600)"
267         @echo " RETRIES=<n>          - retry failed tests <n> times"
268         @echo " DEBUG=<type>         - set VPP debugging kind"
269         @echo "    DEBUG=core        - detect coredump and load it in gdb on crash"
270         @echo "    DEBUG=gdb         - allow easy debugging by printing VPP PID"
271         @echo "                        and waiting for user input before running"
272         @echo "                        and tearing down a testcase"
273         @echo "    DEBUG=gdbserver   - run gdb inside a gdb server, otherwise"
274         @echo "                        same as above"
275         @echo " STEP=[yes|no]        - ease debugging by stepping through a testcase"
276         @echo " SANITY=[yes|no]      - perform sanity import of vpp-api/sanity vpp run before running tests (default: yes)"
277         @echo " EXTENDED_TESTS=[1|y] - run extended tests"
278         @echo " TEST=<filter>        - filter the set of tests:"
279         @echo "    by file-name      - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py"
280         @echo "    by file-suffix    - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py"
281         @echo "    by wildcard       - wildcard filter is <file>.<class>.<test function>, each can be replaced by '*'"
282         @echo "                        e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name"
283         @echo "                             TEST='bfd.*.*' is equivalent to above example of filter by file-suffix"
284         @echo "                             TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class"
285         @echo "                             TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase"
286         @echo "                             TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes"
287         @echo ""
288         @echo " VPP_ZOMBIE_NOCHECK=1 - skip checking for vpp (zombie) processes (CAUTION)"
289         @echo " COREDUMP_SIZE=<size> - pass <size> as unix { coredump-size <size> } argument to vpp"
290         @echo "                        e.g. COREDUMP_SIZE=4g"
291         @echo "                             COREDUMP_SIZE=unlimited"
292         @echo " EXTERN_TESTS=<path>  - path to out-of-tree test_<name>.py files containing test cases"
293         @echo " EXTERN_PLUGINS=<path>- path to out-of-tree plugins to be loaded by vpp under test"
294         @echo " EXTERN_COV_DIR=<path>- path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report"
295         @echo ""
296         @echo " PROFILE=1            - enable profiling of test framework via cProfile module"
297         @echo " PROFILE_SORT_BY=opt  - sort profiling report by opt - consult cProfile documentation for possible values (default: cumtime)"
298         @echo " PROFILE_OUTPUT=file  - output profiling info to file - use absolute path (default: stdout)"
299         @echo ""
300         @echo " TEST_DEBUG=1         - turn on debugging of the test framework itself (expert)"
301         @echo ""
302         @echo " SKIP_AARCH64=1       - skip tests that are failing on the ARM platorm in FD.io CI"
303         @echo ""
304         @echo "Creating test documentation"
305         @echo " test-doc            - generate documentation for test framework"
306         @echo " test-wipe-doc       - wipe documentation for test framework"
307         @echo ""
308         @echo "Creating test code coverage report"
309         @echo " test-cov            - generate code coverage report for test framework"
310         @echo " test-wipe-cov       - wipe code coverage report for test framework"
311         @echo ""
312         @echo "Verifying code-style"
313         @echo " test-checkstyle     - check PEP8 compliance"
314         @echo ""