BenoƮt Ganne | 9fb6d40 | 2019-04-15 15:28:21 +0200 | [diff] [blame] | 1 | ASAN_OPTIONS?=verify_asan_link_order=0:detect_leaks=0:abort_on_error=1:unmap_shadow_on_exit=1:disable_coredump=0 |
| 2 | export ASAN_OPTIONS |
| 3 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 4 | .PHONY: verify-env |
| 5 | verify-env: |
| 6 | ifndef WS_ROOT |
| 7 | $(error WS_ROOT is not set) |
| 8 | endif |
| 9 | ifndef BR |
| 10 | $(error BR is not set) |
| 11 | endif |
Klement Sekera | b8c72a4 | 2018-11-08 11:21:39 +0100 | [diff] [blame] | 12 | ifndef TEST_DIR |
| 13 | $(error TEST_DIR is not set) |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 14 | endif |
| 15 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 16 | export TEST_BR = $(BR)/build-test |
| 17 | export TEST_DOC_BR = $(TEST_BR)/doc |
| 18 | export BUILD_TEST_SRC = $(TEST_BR)/src |
| 19 | FAILED_DIR=/tmp/vpp-failed-unittests/ |
| 20 | PLUGIN_TEST_DIRS=$(shell find $(PLUGIN_SRC_DIR) -type d -name test -exec echo -n " -d {}" \;) |
| 21 | CORE_TEST_DIRS=$(shell find $(WS_ROOT)/src -not \( -path $(INTERN_PLUGIN_SRC_DIR) -prune \) -type d -name test -exec echo -n " -d {}" \;) |
| 22 | VPP_TEST_DIRS=$(shell ls -d $(TEST_DIR)$(PLUGIN_TEST_DIRS)$(CORE_TEST_DIRS) $(EXTERN_TESTS)) |
Dave Wallace | fd24374 | 2021-03-16 22:12:07 -0400 | [diff] [blame] | 23 | VPP_TEST_SRC=$(shell for dir in $(VPP_TEST_DIRS) ; do ls $$dir/*.py 2>/dev/null; done) |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 24 | |
Klement Sekera | b93d142 | 2017-03-02 08:16:20 +0100 | [diff] [blame] | 25 | .PHONY: verify-no-running-vpp |
| 26 | |
| 27 | ifdef VPP_ZOMBIE_NOCHECK |
| 28 | VPP_PIDS= |
| 29 | else |
| 30 | VPP_PIDS=$(shell pgrep -d, -x vpp_main) |
| 31 | endif |
| 32 | |
Klement Sekera | db4e84c | 2017-08-11 10:06:15 +0200 | [diff] [blame] | 33 | ifeq ($(DEBUG),gdb) |
| 34 | FORCE_FOREGROUND=1 |
| 35 | else ifeq ($(DEBUG),gdbserver) |
| 36 | FORCE_FOREGROUND=1 |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 37 | else ifeq ($(DEBUG),gdb-all) |
| 38 | FORCE_FOREGROUND=1 |
| 39 | else ifeq ($(DEBUG),gdbserver-all) |
| 40 | FORCE_FOREGROUND=1 |
Klement Sekera | b90be67 | 2017-10-10 06:44:05 +0200 | [diff] [blame] | 41 | else ifeq ($(DEBUG),core) |
| 42 | FORCE_FOREGROUND=1 |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 43 | else ifeq ($(STEP),yes) |
| 44 | FORCE_FOREGROUND=1 |
| 45 | else ifeq ($(STEP),y) |
| 46 | FORCE_FOREGROUND=1 |
| 47 | else ifeq ($(STEP),1) |
| 48 | FORCE_FOREGROUND=1 |
Klement Sekera | db4e84c | 2017-08-11 10:06:15 +0200 | [diff] [blame] | 49 | else |
| 50 | FORCE_FOREGROUND=0 |
| 51 | endif |
| 52 | |
Klement Sekera | bbfa5fd | 2018-06-27 13:54:32 +0200 | [diff] [blame] | 53 | ifdef PROFILE_OUTPUT |
| 54 | PROFILE_OUTPUT_OPTS=-o $(PROFILE_OUTPUT) |
| 55 | endif |
| 56 | |
| 57 | ifndef PROFILE_SORT_BY |
| 58 | PROFILE_SORT_BY=cumtime |
| 59 | endif |
| 60 | |
| 61 | ifeq ($(PROFILE),1) |
| 62 | PYTHON_PROFILE_OPTS=-m cProfile $(PROFILE_OUTPUT_OPTS) -s $(PROFILE_SORT_BY) |
| 63 | FORCE_FOREGROUND=1 |
| 64 | endif |
| 65 | |
Klement Sekera | b93d142 | 2017-03-02 08:16:20 +0100 | [diff] [blame] | 66 | verify-no-running-vpp: |
| 67 | @if [ "$(VPP_PIDS)" != "" ]; then \ |
| 68 | echo; \ |
| 69 | echo "*** Existing vpp processes detected (PID(s): $(VPP_PIDS)). Running tests under these conditions is not supported. ***"; \ |
| 70 | echo; \ |
| 71 | ps -fp $(VPP_PIDS);\ |
| 72 | echo; \ |
| 73 | false; \ |
| 74 | fi |
| 75 | |
Klement Sekera | 993e0ed | 2017-03-16 09:14:59 +0100 | [diff] [blame] | 76 | UNITTEST_EXTRA_OPTS= |
| 77 | UNITTEST_FAILFAST_OPTS= |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 78 | |
| 79 | ifeq ($(FAILFAST),1) |
Klement Sekera | 993e0ed | 2017-03-16 09:14:59 +0100 | [diff] [blame] | 80 | UNITTEST_EXTRA_OPTS=-f |
| 81 | endif |
| 82 | |
| 83 | ifneq ($(EXTERN_TESTS),) |
| 84 | UNITTEST_EXTRA_OPTS=$(UNITTEST_FAILFAST_OPTS) -d $(EXTERN_TESTS) |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 85 | endif |
| 86 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 87 | VENV_PATH=$(TEST_BR)/venv |
Klement Sekera | b8c72a4 | 2018-11-08 11:21:39 +0100 | [diff] [blame] | 88 | |
Klement Sekera | ebbaf55 | 2018-02-17 13:41:33 +0100 | [diff] [blame] | 89 | ifeq ($(TEST_DEBUG),1) |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 90 | VENV_RUN_DIR:=$(VENV_PATH)/run-debug |
Klement Sekera | ebbaf55 | 2018-02-17 13:41:33 +0100 | [diff] [blame] | 91 | else |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 92 | VENV_RUN_DIR:=$(VENV_PATH)/run |
Klement Sekera | ebbaf55 | 2018-02-17 13:41:33 +0100 | [diff] [blame] | 93 | endif |
| 94 | |
vagrant | 937bf30 | 2017-04-07 01:48:47 +0000 | [diff] [blame] | 95 | ifeq ($(PYTHON),) |
Ole Troan | 6e6ad64 | 2020-02-04 13:28:13 +0100 | [diff] [blame] | 96 | PYTHON_INTERP=python3 |
vagrant | 937bf30 | 2017-04-07 01:48:47 +0000 | [diff] [blame] | 97 | else |
| 98 | PYTHON_INTERP=$(PYTHON) |
| 99 | endif |
| 100 | |
Dave Wallace | fd24374 | 2021-03-16 22:12:07 -0400 | [diff] [blame] | 101 | empty:= |
| 102 | space:= $(empty) $(empty) |
| 103 | export PYTHONPATH=$(subst $(space),:,$(VPP_TEST_DIRS)) |
| 104 | export PYTHONPYCACHEPREFIX=$(TEST_BR)/pycache |
| 105 | |
Aloys Augustin | 28fa8cb | 2019-06-21 17:04:29 +0200 | [diff] [blame] | 106 | PYTHON_VERSION=$(shell $(PYTHON_INTERP) -c 'import sys; print(sys.version_info.major)') |
Aloys Augustin | ef29fa4 | 2020-05-25 18:07:24 +0200 | [diff] [blame] | 107 | PIP_VERSION=20.1.1 |
| 108 | # Keep in sync with requirements.txt |
| 109 | PIP_TOOLS_VERSION=5.1.2 |
Aloys Augustin | 28fa8cb | 2019-06-21 17:04:29 +0200 | [diff] [blame] | 110 | PYTHON_DEPENDS=requirements-$(PYTHON_VERSION).txt |
Ole Troan | 6e6ad64 | 2020-02-04 13:28:13 +0100 | [diff] [blame] | 111 | SCAPY_SOURCE=$(shell find $(VENV_PATH)/lib/python* -name site-packages) |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 112 | BUILD_COV_DIR=$(TEST_BR)/coverage |
Aloys Augustin | 28fa8cb | 2019-06-21 17:04:29 +0200 | [diff] [blame] | 113 | |
Aloys Augustin | ef29fa4 | 2020-05-25 18:07:24 +0200 | [diff] [blame] | 114 | PIP_TOOLS_INSTALL_DONE=$(VENV_RUN_DIR)/pip-tools-install-$(PYTHON_VERSION)-$(PIP_TOOLS_VERSION).done |
| 115 | PIP_INSTALL_DONE=$(VENV_RUN_DIR)/pip-install-$(PYTHON_VERSION)-$(PIP_VERSION).done |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 116 | PIP_PATCH_DONE=$(VENV_RUN_DIR)/pip-patch-$(PYTHON_VERSION).done |
| 117 | PAPI_INSTALL_DONE=$(VENV_RUN_DIR)/papi-install-$(PYTHON_VERSION).done |
| 118 | PAPI_PYTHON_SRC_DIR=$(WS_ROOT)/src/vpp-api/python |
| 119 | PAPI_WIPE_DIST=$(WS_ROOT)/src/vpp-api/vapi/__pycache__ \ |
| 120 | $(PAPI_PYTHON_SRC_DIR)/build \ |
| 121 | $(PAPI_PYTHON_SRC_DIR)/vpp_papi.egg-info \ |
| 122 | $(PAPI_PYTHON_SRC_DIR)/vpp_papi/__pycache__ |
Aloys Augustin | 28fa8cb | 2019-06-21 17:04:29 +0200 | [diff] [blame] | 123 | |
Aloys Augustin | 28fa8cb | 2019-06-21 17:04:29 +0200 | [diff] [blame] | 124 | $(PIP_TOOLS_INSTALL_DONE): |
| 125 | @rm -rf $(VENV_PATH) |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 126 | @mkdir -p $(VENV_RUN_DIR) |
Klement Sekera | 7554aef | 2021-03-30 19:46:06 +0200 | [diff] [blame] | 127 | @$(PYTHON_INTERP) -m venv $(VENV_PATH) |
Aloys Augustin | 8adb92b | 2019-07-23 15:19:28 +0200 | [diff] [blame] | 128 | # pip version pinning |
| 129 | @bash -c "source $(VENV_PATH)/bin/activate && \ |
| 130 | $(PYTHON_INTERP) -m pip install pip===$(PIP_VERSION)" |
Aloys Augustin | 28fa8cb | 2019-06-21 17:04:29 +0200 | [diff] [blame] | 131 | @bash -c "source $(VENV_PATH)/bin/activate && \ |
| 132 | $(PYTHON_INTERP) -m pip install pip-tools===$(PIP_TOOLS_VERSION)" |
| 133 | @touch $@ |
| 134 | |
Aloys Augustin | 8eca60d | 2020-06-24 11:33:20 +0200 | [diff] [blame] | 135 | $(PYTHON_DEPENDS): requirements.txt |
Aloys Augustin | 28fa8cb | 2019-06-21 17:04:29 +0200 | [diff] [blame] | 136 | @bash -c "source $(VENV_PATH)/bin/activate && \ |
| 137 | CUSTOM_COMPILE_COMMAND='make test-refresh-deps (or update requirements.txt)' \ |
| 138 | $(PYTHON_INTERP) -m piptools compile -q --generate-hashes requirements.txt --output-file $@" |
| 139 | |
Aloys Augustin | 8eca60d | 2020-06-24 11:33:20 +0200 | [diff] [blame] | 140 | $(PIP_INSTALL_DONE): $(PIP_TOOLS_INSTALL_DONE) $(PYTHON_DEPENDS) |
Aloys Augustin | 28fa8cb | 2019-06-21 17:04:29 +0200 | [diff] [blame] | 141 | @bash -c "source $(VENV_PATH)/bin/activate && \ |
| 142 | $(PYTHON_INTERP) -m piptools sync $(PYTHON_DEPENDS)" |
Neale Ranns | 177bbdc | 2016-11-15 09:46:51 +0000 | [diff] [blame] | 143 | @touch $@ |
| 144 | |
Klement Sekera | 9f9d07b | 2016-12-12 09:20:50 +0100 | [diff] [blame] | 145 | $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE) |
Neale Ranns | 177bbdc | 2016-11-15 09:46:51 +0000 | [diff] [blame] | 146 | @echo --- patching --- |
Dave Wallace | 6f692d6 | 2017-01-26 21:07:10 -0500 | [diff] [blame] | 147 | @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc |
snaramre | 5d4b891 | 2019-12-13 23:39:35 +0000 | [diff] [blame] | 148 | for f in $(CURDIR)/patches/scapy-2.4.3/*.patch ; do \ |
Neale Ranns | 177bbdc | 2016-11-15 09:46:51 +0000 | [diff] [blame] | 149 | echo Applying patch: $$(basename $$f) ; \ |
Aloys Augustin | 28fa8cb | 2019-06-21 17:04:29 +0200 | [diff] [blame] | 150 | patch --forward -p1 -d $(SCAPY_SOURCE) < $$f ; \ |
| 151 | retCode=$$?; \ |
Aloys Augustin | 8eca60d | 2020-06-24 11:33:20 +0200 | [diff] [blame] | 152 | [ $$retCode -gt 1 ] && exit $$retCode; \ |
Aloys Augustin | 28fa8cb | 2019-06-21 17:04:29 +0200 | [diff] [blame] | 153 | done; \ |
| 154 | touch $@ |
Neale Ranns | 177bbdc | 2016-11-15 09:46:51 +0000 | [diff] [blame] | 155 | |
Klement Sekera | 9f9d07b | 2016-12-12 09:20:50 +0100 | [diff] [blame] | 156 | $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE) |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 157 | @bash -c "source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) -m pip install -e $(PAPI_PYTHON_SRC_DIR)" |
Neale Ranns | 177bbdc | 2016-11-15 09:46:51 +0000 | [diff] [blame] | 158 | @touch $@ |
| 159 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 160 | .PHONY: refresh-deps |
Aloys Augustin | 28fa8cb | 2019-06-21 17:04:29 +0200 | [diff] [blame] | 161 | refresh-deps: clean-deps $(PYTHON_DEPENDS) |
| 162 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 163 | .PHONY: clean-deps |
Aloys Augustin | 28fa8cb | 2019-06-21 17:04:29 +0200 | [diff] [blame] | 164 | clean-deps: |
| 165 | @rm -f $(PYTHON_DEPENDS) |
| 166 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 167 | INTERN_PLUGIN_SRC_DIR=$(WS_ROOT)/src/plugins |
Dave Wallace | a43c93f | 2019-08-22 00:32:29 +0000 | [diff] [blame] | 168 | ifneq ($(EXTERN_PLUGIN_SRC_DIR),) |
| 169 | PLUGIN_SRC_DIR=$(EXTERN_PLUGIN_SRC_DIR) |
| 170 | else |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 171 | PLUGIN_SRC_DIR=$(INTERN_PLUGIN_SRC_DIR) |
Dave Wallace | a43c93f | 2019-08-22 00:32:29 +0000 | [diff] [blame] | 172 | endif |
Dave Wallace | a43c93f | 2019-08-22 00:32:29 +0000 | [diff] [blame] | 173 | |
Juraj Sloboda | 0279b29 | 2016-11-16 19:50:24 +0100 | [diff] [blame] | 174 | define retest-func |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 175 | @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) $(BUILD_TEST_SRC)/run_tests.py -d $(BUILD_TEST_SRC) $(UNITTEST_EXTRA_OPTS) || env FAILED_DIR=$(FAILED_DIR) COMPRESS_FAILED_TEST_LOGS=$(COMPRESS_FAILED_TEST_LOGS) scripts/compress_failed.sh |
Juraj Sloboda | 0279b29 | 2016-11-16 19:50:24 +0100 | [diff] [blame] | 176 | endef |
| 177 | |
Klement Sekera | c160ae0 | 2017-03-09 08:20:13 +0100 | [diff] [blame] | 178 | .PHONY: sanity |
| 179 | |
Klement Sekera | 41a9e51 | 2017-10-17 07:59:31 +0200 | [diff] [blame] | 180 | ifeq ($(SANITY),no) |
| 181 | SANITY_IMPORT_VPP_PAPI_CMD=true |
| 182 | SANITY_RUN_VPP_CMD=true |
| 183 | else |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 184 | SANITY_IMPORT_VPP_PAPI_CMD=source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) $(BUILD_TEST_SRC)/sanity_import_vpp_papi.py |
Dave Wallace | fd24374 | 2021-03-16 22:12:07 -0400 | [diff] [blame] | 185 | SANITY_RUN_VPP_CMD=source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) $(BUILD_TEST_SRC)/sanity_run_vpp.py |
Klement Sekera | 41a9e51 | 2017-10-17 07:59:31 +0200 | [diff] [blame] | 186 | endif |
| 187 | |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 188 | ifndef TEST_JOBS |
| 189 | PARALLEL_ILLEGAL=0 |
| 190 | else ifeq ($(FORCE_FOREGROUND),0) |
| 191 | PARALLEL_ILLEGAL=0 |
| 192 | else ifeq ($(TEST_JOBS),auto) |
| 193 | PARALLEL_ILLEGAL=0 |
| 194 | else ifeq ($(TEST_JOBS),1) |
| 195 | PARALLEL_ILLEGAL=0 |
| 196 | else |
| 197 | PARALLEL_ILLEGAL=1 |
| 198 | endif |
| 199 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 200 | sanity: test-dep verify-no-running-vpp |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 201 | @bash -c "test $(PARALLEL_ILLEGAL) -eq 0 ||\ |
| 202 | (echo \"*******************************************************************\" &&\ |
| 203 | echo \"* Sanity check failed, TEST_JOBS is not 1 or 'auto' and DEBUG, STEP or PROFILE is set\" &&\ |
| 204 | echo \"*******************************************************************\" &&\ |
| 205 | false)" |
Klement Sekera | 41a9e51 | 2017-10-17 07:59:31 +0200 | [diff] [blame] | 206 | @bash -c "$(SANITY_IMPORT_VPP_PAPI_CMD) ||\ |
Klement Sekera | c160ae0 | 2017-03-09 08:20:13 +0100 | [diff] [blame] | 207 | (echo \"*******************************************************************\" &&\ |
| 208 | echo \"* Sanity check failed, cannot import vpp_papi\" &&\ |
| 209 | echo \"* to debug: \" &&\ |
| 210 | echo \"* 1. enter test shell: make test-shell\" &&\ |
| 211 | echo \"* 2. execute debugger: gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\ |
| 212 | echo \"*******************************************************************\" &&\ |
| 213 | false)" |
Klement Sekera | 41a9e51 | 2017-10-17 07:59:31 +0200 | [diff] [blame] | 214 | @bash -c "$(SANITY_RUN_VPP_CMD) ||\ |
Klement Sekera | 3747c75 | 2017-04-10 06:30:17 +0200 | [diff] [blame] | 215 | (echo \"*******************************************************************\" &&\ |
| 216 | echo \"* Sanity check failed, cannot run vpp\" &&\ |
| 217 | echo \"*******************************************************************\" &&\ |
| 218 | false)" |
Klement Sekera | c160ae0 | 2017-03-09 08:20:13 +0100 | [diff] [blame] | 219 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 220 | .PHONY: ext-test-apps |
| 221 | ext-test-apps: |
| 222 | make -C ext test-apps |
Klement Sekera | 8f2a4ea | 2017-05-04 06:15:18 +0200 | [diff] [blame] | 223 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 224 | $(BUILD_TEST_SRC): verify-env |
Dave Wallace | fd24374 | 2021-03-16 22:12:07 -0400 | [diff] [blame] | 225 | @rm -rf $@ |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 226 | @mkdir -p $@ |
Neale Ranns | 02da926 | 2021-01-08 08:43:14 +0000 | [diff] [blame] | 227 | @for file in $(VPP_TEST_SRC); do if [ ! -L $$file ] && [ ! -e $(BUILD_TEST_SRC)/$$(basename $$file) ] ; then ln -s $$file $(BUILD_TEST_SRC) ; fi ; done |
Ed Kern | 56ccc23 | 2018-04-02 16:42:48 -0600 | [diff] [blame] | 228 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 229 | $(FAILED_DIR): reset |
| 230 | @mkdir -p $@ |
| 231 | |
| 232 | .PHONY: test-dep |
| 233 | test-dep: $(BUILD_TEST_SRC) $(PAPI_INSTALL_DONE) $(FAILED_DIR) |
| 234 | |
| 235 | .PHONY: test |
| 236 | test: test-dep ext-test-apps sanity |
Juraj Sloboda | 0279b29 | 2016-11-16 19:50:24 +0100 | [diff] [blame] | 237 | $(call retest-func) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 238 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 239 | .PHONY: retest |
| 240 | retest: verify-env sanity $(FAILED_DIR) |
Juraj Sloboda | 0279b29 | 2016-11-16 19:50:24 +0100 | [diff] [blame] | 241 | $(call retest-func) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 242 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 243 | .PHONY: shell |
| 244 | shell: test-dep |
Klement Sekera | b8c72a4 | 2018-11-08 11:21:39 +0100 | [diff] [blame] | 245 | @echo "source $(VENV_PATH)/bin/activate;\ |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 246 | cd $(BUILD_TEST_SRC);\ |
Dave Wallace | fd24374 | 2021-03-16 22:12:07 -0400 | [diff] [blame] | 247 | export PYTHONPATH=$(PYTHONPATH);\ |
Paul Vinciguerra | c701e57 | 2019-12-19 16:09:43 -0500 | [diff] [blame] | 248 | export RND_SEED=$(RND_SEED);\ |
Klement Sekera | a86e289 | 2017-03-09 08:01:52 +0100 | [diff] [blame] | 249 | echo '***';\ |
Dave Wallace | fd24374 | 2021-03-16 22:12:07 -0400 | [diff] [blame] | 250 | echo PYTHONPATH=$(PYTHONPATH);\ |
Paul Vinciguerra | c701e57 | 2019-12-19 16:09:43 -0500 | [diff] [blame] | 251 | echo RND_SEED=$(RND_SEED);\ |
Klement Sekera | 593635d | 2019-02-07 19:56:50 +0100 | [diff] [blame] | 252 | echo VPP_BUILD_DIR=$(VPP_BUILD_DIR);\ |
| 253 | echo VPP_BIN=$(VPP_BIN);\ |
| 254 | echo VPP_PLUGIN_PATH=$(VPP_PLUGIN_PATH);\ |
Dave Barach | 7d31ab2 | 2019-05-08 19:18:18 -0400 | [diff] [blame] | 255 | echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\ |
Klement Sekera | 593635d | 2019-02-07 19:56:50 +0100 | [diff] [blame] | 256 | echo VPP_INSTALL_PATH=$(VPP_INSTALL_PATH);\ |
Klement Sekera | 47e275b | 2017-03-21 08:21:25 +0100 | [diff] [blame] | 257 | echo EXTERN_TESTS=$(EXTERN_TESTS);\ |
| 258 | echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\ |
Klement Sekera | cd6cb98 | 2017-05-11 06:55:32 +0200 | [diff] [blame] | 259 | echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\ |
Klement Sekera | a86e289 | 2017-03-09 08:01:52 +0100 | [diff] [blame] | 260 | echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\ |
| 261 | echo '***';\ |
| 262 | exec </dev/tty" | bash -i |
| 263 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 264 | .PHONY: reset |
Neale Ranns | 177bbdc | 2016-11-15 09:46:51 +0000 | [diff] [blame] | 265 | reset: |
Klement Sekera | aa7a2a1 | 2021-03-18 15:22:57 +0100 | [diff] [blame] | 266 | @rm -f /dev/shm/vpp-unittest-* |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 267 | @rm -rf /tmp/vpp-unittest-* |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 268 | @rm -f /tmp/api_post_mortem.* |
Klement Sekera | b8c72a4 | 2018-11-08 11:21:39 +0100 | [diff] [blame] | 269 | @rm -rf $(FAILED_DIR) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 270 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 271 | .PHONY: wipe |
Neale Ranns | 177bbdc | 2016-11-15 09:46:51 +0000 | [diff] [blame] | 272 | wipe: reset |
Klement Sekera | a61d125 | 2017-09-27 06:48:44 +0200 | [diff] [blame] | 273 | @make -C ext clean |
Klement Sekera | b8c72a4 | 2018-11-08 11:21:39 +0100 | [diff] [blame] | 274 | @rm -rf $(VENV_PATH) |
Neale Ranns | 02da926 | 2021-01-08 08:43:14 +0000 | [diff] [blame] | 275 | @rm -rf $(patsubst %,%/__pycache__, $(VPP_TEST_DIRS)) |
| 276 | @rm -rf $(BUILD_TEST_SRC) |
Neale Ranns | 177bbdc | 2016-11-15 09:46:51 +0000 | [diff] [blame] | 277 | |
Aloys Augustin | 1f2e146 | 2020-04-07 15:43:33 +0200 | [diff] [blame] | 278 | $(TEST_DOC_BR): $(PIP_INSTALL_DONE) |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 279 | @mkdir -p $@ |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 280 | @bash -c "source $(VENV_PATH)/bin/activate && make -C doc html" |
| 281 | |
| 282 | .PHONY: doc |
| 283 | doc: $(BUILD_TEST_SRC) $(PIP_PATCH_DONE) $(TEST_DOC_BR) |
| 284 | @echo |
| 285 | @echo "Test Documentation URL: $(TEST_DOC_BR)/html/index.html" |
| 286 | @echo "Run 'make test-wipe-doc test-doc' to rebuild the test docs" |
| 287 | @echo |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 288 | |
Klement Sekera | 9f9d07b | 2016-12-12 09:20:50 +0100 | [diff] [blame] | 289 | .PHONY: wipe-doc |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 290 | wipe-doc: |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 291 | @rm -rf $(TEST_DOC_BR) |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 292 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 293 | $(BUILD_COV_DIR): |
| 294 | @mkdir -p $@ |
| 295 | |
| 296 | .PHONY: cov |
| 297 | cov: wipe-cov test-dep ext $(BUILD_COV_DIR) |
Klement Sekera | 593635d | 2019-02-07 19:56:50 +0100 | [diff] [blame] | 298 | @lcov --zerocounters --directory $(VPP_BUILD_DIR) |
Klement Sekera | cd6cb98 | 2017-05-11 06:55:32 +0200 | [diff] [blame] | 299 | @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR) |
Juraj Sloboda | 0279b29 | 2016-11-16 19:50:24 +0100 | [diff] [blame] | 300 | $(call retest-func) |
Klement Sekera | 593635d | 2019-02-07 19:56:50 +0100 | [diff] [blame] | 301 | @lcov --capture --directory $(VPP_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info |
Klement Sekera | cd6cb98 | 2017-05-11 06:55:32 +0200 | [diff] [blame] | 302 | @test -z "$(EXTERN_COV_DIR)" || lcov --capture --directory $(EXTERN_COV_DIR) --output-file $(BUILD_COV_DIR)/extern-coverage.info |
Juraj Sloboda | 0279b29 | 2016-11-16 19:50:24 +0100 | [diff] [blame] | 303 | @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html |
Klement Sekera | cd6cb98 | 2017-05-11 06:55:32 +0200 | [diff] [blame] | 304 | @test -z "$(EXTERN_COV_DIR)" || genhtml $(BUILD_COV_DIR)/extern-coverage.info --output-directory $(BUILD_COV_DIR)/extern-html |
Juraj Sloboda | 0279b29 | 2016-11-16 19:50:24 +0100 | [diff] [blame] | 305 | @echo |
| 306 | @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html" |
Klement Sekera | cd6cb98 | 2017-05-11 06:55:32 +0200 | [diff] [blame] | 307 | @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html" |
Juraj Sloboda | 0279b29 | 2016-11-16 19:50:24 +0100 | [diff] [blame] | 308 | |
Klement Sekera | 9f9d07b | 2016-12-12 09:20:50 +0100 | [diff] [blame] | 309 | .PHONY: wipe-cov |
Juraj Sloboda | 0279b29 | 2016-11-16 19:50:24 +0100 | [diff] [blame] | 310 | wipe-cov: wipe |
| 311 | @rm -rf $(BUILD_COV_DIR) |
| 312 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 313 | .PHONY: wipe-papi |
| 314 | wipe-papi: |
| 315 | @rm -rf $(PAPI_INSTALL_DONE) $(PAPI_WIPE_DIST) |
Paul Vinciguerra | 2648e44 | 2019-07-09 16:49:46 -0400 | [diff] [blame] | 316 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 317 | .PHONY: wipe-all |
| 318 | wipe-all: wipe wipe-papi wipe-doc wipe-cov |
| 319 | @rm -rf $(TEST_BR) |
Paul Vinciguerra | 2648e44 | 2019-07-09 16:49:46 -0400 | [diff] [blame] | 320 | |
Klement Sekera | e0b63b2 | 2021-03-24 23:24:52 +0100 | [diff] [blame] | 321 | .PHONY: checkstyle-diff |
| 322 | checkstyle-diff: $(BUILD_TEST_SRC) $(PIP_INSTALL_DONE) |
| 323 | @bash -c "source $(VENV_PATH)/bin/activate &&\ |
| 324 | $(PYTHON_INTERP) -m pip install pycodestyle" |
| 325 | @bash -c "source $(VENV_PATH)/bin/activate &&\ |
| 326 | cd $(WS_ROOT) && git diff --name-only --no-color --relative HEAD~1 ':!*.patch' | grep '.py$$' | xargs -n 1 -I XXX \ |
| 327 | pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 -v XXX ||\ |
| 328 | (echo \"*********************************************************************\" &&\ |
| 329 | echo \"* Test framework PEP8 compliance check FAILED (checked changed files)\" &&\ |
| 330 | echo \"*********************************************************************\" &&\ |
| 331 | false)" |
| 332 | @echo "*********************************************************************" |
| 333 | @echo "* Test framework PEP8 compliance check passed (checked changed files)" |
| 334 | @echo "*********************************************************************" |
| 335 | |
Klement Sekera | 72715ee | 2017-01-17 10:37:05 +0100 | [diff] [blame] | 336 | .PHONY: checkstyle |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 337 | checkstyle: $(BUILD_TEST_SRC) $(PIP_INSTALL_DONE) |
Ole Troan | 4aacc01 | 2019-10-23 11:47:33 +0200 | [diff] [blame] | 338 | @bash -c "source $(VENV_PATH)/bin/activate &&\ |
| 339 | $(PYTHON_INTERP) -m pip install pycodestyle" |
Klement Sekera | b8c72a4 | 2018-11-08 11:21:39 +0100 | [diff] [blame] | 340 | @bash -c "source $(VENV_PATH)/bin/activate &&\ |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 341 | pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 -v $(BUILD_TEST_SRC)/*.py ||\ |
Klement Sekera | 72715ee | 2017-01-17 10:37:05 +0100 | [diff] [blame] | 342 | (echo \"*******************************************************************\" &&\ |
Klement Sekera | e0b63b2 | 2021-03-24 23:24:52 +0100 | [diff] [blame] | 343 | echo \"* Test framework PEP8 compliance check FAILED (checked all files)\" &&\ |
Klement Sekera | 72715ee | 2017-01-17 10:37:05 +0100 | [diff] [blame] | 344 | echo \"*******************************************************************\" &&\ |
| 345 | false)" |
| 346 | @echo "*******************************************************************" |
Klement Sekera | e0b63b2 | 2021-03-24 23:24:52 +0100 | [diff] [blame] | 347 | @echo "* Test framework PEP8 compliance check passed (checked all files)" |
Klement Sekera | 72715ee | 2017-01-17 10:37:05 +0100 | [diff] [blame] | 348 | @echo "*******************************************************************" |
| 349 | |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 350 | .PHONY: help |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 351 | help: |
| 352 | @echo "Running tests:" |
| 353 | @echo "" |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 354 | @echo " test - build and run (basic) functional tests" |
| 355 | @echo " test-debug - build and run (basic) functional tests (debug build)" |
| 356 | @echo " test-all - build and run functional and extended tests" |
| 357 | @echo " test-all-debug - build and run functional and extended tests (debug build)" |
| 358 | @echo " retest - run functional tests" |
| 359 | @echo " retest-debug - run functional tests (debug build)" |
| 360 | @echo " retest-all - run functional and extended tests" |
| 361 | @echo " retest-all-debug - run functional and extended tests (debug build)" |
| 362 | @echo " test-cov - generate code coverage report for test framework" |
| 363 | @echo " test-gcov - build and run functional tests (gcov build)" |
| 364 | |
| 365 | @echo " test-wipe - wipe (temporary) files generated by unit tests" |
| 366 | @echo " test-wipe-cov - wipe code coverage report for test framework" |
| 367 | @echo " test-wipe-doc - wipe documentation for test framework" |
| 368 | @echo " test-wipe-papi - rebuild vpp_papi sources" |
| 369 | @echo " test-wipe-all - wipe (temporary) files generated by unit tests, docs, and coverage" |
| 370 | @echo " test-shell - enter shell with test environment" |
| 371 | @echo " test-shell-debug - enter shell with test environment (debug build)" |
| 372 | @echo " test-checkstyle - check PEP8 compliance for test framework" |
| 373 | @echo " test-refresh-deps - refresh the Python dependencies for the tests" |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 374 | @echo "" |
| 375 | @echo "Arguments controlling test runs:" |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 376 | @echo " V=[0|1|2] - set test verbosity level" |
| 377 | @echo " 0=ERROR, 1=INFO, 2=DEBUG" |
| 378 | @echo " TEST_JOBS=[<n>|auto] - use <n> parallel processes for test execution or automatic discovery of maximum acceptable processes (default: 1)" |
| 379 | @echo " CACHE_OUTPUT=[0|1] - cache VPP stdout/stderr and log as one block after test finishes (default: 1)" |
| 380 | @echo " FAILFAST=[0|1] - fail fast if 1, complete all tests if 0" |
| 381 | @echo " TIMEOUT=<timeout> - fail test suite if any single test takes longer than <timeout> (in seconds) to finish (default: 600)" |
| 382 | @echo " RETRIES=<n> - retry failed tests <n> times" |
| 383 | @echo " DEBUG=<type> - set VPP debugging kind" |
| 384 | @echo " DEBUG=core - detect coredump and load it in gdb on crash" |
| 385 | @echo " DEBUG=gdb - allow easy debugging by printing VPP PID" |
| 386 | @echo " and waiting for user input before running" |
| 387 | @echo " and tearing down a testcase" |
| 388 | @echo " DEBUG=gdbserver - run gdb inside a gdb server, otherwise" |
| 389 | @echo " same as above" |
| 390 | @echo " STEP=[yes|no] - ease debugging by stepping through a testcase" |
| 391 | @echo " SANITY=[yes|no] - perform sanity import of vpp-api/sanity vpp run before running tests (default: yes)" |
| 392 | @echo " EXTENDED_TESTS=[1|y] - used by '[re]test-all' & '[re]test-all-debug' to run extended tests" |
| 393 | @echo " TEST=<filter> - filter the set of tests:" |
| 394 | @echo " by file-name - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py" |
| 395 | @echo " by file-suffix - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py" |
| 396 | @echo " by wildcard - wildcard filter is <file>.<class>.<test function>, each can be replaced by '*'" |
| 397 | @echo " e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name" |
| 398 | @echo " TEST='bfd.*.*' is equivalent to above example of filter by file-suffix" |
| 399 | @echo " TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class" |
| 400 | @echo " TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase" |
| 401 | @echo " TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes" |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 402 | @echo "" |
Ray Kinsella | 4830e4f | 2020-03-10 14:35:32 +0000 | [diff] [blame] | 403 | @echo " VARIANT=<variant> - specify which march node variant to unit test" |
Ray Kinsella | f9c8fe4 | 2020-08-14 15:27:10 +0100 | [diff] [blame] | 404 | @echo " e.g. VARIANT=skx test the skx march variants" |
| 405 | @echo " e.g. VARIANT=icl test the icl march variants" |
Ray Kinsella | 4830e4f | 2020-03-10 14:35:32 +0000 | [diff] [blame] | 406 | @echo "" |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 407 | @echo " VPP_ZOMBIE_NOCHECK=1 - skip checking for vpp (zombie) processes (CAUTION)" |
| 408 | @echo " COREDUMP_SIZE=<size> - pass <size> as unix { coredump-size <size> } argument to vpp" |
| 409 | @echo " e.g. COREDUMP_SIZE=4g" |
| 410 | @echo " COREDUMP_SIZE=unlimited" |
| 411 | @echo " COREDUMP_COMPRESS=1 - compress core files if not debugging them" |
| 412 | @echo " EXTERN_TESTS=<path> - path to out-of-tree test_<name>.py files containing test cases" |
| 413 | @echo " EXTERN_PLUGINS=<path> - path to out-of-tree plugins to be loaded by vpp under test" |
| 414 | @echo " EXTERN_COV_DIR=<path> - path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report" |
Klement Sekera | b93d142 | 2017-03-02 08:16:20 +0100 | [diff] [blame] | 415 | @echo "" |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 416 | @echo " PROFILE=1 - enable profiling of test framework via cProfile module" |
| 417 | @echo " PROFILE_SORT_BY=opt - sort profiling report by opt - consult cProfile documentation for possible values (default: cumtime)" |
| 418 | @echo " PROFILE_OUTPUT=file - output profiling info to file - use absolute path (default: stdout)" |
Klement Sekera | bbfa5fd | 2018-06-27 13:54:32 +0200 | [diff] [blame] | 419 | @echo "" |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 420 | @echo " TEST_DEBUG=1 - turn on debugging of the test framework itself (expert)" |
Klement Sekera | ebbaf55 | 2018-02-17 13:41:33 +0100 | [diff] [blame] | 421 | @echo "" |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 422 | @echo " SKIP_AARCH64=1 - skip tests that are failing on the ARM platorm in FD.io CI" |
juraj.linkes | 68ebc83 | 2018-11-29 09:37:08 +0100 | [diff] [blame] | 423 | @echo "" |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 424 | @echo " RND_SEED=seed - Seed RND with given seed" |
Klement Sekera | 45a95dd | 2019-11-05 11:18:25 +0000 | [diff] [blame] | 425 | @echo "" |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 426 | @echo "Creating test documentation" |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 427 | @echo " test-doc - generate documentation for test framework" |
| 428 | @echo " test-wipe-doc - wipe documentation for test framework" |
Juraj Sloboda | 0279b29 | 2016-11-16 19:50:24 +0100 | [diff] [blame] | 429 | @echo "" |
| 430 | @echo "Creating test code coverage report" |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 431 | @echo " test-cov - generate code coverage report for test framework" |
| 432 | @echo " test-wipe-cov - wipe code coverage report for test framework" |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 433 | @echo "" |
Klement Sekera | 72715ee | 2017-01-17 10:37:05 +0100 | [diff] [blame] | 434 | @echo "Verifying code-style" |
Dave Wallace | f0797d1 | 2019-11-15 17:29:15 -0500 | [diff] [blame] | 435 | @echo " test-checkstyle - check PEP8 compliance" |
Klement Sekera | 72715ee | 2017-01-17 10:37:05 +0100 | [diff] [blame] | 436 | @echo "" |