test/Makefile

   1 .PHONY: verify-python-path
   2
   3 verify-python-path:
   4 ifndef VPP_PYTHON_PREFIX
   5         $(error VPP_PYTHON_PREFIX is not set)
   6 endif
   7
   8 .PHONY: verify-no-running-vpp
   9
  10 ifdef VPP_ZOMBIE_NOCHECK
  11 VPP_PIDS=
  12 else
  13 VPP_PIDS=$(shell pgrep -d, -x vpp_main)
  14 endif
  15
  16 verify-no-running-vpp:
  17         @if [ "$(VPP_PIDS)" != "" ]; then \
  18                 echo; \
  19                 echo "*** Existing vpp processes detected (PID(s): $(VPP_PIDS)). Running tests under these conditions is not supported. ***"; \
  20                 echo; \
  21                 ps -fp $(VPP_PIDS);\
  22                 echo; \
  23                 false; \
  24         fi
  25
  26 UNITTEST_EXTRA_OPTS=""
  27
  28 ifeq ($(FAILFAST),1)
  29 UNITTEST_EXTRA_OPTS="-f"
  30 endif
  31
  32 PYTHON_VENV_PATH=$(VPP_PYTHON_PREFIX)/virtualenv
  33 PYTHON_DEPENDS=scapy==2.3.3 pexpect subprocess32 git+https://github.com/klement/py-lispnetworking@setup
  34 SCAPY_SOURCE=$(PYTHON_VENV_PATH)/lib/python2.7/site-packages/
  35 BUILD_COV_DIR = $(BR)/test-cov
  36
  37 PIP_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/pip-install.done
  38 PIP_PATCH_DONE=$(VPP_PYTHON_PREFIX)/pip-patch.done
  39 PAPI_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/papi-install.done
  40
  41 PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE)
  42
  43 $(PIP_INSTALL_DONE):
  44         @virtualenv $(PYTHON_VENV_PATH) -p python2.7
  45         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install $(PYTHON_DEPENDS)"
  46         @touch $@
  47
  48 $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
  49         @echo --- patching ---
  50         @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
  51         for f in $(CURDIR)/patches/scapy-2.3.3/*.patch ; do \
  52                 echo Applying patch: $$(basename $$f) ; \
  53                 patch -p1 -d $(SCAPY_SOURCE) < $$f ; \
  54         done
  55         @touch $@
  56
  57 $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
  58         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && cd $(WS_ROOT)/src/vpp-api/python && python setup.py install"
  59         @touch $@
  60
  61 define retest-func
  62         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python run_tests.py discover $(UNITTEST_EXTRA_OPTS) -p test_\"*.py\""
  63 endef
  64
  65 .PHONY: sanity
  66
  67 sanity: verify-no-running-vpp
  68         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python sanity_import_vpp_papi.py ||\
  69                 (echo \"*******************************************************************\" &&\
  70                  echo \"* Sanity check failed, cannot import vpp_papi\" &&\
  71                  echo \"* to debug: \" &&\
  72                  echo \"* 1. enter test shell:   make test-shell\" &&\
  73                  echo \"* 2. execute debugger:   gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
  74                  echo \"*******************************************************************\" &&\
  75                  false)"
  76
  77 test: verify-python-path $(PAPI_INSTALL_DONE) sanity reset
  78         $(call retest-func)
  79
  80 retest: verify-python-path sanity reset
  81         $(call retest-func)
  82
  83 shell: verify-python-path $(PAPI_INSTALL_DONE)
  84         @echo "source $(PYTHON_VENV_PATH)/bin/activate;\
  85                 echo '***';\
  86                 echo VPP_TEST_BUILD_DIR=$(VPP_TEST_BUILD_DIR);\
  87                 echo VPP_TEST_BIN=$(VPP_TEST_BIN);\
  88                 echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\
  89                 echo VPP_TEST_INSTALL_PATH=$(VPP_TEST_INSTALL_PATH);\
  90                 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
  91                 echo '***';\
  92                 exec </dev/tty" | bash -i
  93
  94 .PHONY: wipe doc
  95
  96 reset:
  97         @rm -f /dev/shm/vpp-unittest-*
  98         @rm -rf /tmp/vpp-unittest-*
  99
 100 wipe: reset
 101         @rm -rf $(PYTHON_VENV_PATH)
 102         @rm -f $(PAPI_INSTALL_FLAGS)
 103
 104 doc: verify-python-path $(PIP_PATCH_DONE)
 105         @virtualenv $(PYTHON_VENV_PATH) -p python2.7
 106         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install sphinx sphinx-rtd-theme"
 107         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && make -C doc WS_ROOT=$(WS_ROOT) BR=$(BR) NO_VPP_PAPI=1 html"
 108
 109 .PHONY: wipe-doc
 110
 111 wipe-doc:
 112         @make -C doc wipe BR=$(BR)
 113
 114 cov: wipe-cov reset verify-python-path $(PAPI_INSTALL_DONE)
 115         @lcov --zerocounters --directory $(VPP_TEST_BUILD_DIR)
 116         $(call retest-func)
 117         @mkdir $(BUILD_COV_DIR)
 118         @lcov --capture --directory $(VPP_TEST_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
 119         @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
 120         @echo
 121         @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
 122
 123 .PHONY: wipe-cov
 124
 125 wipe-cov: wipe
 126         @rm -rf $(BUILD_COV_DIR)
 127
 128 .PHONY: checkstyle
 129 checkstyle: verify-python-path
 130         @virtualenv $(PYTHON_VENV_PATH) -p python2.7
 131         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install pep8"
 132         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate &&\
 133                 pep8 --show-source -v $(WS_ROOT)/test/*.py ||\
 134                 (echo \"*******************************************************************\" &&\
 135                  echo \"* Test framework PEP8 compliance check FAILED \" &&\
 136                  echo \"*******************************************************************\" &&\
 137                  false)"
 138         @echo "*******************************************************************"
 139         @echo "* Test framework PEP8 compliance check passed"
 140         @echo "*******************************************************************"
 141
 142 help:
 143         @echo "Running tests:"
 144         @echo ""
 145         @echo " test                - build and run (basic) functional tests"
 146         @echo " test-debug          - build and run (basic) functional tests (debug build)"
 147         @echo " test-all            - build and run (all) functional tests"
 148         @echo " test-all-debug      - build and run (all) functional tests (debug build)"
 149         @echo " retest              - run functional tests"
 150         @echo " retest-debug        - run functional tests (debug build)"
 151         @echo " test-wipe           - wipe (temporary) files generated by unit tests"
 152         @echo " test-shell          - enter shell with test environment"
 153         @echo " test-shell-debug    - enter shell with test environment (debug build)"
 154         @echo ""
 155         @echo "Arguments controlling test runs:"
 156         @echo " V=[0|1|2]            - set test verbosity level"
 157         @echo " FAILFAST=[0|1]       - fail fast if 1, complete all tests if 0"
 158         @echo " DEBUG=<type>         - set VPP debugging kind"
 159         @echo "    DEBUG=core        - detect coredump and load it in gdb on crash"
 160         @echo "    DEBUG=gdb         - allow easy debugging by printing VPP PID "
 161         @echo "                        and waiting for user input before running "
 162         @echo "                        and tearing down a testcase"
 163         @echo "    DEBUG=gdbserver   - run gdb inside a gdb server, otherwise "
 164         @echo "                        same as above"
 165         @echo " STEP=[yes|no]        - ease debugging by stepping through a testcase "
 166         @echo " TEST=<filter>        - filter the set of tests:"
 167         @echo "    by file-name      - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py"
 168         @echo "    by file-suffix    - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py"
 169         @echo "    by wildcard       - wildcard filter is <file>.<class>.<test function>, each can be replaced by '*'"
 170         @echo "                        e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name"
 171         @echo "                             TEST='bfd.*.*' is equivalent to above example of filter by file-suffix"
 172         @echo "                             TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class"
 173         @echo "                             TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase"
 174         @echo "                             TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes"
 175         @echo ""
 176         @echo " VPP_ZOMBIE_NOCHECK=1 - skip checking for vpp (zombie) processes (CAUTION)"
 177         @echo " COREDUMP_SIZE=<size> - pass <size> as unix { coredump-size <size> } argument to vpp"
 178         @echo "                        e.g. COREDUMP_SIZE=4g"
 179         @echo "                             COREDUMP_SIZE=unlimited"
 180         @echo ""
 181         @echo "Creating test documentation"
 182         @echo " test-doc            - generate documentation for test framework"
 183         @echo " test-wipe-doc       - wipe documentation for test framework"
 184         @echo ""
 185         @echo "Creating test code coverage report"
 186         @echo " test-cov            - generate code coverage report for test framework"
 187         @echo " test-wipe-cov       - wipe code coverage report for test framework"
 188         @echo ""
 189         @echo "Verifying code-style"
 190         @echo " test-checkstyle     - check PEP8 compliance"
 191         @echo ""