test/Makefile

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