/src/vpp_api/.tox
/src/vpp_api/.stestr
-# Build files in the test directory
-/test/*.ok
-/test/ext/.d
-
# vppctl command list
/src/scripts/vppctl-cmd-list
@echo " run-release - run release binary"
@echo " debug - run debug binary with debugger"
@echo " debug-release - run release binary with debugger"
- @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 " test-gcov - build and run functional tests (gcov build)"
- @echo " test-shell - enter shell with test environment"
- @echo " test-shell-debug - enter shell with test environment (debug build)"
- @echo " test-wipe - wipe files generated by unit tests"
- @echo " retest - run functional tests"
- @echo " retest-debug - run functional tests (debug build)"
- @echo " test-all - run functional and extended tests"
- @echo " test-all-debug - run functional and extended tests (debug build)"
+ @echo " test - build and run tests"
@echo " test-help - show help on test framework"
@echo " run-vat - run vpp-api-test tool"
@echo " pkg-deb - build DEB packages"
@echo " docs - Build the Sphinx documentation"
@echo " docs-venv - Build the virtual environment for the Sphinx docs"
@echo " docs-clean - Remove the generated files from the Sphinx docs"
- @echo " test-doc - generate documentation for test framework"
- @echo " test-wipe-doc - wipe documentation 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 " test-wipe-papi - wipe test framework papi test code"
- @echo " test-checkstyle - check PEP8 compliance for test framework"
- @echo " test-refresh-deps - refresh the Python dependencies for the tests"
@echo ""
@echo "Make Arguments:"
@echo " V=[0|1] - set build verbosity level"
test-wipe-cov:
@make -C test wipe-cov
+.PHONY: test-wipe-all
+test-wipe-all:
+ @make -C test wipe-all
+
.PHONY: test-checkstyle
test-checkstyle:
@make -C test checkstyle
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
-.PHONY: verify-test-dir
-
-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
+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)
+
.PHONY: verify-no-running-vpp
ifdef VPP_ZOMBIE_NOCHECK
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),)
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_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
+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_TOOLS_INSTALL_DONE):
@rm -rf $(VENV_PATH)
- @mkdir -p $(TEST_RUN_DIR)
+ @mkdir -p $(VENV_RUN_DIR)
@virtualenv $(VENV_PATH) -p $(PYTHON_INTERP)
# pip version pinning
@bash -c "source $(VENV_PATH)/bin/activate && \
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=$(WS_ROOT)/src/plugins
+PLUGIN_SRC_DIR=$(INTERN_PLUGIN_SRC_DIR)
endif
-PLUGIN_TEST_DIRS=$(shell find $(PLUGIN_SRC_DIR) -type d -name test -exec echo -n " -d {}" \;)
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)$(PLUGIN_TEST_DIRS) $(UNITTEST_EXTRA_OPTS) || env FAILED_DIR=$(FAILED_DIR) COMPRESS_FAILED_TEST_LOGS=$(COMPRESS_FAILED_TEST_LOGS) scripts/compress_failed.sh
+@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
.PHONY: sanity
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 && PYTHONPATH=$(BUILD_TEST_SRC) $(PYTHON_INTERP) $(BUILD_TEST_SRC)/sanity_run_vpp.py
endif
ifndef TEST_JOBS
PARALLEL_ILLEGAL=1
endif
-sanity: verify-no-running-vpp
+sanity: test-dep verify-no-running-vpp
@sys_req/dev_shm_size.sh
@bash -c "test $(PARALLEL_ILLEGAL) -eq 0 ||\
(echo \"*******************************************************************\" &&\
echo \"*******************************************************************\" &&\
false)"
-.PHONY: ext
-ext:
- make -C ext
+.PHONY: ext-test-apps
+ext-test-apps:
+ make -C ext test-apps
-test-dep: verify-test-dir $(PAPI_INSTALL_DONE)
+$(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
-test: verify-test-dir $(PAPI_INSTALL_DONE) ext sanity reset
+$(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: 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=$(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 '***';\
exec </dev/tty" | bash -i
-.PHONY: wipe doc
-
+.PHONY: reset
reset:
@rm -f /dev/shm/vpp-unittest-*
@rm -rf /tmp/vpp-unittest-*
+ @rm -f /tmp/api_post_mortem.*
@rm -rf $(FAILED_DIR)
- @mkdir $(FAILED_DIR)
+.PHONY: wipe
wipe: reset
@make -C ext clean
@rm -rf $(VENV_PATH)
- @rm -f $(PAPI_INSTALL_FLAGS)
+ @rm -rf $(patsubst %,%/__pycache__, $(VPP_TEST_DIRS) $(BUILD_TEST_SRC))
-doc: verify-test-dir $(PIP_PATCH_DONE)
+$(TEST_DOC_BR):
+ @mkdir -p $@
@bash -c "source $(VENV_PATH)/bin/activate && \
$(PYTHON_INTERP) -m pip install sphinx sphinx-rtd-theme"
- @bash -c "source $(VENV_PATH)/bin/activate && make -C doc WS_ROOT=$(WS_ROOT) BR=$(BR) html"
+ @bash -c "source $(VENV_PATH)/bin/activate && make -C doc html"
-.PHONY: wipe-doc
+.PHONY: doc
+doc: $(BUILD_TEST_SRC) $(PIP_PATCH_DONE) $(TEST_DOC_BR)
+ @echo
+ @echo "Test Documentation URL: $(TEST_DOC_BR)/html/index.html"
+ @echo "Run 'make test-wipe-doc test-doc' to rebuild the test docs"
+ @echo
+.PHONY: wipe-doc
wipe-doc:
- @make -C doc wipe BR=$(BR)
+ @rm -rf $(TEST_DOC_BR)
-cov: wipe-cov reset ext verify-test-dir $(PAPI_INSTALL_DONE)
+$(BUILD_COV_DIR):
+ @mkdir -p $@
+
+.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_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)" || 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: papi-wipe
+.PHONY: wipe-papi
+wipe-papi:
+ @rm -rf $(PAPI_INSTALL_DONE) $(PAPI_WIPE_DIST)
-papi-wipe:
- @rm -rf $(PAPI_INSTALL_DONE)
+.PHONY: wipe-all
+wipe-all: wipe wipe-papi wipe-doc wipe-cov
+ @rm -rf $(TEST_BR)
.PHONY: checkstyle
-checkstyle: verify-test-dir $(PIP_INSTALL_DONE)
+checkstyle: $(BUILD_TEST_SRC) $(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 --exclude=$(WS_ROOT)/test/_*.py -v $(WS_ROOT)/test/*.py $(PLUGIN_SRC_DIR)/*/test/*.py ||\
+ pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 -v $(BUILD_TEST_SRC)/*.py ||\
(echo \"*******************************************************************\" &&\
echo \"* Test framework PEP8 compliance check FAILED \" &&\
echo \"*******************************************************************\" &&\
@echo "* Test framework PEP8 compliance check passed"
@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 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 " papi-wipe - rebuild vpp_papi sources"
- @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-doc - wipe documentation for test framework"
+ @echo " test-wipe-papi - rebuild vpp_papi sources"
+ @echo " test-wipe-all - wipe (temporary) files generated by unit tests, docs, 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 " 0=ERROR, 1=INFO, 2=DEBUG"
- @echo " TEST_JOBS=[<n>|auto] - use <n> 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=<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 " 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 'test-all' & '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 " V=[0|1|2] - set test verbosity level"
+ @echo " 0=ERROR, 1=INFO, 2=DEBUG"
+ @echo " TEST_JOBS=[<n>|auto] - use <n> 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=<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 " 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 " 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 " 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 " 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 " 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 " 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 " 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 " 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 " SOCKET=1 - Communicate with VPP over Unix domain socket instead of SHM"
@echo ""
- @echo " RND_SEED=seed - Seed RND with given seed"
+ @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 ""
-# Makefile for Sphinx documentation
+# Makefile for VPP Test documentation
#
-# You can set these variables from the command line.
SPHINXOPTS =
SRC_DOC_DIR = $(TEST_DIR)/doc
SPHINXBUILD = sphinx-build
-PAPER =
-BUILD_DOC_ROOT = $(TEST_DIR)/doc
-BUILD_DOC_DIR = $(BUILD_DOC_ROOT)/build
-API_DOC_GEN_DIR = $(BUILD_DOC_ROOT)/apidoc
+HTML_DOC_GEN_DIR = $(TEST_DOC_BR)/html
+API_DOC_GEN_DIR = $(TEST_DOC_BR)/api
# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d $(BUILD_DOC_DIR)/.sphinx-cache $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(API_DOC_GEN_DIR) -c $(SRC_DOC_DIR)
-# the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+ALLSPHINXOPTS = -d $(TEST_DOC_BR)/.sphinx-cache $(SPHINXOPTS) $(API_DOC_GEN_DIR) -c $(SRC_DOC_DIR)
IN_VENV:=$(shell if pip -V | grep "venv" 2>&1 > /dev/null; then echo 1; else echo 0; fi)
.PHONY: verify-virtualenv
verify-virtualenv:
+ifndef TEST_DIR
+ $(error TEST_DIR is not set)
+endif
+ifndef TEST_DOC_BR
+ $(error TEST_DOC_BR is not set)
+endif
+ifndef BUILD_TEST_SRC
+ $(error BUILD_TEST_SRC is not set)
+endif
ifeq ($(IN_VENV),0)
$(error "Not running inside virtualenv (are you running 'make test-doc' from root?)")
endif
@cp $(SRC_DOC_DIR)/index.rst $(API_DOC_GEN_DIR)
@cp $(SRC_DOC_DIR)/indices.rst $(API_DOC_GEN_DIR)
@cp $(SRC_DOC_DIR)/overview.rst $(API_DOC_GEN_DIR)
- sphinx-apidoc -o $(API_DOC_GEN_DIR) -H "Module documentation" ..
-
-.PHONY: help
-help:
- @echo "Please use \`make <target>' where <target> is one of"
- @echo " html to make standalone HTML files"
- @echo " dirhtml to make HTML files named index.html in directories"
- @echo " singlehtml to make a single large HTML file"
- @echo " pickle to make pickle files"
- @echo " json to make JSON files"
- @echo " htmlhelp to make HTML files and a HTML help project"
- @echo " qthelp to make HTML files and a qthelp project"
- @echo " applehelp to make an Apple Help Book"
- @echo " devhelp to make HTML files and a Devhelp project"
- @echo " epub to make an epub"
- @echo " epub3 to make an epub3"
- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
- @echo " latexpdf to make LaTeX files and run them through pdflatex"
- @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
- @echo " text to make text files"
- @echo " man to make manual pages"
- @echo " texinfo to make Texinfo files"
- @echo " info to make Texinfo files and run them through makeinfo"
- @echo " gettext to make PO message catalogs"
- @echo " changes to make an overview of all changed/added/deprecated items"
- @echo " xml to make Docutils-native XML files"
- @echo " pseudoxml to make pseudoxml-XML files for display purposes"
- @echo " linkcheck to check all external links for integrity"
- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
- @echo " coverage to run coverage check of the documentation (if enabled)"
- @echo " dummy to check syntax errors of document sources"
-
-.PHONY: wipe
-wipe:
- rm -rf $(BUILD_DOC_ROOT)
+ sphinx-apidoc -o $(API_DOC_GEN_DIR) -H "Module documentation" $(BUILD_TEST_SRC)
.PHONY: html
html: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/html
- @echo
- @echo "Build finished. The HTML pages are in $(BUILD_DOC_DIR)/html."
-
-.PHONY: dirhtml
-dirhtml: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/dirhtml
- @echo
- @echo "Build finished. The HTML pages are in $(BUILD_DOC_DIR)/dirhtml."
-
-.PHONY: singlehtml
-singlehtml: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/singlehtml
- @echo
- @echo "Build finished. The HTML page is in $(BUILD_DOC_DIR)/singlehtml."
-
-.PHONY: pickle
-pickle: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/pickle
- @echo
- @echo "Build finished; now you can process the pickle files."
-
-.PHONY: json
-json: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/json
- @echo
- @echo "Build finished; now you can process the JSON files."
-
-.PHONY: htmlhelp
-htmlhelp: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/htmlhelp
- @echo
- @echo "Build finished; now you can run HTML Help Workshop with the" \
- ".hhp project file in $(BUILD_DOC_DIR)/htmlhelp."
-
-.PHONY: qthelp
-qthelp: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/qthelp
- @echo
- @echo "Build finished; now you can run "qcollectiongenerator" with the" \
- ".qhcp project file in $(BUILD_DOC_DIR)/qthelp, like this:"
- @echo "# qcollectiongenerator $(BUILD_DOC_DIR)/qthelp/VPPtestframework.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILD_DOC_DIR)/qthelp/VPPtestframework.qhc"
-
-.PHONY: applehelp
-applehelp: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/applehelp
- @echo
- @echo "Build finished. The help book is in $(BUILD_DOC_DIR)/applehelp."
- @echo "N.B. You won't be able to view it unless you put it in" \
- "~/Library/Documentation/Help or install it in your application" \
- "bundle."
-
-.PHONY: devhelp
-devhelp: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/devhelp
- @echo
- @echo "Build finished."
- @echo "To view the help file:"
- @echo "# mkdir -p $$HOME/.local/share/devhelp/VPPtestframework"
- @echo "# ln -s $(BUILD_DOC_DIR)/devhelp $$HOME/.local/share/devhelp/VPPtestframework"
- @echo "# devhelp"
-
-.PHONY: epub
-epub: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/epub
- @echo
- @echo "Build finished. The epub file is in $(BUILD_DOC_DIR)/epub."
-
-.PHONY: epub3
-epub3:
- $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/epub3
- @echo
- @echo "Build finished. The epub3 file is in $(BUILD_DOC_DIR)/epub3."
-
-.PHONY: latex
-latex: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/latex
- @echo
- @echo "Build finished; the LaTeX files are in $(BUILD_DOC_DIR)/latex."
- @echo "Run \`make' in that directory to run these through (pdf)latex" \
- "(use \`make latexpdf' here to do that automatically)."
-
-.PHONY: latexpdf
-latexpdf: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/latex
- @echo "Running LaTeX files through pdflatex..."
- $(MAKE) -C $(BUILD_DOC_DIR)/latex all-pdf
- @echo "pdflatex finished; the PDF files are in $(BUILD_DOC_DIR)/latex."
-
-.PHONY: latexpdfja
-latexpdfja: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/latex
- @echo "Running LaTeX files through platex and dvipdfmx..."
- $(MAKE) -C $(BUILD_DOC_DIR)/latex all-pdf-ja
- @echo "pdflatex finished; the PDF files are in $(BUILD_DOC_DIR)/latex."
-
-.PHONY: text
-text: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/text
- @echo
- @echo "Build finished. The text files are in $(BUILD_DOC_DIR)/text."
-
-.PHONY: man
-man: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/man
- @echo
- @echo "Build finished. The manual pages are in $(BUILD_DOC_DIR)/man."
-
-.PHONY: texinfo
-texinfo: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/texinfo
- @echo
- @echo "Build finished. The Texinfo files are in $(BUILD_DOC_DIR)/texinfo."
- @echo "Run \`make' in that directory to run these through makeinfo" \
- "(use \`make info' here to do that automatically)."
-
-.PHONY: info
-info: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/texinfo
- @echo "Running Texinfo files through makeinfo..."
- make -C $(BUILD_DOC_DIR)/texinfo info
- @echo "makeinfo finished; the Info files are in $(BUILD_DOC_DIR)/texinfo."
-
-.PHONY: gettext
-gettext: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILD_DOC_DIR)/locale
- @echo
- @echo "Build finished. The message catalogs are in $(BUILD_DOC_DIR)/locale."
-
-.PHONY: changes
-changes: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/changes
- @echo
- @echo "The overview file is in $(BUILD_DOC_DIR)/changes."
-
-.PHONY: linkcheck
-linkcheck: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/linkcheck
- @echo
- @echo "Link check complete; look for any errors in the above output " \
- "or in $(BUILD_DOC_DIR)/linkcheck/output.txt."
-
-.PHONY: doctest
-doctest: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/doctest
- @echo "Testing of doctests in the sources finished, look at the " \
- "results in $(BUILD_DOC_DIR)/doctest/output.txt."
-
-.PHONY: coverage
-coverage: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/coverage
- @echo "Testing of coverage in the sources finished, look at the " \
- "results in $(BUILD_DOC_DIR)/coverage/python.txt."
-
-.PHONY: xml
-xml: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/xml
- @echo
- @echo "Build finished. The XML files are in $(BUILD_DOC_DIR)/xml."
-
-.PHONY: pseudoxml
-pseudoxml: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/pseudoxml
- @echo
- @echo "Build finished. The pseudo-XML files are in $(BUILD_DOC_DIR)/pseudoxml."
-
-.PHONY: dummy
-dummy: regen-api-doc verify-virtualenv
- $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILD_DOC_DIR)/dummy
- @echo
- @echo "Build finished. Dummy builder generates no files."
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(HTML_DOC_GEN_DIR)
#
import os
import sys
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('../../build-root/build-test/src'))
# -- General configuration ------------------------------------------------
# General information about the project.
project = u'VPP test framework'
-copyright = u'2016, VPP team'
+copyright = u'2019, VPP team'
author = u'VPP team'
# The version info for the project you're documenting, acts as replacement for
# built documents.
#
# The short X.Y version.
-version = u'0.1'
+version = u'20.01'
# The full version, including alpha/beta/rc tags.
-release = u'0.1'
+release = u'20.01-rc0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
-VAPI_BINDIR = $(TEST_DIR)/build/vapi_test/
-VAPI_CBIN = $(addprefix $(VAPI_BINDIR), vapi_c_test)
-VAPI_CPPBIN = $(addprefix $(VAPI_BINDIR), vapi_cpp_test)
-VOM_BINDIR = $(TEST_DIR)/build/vom_test/
-VOM_BIN = $(addprefix $(VOM_BINDIR), vom_test)
-
-ifeq ($(filter rhel centos,$(OS_ID)),$(OS_ID))
-VAPI_CPPBIN=
-endif
-
-ifeq ($(filter yes,$(EXTENDED_TESTS)),$(EXTENDED_TESTS))
-VOM_BIN=
-endif
+TEST_EXT_DIR=$(TEST_DIR)/ext
+VAPI_BINDIR = $(TEST_BR)/vapi_test
+VAPI_CBIN = $(addprefix $(VAPI_BINDIR), /vapi_c_test)
+VAPI_CPPBIN = $(addprefix $(VAPI_BINDIR), /vapi_cpp_test)
+VOM_BINDIR = $(TEST_BR)/vom_test
VAPI_LIBS = \
-L$(VPP_INSTALL_PATH)/vpp/lib \
CFLAGS = -std=gnu99 $(FLAGS)
CPPFLAGS = -std=c++11 $(FLAGS) -I$(WS_ROOT)/extras/vom
-all: $(VAPI_CBIN) $(VAPI_CPPBIN) $(VOM_BIN)
-
$(VAPI_BINDIR):
- mkdir -p $(VAPI_BINDIR)
+ @mkdir -p $(VAPI_BINDIR)
-CSRC = vapi_c_test.c
+CSRC = $(TEST_EXT_DIR)/vapi_c_test.c
$(VAPI_BINDIR)/fake.api.vapi.h: fake.api.json $(WS_ROOT)/src/vpp-api/vapi/vapi_c_gen.py | $(VAPI_BINDIR)
$(WS_ROOT)/src/vpp-api/vapi/vapi_c_gen.py --prefix $(VAPI_BINDIR) $<
$(VAPI_BINDIR)/fake.api.vapi.hpp: fake.api.json $(WS_ROOT)/src/vpp-api/vapi/vapi_cpp_gen.py | $(VAPI_BINDIR)
$(WS_ROOT)/src/vpp-api/vapi/vapi_cpp_gen.py --prefix $(VAPI_BINDIR) $<
-$(VAPI_CBIN): $(CSRC) $(VAPI_BINDIR)/fake.api.vapi.h
+$(VAPI_CBIN): $(VAPI_BINDIR) $(CSRC) $(VAPI_BINDIR)/fake.api.vapi.h
$(CC) -o $@ $(CFLAGS) $(CSRC) $(VAPI_LIBS)
$(VAPI_CBIN).d: $(CSRC) $(VAPI_BINDIR)/fake.api.vapi.h
$(CC) -o $@ $(CFLAGS) -MM -MT '$(VAPI_CBIN)' $(CSRC) > $@
-CPPSRC = vapi_cpp_test.cpp
+ifeq ($(filter rhel centos,$(OS_ID)),$(OS_ID))
+VAPI_CPPBIN=
+else
+CPPSRC = $(TEST_EXT_DIR)/vapi_cpp_test.cpp
-$(VAPI_CPPBIN): $(CPPSRC) $(VAPI_BINDIR)/fake.api.vapi.hpp
+$(VAPI_CPPBIN): $(VAPI_BINDIR) $(CPPSRC) $(VAPI_BINDIR)/fake.api.vapi.hpp
$(CXX) -o $@ $(CPPFLAGS) $(CPPSRC) $(VAPI_LIBS)
$(VAPI_CPPBIN).d: $(CPPSRC) $(VAPI_BINDIR)/fake.api.vapi.hpp
$(CXX) -o $@ $(CPPFLAGS) -MM -MT '$(VAPI_CPPBIN)' $(CPPSRC) > $@
+endif
-VOM_CPPSRC = vom_test.cpp
+ifeq ($(filter yes,$(EXTENDED_TESTS)),$(EXTENDED_TESTS))
+VOM_BIN = $(addprefix $(VOM_BINDIR), /vom_test)
+VOM_CPPSRC = $(TEST_EXT_DIR)/vom_test.cpp
$(VOM_BINDIR):
- mkdir -p $(VOM_BINDIR)
+ @mkdir -p $(VOM_BINDIR)
LIB_VOM = -lvom
VOM_LIBS = \
$(VOM_BIN).d: $(VOM_CPPSRC) $(VOM_BINDIR)
$(CXX) -o $@ $(VOM_CPPFLAGS) -MM -MT '$(VOM_BIN)' $(VOM_CPPSRC) > $@
+endif
+.PHONY: test-apps
+test-apps: $(VAPI_CBIN) $(VAPI_CPPBIN) $(VOM_BIN)
+.PHONY: clean
clean:
- rm -rf $(VAPI_BINDIR) $(VOM_BINDIR)
+ @rm -rf $(VAPI_BINDIR) $(VOM_BINDIR)
ifneq ($(MAKECMDGOALS),clean)
--include $(VAPI_CPPBIN).d
-include $(VAPI_CBIN).d
+ifneq ($(VAPI_CPPBIN),)
+-include $(VAPI_CPPBIN).d
+endif
+ifneq ($(VOM_BIN),)
-include $(VOM_BIN).d
endif
-
+endif
def test_vapi_c(self):
""" run C VAPI tests """
- var = "TEST_DIR"
+ var = "TEST_BR"
built_root = os.getenv(var, None)
self.assertIsNotNone(built_root,
"Environment variable `%s' not set" % var)
- executable = "%s/build/vapi_test/vapi_c_test" % built_root
+ executable = "%s/vapi_test/vapi_c_test" % built_root
worker = Worker(
[executable, "vapi client", self.shm_prefix], self.logger)
worker.start()
@unittest.skipIf(running_on_centos, "Centos's gcc can't compile our C++")
def test_vapi_cpp(self):
""" run C++ VAPI tests """
- var = "TEST_DIR"
+ var = "TEST_BR"
built_root = os.getenv(var, None)
self.assertIsNotNone(built_root,
"Environment variable `%s' not set" % var)
- executable = "%s/build/vapi_test/vapi_cpp_test" % built_root
+ executable = "%s/vapi_test/vapi_cpp_test" % built_root
worker = Worker(
[executable, "vapi client", self.shm_prefix], self.logger)
worker.start()
def test_vom_cpp(self):
""" run C++ VOM tests """
- var = "TEST_DIR"
+ var = "TEST_BR"
built_root = os.getenv(var, None)
self.assertIsNotNone(built_root,
"Environment variable `%s' not set" % var)
- executable = "%s/build/vom_test/vom_test" % built_root
+ executable = "%s/vom_test/vom_test" % built_root
worker = Worker(
[executable, "vpp object model", self.shm_prefix], self.logger)
worker.start()
Code Review / vpp.git / commitdiff