refactor test framework
[vpp.git] / Makefile
index dee2566..54b0f29 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -24,12 +24,16 @@ GDB_ARGS= -ex "handle SIGUSR1 noprint nostop"
 #
 # OS Detection
 #
+# We allow Darwin (MacOS) for docs generation; VPP build will still fail.
+ifneq ($(shell uname),Darwin)
 OS_ID        = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
 OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
+endif
 
 DEB_DEPENDS  = curl build-essential autoconf automake bison libssl-dev ccache
 DEB_DEPENDS += debhelper dkms git libtool libganglia1-dev libapr1-dev dh-systemd
 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope
+DEB_DEPENDS += python-dev
 ifeq ($(OS_VERSION_ID),14.04)
        DEB_DEPENDS += openjdk-8-jdk-headless
 else
@@ -39,9 +43,8 @@ endif
 RPM_DEPENDS_GROUPS = 'Development Tools'
 RPM_DEPENDS  = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
 RPM_DEPENDS += openssl-devel https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm apr-devel
-#RPM_DEPENDS += doxygen # TODO
+RPM_DEPENDS += python-devel
 EPEL_DEPENDS = libconfuse-devel ganglia-devel
-#EPEL_DEPENDS += graphviz # TODO
 
 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
         STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
@@ -49,11 +52,13 @@ endif
 
 ifeq ($(findstring y,$(UNATTENDED)),y)
 CONFIRM=-y
+FORCE=--force-yes
 endif
 
 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
-.PHONY: ctags cscope
+.PHONY: ctags cscope plugins plugins-release build-vpp-api
+.PHONY: test test-debug retest retest-debug
 
 help:
        @echo "Make Targets:"
@@ -63,18 +68,31 @@ help:
        @echo " wipe-release        - wipe all products of release build "
        @echo " build               - build debug binaries"
        @echo " build-release       - build release binaries"
+       @echo " plugins             - build debug plugin binaries"
+       @echo " plugins-release     - build release plugin binaries"
        @echo " rebuild             - wipe and build debug binares"
        @echo " rebuild-release     - wipe and build release binares"
        @echo " run                 - run debug binary"
        @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 functional tests"
+       @echo " test-debug          - build and run functional tests (debug build)"
+       @echo " retest              - run functional tests"
+       @echo " retest-debug        - run functional tests (debug build)"
        @echo " build-vat           - build vpp-api-test tool"
+       @echo " build-vpp-api       - build vpp-api"
        @echo " run-vat             - run vpp-api-test tool"
        @echo " pkg-deb             - build DEB packages"
        @echo " pkg-rpm             - build RPM packages"
        @echo " ctags               - (re)generate ctags database"
+       @echo " gtags               - (re)generate gtags database"
        @echo " cscope              - (re)generate cscope database"
+       @echo " checkstyle          - check coding style"
+       @echo " fixstyle            - fix coding style"
+       @echo " doxygen             - (re)generate documentation"
+       @echo " bootstrap-doxygen   - setup Doxygen dependencies"
+       @echo " wipe-doxygen        - wipe all generated documentation"
        @echo ""
        @echo "Make Arguments:"
        @echo " V=[0|1]             - set build verbosity level"
@@ -85,6 +103,7 @@ help:
        @echo "                       startup.conf file is present"
        @echo " GDB=<path>          - gdb binary to use for debugging"
        @echo " PLATFORM=<name>     - target platform. default is vpp"
+       @echo " TEST=<name>         - only run specific test"
        @echo ""
        @echo "Current Argumernt Values:"
        @echo " V            = $(V)"
@@ -126,11 +145,11 @@ bootstrap: $(BR)/.bootstrap.ok
 install-dep:
 ifeq ($(OS_ID),ubuntu)
 ifeq ($(OS_VERSION_ID),14.04)
-       @sudo apt-get $(CONFIRM) install software-properties-common
-       @sudo add-apt-repository $(CONFIRM) ppa:openjdk-r/ppa
-       @sudo apt-get update
+       @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
+       @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
+       @sudo -E apt-get update
 endif
-       @sudo apt-get $(CONFIRM) install $(DEB_DEPENDS)
+       @sudo -E apt-get $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
 else ifneq ("$(wildcard /etc/redhat-release)","")
        @sudo yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
        @sudo yum install $(CONFIRM) $(RPM_DEPENDS)
@@ -160,16 +179,58 @@ wipe-release: $(BR)/.bootstrap.ok
 
 rebuild-release: wipe-release build-release
 
