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)
  90         @env VPP_TEST_FAILED_DIR=$(VPP_TEST_FAILED_DIR) scripts/compress_failed.sh
  91 endef
  92
  93 .PHONY: sanity
  94
  95 sanity: verify-no-running-vpp
  96         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python sanity_import_vpp_papi.py ||\
  97                 (echo \"*******************************************************************\" &&\
  98                  echo \"* Sanity check failed, cannot import vpp_papi\" &&\
  99                  echo \"* to debug: \" &&\
 100                  echo \"* 1. enter test shell:   make test-shell\" &&\
 101                  echo \"* 2. execute debugger:   gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
 102                  echo \"*******************************************************************\" &&\
 103                  false)"
 104         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python sanity_run_vpp.py ||\
 105                 (echo \"*******************************************************************\" &&\
 106                  echo \"* Sanity check failed, cannot run vpp\" &&\
 107                  echo \"*******************************************************************\" &&\
 108                  false)"
 109
 110 test: verify-python-path $(PAPI_INSTALL_DONE) sanity reset
 111         $(call retest-func)
 112
 113 retest: verify-python-path sanity reset
 114         $(call retest-func)
 115
 116 shell: verify-python-path $(PAPI_INSTALL_DONE)
 117         @echo "source $(PYTHON_VENV_PATH)/bin/activate;\
 118                 echo '***';\
 119                 echo VPP_TEST_BUILD_DIR=$(VPP_TEST_BUILD_DIR);\
 120                 echo VPP_TEST_BIN=$(VPP_TEST_BIN);\
 121                 echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\
 122                 echo VPP_TEST_INSTALL_PATH=$(VPP_TEST_INSTALL_PATH);\
 123                 echo EXTERN_TESTS=$(EXTERN_TESTS);\
 124                 echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\
 125                 echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\
 126                 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
 127                 echo '***';\
 128                 exec </dev/tty" | bash -i
 129
 130 .PHONY: wipe doc
 131
 132 reset:
 133         @rm -f /dev/shm/vpp-unittest-*
 134         @rm -rf /tmp/vpp-unittest-*
 135         @rm -rf $(VPP_TEST_FAILED_DIR)
 136         @mkdir $(VPP_TEST_FAILED_DIR)
 137
 138 wipe: reset
 139         @rm -rf $(PYTHON_VENV_PATH)
 140         @rm -f $(PAPI_INSTALL_FLAGS)
 141
 142 doc: verify-python-path $(PIP_PATCH_DONE)
 143         @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
 144         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install sphinx sphinx-rtd-theme"
 145         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && make -C doc WS_ROOT=$(WS_ROOT) BR=$(BR) NO_VPP_PAPI=1 html"
 146
 147 .PHONY: wipe-doc
 148
 149 wipe-doc:
 150         @make -C doc wipe BR=$(BR)
 151
 152 cov: wipe-cov reset verify-python-path $(PAPI_INSTALL_DONE)
 153         @lcov --zerocounters --directory $(VPP_TEST_BUILD_DIR)
 154         @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
 155         $(call retest-func)
 156         @mkdir $(BUILD_COV_DIR)
 157         @lcov --capture --directory $(VPP_TEST_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
 158         @test -z "$(EXTERN_COV_DIR)" || lcov --capture --directory $(EXTERN_COV_DIR) --output-file $(BUILD_COV_DIR)/extern-coverage.info
 159         @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
 160         @test -z "$(EXTERN_COV_DIR)" || genhtml $(BUILD_COV_DIR)/extern-coverage.info --output-directory $(BUILD_COV_DIR)/extern-html
 161         @echo
 162         @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
 163         @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
 164
 165 .PHONY: wipe-cov
 166
 167 wipe-cov: wipe
 168         @rm -rf $(BUILD_COV_DIR)
 169
 170 .PHONY: checkstyle
 171 checkstyle: verify-python-path
 172         @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
 173         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install pep8"
 174         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate &&\
 175                 pep8 --show-source -v $(WS_ROOT)/test/*.py ||\
 176                 (echo \"*******************************************************************\" &&\
 177                  echo \"* Test framework PEP8 compliance check FAILED \" &&\
 178                  echo \"*******************************************************************\" &&\
 179                  false)"
 180         @echo "*******************************************************************"
 181         @echo "* Test framework PEP8 compliance check passed"
 182         @echo "*******************************************************************"
 183
 184 help:
 185         @echo "Running tests:"
 186         @echo ""
 187         @echo " test                - build and run (basic) functional tests"
 188         @echo " test-debug          - build and run (basic) functional tests (debug build)"
 189         @echo " test-all            - build and run (all) functional tests"
 190         @echo " test-all-debug      - build and run (all) functional tests (debug build)"
 191         @echo " retest              - run functional tests"
 192         @echo " retest-debug        - run functional tests (debug build)"
 193         @echo " test-wipe           - wipe (temporary) files generated by unit tests"
 194         @echo " test-shell          - enter shell with test environment"
 195         @echo " test-shell-debug    - enter shell with test environment (debug build)"
 196         @echo ""
 197         @echo "Arguments controlling test runs:"
 198         @echo " V=[0|1|2]            - set test verbosity level"
 199         @echo " FAILFAST=[0|1]       - fail fast if 1, complete all tests if 0"
 200         @echo " TIMEOUT=<timeout>    - fail test suite if any single test takes longer than <timeout> to finish"
 201         @echo " DEBUG=<type>         - set VPP debugging kind"
 202         @echo "    DEBUG=core        - detect coredump and load it in gdb on crash"
 203         @echo "    DEBUG=gdb         - allow easy debugging by printing VPP PID "
 204         @echo "                        and waiting for user input before running "
 205         @echo "                        and tearing down a testcase"
 206         @echo "    DEBUG=gdbserver   - run gdb inside a gdb server, otherwise "
 207         @echo "                        same as above"
 208         @echo " STEP=[yes|no]        - ease debugging by stepping through a testcase "
 209         @echo " TEST=<filter>        - filter the set of tests:"
 210         @echo "    by file-name      - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py"
 211         @echo "    by file-suffix    - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py"
 212         @echo "    by wildcard       - wildcard filter is <file>.<class>.<test function>, each can be replaced by '*'"
 213         @echo "                        e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name"
 214         @echo "                             TEST='bfd.*.*' is equivalent to above example of filter by file-suffix"
 215         @echo "                             TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class"
 216         @echo "                             TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase"
 217         @echo "                             TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes"
 218         @echo ""
 219         @echo " VPP_ZOMBIE_NOCHECK=1 - skip checking for vpp (zombie) processes (CAUTION)"
 220         @echo " COREDUMP_SIZE=<size> - pass <size> as unix { coredump-size <size> } argument to vpp"
 221         @echo "                        e.g. COREDUMP_SIZE=4g"
 222         @echo "                             COREDUMP_SIZE=unlimited"
 223         @echo " EXTERN_TESTS=<path>  - path to out-of-tree test_<name>.py files containing test cases"
 224         @echo " EXTERN_PLUGINS=<path>- path to out-of-tree plugins to be loaded by vpp under test"
 225         @echo " EXTERN_COV_DIR=<path>- path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report"
 226         @echo ""
 227         @echo "Creating test documentation"
 228         @echo " test-doc            - generate documentation for test framework"
 229         @echo " test-wipe-doc       - wipe documentation for test framework"
 230         @echo ""
 231         @echo "Creating test code coverage report"
 232         @echo " test-cov            - generate code coverage report for test framework"
 233         @echo " test-wipe-cov       - wipe code coverage report for test framework"
 234         @echo ""
 235         @echo "Verifying code-style"
 236         @echo " test-checkstyle     - check PEP8 compliance"
 237         @echo ""