X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=test%2FMakefile;h=025f8651281e8317a433ab659adc8cdbd46e63ec;hb=de312c2d5;hp=00d70400076bc09969eac01194789819aa223fc5;hpb=41a9e51f65aae3639771d9af53e810b43a5aee19;p=vpp.git

diff --git a/test/Makefile b/test/Makefile
index 00d70400076..025f8651281 100644
--- a/test/Makefile
+++ b/test/Makefile
@@ -1,10 +1,10 @@
-.PHONY: verify-python-path
+.PHONY: verify-test-dir
 
-VPP_TEST_FAILED_DIR=/tmp/vpp-failed-unittests/
+FAILED_DIR=/tmp/vpp-failed-unittests/
 
-verify-python-path:
-ifndef VPP_PYTHON_PREFIX
-	$(error VPP_PYTHON_PREFIX is not set)
+verify-test-dir:
+ifndef TEST_DIR
+	$(error TEST_DIR is not set)
 endif
 
 .PHONY: verify-no-running-vpp
@@ -19,10 +19,31 @@ ifeq ($(DEBUG),gdb)
 FORCE_FOREGROUND=1
 else ifeq ($(DEBUG),gdbserver)
 FORCE_FOREGROUND=1
+else ifeq ($(DEBUG),core)
+FORCE_FOREGROUND=1
+else ifeq ($(STEP),yes)
+FORCE_FOREGROUND=1
+else ifeq ($(STEP),y)
+FORCE_FOREGROUND=1
+else ifeq ($(STEP),1)
+FORCE_FOREGROUND=1
 else
 FORCE_FOREGROUND=0
 endif
 
+ifdef PROFILE_OUTPUT
+PROFILE_OUTPUT_OPTS=-o $(PROFILE_OUTPUT)
+endif
+
+ifndef PROFILE_SORT_BY
+PROFILE_SORT_BY=cumtime
+endif
+
+ifeq ($(PROFILE),1)
+PYTHON_PROFILE_OPTS=-m cProfile $(PROFILE_OUTPUT_OPTS) -s $(PROFILE_SORT_BY)
+FORCE_FOREGROUND=1
+endif
+
 verify-no-running-vpp:
 	@if [ "$(VPP_PIDS)" != "" ]; then \
 		echo; \
@@ -44,17 +65,13 @@ ifneq ($(EXTERN_TESTS),)
 UNITTEST_EXTRA_OPTS=$(UNITTEST_FAILFAST_OPTS) -d $(EXTERN_TESTS)
 endif
 
-PYTHON_VENV_PATH=$(VPP_PYTHON_PREFIX)/virtualenv
-PYTHON_DEPENDS=faulthandler six scapy==2.3.3 pexpect subprocess32 cffi git+https://github.com/klement/py-lispnetworking@setup
-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
+VENV_PATH=$(TEST_DIR)/run/venv
 
-PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE)
+ifeq ($(TEST_DEBUG),1)
+TEST_RUN_DIR:=$(VENV_PATH)/run-debug
+else
+TEST_RUN_DIR:=$(VENV_PATH)/run
+endif
 
 ifeq ($(PYTHON),)
 PYTHON_INTERP=python2.7
@@ -62,31 +79,71 @@ 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=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_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)"
+PIP_TOOLS_INSTALL_DONE=$(TEST_RUN_DIR)/pip-tools-install-$(PYTHON_VERSION).done
+PIP_INSTALL_DONE=$(TEST_RUN_DIR)/pip-install-$(PYTHON_VERSION).done
+PIP_PATCH_DONE=$(TEST_RUN_DIR)/pip-patch-$(PYTHON_VERSION).done
+PAPI_INSTALL_DONE=$(TEST_RUN_DIR)/papi-install-$(PYTHON_VERSION).done
+
+PAPI_INSTALL_FLAGS=$(PIP_INSTALL_DONE) $(PIP_PATCH_DONE) $(PAPI_INSTALL_DONE)
+
+$(PIP_TOOLS_INSTALL_DONE):
+	@rm -rf $(VENV_PATH)
+	@mkdir -p $(TEST_RUN_DIR)
+	@virtualenv $(VENV_PATH) -p $(PYTHON_INTERP)
+	# pip version pinning
+	@bash -c "source $(VENV_PATH)/bin/activate && \
+		  $(PYTHON_INTERP) -m pip install pip===$(PIP_VERSION)"
+	@bash -c "source $(VENV_PATH)/bin/activate && \
+		  $(PYTHON_INTERP) -m pip install pip-tools===$(PIP_TOOLS_VERSION)"
+	@touch $@
+
+$(PYTHON_DEPENDS): $(PIP_TOOLS_INSTALL_DONE) requirements.txt
+	@bash -c "source $(VENV_PATH)/bin/activate && \
+		  CUSTOM_COMPILE_COMMAND='make test-refresh-deps (or update requirements.txt)' \
+		  $(PYTHON_INTERP) -m piptools compile -q --generate-hashes requirements.txt --output-file $@"
+
+$(PIP_INSTALL_DONE): $(PYTHON_DEPENDS)
+	@bash -c "source $(VENV_PATH)/bin/activate && \
+		  $(PYTHON_INTERP) -m piptools sync $(PYTHON_DEPENDS)"
 	@touch $@
 
 $(PIP_PATCH_DONE): $(PIP_INSTALL_DONE)
 	@echo --- patching ---
 	@sleep 1 # Ensure python recompiles patched *.py files -> *.pyc
