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