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