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