+plugins: $(BR)/.bootstrap.ok
+       $(call make,$(PLATFORM)_debug,plugins-install)
+
+plugins-release: $(BR)/.bootstrap.ok
+       $(call make,$(PLATFORM),plugins-install)
+
+build-vpp-api: $(BR)/.bootstrap.ok
+       $(call make,$(PLATFORM)_debug,vpp-api-install)
+
+PYTHON_PATH=$(BR)/python
+
+define test
+       $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-api-install plugins-install vpp-install vpp-api-test-install,)
+       make -C test \
+         VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
+         VPP_TEST_API_TEST_BIN=$(BR)/install-$(2)-native/vpp-api-test/bin/vpp_api_test \
+         VPP_TEST_PLUGIN_PATH=$(BR)/install-$(2)-native/plugins/lib64/vpp_plugins \
+         LD_LIBRARY_PATH=$(BR)/install-$(2)-native/vpp-api/lib64/ \
+         WS_ROOT=$(WS_ROOT) I=$(I) V=$(V) TEST=$(TEST) PYTHON_PATH=$(PYTHON_PATH) $(3)
+endef
+
+test: bootstrap
+       $(call test,vpp_lite,vpp_lite,test)
+
+test-debug: bootstrap
+       $(call test,vpp_lite,vpp_lite_debug,test)
+
+test-doc:
+       make -C $(BR) PLATFORM=vpp_lite TAG=vpp_lite vpp-api-install plugins-install vpp-install vpp-api-test-install
+       make -C test PYTHON_PATH=$(PYTHON_PATH) LD_LIBRARY_PATH=$(BR)/install-vpp_lite-native/vpp-api/lib64/ doc
+
+test-clean:
+       make -C test clean
+
+retest:
+       $(call test,vpp_lite,vpp_lite,retest)
+
+retest-debug:
+       $(call test,vpp_lite,vpp_lite_debug,retest)
+
 STARTUP_DIR ?= $(PWD)
 ifeq ("$(wildcard $(STARTUP_CONF))","")
 define run
        @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
        @echo "         Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
-       @cd $(STARTUP_DIR) && sudo $(1) $(MINIMAL_STARTUP_CONF)
+       @cd $(STARTUP_DIR) && \
+         sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) plugin_path $(1)/plugins/lib64/vpp_plugins
 endef
 else
 define run
-       @cd $(STARTUP_DIR) && sudo $(1) -c $(STARTUP_CONF)
+       @cd $(STARTUP_DIR) && \
+         sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') plugin_path $(1)/plugins/lib64/vpp_plugins
 endef
 endif
 
@@ -181,16 +242,16 @@ endif
 .FORCE:
 
 run:
-       $(call run, $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp)
+       $(call run, $(BR)/install-$(PLATFORM)_debug-native)
 
 run-release:
-       $(call run, $(BR)/install-$(PLATFORM)-native/vpp/bin/vpp)
+       $(call run, $(BR)/install-$(PLATFORM)-native)
 
 debug:
-       $(call run, $(GDB) $(GDB_ARGS) --args $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp)
+       $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
 
 debug-release:
-       $(call run, $(GDB) $(GDB_ARGS) --args $(BR)/install-$(PLATFORM)-native/vpp/bin/vpp)
+       $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
 
 build-vat:
        $(call make,$(PLATFORM)_debug,vpp-api-test-install)
@@ -208,29 +269,37 @@ ctags: ctags.files
        @ctags --totals --tag-relative -L $<
        @rm $<
 
+gtags: ctags
+       @gtags --gtagslabel=ctags
+
 cscope: cscope.files
        @cscope -b -q -v
 
+checkstyle:
+       @build-root/scripts/checkstyle.sh
+
+fixstyle:
+       @build-root/scripts/checkstyle.sh --fix
+
+#
+# Build the documentation
+#
 
-DOXY_INPUT = \
-       README.md \
-       vppinfra \
-       svm \
-       vlib \
-       vlib-api \
-       vnet \
-       vpp \
-       vpp-api
+# Doxygen configuration and our utility scripts
+export DOXY_DIR ?= $(WS_ROOT)/doxygen
+
+define make-doxy
+       @OS_ID="$(OS_ID)" WS_ROOT="$(WS_ROOT)" BR="$(BR)" make -C $(DOXY_DIR) $@
+endef
+
+.PHONY: bootstrap-doxygen doxygen wipe-doxygen
+
+bootstrap-doxygen:
+       $(call make-doxy)
 
-.PHONY: doxygen
 doxygen:
-       @mkdir -p "$(BR)/docs"
-       ROOT="$(WS_ROOT)" \
-            BUILD_ROOT="$(BR)" \
-            INPUT="$(addprefix $(WS_ROOT)/,$(DOXY_INPUT))" \
-            HTML=YES \
-            VERSION="`git describe --tags --dirty`" \
-            doxygen doxygen/doxygen.cfg
+       $(call make-doxy)
 
 wipe-doxygen:
-       rm -rf "$(BR)/docs"
+       $(call make-doxy)
+