Add RFC5424 syslog protocol support (VPP-1139)
[vpp.git] / test / Makefile
index 72b4dac..5f456e1 100644 (file)
@@ -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,8 +65,15 @@ ifneq ($(EXTERN_TESTS),)
 UNITTEST_EXTRA_OPTS=$(UNITTEST_FAILFAST_OPTS) -d $(EXTERN_TESTS)
 endif
 
+ifeq ($(TEST_DEBUG),1)
+VPP_PYTHON_PREFIX:=$(VPP_PYTHON_PREFIX)/debug
+PYTHON_EXTRA_DEPENDS=objgraph pympler
+else
+PYTHON_EXTRA_DEPENDS=
+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
+PYTHON_DEPENDS=$(PYTHON_EXTRA_DEPENDS) psutil faulthandler six scapy==2.4.0 pexpect cryptography subprocess32 cffi syslog-rfc5424-parser git+https://github.com/vpp-dev/py-lispnetworking
 SCAPY_SOURCE=$(shell find $(PYTHON_VENV_PATH) -name site-packages)
 BUILD_COV_DIR=$(BR)/test-cov
 
@@ -75,7 +103,7 @@ $(PIP_INSTALL_DONE): $(GET_PIP_SCRIPT)
 $(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
@@ -86,14 +114,39 @@ $(PAPI_INSTALL_DONE): $(PIP_PATCH_DONE)
        @touch $@
 
 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) scripts/compress_failed.sh
+@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
 endef
 
 .PHONY: sanity
 
+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
+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
-       @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python sanity_import_vpp_papi.py ||\
+       @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\" &&\
                 echo \"* to debug: \" &&\
@@ -101,13 +154,22 @@ sanity: verify-no-running-vpp
                 echo \"* 2. execute debugger:   gdb python -ex 'run sanity_import_vpp_papi.py'\" &&\
                 echo \"*******************************************************************\" &&\
                 false)"
-       @bash -c "source $(PYTHON_VENV_PATH)/bin/activate && python sanity_run_vpp.py ||\
+       @bash -c "$(SANITY_RUN_VPP_CMD) ||\
                (echo \"*******************************************************************\" &&\
                 echo \"* Sanity check failed, cannot run vpp\" &&\
                 echo \"*******************************************************************\" &&\
                 false)"
 
-test: verify-python-path $(PAPI_INSTALL_DONE) sanity reset 
+.PHONY: ext
+ext:
+       make -C ext
+
+test-dep: verify-python-path $(PAPI_INSTALL_DONE)
+
+test: verify-python-path $(PAPI_INSTALL_DONE) sanity reset
+       $(call retest-func)
+
+test-ext: verify-python-path $(PAPI_INSTALL_DONE) ext sanity reset
        $(call retest-func)
 
 retest: verify-python-path sanity reset
@@ -136,6 +198,7 @@ reset:
        @mkdir $(VPP_TEST_FAILED_DIR)
 
 wipe: reset
+       @make -C ext clean
        @rm -rf $(PYTHON_VENV_PATH)
        @rm -f $(PAPI_INSTALL_FLAGS)
 
@@ -149,7 +212,7 @@ doc: verify-python-path $(PIP_PATCH_DONE)
 wipe-doc:
        @make -C doc wipe BR=$(BR)
 
-cov: wipe-cov reset verify-python-path $(PAPI_INSTALL_DONE)
+cov: wipe-cov reset ext verify-python-path $(PAPI_INSTALL_DONE)
        @lcov --zerocounters --directory $(VPP_TEST_BUILD_DIR)
        @test -z "$(EXTERN_COV_DIR)" || lcov --zerocounters --directory $(EXTERN_COV_DIR)
        $(call retest-func)
@@ -170,9 +233,9 @@ wipe-cov: wipe
 .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 && pip install pycodestyle"
        @bash -c "source $(PYTHON_VENV_PATH)/bin/activate &&\
-               pep8 --show-source -v $(WS_ROOT)/test/*.py ||\
+               pycodestyle --show-source --ignore=W504,E126,E241,E226,E305,E704,E741,E722 -v $(WS_ROOT)/test/*.py ||\
                (echo \"*******************************************************************\" &&\
                 echo \"* Test framework PEP8 compliance check FAILED \" &&\
                 echo \"*******************************************************************\" &&\
@@ -196,16 +259,21 @@ help:
        @echo ""
        @echo "Arguments controlling test runs:"
        @echo " V=[0|1|2]            - set test verbosity level"
+       @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] - 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"
@@ -224,6 +292,12 @@ help:
        @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 "Creating test documentation"
        @echo " test-doc            - generate documentation for test framework"
        @echo " test-wipe-doc       - wipe documentation for test framework"