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