test/Makefile

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