From f0797d130f82f751c1657e40e203eeb26f7aa3da Mon Sep 17 00:00:00 2001 From: Dave Wallace Date: Fri, 15 Nov 2019 17:29:15 -0500 Subject: [PATCH] build: fix make test with distributed src This patch addresses the functionality that is missing for distributed make test source files. In addition it extends the concept of colocating test source code with functional source code (eg. src/vcl/test). It also cleans up deficiencies in the make test makefiles. NOTE: Due to the way sphinx document tools work, all test, all of the make test python code is gathered using soft links into the directory: .../build-root/build-test/src Change summary: - Remove 'make test' help details from main makefile help output to reduce clutter and redundant help output - Move all generated build output to .../build-root/build-test - Move test_vcl.py as first usecase for distributed core feature make test code - Add test-wipe-all target and fix wipe targets to remove all generated files - Fix 'make test-doc' to generate module documentation for all source files - Remove unused targets in test/doc/Makefile - Fix 'make test-shell' - Fix test/ext Makefile to not generate bogus output Type: fix Fixes: a43c93f8554ad7418e31be3791b3fb71232f60ac Change-Id: Icc2ddb81d474081c3ede4548ecd7a0624651f62d Signed-off-by: Dave Wallace --- .gitignore | 4 - Makefile | 24 +--- {test => src/vcl/test}/test_vcl.py | 0 test/Makefile | 259 ++++++++++++++++++++++--------------- test/doc/Makefile | 234 +++------------------------------ test/doc/conf.py | 8 +- test/ext/Makefile | 53 ++++---- test/test_vapi.py | 8 +- test/test_vom.py | 4 +- 9 files changed, 215 insertions(+), 379 deletions(-) rename {test => src/vcl/test}/test_vcl.py (100%) diff --git a/.gitignore b/.gitignore index c56b4cfb534..b39d137d838 100644 --- a/.gitignore +++ b/.gitignore @@ -97,10 +97,6 @@ GTAGS /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 diff --git a/Makefile b/Makefile index 4686c96cb64..e5172eb8a5c 100644 --- a/Makefile +++ b/Makefile @@ -188,18 +188,7 @@ help: @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" @@ -225,13 +214,6 @@ help: @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" @@ -494,6 +476,10 @@ test-cov: 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 diff --git a/test/test_vcl.py b/src/vcl/test/test_vcl.py similarity index 100% rename from test/test_vcl.py rename to src/vcl/test/test_vcl.py diff --git a/test/Makefile b/test/Makefile index 5a580b8c556..4dd77b9b5e8 100644 --- a/test/Makefile +++ b/test/Makefile @@ -1,15 +1,27 @@ 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 @@ -72,12 +84,12 @@ 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),) @@ -91,18 +103,23 @@ 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_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 && \ @@ -133,24 +150,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=$(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 @@ -159,8 +177,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 && PYTHONPATH=$(BUILD_TEST_SRC) $(PYTHON_INTERP) $(BUILD_TEST_SRC)/sanity_run_vpp.py endif ifndef TEST_JOBS @@ -175,7 +193,7 @@ else 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 \"*******************************************************************\" &&\ @@ -196,21 +214,35 @@ sanity: verify-no-running-vpp 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);\ @@ -223,34 +255,44 @@ 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] - used by 'test-all' & '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 " 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 " 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 " 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 "" diff --git a/test/doc/Makefile b/test/doc/Makefile index be070e15346..608df0a1baf 100644 --- a/test/doc/Makefile +++ b/test/doc/Makefile @@ -1,25 +1,27 @@ -# 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 @@ -30,214 +32,8 @@ regen-api-doc: verify-virtualenv @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 ' where 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) diff --git a/test/doc/conf.py b/test/doc/conf.py index 25cd65b9f1f..f5e974954d8 100644 --- a/test/doc/conf.py +++ b/test/doc/conf.py @@ -18,7 +18,7 @@ # 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 ------------------------------------------------ @@ -59,7 +59,7 @@ master_doc = 'index' # 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 @@ -67,9 +67,9 @@ author = u'VPP team' # 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. diff --git a/test/ext/Makefile b/test/ext/Makefile index 6ec1213d532..cbb706528e2 100644 --- a/test/ext/Makefile +++ b/test/ext/Makefile @@ -1,16 +1,8 @@ -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 \ @@ -24,12 +16,10 @@ FLAGS = -g -Wall -lstdc++ -pthread -I$(WS_ROOT)/src -I$(VPP_INSTALL_PATH)/vpp/in 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) $< @@ -37,25 +27,31 @@ $(VAPI_BINDIR)/fake.api.vapi.h: fake.api.json $(WS_ROOT)/src/vpp-api/vapi/vapi_c $(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 = \ @@ -77,14 +73,21 @@ $(VOM_BIN): $(VOM_CPPSRC) $(VOM_BINDIR) $(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 diff --git a/test/test_vapi.py b/test/test_vapi.py index 5dbe56ac6e2..1a4293d7888 100644 --- a/test/test_vapi.py +++ b/test/test_vapi.py @@ -20,11 +20,11 @@ class VAPITestCase(VppTestCase): 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() @@ -50,11 +50,11 @@ class VAPITestCase(VppTestCase): @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() diff --git a/test/test_vom.py b/test/test_vom.py index 2d735ee0148..7dea7697f8c 100644 --- a/test/test_vom.py +++ b/test/test_vom.py @@ -22,11 +22,11 @@ class VOMTestCase(VppTestCase): 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() -- 2.16.6