X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=test%2FMakefile;h=facdc6e4c14e819aeb33cb0ee23456ac4093c0ba;hb=5d4b8912d2fe186b4fb920a72b3a2f7b556f4e7d;hp=5c0d48f0f07aae78d1c37705544fede3d20b5211;hpb=104543fa6a836df84b5b6d9b1909df3d5226a1e7;p=vpp.git diff --git a/test/Makefile b/test/Makefile index 5c0d48f0f07..facdc6e4c14 100644 --- a/test/Makefile +++ b/test/Makefile @@ -1,89 +1,324 @@ -.PHONY: verify-python-path +ASAN_OPTIONS?=verify_asan_link_order=0:detect_leaks=0:abort_on_error=1:unmap_shadow_on_exit=1:disable_coredump=0 +export ASAN_OPTIONS -verify-python-path: -ifndef VPP_PYTHON_PREFIX - $(error VPP_PYTHON_PREFIX is not set) +.PHONY: verify-env +verify-env: +ifndef WS_ROOT + $(error WS_ROOT is not set) +endif +ifndef BR + $(error BR is not set) +endif +ifndef TEST_DIR + $(error TEST_DIR is not set) endif -PYTHON_VENV_PATH=$(VPP_PYTHON_PREFIX)/virtualenv -PYTHON_DEPENDS=scapy==2.3.3 pexpect -SCAPY_SOURCE=$(PYTHON_VENV_PATH)/lib/python2.7/site-packages/ -BUILD_COV_DIR = $(BR)/test-cov +export TEST_BR = $(BR)/build-test +export TEST_DOC_BR = $(TEST_BR)/doc +export BUILD_TEST_SRC = $(TEST_BR)/src +FAILED_DIR=/tmp/vpp-failed-unittests/ +PLUGIN_TEST_DIRS=$(shell find $(PLUGIN_SRC_DIR) -type d -name test -exec echo -n " -d {}" \;) +CORE_TEST_DIRS=$(shell find $(WS_ROOT)/src -not \( -path $(INTERN_PLUGIN_SRC_DIR) -prune \) -type d -name test -exec echo -n " -d {}" \;) +VPP_TEST_DIRS=$(shell ls -d $(TEST_DIR)$(PLUGIN_TEST_DIRS)$(CORE_TEST_DIRS) $(EXTERN_TESTS)) +VPP_TEST_SRC=$(shell for dir in $(VPP_TEST_DIRS) ; do ls $$dir/*.py; done) -PIP_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/pip-install.done -PIP_PATCH_DONE=$(VPP_PYTHON_PREFIX)/pip-patch.done -PAPI_INSTALL_DONE=$(VPP_PYTHON_PREFIX)/papi-install.done +.PHONY: verify-no-running-vpp + +ifdef VPP_ZOMBIE_NOCHECK +VPP_PIDS= +else +VPP_PIDS=$(shell pgrep -d, -x vpp_main) +endif + +ifeq ($(DEBUG),gdb) +FORCE_FOREGROUND=1 +else ifeq ($(DEBUG),gdbserver) +FORCE_FOREGROUND=1 +else ifeq ($(DEBUG),gdb-all) +FORCE_FOREGROUND=1 +else ifeq ($(DEBUG),gdbserver-all) +FORCE_FOREGROUND=1 +else ifeq ($(DEBUG),core) +FORCE_FOREGROUND=1 +else ifeq ($(STEP),yes) +FORCE_FOREGROUND=1 +else ifeq ($(STEP),y) +FORCE_FOREGROUND=1 +else ifeq ($(STEP),1) +FORCE_FOREGROUND=1 +else +FORCE_FOREGROUND=0 +endif + +ifdef PROFILE_OUTPUT +PROFILE_OUTPUT_OPTS=-o $(PROFILE_OUTPUT) +endif + +ifndef PROFILE_SORT_BY +PROFILE_SORT_BY=cumtime +endif + +ifeq ($(PROFILE),1) +PYTHON_PROFILE_OPTS=-m cProfile $(PROFILE_OUTPUT_OPTS) -s $(PROFILE_SORT_BY) +FORCE_FOREGROUND=1 +endif + +verify-no-running-vpp: + @if [ "$(VPP_PIDS)" != "" ]; then \ + echo; \ + echo "*** Existing vpp processes detected (PID(s): $(VPP_PIDS)). Running tests under these conditions is not supported. ***"; \ + echo; \ + ps -fp $(VPP_PIDS);\ + echo; \ + false; \ + fi + +UNITTEST_EXTRA_OPTS= +UNITTEST_FAILFAST_OPTS= + +ifeq ($(FAILFAST),1) +UNITTEST_EXTRA_OPTS=-f +endif + +ifneq ($(EXTERN_TESTS),) +UNITTEST_EXTRA_OPTS=$(UNITTEST_FAILFAST_OPTS) -d $(EXTERN_TESTS) +endif + +VENV_PATH=$(TEST_BR)/venv + +ifeq ($(TEST_DEBUG),1) +VENV_RUN_DIR:=$(VENV_PATH)/run-debug +else +VENV_RUN_DIR:=$(VENV_PATH)/run +endif + +ifeq ($(PYTHON),) +PYTHON_INTERP=python3.6 +else +PYTHON_INTERP=$(PYTHON) +endif + +PYTHON_VERSION=$(shell $(PYTHON_INTERP) -c 'import sys; print(sys.version_info.major)') +PIP_VERSION=19.1.1 +PIP_TOOLS_VERSION=3.8.0 # Keep in sync with requirements.txt +PYTHON_DEPENDS=requirements-$(PYTHON_VERSION).txt +SCAPY_SOURCE=$(shell find $(VENV_PATH)/lib/$(PYTHON_INTERP) -name site-packages) +BUILD_COV_DIR=$(TEST_BR)/coverage + +PIP_TOOLS_INSTALL_DONE=$(VENV_RUN_DIR)/pip-tools-install-$(PYTHON_VERSION).done +PIP_INSTALL_DONE=$(VENV_RUN_DIR)/pip-install-$(PYTHON_VERSION).done +PIP_PATCH_DONE=$(VENV_RUN_DIR)/pip-patch-$(PYTHON_VERSION).done +PAPI_INSTALL_DONE=$(VENV_RUN_DIR)/papi-install-$(PYTHON_VERSION).done +PAPI_PYTHON_SRC_DIR=$(WS_ROOT)/src/vpp-api/python +PAPI_WIPE_DIST=$(WS_ROOT)/src/vpp-api/vapi/__pycache__ \ + $(PAPI_PYTHON_SRC_DIR)/build \ + $(PAPI_PYTHON_SRC_DIR)/vpp_papi.egg-info \ + $(PAPI_PYTHON_SRC_DIR)/vpp_papi/__pycache__ PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE) -$(PIP_INSTALL_DONE): - @virtualenv $(PYTHON_VENV_PATH) -p python2.7 - @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install $(PYTHON_DEPENDS)" +$(PIP_TOOLS_INSTALL_DONE): + @rm -rf $(VENV_PATH) + @mkdir -p $(VENV_RUN_DIR) + @virtualenv $(VENV_PATH) -p $(PYTHON_INTERP) + # pip version pinning + @bash -c "source $(VENV_PATH)/bin/activate && \ + $(PYTHON_INTERP) -m pip install pip===$(PIP_VERSION)" + @bash -c "source $(VENV_PATH)/bin/activate && \ + $(PYTHON_INTERP) -m pip install pip-tools===$(PIP_TOOLS_VERSION)" + @touch $@ + +$(PYTHON_DEPENDS): $(PIP_TOOLS_INSTALL_DONE) requirements.txt + @bash -c "source $(VENV_PATH)/bin/activate && \ + CUSTOM_COMPILE_COMMAND='make test-refresh-deps (or update requirements.txt)' \ + $(PYTHON_INTERP) -m piptools compile -q --generate-hashes requirements.txt --output-file $@" + +$(PIP_INSTALL_DONE): $(PYTHON_DEPENDS) + @bash -c "source $(VENV_PATH)/bin/activate && \ + $(PYTHON_INTERP) -m piptools sync $(PYTHON_DEPENDS)" @touch $@ $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE) @echo --- patching --- @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc - for f in $(CURDIR)/patches/scapy-2.3.3/*.patch ; do \ + for f in $(CURDIR)/patches/scapy-2.4.3/*.patch ; do \ echo Applying patch: $$(basename $$f) ; \ - patch -p1 -d $(SCAPY_SOURCE) < $$f ; \ - done - @touch $@ + patch --forward -p1 -d $(SCAPY_SOURCE) < $$f ; \ + retCode=$$?; \ + [ $$retCode -gt 1 ] && exit $$retCode; \ + done; \ + touch $@ $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE) - @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && cd $(WS_ROOT)/src/vpp-api/python && python setup.py install" + @bash -c "source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) -m pip install -e $(PAPI_PYTHON_SRC_DIR)" @touch $@ +.PHONY: refresh-deps +refresh-deps: clean-deps $(PYTHON_DEPENDS) + +.PHONY: clean-deps +clean-deps: + @rm -f $(PYTHON_DEPENDS) + +INTERN_PLUGIN_SRC_DIR=$(WS_ROOT)/src/plugins +ifneq ($(EXTERN_PLUGIN_SRC_DIR),) +PLUGIN_SRC_DIR=$(EXTERN_PLUGIN_SRC_DIR) +else +PLUGIN_SRC_DIR=$(INTERN_PLUGIN_SRC_DIR) +endif + define retest-func - @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python run_tests.py discover -p test_\"*.py\"" +@env FORCE_FOREGROUND=$(FORCE_FOREGROUND) FAILED_DIR=$(FAILED_DIR) VENV_PATH=$(VENV_PATH) scripts/setsid_wrapper.sh $(FORCE_FOREGROUND) $(VENV_PATH)/bin/activate $(PYTHON_INTERP) $(PYTHON_PROFILE_OPTS) $(BUILD_TEST_SRC)/run_tests.py -d $(BUILD_TEST_SRC) $(UNITTEST_EXTRA_OPTS) || env FAILED_DIR=$(FAILED_DIR) COMPRESS_FAILED_TEST_LOGS=$(COMPRESS_FAILED_TEST_LOGS) scripts/compress_failed.sh endef -test: reset verify-python-path $(PAPI_INSTALL_DONE) +.PHONY: sanity + +ifeq ($(SANITY),no) +SANITY_IMPORT_VPP_PAPI_CMD=true +SANITY_RUN_VPP_CMD=true +else +SANITY_IMPORT_VPP_PAPI_CMD=source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) $(BUILD_TEST_SRC)/sanity_import_vpp_papi.py +SANITY_RUN_VPP_CMD=source $(VENV_PATH)/bin/activate && PYTHONPATH=$(BUILD_TEST_SRC) $(PYTHON_INTERP) $(BUILD_TEST_SRC)/sanity_run_vpp.py +endif + +ifndef TEST_JOBS +PARALLEL_ILLEGAL=0 +else ifeq ($(FORCE_FOREGROUND),0) +PARALLEL_ILLEGAL=0 +else ifeq ($(TEST_JOBS),auto) +PARALLEL_ILLEGAL=0 +else ifeq ($(TEST_JOBS),1) +PARALLEL_ILLEGAL=0 +else +PARALLEL_ILLEGAL=1 +endif + +sanity: test-dep verify-no-running-vpp + @sys_req/dev_shm_size.sh + @bash -c "test $(PARALLEL_ILLEGAL) -eq 0 ||\ + (echo \"*******************************************************************\" &&\ + echo \"* Sanity check failed, TEST_JOBS is not 1 or 'auto' and DEBUG, STEP or PROFILE is set\" &&\ + echo \"*******************************************************************\" &&\ + false)" + @bash -c "$(SANITY_IMPORT_VPP_PAPI_CMD) ||\ + (echo \"*******************************************************************\" &&\ + echo \"* Sanity check failed, cannot import vpp_papi\" &&\ + echo \"* to debug: \" &&\ + echo \"* 1. enter test shell: make test-shell\" &&\ + echo \"* 2. execute debugger: gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\ + echo \"*******************************************************************\" &&\ + false)" + @bash -c "$(SANITY_RUN_VPP_CMD) ||\ + (echo \"*******************************************************************\" &&\ + echo \"* Sanity check failed, cannot run vpp\" &&\ + echo \"*******************************************************************\" &&\ + false)" + +.PHONY: ext-test-apps +ext-test-apps: + make -C ext test-apps + +$(BUILD_TEST_SRC): verify-env + @mkdir -p $@ + @for file in $(VPP_TEST_SRC); do if [ ! -e $(BUILD_TEST_SRC)/$$(basename $$file) ] ; then ln -s $$file $(BUILD_TEST_SRC) ; fi ; done + +$(FAILED_DIR): reset + @mkdir -p $@ + +.PHONY: test-dep +test-dep: $(BUILD_TEST_SRC) $(PAPI_INSTALL_DONE) $(FAILED_DIR) + +.PHONY: test +test: test-dep ext-test-apps sanity $(call retest-func) -retest: reset verify-python-path +.PHONY: retest +retest: verify-env sanity $(FAILED_DIR) $(call retest-func) -.PHONY: wipe doc +.PHONY: shell +shell: test-dep + @echo "source $(VENV_PATH)/bin/activate;\ + cd $(BUILD_TEST_SRC);\ + export PYTHONPATH=$(BUILD_TEST_SRC);\ + echo '***';\ + echo PYTHONPATH=$(BUILD_TEST_SRC);\ + echo VPP_BUILD_DIR=$(VPP_BUILD_DIR);\ + echo VPP_BIN=$(VPP_BIN);\ + echo VPP_PLUGIN_PATH=$(VPP_PLUGIN_PATH);\ + echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\ + echo VPP_INSTALL_PATH=$(VPP_INSTALL_PATH);\ + echo EXTERN_TESTS=$(EXTERN_TESTS);\ + echo EXTERN_PLUGINS=$(EXTERN_PLUGINS);\ + echo EXTERN_COV_DIR=$(EXTERN_COV_DIR);\ + echo LD_LIBRARY_PATH=$(LD_LIBRARY_PATH);\ + echo '***';\ + exec - set VPP debugging kind" - @echo " DEBUG=core - detect coredump and load it in gdb on crash" - @echo " DEBUG=gdb - allow easy debugging by printing VPP PID " - @echo " and waiting for user input before running " - @echo " and tearing down a testcase" - @echo " DEBUG=gdbserver - run gdb inside a gdb server, otherwise " - @echo " same as above" - @echo " STEP=[yes|no] - ease debugging by stepping through a testcase " - @echo " TEST= - filter the set of tests:" - @echo " by file-name - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py" - @echo " by file-suffix - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py" - @echo " by wildcard - wildcard filter is .., each can be replaced by '*'" - @echo " e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name" - @echo " TEST='bfd.*.*' is equivalent to above example of filter by file-suffix" - @echo " TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class" - @echo " TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase" - @echo " TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes" + @echo " V=[0|1|2] - set test verbosity level" + @echo " 0=ERROR, 1=INFO, 2=DEBUG" + @echo " TEST_JOBS=[|auto] - use parallel processes for test execution or automatic discovery of maximum acceptable processes (default: 1)" + @echo " CACHE_OUTPUT=[0|1] - cache VPP stdout/stderr and log as one block after test finishes (default: 1)" + @echo " FAILFAST=[0|1] - fail fast if 1, complete all tests if 0" + @echo " TIMEOUT= - fail test suite if any single test takes longer than (in seconds) to finish (default: 600)" + @echo " RETRIES= - retry failed tests times" + @echo " DEBUG= - set VPP debugging kind" + @echo " DEBUG=core - detect coredump and load it in gdb on crash" + @echo " DEBUG=gdb - allow easy debugging by printing VPP PID" + @echo " and waiting for user input before running" + @echo " and tearing down a testcase" + @echo " DEBUG=gdbserver - run gdb inside a gdb server, otherwise" + @echo " same as above" + @echo " STEP=[yes|no] - ease debugging by stepping through a testcase" + @echo " SANITY=[yes|no] - perform sanity import of vpp-api/sanity vpp run before running tests (default: yes)" + @echo " EXTENDED_TESTS=[1|y] - used by '[re]test-all' & '[re]test-all-debug' to run extended tests" + @echo " TEST= - filter the set of tests:" + @echo " by file-name - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py" + @echo " by file-suffix - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py" + @echo " by wildcard - wildcard filter is .., each can be replaced by '*'" + @echo " e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name" + @echo " TEST='bfd.*.*' is equivalent to above example of filter by file-suffix" + @echo " TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class" + @echo " TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase" + @echo " TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes" + @echo "" + @echo " VPP_ZOMBIE_NOCHECK=1 - skip checking for vpp (zombie) processes (CAUTION)" + @echo " COREDUMP_SIZE= - pass as unix { coredump-size } argument to vpp" + @echo " e.g. COREDUMP_SIZE=4g" + @echo " COREDUMP_SIZE=unlimited" + @echo " COREDUMP_COMPRESS=1 - compress core files if not debugging them" + @echo " EXTERN_TESTS= - path to out-of-tree test_.py files containing test cases" + @echo " EXTERN_PLUGINS= - path to out-of-tree plugins to be loaded by vpp under test" + @echo " EXTERN_COV_DIR= - path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report" + @echo "" + @echo " PROFILE=1 - enable profiling of test framework via cProfile module" + @echo " PROFILE_SORT_BY=opt - sort profiling report by opt - consult cProfile documentation for possible values (default: cumtime)" + @echo " PROFILE_OUTPUT=file - output profiling info to file - use absolute path (default: stdout)" + @echo "" + @echo " TEST_DEBUG=1 - turn on debugging of the test framework itself (expert)" + @echo "" + @echo " SKIP_AARCH64=1 - skip tests that are failing on the ARM platorm in FD.io CI" + @echo "" + @echo " SOCKET=1 - Communicate with VPP over Unix domain socket instead of SHM" + @echo "" + @echo " RND_SEED=seed - Seed RND with given seed" @echo "" @echo "Creating test documentation" - @echo " test-doc - generate documentation for test framework" - @echo " test-wipe-doc - wipe documentation for test framework" + @echo " test-doc - generate documentation for test framework" + @echo " test-wipe-doc - wipe documentation for test framework" @echo "" @echo "Creating test code coverage report" - @echo " test-cov - generate code coverage report for test framework" - @echo " test-wipe-cov - wipe code coverage report for test framework" + @echo " test-cov - generate code coverage report for test framework" + @echo " test-wipe-cov - wipe code coverage report for test framework" @echo "" @echo "Verifying code-style" - @echo " test-checkstyle - check PEP8 compliance" + @echo " test-checkstyle - check PEP8 compliance" @echo ""