-.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
-VPP_TEST_FAILED_DIR=/tmp/vpp-failed-unittests/
-
-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
-
-.PHONY: verify-no-running-vpp
-
-ifdef VPP_ZOMBIE_NOCHECK
-VPP_PIDS=
-else
-VPP_PIDS=$(shell pgrep -d, -x vpp_main)
+ifndef BR
+ $(error BR is not set)
+endif
+ifndef TEST_DIR
+ $(error TEST_DIR is not set)
endif
+export TEST_BR = $(TEST_DIR)
+FAILED_DIR=/tmp/vpp-failed-unittests/
+VPP_TEST_DIRS=$(shell ls -d $(TEST_DIR) $(EXTERN_TESTS))
+
+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)
+FORCE_FOREGROUND=1
+else ifeq ($(STEP),1)
+FORCE_FOREGROUND=1
else
FORCE_FOREGROUND=0
endif
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=
UNITTEST_EXTRA_OPTS=$(UNITTEST_FAILFAST_OPTS) -d $(EXTERN_TESTS)
endif
+VENV_PATH=$(TEST_DIR)/venv
+
ifeq ($(TEST_DEBUG),1)
-VPP_PYTHON_PREFIX:=$(VPP_PYTHON_PREFIX)/debug
-PYTHON_EXTRA_DEPENDS=objgraph pympler
+VENV_RUN_DIR:=$(VENV_PATH)/run-debug
else
-PYTHON_EXTRA_DEPENDS=
+VENV_RUN_DIR:=$(VENV_PATH)/run
endif
-PYTHON_VENV_PATH=$(VPP_PYTHON_PREFIX)/virtualenv
-PYTHON_DEPENDS=$(PYTHON_EXTRA_DEPENDS) psutil faulthandler six scapy==2.4.0 pexpect cryptography subprocess32 cffi git+https://github.com/vpp-dev/py-lispnetworking
-SCAPY_SOURCE=$(shell find $(PYTHON_VENV_PATH) -name site-packages)
-BUILD_COV_DIR=$(BR)/test-cov
-
-GET_PIP_SCRIPT=$(VPP_PYTHON_PREFIX)/get-pip.py
-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
-
-PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE)
-
ifeq ($(PYTHON),)
-PYTHON_INTERP=python2.7
+PYTHON_INTERP=python3
else
PYTHON_INTERP=$(PYTHON)
endif
-$(GET_PIP_SCRIPT):
- @mkdir -p $(VPP_PYTHON_PREFIX)
- @bash -c "cd $(VPP_PYTHON_PREFIX) && curl -O https://bootstrap.pypa.io/get-pip.py"
+PYTHON_VERSION=$(shell $(PYTHON_INTERP) -c 'import sys; print(sys.version_info.major)')
+PIP_VERSION=21.3.1
+# Keep in sync with requirements.txt
+PIP_TOOLS_VERSION=6.4.0
+PYTHON_DEPENDS=requirements-$(PYTHON_VERSION).txt
+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 $(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 $@
-$(PIP_INSTALL_DONE): $(GET_PIP_SCRIPT)
- @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
- @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python $(GET_PIP_SCRIPT)"
- @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install $(PYTHON_DEPENDS)"
+$(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): $(PIP_TOOLS_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.4/*.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
-@env FORCE_FOREGROUND=$(FORCE_FOREGROUND) VPP_TEST_FAILED_DIR=$(VPP_TEST_FAILED_DIR) scripts/setsid_wrapper.sh $(FORCE_FOREGROUND) $(PYTHON_VENV_PATH)/bin/activate python $(PYTHON_PROFILE_OPTS) 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
+@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) 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
endef
.PHONY: sanity
SANITY_IMPORT_VPP_PAPI_CMD=true
SANITY_RUN_VPP_CMD=true
else
-SANITY_IMPORT_VPP_PAPI_CMD=source $(PYTHON_VENV_PATH)/bin/activate && python sanity_import_vpp_papi.py
-SANITY_RUN_VPP_CMD=source $(PYTHON_VENV_PATH)/bin/activate && python sanity_run_vpp.py
+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
+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: 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\" &&\
+ echo \"*******************************************************************\" &&\
+ false)"
@bash -c "$(SANITY_IMPORT_VPP_PAPI_CMD) ||\
(echo \"*******************************************************************\" &&\
echo \"* Sanity check failed, cannot import vpp_papi\" &&\
echo \"*******************************************************************\" &&\
false)"
-.PHONY: ext
-ext:
- make -C ext
-
-test-dep: verify-python-path $(PAPI_INSTALL_DONE)
+$(FAILED_DIR): reset
+ @mkdir -p $@
-test: verify-python-path $(PAPI_INSTALL_DONE) sanity reset
- $(call retest-func)
+.PHONY: test-dep
+test-dep: $(PAPI_INSTALL_DONE) $(FAILED_DIR)
-test-ext: verify-python-path $(PAPI_INSTALL_DONE) ext sanity reset
+.PHONY: test
+test: test-dep sanity
$(call retest-func)
-retest: verify-python-path sanity reset
+.PHONY: retest
+retest: verify-env sanity $(FAILED_DIR)
$(call retest-func)
-shell: verify-python-path $(PAPI_INSTALL_DONE)
- @echo "source $(PYTHON_VENV_PATH)/bin/activate;\
+.PHONY: shell
+shell: test-dep
+ @echo "source $(VENV_PATH)/bin/activate;\
+ export RND_SEED=$(RND_SEED);\
echo '***';\
- echo VPP_TEST_BUILD_DIR=$(VPP_TEST_BUILD_DIR);\
- echo VPP_TEST_BIN=$(VPP_TEST_BIN);\
+ 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);\
echo VPP_TEST_PLUGIN_PATH=$(VPP_TEST_PLUGIN_PATH);\
- echo VPP_TEST_INSTALL_PATH=$(VPP_TEST_INSTALL_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 '***';\
exec </dev/tty" | bash -i
-.PHONY: wipe doc
-
+.PHONY: reset
reset:
@rm -f /dev/shm/vpp-unittest-*
- @rm -rf /tmp/vpp-unittest-*
- @rm -rf $(VPP_TEST_FAILED_DIR)
- @mkdir $(VPP_TEST_FAILED_DIR)
+ @if [ $(FORCE_NO_WIPE) -eq "0" ] ; then rm -rf /tmp/vpp-unittest-*; fi
+ @rm -f /tmp/api_post_mortem.*
+ @rm -rf $(FAILED_DIR)
+.PHONY: wipe
wipe: reset
- @make -C ext clean
- @rm -rf $(PYTHON_VENV_PATH)
- @rm -f $(PAPI_INSTALL_FLAGS)
-
-doc: verify-python-path $(PIP_PATCH_DONE)
- @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
- @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install sphinx sphinx-rtd-theme"
- @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && make -C doc WS_ROOT=$(WS_ROOT) BR=$(BR) NO_VPP_PAPI=1 html"
+ @rm -rf $(VENV_PATH)
+ @rm -rf $(patsubst %,%/__pycache__, $(VPP_TEST_DIRS))
-.PHONY: wipe-doc
+$(BUILD_COV_DIR):
+ @mkdir -p $@
-wipe-doc:
- @make -C doc wipe BR=$(BR)
-
-cov: wipe-cov reset ext verify-python-path $(PAPI_INSTALL_DONE)
- @lcov --zerocounters --directory $(VPP_TEST_BUILD_DIR)
+.PHONY: cov
+cov: wipe-cov test-dep ext $(BUILD_COV_DIR)
+ @lcov --zerocounters --directory $(VPP_BUILD_DIR)
@test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
$(call retest-func)
- @mkdir $(BUILD_COV_DIR)
- @lcov --capture --directory $(VPP_TEST_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
+ @lcov --capture --directory $(VPP_BUILD_DIR) --output-file $(BUILD_COV_DIR)/coverage.info
@test -z "$(EXTERN_COV_DIR)" || lcov --capture --directory $(EXTERN_COV_DIR) --output-file $(BUILD_COV_DIR)/extern-coverage.info
@genhtml $(BUILD_COV_DIR)/coverage.info --output-directory $(BUILD_COV_DIR)/html
@test -z "$(EXTERN_COV_DIR)" || genhtml $(BUILD_COV_DIR)/extern-coverage.info --output-directory $(BUILD_COV_DIR)/extern-html
@test -z "$(EXTERN_COV_DIR)" || echo "Code coverage report for out-of-tree objects is in $(BUILD_COV_DIR)/extern-html/index.html"
.PHONY: wipe-cov
-
wipe-cov: wipe
@rm -rf $(BUILD_COV_DIR)
+.PHONY: wipe-papi
+wipe-papi:
+ @rm -rf $(PAPI_INSTALL_DONE) $(PAPI_WIPE_DIST)
+
+.PHONY: wipe-all
+wipe-all: wipe wipe-papi wipe-cov
+ @rm -rf $(TEST_BR)
+
+.PHONY: checkstyle-diff
+checkstyle-diff: $(PIP_INSTALL_DONE)
+ @bash -c "source $(VENV_PATH)/bin/activate &&\
+ $(PYTHON_INTERP) -m pip install pycodestyle"
+ @bash -c "source $(VENV_PATH)/bin/activate &&\
+ cd $(WS_ROOT) && git diff --name-only --no-color --relative HEAD~1 ':!*.patch' | grep '.py$$' | xargs -n 1 -I XXX \
+ pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 -v XXX ||\
+ (echo \"*********************************************************************\" &&\
+ echo \"* Test framework PEP8 compliance check FAILED (checked changed files)\" &&\
+ echo \"*********************************************************************\" &&\
+ false)"
+ @echo "*********************************************************************"
+ @echo "* Test framework PEP8 compliance check passed (checked changed files)"
+ @echo "*********************************************************************"
+
+.PHONY: start-gdb
+start-gdb: sanity
+ $(eval VPP_IN_GDB=1)
+ $(eval FORCE_FOREGROUND=1)
+ $(call retest-func)
+
.PHONY: checkstyle
-checkstyle: verify-python-path
- @virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
- @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install pycodestyle"
- @bash -c "source $(PYTHON_VENV_PATH)/bin/activate &&\
- pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 -v $(WS_ROOT)/test/*.py ||\
+checkstyle: $(PIP_INSTALL_DONE)
+ @bash -c "source $(VENV_PATH)/bin/activate &&\
+ $(PYTHON_INTERP) -m pip install pycodestyle"
+ @bash -c "source $(VENV_PATH)/bin/activate &&\
+ pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 -v *.py ||\
(echo \"*******************************************************************\" &&\
- echo \"* Test framework PEP8 compliance check FAILED \" &&\
+ echo \"* Test framework PEP8 compliance check FAILED (checked all files)\" &&\
echo \"*******************************************************************\" &&\
false)"
@echo "*******************************************************************"
- @echo "* Test framework PEP8 compliance check passed"
+ @echo "* Test framework PEP8 compliance check passed (checked all files)"
@echo "*******************************************************************"
+.PHONY: help
help:
@echo "Running tests:"
@echo ""
- @echo " test - build and run (basic) functional tests"
- @echo " test-debug - build and run (basic) functional tests (debug build)"
- @echo " test-all - build and run (all) functional tests"
- @echo " test-all-debug - build and run (all) functional tests (debug build)"
- @echo " retest - run functional tests"
- @echo " retest-debug - run functional tests (debug build)"
- @echo " test-wipe - wipe (temporary) files generated by unit tests"
- @echo " test-shell - enter shell with test environment"
- @echo " test-shell-debug - enter shell with test environment (debug build)"
+ @echo " test - build and run (basic) functional tests"
+ @echo " test-debug - build and run (basic) functional tests (debug build)"
+ @echo " test-all - build and run functional and extended tests"
+ @echo " test-all-debug - build and run functional and extended tests (debug build)"
+ @echo " retest - run functional tests"
+ @echo " retest-debug - run functional tests (debug build)"
+ @echo " retest-all - run functional and extended tests"
+ @echo " retest-all-debug - run functional and extended tests (debug build)"
+ @echo " test-cov - generate code coverage report for test framework"
+ @echo " test-gcov - build and run functional tests (gcov build)"
+ @echo " test-wipe - wipe (temporary) files generated by unit tests"
+ @echo " test-wipe-cov - wipe code coverage report for test framework"
+ @echo " test-wipe-papi - rebuild vpp_papi sources"
+ @echo " test-wipe-all - wipe (temporary) files generated by unit tests, and coverage"
+ @echo " test-shell - enter shell with test environment"
+ @echo " test-shell-debug - enter shell with test environment (debug build)"
+ @echo " test-checkstyle - check PEP8 compliance for test framework"
+ @echo " test-refresh-deps - refresh the Python dependencies for the tests"
@echo ""
@echo "Arguments controlling test runs:"
- @echo " V=[0|1|2] - set test verbosity level"
- @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=<timeout> - fail test suite if any single test takes longer than <timeout> (in seconds) to finish"
- @echo " RETRIES=<n> - retry failed tests <n> times"
- @echo " DEBUG=<type> - 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> - 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 <file>.<class>.<test function>, 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=[<n>|auto] - use at most <n> parallel python processes for test execution, if auto, set to number of available cpus (default: 1)"
+ @echo " MAX_VPP_CPUS=[<n>|auto]- use at most <n> 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=<timeout> - fail test suite if any single test takes longer than <timeout> (in seconds) to finish (default: 600)"
+ @echo " RETRIES=<n> - retry failed tests <n> times"
+ @echo " DEBUG=<type> - 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> - 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 <file>.<class>.<test function>, 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=<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=<size> - pass <size> as unix { coredump-size <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> - path to out-of-tree test_<name>.py files containing test cases"
+ @echo " EXTERN_PLUGINS=<path> - path to out-of-tree plugins to be loaded by vpp under test"
+ @echo " EXTERN_COV_DIR=<path> - 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 " VPP_ZOMBIE_NOCHECK=1 - skip checking for vpp (zombie) processes (CAUTION)"
- @echo " COREDUMP_SIZE=<size> - pass <size> as unix { coredump-size <size> } argument to vpp"
- @echo " e.g. COREDUMP_SIZE=4g"
- @echo " COREDUMP_SIZE=unlimited"
- @echo " EXTERN_TESTS=<path> - path to out-of-tree test_<name>.py files containing test cases"
- @echo " EXTERN_PLUGINS=<path>- path to out-of-tree plugins to be loaded by vpp under test"
- @echo " EXTERN_COV_DIR=<path>- path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report"
+ @echo " RND_SEED=seed - Seed RND with given seed"
@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 "Starting VPP in GDB for use with DEBUG=attach:"
@echo ""
- @echo " TEST_DEBUG=1 - turn on debugging of the test framework itself (expert)"
+ @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 "Creating test documentation"
- @echo " test-doc - generate documentation for test framework"
- @echo " test-wipe-doc - wipe documentation for test framework"
+ @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 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 ""