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 test: verify-python-path verify-no-running-vpp reset $(PAPI_INSTALL_DONE)
  66         $(call retest-func)
  67
  68 retest: verify-python-path verify-no-running-vpp reset
  69         $(call retest-func)
  70
  71 .PHONY: wipe doc
  72
  73 reset:
  74         @rm -f /dev/shm/vpp-unittest-*
  75         @rm -rf /tmp/vpp-unittest-*
  76
  77 wipe: reset
  78         @rm -rf $(PYTHON_VENV_PATH)
  79         @rm -f $(PAPI_INSTALL_FLAGS)
  80
  81 doc: verify-python-path $(PIP_PATCH_DONE)
  82         @virtualenv $(PYTHON_VENV_PATH) -p python2.7
  83         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install sphinx sphinx-rtd-theme"
  84         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && make -C doc WS_ROOT=$(WS_ROOT) BR=$(BR) NO_VPP_PAPI=1 html"
  85
  86 .PHONY: wipe-doc
  87
  88 wipe-doc:
  89         @make -C doc wipe BR=$(BR)
  90
  91 cov: wipe-cov reset verify-python-path $(PAPI_INSTALL_DONE)
  92         @lcov --zerocounters --directory $(VPP_TEST_BUILD_DIR)
  93         $(call retest-func)
  94         @mkdir $(BUILD_COV_DIR)
  95         @lcov --capture --directory $(VPP_TEST_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
  96         @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
  97         @echo
  98         @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
  99
 100 .PHONY: wipe-cov
 101
 102 wipe-cov: wipe
 103         @rm -rf $(BUILD_COV_DIR)
 104
 105 .PHONY: checkstyle
 106 checkstyle: verify-python-path
 107         @virtualenv $(PYTHON_VENV_PATH) -p python2.7
 108         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install pep8"
 109         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate &&\
 110                 pep8 --show-source -v $(WS_ROOT)/test/*.py ||\
 111                 (echo \"*******************************************************************\" &&\
 112                  echo \"* Test framework PEP8 compliance check FAILED \" &&\
 113                  echo \"*******************************************************************\" &&\
 114                  false)"
 115         @echo "*******************************************************************"
 116         @echo "* Test framework PEP8 compliance check passed"
 117         @echo "*******************************************************************"
 118
 119 help:
 120         @echo "Running tests:"
 121         @echo ""
 122         @echo " test                - build and run (basic) functional tests"
 123         @echo " test-debug          - build and run (basic) functional tests (debug build)"
 124         @echo " test-all            - build and run (all) functional tests"
 125         @echo " test-all-debug      - build and run (all) functional tests (debug build)"
 126         @echo " retest              - run functional tests"
 127         @echo " retest-debug        - run functional tests (debug build)"
 128         @echo " test-wipe           - wipe (temporary) files generated by unit tests"
 129         @echo ""
 130         @echo "Arguments controlling test runs:"
 131         @echo " V=[0|1|2]            - set test verbosity level"
 132         @echo " FAILFAST=[0|1]       - fail fast if 1, complete all tests if 0"
 133         @echo " DEBUG=<type>         - set VPP debugging kind"
 134         @echo "    DEBUG=core        - detect coredump and load it in gdb on crash"
 135         @echo "    DEBUG=gdb         - allow easy debugging by printing VPP PID "
 136         @echo "                        and waiting for user input before running "
 137         @echo "                        and tearing down a testcase"
 138         @echo "    DEBUG=gdbserver   - run gdb inside a gdb server, otherwise "
 139         @echo "                        same as above"
 140         @echo " STEP=[yes|no]        - ease debugging by stepping through a testcase "
 141         @echo " TEST=<filter>        - filter the set of tests:"
 142         @echo "    by file-name      - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py"
 143         @echo "    by file-suffix    - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py"
 144         @echo "    by wildcard       - wildcard filter is <file>.<class>.<test function>, each can be replaced by '*'"
 145         @echo "                        e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name"
 146         @echo "                             TEST='bfd.*.*' is equivalent to above example of filter by file-suffix"
 147         @echo "                             TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class"
 148         @echo "                             TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase"
 149         @echo "                             TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes"
 150         @echo ""
 151         @echo " VPP_ZOMBIE_NOCHECK=1 - skip checking for vpp (zombie) processes (CAUTION)"
 152         @echo " COREDUMP_SIZE=<size> - pass <size> as unix { coredump-size <size> } argument to vpp"
 153         @echo "                        e.g. COREDUMP_SIZE=4g"
 154         @echo "                             COREDUMP_SIZE=unlimited"
 155         @echo ""
 156         @echo "Creating test documentation"
 157         @echo " test-doc            - generate documentation for test framework"
 158         @echo " test-wipe-doc       - wipe documentation for test framework"
 159         @echo ""
 160         @echo "Creating test code coverage report"
 161         @echo " test-cov            - generate code coverage report for test framework"
 162         @echo " test-wipe-cov       - wipe code coverage report for test framework"
 163         @echo ""
 164         @echo "Verifying code-style"
 165         @echo " test-checkstyle     - check PEP8 compliance"
 166         @echo ""