test/Makefile

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