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