X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=test%2FMakefile;h=0ee61a23c0b3c8fd07ce7479a83d2abc10cbd16a;hb=06111a837;hp=e2823ee103e37cf88cc7d071c16956155df6d6f3;hpb=28fa8cbc6c635758db1a885fd5ae2ff8719569c3;p=vpp.git diff --git a/test/Makefile b/test/Makefile index e2823ee103e..0ee61a23c0b 100644 --- a/test/Makefile +++ b/test/Makefile @@ -1,26 +1,41 @@ -.PHONY: verify-test-dir +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 -FAILED_DIR=/tmp/vpp-failed-unittests/ - -verify-test-dir: +.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 -.PHONY: verify-no-running-vpp - -ifdef VPP_ZOMBIE_NOCHECK -VPP_PIDS= -else -VPP_PIDS=$(shell pgrep -d, -x vpp_main) -endif +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 2>/dev/null; done) +FORCE_NO_WIPE=0 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 ($(DEBUG),attach) +FORCE_FOREGROUND=1 +FORCE_NO_WIPE=1 else ifeq ($(STEP),yes) FORCE_FOREGROUND=1 else ifeq ($(STEP),y) @@ -44,16 +59,6 @@ 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= @@ -65,47 +70,60 @@ ifneq ($(EXTERN_TESTS),) UNITTEST_EXTRA_OPTS=$(UNITTEST_FAILFAST_OPTS) -d $(EXTERN_TESTS) endif -VENV_PATH=$(TEST_DIR)/run/venv +VENV_PATH=$(TEST_BR)/venv ifeq ($(TEST_DEBUG),1) -TEST_RUN_DIR:=$(VENV_PATH)/run-debug +VENV_RUN_DIR:=$(VENV_PATH)/run-debug else -TEST_RUN_DIR:=$(VENV_PATH)/run +VENV_RUN_DIR:=$(VENV_PATH)/run endif ifeq ($(PYTHON),) -PYTHON_INTERP=python2.7 +PYTHON_INTERP=python3 else PYTHON_INTERP=$(PYTHON) endif +empty:= +space:= $(empty) $(empty) +export PYTHONPATH=$(subst $(space),:,$(VPP_TEST_DIRS)) +export PYTHONPYCACHEPREFIX=$(TEST_BR)/pycache + PYTHON_VERSION=$(shell $(PYTHON_INTERP) -c 'import sys; print(sys.version_info.major)') -PIP_TOOLS_VERSION=3.8.0 # Keep in sync with requirements.txt +PIP_VERSION=20.1.1 +# Keep in sync with requirements.txt +PIP_TOOLS_VERSION=5.1.2 PYTHON_DEPENDS=requirements-$(PYTHON_VERSION).txt -SCAPY_SOURCE=$(shell find $(VENV_PATH)/lib/$(PYTHON_INTERP) -name site-packages) -BUILD_COV_DIR=$(TEST_DIR)/coverage - -PIP_TOOLS_INSTALL_DONE=$(TEST_RUN_DIR)/pip-tools-install-$(PYTHON_VERSION).done -PIP_INSTALL_DONE=$(TEST_RUN_DIR)/pip-install-$(PYTHON_VERSION).done -PIP_PATCH_DONE=$(TEST_RUN_DIR)/pip-patch-$(PYTHON_VERSION).done -PAPI_INSTALL_DONE=$(TEST_RUN_DIR)/papi-install-$(PYTHON_VERSION).done - -PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE) +SCAPY_SOURCE=$(shell find $(VENV_PATH)/lib/python* -name site-packages) +BUILD_COV_DIR=$(TEST_BR)/coverage + +PIP_TOOLS_INSTALL_DONE=$(VENV_RUN_DIR)/pip-tools-install-$(PYTHON_VERSION)-$(PIP_TOOLS_VERSION).done +PIP_INSTALL_DONE=$(VENV_RUN_DIR)/pip-install-$(PYTHON_VERSION)-$(PIP_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__ $(PIP_TOOLS_INSTALL_DONE): @rm -rf $(VENV_PATH) - @mkdir -p $(TEST_RUN_DIR) - @virtualenv $(VENV_PATH) -p $(PYTHON_INTERP) + @mkdir -p $(VENV_RUN_DIR) + @$(PYTHON_INTERP) -m venv $(VENV_PATH) + # 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 +$(PYTHON_DEPENDS): 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) +$(PIP_INSTALL_DONE): $(PIP_TOOLS_INSTALL_DONE) $(PYTHON_DEPENDS) @bash -c "source $(VENV_PATH)/bin/activate && \ $(PYTHON_INTERP) -m piptools sync $(PYTHON_DEPENDS)" @touch $@ @@ -113,7 +131,7 @@ $(PIP_INSTALL_DONE): $(PYTHON_DEPENDS) $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE) @echo --- patching --- @sleep 1 # Ensure python recompiles patched *.py files -> *.pyc - for f in $(CURDIR)/patches/scapy-2.4/*.patch ; do \ + for f in $(CURDIR)/patches/scapy-2.4.3/*.patch ; do \ echo Applying patch: $$(basename $$f) ; \ patch --forward -p1 -d $(SCAPY_SOURCE) < $$f ; \ retCode=$$?; \ @@ -122,17 +140,25 @@ $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE) touch $@ $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE) - @bash -c "source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) -m pip install -e $(WS_ROOT)/src/vpp-api/python" + @bash -c "source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) -m pip install -e $(PAPI_PYTHON_SRC_DIR)" @touch $@ -.PHONY: update-deps clear-deps +.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 -@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) run_tests.py -d $(TEST_DIR) $(UNITTEST_EXTRA_OPTS) || env FAILED_DIR=$(FAILED_DIR) COMPRESS_FAILED_TEST_LOGS=$(COMPRESS_FAILED_TEST_LOGS) scripts/compress_failed.sh +@env VPP_IN_GDB=$(VPP_IN_GDB) 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 .PHONY: sanity @@ -141,8 +167,8 @@ 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) sanity_import_vpp_papi.py -SANITY_RUN_VPP_CMD=source $(VENV_PATH)/bin/activate && $(PYTHON_INTERP) sanity_run_vpp.py +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 && $(PYTHON_INTERP) $(BUILD_TEST_SRC)/sanity_run_vpp.py endif ifndef TEST_JOBS @@ -157,8 +183,7 @@ else PARALLEL_ILLEGAL=1 endif -sanity: verify-no-running-vpp - @sys_req/dev_shm_size.sh +sanity: test-dep @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\" &&\ @@ -178,23 +203,38 @@ sanity: verify-no-running-vpp echo \"*******************************************************************\" &&\ false)" -.PHONY: ext -ext: - @if [ "$(EXTENDED_TESTS)" = "yes" ]; then\ - make -C ext;\ - fi +.PHONY: ext-test-apps +ext-test-apps: + make -C ext test-apps + +$(BUILD_TEST_SRC): verify-env + @rm -rf $@ + @mkdir -p $@ + @for file in $(VPP_TEST_SRC); do if [ ! -L $$file ] && [ ! -e $(BUILD_TEST_SRC)/$$(basename $$file) ] ; then ln -s $$file $(BUILD_TEST_SRC) ; fi ; done + +$(FAILED_DIR): reset + @mkdir -p $@ -test-dep: verify-test-dir $(PAPI_INSTALL_DONE) +.PHONY: test-dep +test-dep: $(BUILD_TEST_SRC) $(PAPI_INSTALL_DONE) $(FAILED_DIR) -test: verify-test-dir $(PAPI_INSTALL_DONE) ext sanity reset +.PHONY: test +test: test-dep ext-test-apps sanity $(call retest-func) -retest: verify-test-dir sanity reset +.PHONY: retest +retest: verify-env sanity $(FAILED_DIR) $(call retest-func) -shell: verify-test-dir $(PAPI_INSTALL_DONE) +.PHONY: shell +shell: test-dep @echo "source $(VENV_PATH)/bin/activate;\ + cd $(BUILD_TEST_SRC);\ + export PYTHONPATH=$(PYTHONPATH);\ + export RND_SEED=$(RND_SEED);\ echo '***';\ + echo PYTHONPATH=$(PYTHONPATH);\ + echo RND_SEED=$(RND_SEED);\ echo VPP_BUILD_DIR=$(VPP_BUILD_DIR);\ echo VPP_BIN=$(VPP_BIN);\ echo VPP_PLUGIN_PATH=$(VPP_PLUGIN_PATH);\ @@ -207,34 +247,43 @@ shell: verify-test-dir $(PAPI_INSTALL_DONE) echo '***';\ exec |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] - 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 " V=[0|1|2] - set test verbosity level" + @echo " 0=ERROR, 1=INFO, 2=DEBUG" + @echo " TEST_JOBS=[|auto] - use at most parallel python processes for test execution, if auto, set to number of available cpus (default: 1)" + @echo " MAX_VPP_CPUS=[|auto]- use at most cpus for running vpp main and worker threads, if auto, set to number of available cpus (default: auto)" + @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 " DEBUG=attach - attach test case to already running vpp in gdb (see test-start-vpp-in-gdb)" + @echo "" + @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 " VARIANT= - specify which march node variant to unit test" + @echo " e.g. VARIANT=skx test the skx march variants" + @echo " e.g. VARIANT=icl test the icl march variants" + @echo "" + @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 " 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 " SKIP_AARCH64=1 - skip tests that are failing on the ARM platorm in FD.io CI" @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 " RND_SEED=seed - Seed RND with given seed" @echo "" - @echo " TEST_DEBUG=1 - turn on debugging of the test framework itself (expert)" + @echo "Starting VPP in GDB for use with DEBUG=attach:" @echo "" - @echo " SKIP_AARCH64=1 - skip tests that are failing on the ARM platorm in FD.io CI" + @echo " test-start-vpp-in-gdb - start VPP in gdb (release)" + @echo " test-start-vpp-debug-in-gdb - start VPP in gdb (debug)" @echo "" - @echo " SOCKET=1 - Communicate with VPP over Unix domain socket instead of SHM" + @echo "Arguments controlling VPP in GDB runs:" + @echo " " + @echo " VPP_IN_GDB_TMP_DIR - specify directory to run VPP IN (default: /tmp/unittest-attach-gdb)" + @echo " VPP_IN_GDB_NO_RMDIR=0 - don't remove existing tmp dir but fail instead" + @echo " VPP_IN_GDB_CMDLINE=1 - add 'interactive' to VPP arguments to run with command line" @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 ""