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