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 ifeq ($(DEBUG),core)
  23 FORCE_FOREGROUND=1
  24 else
  25 FORCE_FOREGROUND=0
  26 endif
  27
  28 verify-no-running-vpp:
  29         @if [ "$(VPP_PIDS)" != "" ]; then \
  30                 echo; \
  31                 echo "*** Existing vpp processes detected (PID(s): $(VPP_PIDS)). Running tests under these conditions is not supported. ***"; \
  32                 echo; \
  33                 ps -fp $(VPP_PIDS);\
  34                 echo; \
  35                 false; \
  36         fi
  37
  38 UNITTEST_EXTRA_OPTS=
  39 UNITTEST_FAILFAST_OPTS=
  40
  41 ifeq ($(FAILFAST),1)
  42 UNITTEST_EXTRA_OPTS=-f
  43 endif
  44
  45 ifneq ($(EXTERN_TESTS),)
  46 UNITTEST_EXTRA_OPTS=$(UNITTEST_FAILFAST_OPTS) -d $(EXTERN_TESTS)
  47 endif
  48
  49 ifeq ($(TEST_DEBUG),1)
  50 VPP_PYTHON_PREFIX:=$(VPP_PYTHON_PREFIX)/debug
  51 PYTHON_EXTRA_DEPENDS=objgraph pympler
  52 else
  53 PYTHON_EXTRA_DEPENDS=
  54 endif
  55
  56 PYTHON_VENV_PATH=$(VPP_PYTHON_PREFIX)/virtualenv
  57 PYTHON_DEPENDS=$(PYTHON_EXTRA_DEPENDS) faulthandler six scapy==2.4.0rc5 pexpect cryptography subprocess32 cffi git+https://github.com/vpp-dev/py-lispnetworking
  58 SCAPY_SOURCE=$(shell find $(PYTHON_VENV_PATH) -name site-packages)
  59 BUILD_COV_DIR=$(BR)/test-cov
  60
  61 GET_PIP_SCRIPT=$(VPP_PYTHON_PREFIX)/get-pip.py
  62 PIP_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/pip-install.done
  63 PIP_PATCH_DONE=$(VPP_PYTHON_PREFIX)/pip-patch.done
  64 PAPI_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/papi-install.done
  65
  66 PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE)
  67
  68 ifeq ($(PYTHON),)
  69 PYTHON_INTERP=python2.7
  70 else
  71 PYTHON_INTERP=$(PYTHON)
  72 endif
  73
  74 $(GET_PIP_SCRIPT):
  75         @mkdir -p $(VPP_PYTHON_PREFIX)
  76         @bash -c "cd $(VPP_PYTHON_PREFIX) && curl -O https://bootstrap.pypa.io/get-pip.py"
  77
  78 $(PIP_INSTALL_DONE): $(GET_PIP_SCRIPT)
  79         @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
  80         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python $(GET_PIP_SCRIPT)"
  81         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install $(PYTHON_DEPENDS)"
  82         @touch $@
  83
  84 $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
  85         @echo --- patching ---
  86         @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
  87         for f in $(CURDIR)/patches/scapy-2.4/*.patch ; do \
  88                 echo Applying patch: $$(basename $$f) ; \
  89                 patch -p1 -d $(SCAPY_SOURCE) < $$f ; \
  90         done
  91         @touch $@
  92
  93 $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
  94         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && cd $(WS_ROOT)/src/vpp-api/python && python setup.py install"
  95         @touch $@
  96
  97 define retest-func
  98 @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) || env VPP_TEST_FAILED_DIR=$(VPP_TEST_FAILED_DIR) COMPRESS_FAILED_TEST_LOGS=$(COMPRESS_FAILED_TEST_LOGS) scripts/compress_failed.sh
  99 endef
 100
 101 .PHONY: sanity
 102
 103 ifeq ($(SANITY),no)
 104 SANITY_IMPORT_VPP_PAPI_CMD=true
 105 SANITY_RUN_VPP_CMD=true
 106 else
 107 SANITY_IMPORT_VPP_PAPI_CMD=source $(PYTHON_VENV_PATH)/bin/activate && python sanity_import_vpp_papi.py
 108 SANITY_RUN_VPP_CMD=source $(PYTHON_VENV_PATH)/bin/activate && python sanity_run_vpp.py
 109 endif
 110
 111 sanity: verify-no-running-vpp
 112         @sys_req/dev_shm_size.sh
 113         @bash -c "$(SANITY_IMPORT_VPP_PAPI_CMD) ||\
 114                 (echo \"*******************************************************************\" &&\
 115                  echo \"* Sanity check failed, cannot import vpp_papi\" &&\
 116                  echo \"* to debug: \" &&\
 117                  echo \"* 1. enter test shell:   make test-shell\" &&\
 118                  echo \"* 2. execute debugger:   gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
 119                  echo \"*******************************************************************\" &&\
 120                  false)"
 121         @bash -c "$(SANITY_RUN_VPP_CMD) ||\
 122                 (echo \"*******************************************************************\" &&\
 123                  echo \"* Sanity check failed, cannot run vpp\" &&\
 124                  echo \"*******************************************************************\" &&\
 125                  false)"
 126
 127 .PHONY: ext
 128 ext:
 129         make -C ext
 130
 131 test-dep: verify-python-path $(PAPI_INSTALL_DONE)
 132
 133 test: verify-python-path $(PAPI_INSTALL_DONE) ext sanity reset
 134         $(call retest-func)
 135
 136 retest: verify-python-path sanity reset
 137         $(call retest-func)
 138
 139 shell: verify-python-path $(PAPI_INSTALL_DONE)
 140         @echo "source $(PYTHON_VENV_PATH)/bin/activate;\
 141                 echo '***';\
 142                 echo VPP_TEST_BUILD_DIR=$(VPP_TEST_BUILD_DIR);\
 143                 echo VPP_TEST_BIN=$(VPP_TEST_BIN);\
 144                 echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\
 145                 echo VPP_TEST_INSTALL_PATH=$(VPP_TEST_INSTALL_PATH);\
 146                 echo EXTERN_TESTS=$(EXTERN_TESTS);\
 147                 echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\
 148                 echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\
 149                 echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\
 150                 echo '***';\
 151                 exec </dev/tty" | bash -i
 152
 153 .PHONY: wipe doc
 154
 155 reset:
 156         @rm -f /dev/shm/vpp-unittest-*
 157         @rm -rf /tmp/vpp-unittest-*
 158         @rm -rf $(VPP_TEST_FAILED_DIR)
 159         @mkdir $(VPP_TEST_FAILED_DIR)
 160
 161 wipe: reset
 162         @make -C ext clean
 163         @rm -rf $(PYTHON_VENV_PATH)
 164         @rm -f $(PAPI_INSTALL_FLAGS)
 165
 166 doc: verify-python-path $(PIP_PATCH_DONE)
 167         @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
 168         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install sphinx sphinx-rtd-theme"
 169         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && make -C doc WS_ROOT=$(WS_ROOT) BR=$(BR) NO_VPP_PAPI=1 html"
 170
 171 .PHONY: wipe-doc
 172
 173 wipe-doc:
 174         @make -C doc wipe BR=$(BR)
 175
 176 cov: wipe-cov reset ext verify-python-path $(PAPI_INSTALL_DONE)
 177         @lcov --zerocounters --directory $(VPP_TEST_BUILD_DIR)
 178         @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
 179         $(call retest-func)
 180         @mkdir $(BUILD_COV_DIR)
 181         @lcov --capture --directory $(VPP_TEST_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
 182         @test -z "$(EXTERN_COV_DIR)" || lcov --capture --directory $(EXTERN_COV_DIR) --output-file $(BUILD_COV_DIR)/extern-coverage.info
 183         @genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
 184         @test -z "$(EXTERN_COV_DIR)" || genhtml $(BUILD_COV_DIR)/extern-coverage.info --output-directory $(BUILD_COV_DIR)/extern-html
 185         @echo
 186         @echo "Build finished. Code coverage report is in $(BUILD_COV_DIR)/html/index.html"
 187         @test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
 188
 189 .PHONY: wipe-cov
 190
 191 wipe-cov: wipe
 192         @rm -rf $(BUILD_COV_DIR)
 193
 194 .PHONY: checkstyle
 195 checkstyle: verify-python-path
 196         @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
 197         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install pycodestyle"
 198         @bash -c "source $(PYTHON_VENV_PATH)/bin/activate &&\
 199                 pycodestyle --show-source --ignore=E126,E241,E226,E305,E704,E741,E722 -v $(WS_ROOT)/test/*.py ||\
 200                 (echo \"*******************************************************************\" &&\
 201                  echo \"* Test framework PEP8 compliance check FAILED \" &&\
 202                  echo \"*******************************************************************\" &&\
 203                  false)"
 204         @echo "*******************************************************************"
 205         @echo "* Test framework PEP8 compliance check passed"
 206         @echo "*******************************************************************"
 207
 208 help:
 209         @echo "Running tests:"
 210         @echo ""
 211         @echo " test                - build and run (basic) functional tests"
 212         @echo " test-debug          - build and run (basic) functional tests (debug build)"
 213         @echo " test-all            - build and run (all) functional tests"
 214         @echo " test-all-debug      - build and run (all) functional tests (debug build)"
 215         @echo " retest              - run functional tests"
 216         @echo " retest-debug        - run functional tests (debug build)"
 217         @echo " test-wipe           - wipe (temporary) files generated by unit tests"
 218         @echo " test-shell          - enter shell with test environment"
 219         @echo " test-shell-debug    - enter shell with test environment (debug build)"
 220         @echo ""
 221         @echo "Arguments controlling test runs:"
 222         @echo " V=[0|1|2]            - set test verbosity level"
 223         @echo " CACHE_OUTPUT=[0|1]   - cache VPP stdout/stderr and log as one block after test finishes (default: 1)"
 224         @echo " FAILFAST=[0|1]       - fail fast if 1, complete all tests if 0"
 225         @echo " TIMEOUT=<timeout>    - fail test suite if any single test takes longer than <timeout> (in seconds) to finish"
 226         @echo " RETRIES=<n>          - retry failed tests <n> times"
 227         @echo " DEBUG=<type>         - set VPP debugging kind"
 228         @echo "    DEBUG=core        - detect coredump and load it in gdb on crash"
 229         @echo "    DEBUG=gdb         - allow easy debugging by printing VPP PID "
 230         @echo "                        and waiting for user input before running "
 231         @echo "                        and tearing down a testcase"
 232         @echo "    DEBUG=gdbserver   - run gdb inside a gdb server, otherwise "
 233         @echo "                        same as above"
 234         @echo " STEP=[yes|no]        - ease debugging by stepping through a testcase "
 235         @echo " SANITY=[yes|no]      - perform sanity import of vpp-api/sanity vpp run before running tests (default: yes)"
 236         @echo " EXTENDED_TESTS=[1|y] - run extended tests"
 237         @echo " TEST=<filter>        - filter the set of tests:"
 238         @echo "    by file-name      - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py"
 239         @echo "    by file-suffix    - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py"
 240         @echo "    by wildcard       - wildcard filter is <file>.<class>.<test function>, each can be replaced by '*'"
 241         @echo "                        e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name"
 242         @echo "                             TEST='bfd.*.*' is equivalent to above example of filter by file-suffix"
 243         @echo "                             TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class"
 244         @echo "                             TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase"
 245         @echo "                             TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes"
 246         @echo ""
 247         @echo " VPP_ZOMBIE_NOCHECK=1 - skip checking for vpp (zombie) processes (CAUTION)"
 248         @echo " COREDUMP_SIZE=<size> - pass <size> as unix { coredump-size <size> } argument to vpp"
 249         @echo "                        e.g. COREDUMP_SIZE=4g"
 250         @echo "                             COREDUMP_SIZE=unlimited"
 251         @echo " EXTERN_TESTS=<path>  - path to out-of-tree test_<name>.py files containing test cases"
 252         @echo " EXTERN_PLUGINS=<path>- path to out-of-tree plugins to be loaded by vpp under test"
 253         @echo " EXTERN_COV_DIR=<path>- path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report"
 254         @echo ""
 255         @echo " TEST_DEBUG=1         - turn on debugging of the test framework itself (expert)"
 256         @echo ""
 257         @echo "Creating test documentation"
 258         @echo " test-doc            - generate documentation for test framework"
 259         @echo " test-wipe-doc       - wipe documentation for test framework"
 260         @echo ""
 261         @echo "Creating test code coverage report"
 262         @echo " test-cov            - generate code coverage report for test framework"
 263         @echo " test-wipe-cov       - wipe code coverage report for test framework"
 264         @echo ""
 265         @echo "Verifying code-style"
 266         @echo " test-checkstyle     - check PEP8 compliance"
 267         @echo ""