-	for f in $(CURDIR)/patches/scapy-2.3.3/*.patch ; do \
+	for f in $(CURDIR)/patches/scapy-2.4/*.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 $(WS_ROOT)/src/vpp-api/python"
 	@touch $@
 
+.PHONY: update-deps clear-deps
+refresh-deps: clean-deps $(PYTHON_DEPENDS)
+
+clean-deps:
+	@rm -f $(PYTHON_DEPENDS)
+
+ifneq ($(EXTERN_PLUGIN_SRC_DIR),)
+PLUGIN_SRC_DIR=$(EXTERN_PLUGIN_SRC_DIR)
+else
+PLUGIN_SRC_DIR=$(WS_ROOT)/src/plugins
+endif
+PLUGIN_TEST_DIRS=$(shell find $(PLUGIN_SRC_DIR) -type d -name test -exec echo -n " -d {}" \;)
+
 define retest-func
-	@env VPP_TEST_FAILED_DIR=$(VPP_TEST_FAILED_DIR) scripts/setsid_wrapper.sh $(FORCE_FOREGROUND) $(PYTHON_VENV_PATH)/bin/activate python 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 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
 endef
 
 .PHONY: sanity
@@ -95,11 +152,29 @@ ifeq ($(SANITY),no)
 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
+	@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\" &&\
@@ -118,19 +193,22 @@ sanity: verify-no-running-vpp
 ext:
 	make -C ext
 
-test: verify-python-path $(PAPI_INSTALL_DONE) ext sanity reset
+test-dep: verify-test-dir $(PAPI_INSTALL_DONE)
+
+test: verify-test-dir $(PAPI_INSTALL_DONE) ext sanity reset
 	$(call retest-func)
 
-retest: verify-python-path sanity reset
+retest: verify-test-dir sanity reset
 	$(call retest-func)
 
-shell: verify-python-path $(PAPI_INSTALL_DONE)
-	@echo "source $(PYTHON_VENV_PATH)/bin/activate;\
+shell: verify-test-dir $(PAPI_INSTALL_DONE)
+	@echo "source $(VENV_PATH)/bin/activate;\
 		echo '***';\
-		echo VPP_TEST_BUILD_DIR=$(VPP_TEST_BUILD_DIR);\
-		echo VPP_TEST_BIN=$(VPP_TEST_BIN);\
+		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);\
@@ -143,30 +221,30 @@ shell: verify-python-path $(PAPI_INSTALL_DONE)
 reset:
 	@rm -f /dev/shm/vpp-unittest-*
 	@rm -rf /tmp/vpp-unittest-*
-	@rm -rf $(VPP_TEST_FAILED_DIR)
-	@mkdir $(VPP_TEST_FAILED_DIR)
+	@rm -rf $(FAILED_DIR)
+	@mkdir $(FAILED_DIR)
 
 wipe: reset
 	@make -C ext clean
-	@rm -rf $(PYTHON_VENV_PATH)
+	@rm -rf $(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"
+doc: verify-test-dir $(PIP_PATCH_DONE)
+	@virtualenv $(VENV_PATH) -p python3
+	@bash -c "source $(VENV_PATH)/bin/activate && python3 -m pip install sphinx sphinx-rtd-theme"
+	@bash -c "source $(VENV_PATH)/bin/activate && make -C doc WS_ROOT=$(WS_ROOT) BR=$(BR) html"
 
 .PHONY: wipe-doc
 
 wipe-doc:
 	@make -C doc wipe BR=$(BR)
 
-cov: wipe-cov reset verify-python-path $(PAPI_INSTALL_DONE)
-	@lcov --zerocounters --directory $(VPP_TEST_BUILD_DIR)
+cov: wipe-cov reset ext verify-test-dir $(PAPI_INSTALL_DONE)
+	@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
@@ -179,12 +257,17 @@ cov: wipe-cov reset verify-python-path $(PAPI_INSTALL_DONE)
 wipe-cov: wipe
 	@rm -rf $(BUILD_COV_DIR)
 
+.PHONY: papi-wipe
+
+papi-wipe:
+	@rm -rf $(PAPI_INSTALL_DONE)
+
 .PHONY: checkstyle
-checkstyle: verify-python-path
-	@virtualenv $(PYTHON_VENV_PATH) -p $(PYTHON_INTERP)
-	@bash -c "source $(PYTHON_VENV_PATH)/bin/activate && pip install pep8"
-	@bash -c "source $(PYTHON_VENV_PATH)/bin/activate &&\
-		pep8 --show-source -v $(WS_ROOT)/test/*.py ||\
+checkstyle: verify-test-dir
+	@virtualenv $(VENV_PATH) -p python3
+	@bash -c "source $(VENV_PATH)/bin/activate && python3 -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 ||\
 		(echo \"*******************************************************************\" &&\
 		 echo \"* Test framework PEP8 compliance check FAILED \" &&\
 	         echo \"*******************************************************************\" &&\
@@ -198,28 +281,33 @@ help:
 	@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 " 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 ""
 	@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> to finish"
+	@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 "    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 "    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 " 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"
@@ -234,10 +322,21 @@ help:
 	@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 " SOCKET=1             - Communicate with VPP over Unix domain socket instead of SHM"
+	@echo ""
 	@echo "Creating test documentation"
 	@echo " test-doc            - generate documentation for test framework"
 	@echo " test-wipe-doc       - wipe documentation for test framework"