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 PYTHON_VENV_PATH=$(VPP_PYTHON_PREFIX)/virtualenv
   9 PYTHON_DEPENDS=scapy==2.3.3 pexpect
  10 SCAPY_SOURCE=$(PYTHON_VENV_PATH)/lib/python2.7/site-packages/
  11 BUILD_COV_DIR = $(BR)/test-cov
  12
  13 PIP_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/pip-install.done
  14 PIP_PATCH_DONE=$(VPP_PYTHON_PREFIX)/pip-patch.done
  15 PAPI_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/papi-install.done
  16
  17 PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE)
  18
  19 $(PIP_INSTALL_DONE):
  20         @virtualenv $(PYTHON_VENV_PATH) -p python2.7
  21         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install $(PYTHON_DEPENDS)"
  22         @touch $@
  23
  24 $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
  25         @echo --- patching ---
  26         @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
  27         for f in $(CURDIR)/patches/scapy-2.3.3/*.patch ; do \
  28                 echo Applying patch: $$(basename $$f) ; \
  29                 patch -p1 -d $(SCAPY_SOURCE) < $$f ; \
  30         done
  31         @touch $@
  32
  33 $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
  34         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && cd $(WS_ROOT)/src/vpp-api/python && python setup.py install"
  35         @touch $@
  36
  37 define retest-func
  38         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python run_tests.py discover -p test_$(TEST)\"*.py\""
  39 endef
  40
  41 test: reset verify-python-path $(PAPI_INSTALL_DONE)
  42         $(call retest-func)
  43
  44 retest: reset verify-python-path
  45         $(call retest-func)
  46
  47 .PHONY: wipe doc
  48
  49 reset:
  50         @rm -f /dev/shm/vpp-unittest-*
  51         @rm -rf /tmp/vpp-unittest-*
  52
  53 wipe: reset
  54         @rm -rf $(PYTHON_VENV_PATH)
  55         @rm -f $(PAPI_INSTALL_FLAGS)
  56
  57 doc: verify-python-path
  58         @virtualenv $(PYTHON_VENV_PATH) -p python2.7
  59         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install $(PYTHON_DEPENDS) sphinx sphinx-rtd-theme"
  60         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && make -C doc WS_ROOT=$(WS_ROOT) BR=$(BR) NO_VPP_PAPI=1 html"
  61
  62 .PHONY: wipe-doc
  63
  64 wipe-doc:
  65         @make -C doc wipe BR=$(BR)
  66
  67 cov: wipe-cov reset verify-python-path $(PAPI_INSTALL_DONE)
  68         @lcov --zerocounters --directory $(VPP_TEST_BUILD_DIR)
  69         $(call retest-func)
  70         @mkdir $(BUILD_COV_DIR)
  71         @lcov --capture --directory $(VPP_TEST_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
  72         @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
  73         @echo
  74         @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
  75
  76 .PHONY: wipe-cov
  77
  78 wipe-cov: wipe
  79         @rm -rf $(BUILD_COV_DIR)
  80
  81 .PHONY: checkstyle
  82 checkstyle: verify-python-path
  83         @virtualenv $(PYTHON_VENV_PATH) -p python2.7
  84         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install $(PYTHON_DEPENDS) pep8"
  85         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate &&\
  86                 pep8 --show-source -v $(WS_ROOT)/test/*.py ||\
  87                 (echo \"*******************************************************************\" &&\
  88                  echo \"* Test framework PEP8 compliance check FAILED \" &&\
  89                  echo \"*******************************************************************\" &&\
  90                  false)"
  91         @echo "*******************************************************************"
  92         @echo "* Test framework PEP8 compliance check passed"
  93         @echo "*******************************************************************"
  94
  95 help:
  96         @echo "Running tests:"
  97         @echo ""
  98         @echo " test                - build and run functional tests"
  99         @echo " test-debug          - build and run functional tests (debug build)"
 100         @echo " retest              - run functional tests"
 101         @echo " retest-debug        - run functional tests (debug build)"
 102         @echo " test-wipe           - wipe (temporary) files generated by unit tests"
 103         @echo ""
 104         @echo "Arguments controlling test runs:"
 105         @echo " V=[0|1|2]            - set test verbosity level"
 106         @echo " DEBUG=<type>         - set VPP debugging kind"
 107         @echo "    DEBUG=core        - detect coredump and load it in gdb on crash"
 108         @echo "    DEBUG=gdb         - allow easy debugging by printing VPP PID "
 109         @echo "                        and waiting for user input before running "
 110         @echo "                        and tearing down a testcase"
 111         @echo "    DEBUG=gdbserver   - run gdb inside a gdb server, otherwise "
 112         @echo "                        same as above"
 113         @echo " STEP=[yes|no]        - ease debugging by stepping through a testcase "
 114         @echo " TEST=<name>          - only run specific test"
 115         @echo ""
 116         @echo "Creating test documentation"
 117         @echo " test-doc            - generate documentation for test framework"
 118         @echo " test-wipe-doc       - wipe documentation for test framework"
 119         @echo ""
 120         @echo "Creating test code coverage report"
 121         @echo " test-cov            - generate code coverage report for test framework"
 122         @echo " test-wipe-cov       - wipe code coverage report for test framework"
 123         @echo ""
 124         @echo "Verifying code-style"
 125         @echo " test-checkstyle     - check PEP8 compliance"
 126         @echo ""