Re: [Qemu-devel] [PATCH v2 02/15] Makefile: Rules for docker testing

["Alex Bennée" <alex.bennee@linaro.org>]

Fam Zheng <famz@redhat.com> writes:

> This adds a group of make targets to run docker tests, all are available
> in source tree without running ./configure.
>
> The usage is shown by "make docker".
>
> Besides the fixed ones, dynamic targets for building each image and
> running each test in each image are generated automatically by make,
> scanning $(SRC_PATH)/tests/docker/ files with specific patterns.
>
> Alternative to manually list particular targets (docker-run-FOO@BAR)
> set, you can control which tests/images to run by filtering variables,
> TESTS= and IMAGES=, which are expressed in Makefile pattern syntax,
> "foo% %bar ...". For example:
>
>     $ make docker-run IMAGES="ubuntu fedora"

This doesn't seem to work for me:

16:49 alex@zen/x86_64  [qemu.git/review/docker-tests-v2] >make
docker-run IMAGES="ubuntu" V=1
/home/alex/lsrc/qemu/qemu.git/rules.mak:178: warning: overriding
commands for target `clean-timestamp'
/home/alex/lsrc/qemu/qemu.git/rules.mak:178: warning: ignoring old
commands for target `clean-timestamp'
make: *** No rule to make target `docker-run'. Stop.
`

>
> Unfortunately, it's impossible to propagate "-j $JOBS" into make in
> containers, however since each combination is made a first class target
> is the top Makefile, "make -j$N docker-run" still parallels the tests
> coarsely.
>
> Signed-off-by: Fam Zheng <famz@redhat.com>
> ---
>  Makefile                      |  4 +-
>  tests/docker/Makefile.include | 93 +++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 96 insertions(+), 1 deletion(-)
>  create mode 100644 tests/docker/Makefile.include
>
> diff --git a/Makefile b/Makefile
> index f9fae3a..f104a08 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -6,7 +6,7 @@ BUILD_DIR=$(CURDIR)
>  # Before including a proper config-host.mak, assume we are in the source tree
>  SRC_PATH=.
>
> -UNCHECKED_GOALS := %clean TAGS cscope ctags
> +UNCHECKED_GOALS := %clean TAGS cscope ctags docker docker-%
>
>  # All following code might depend on configuration variables
>  ifneq ($(wildcard config-host.mak),)
> @@ -651,3 +651,5 @@ endif
>  # Include automatically generated dependency files
>  # Dependencies in Makefile.objs files come from our recursive subdir rules
>  -include $(wildcard *.d tests/*.d)
> +
> +include $(SRC_PATH)/tests/docker/Makefile.include
> diff --git a/tests/docker/Makefile.include b/tests/docker/Makefile.include
> new file mode 100644
> index 0000000..d8c55c3
> --- /dev/null
> +++ b/tests/docker/Makefile.include
> @@ -0,0 +1,93 @@
> +# Makefile for Docker tests
> +
> +$(if $(quiet-command),,$(eval include $(SRC_PATH)/rules.mak))
> +
> +.PHONY: docker docker-test docker-clean docker-image
> +
> +DOCKER_SUFFIX := .docker
> +
> +DOCKER_IMAGES := $(notdir $(basename \
> +	$(wildcard $(SRC_PATH)/tests/docker/dockerfiles/*)))
> +
> +DOCKER_TESTS := $(notdir $(shell \
> +	find $(SRC_PATH)/tests/docker/ -name 'test-*' -type f -executable))
> +
> +DOCKER_TOOLS := travis
> +
> +TESTS ?= %
> +IMAGES ?= %
> +
> +$(foreach i,$(DOCKER_IMAGES), \
> +	$(eval docker-image: docker-image-$i) \
> +	$(eval docker-image-$i: IMAGE = $i) \
> +	$(eval .PHONY: docker-image-$i docker-@$i) \
> +	$(foreach t,$(DOCKER_TESTS) $(DOCKER_TOOLS), \
> +		$(eval .PHONY: docker-$t@$i) \
> +		$(eval docker-$t@$i: docker-image-$i) \
> +		$(eval docker-$t@$i: docker-run-$t@$i) \
> +		$(eval docker-@$i: docker-$t@$i) \
> +		$(eval docker-test: docker-run-$t@$i) \
> +	) \
> +)
> +
> +docker:
> +	@echo 'Building QEMU and running tests inside Docker containers'
> +	@echo
> +	@echo 'Available targets:'
> +	@echo
> +	@echo '    docker:              Print this help.'
> +	@echo '    docker-test:         Run all image/test combinations.'
> +	@echo '    docker-clean:        Kill and remove residual docker testing containers.'
> +	@echo '    docker-TEST@IMAGE:   Run "TEST" in container "IMAGE".'
> +	@echo '                         Note: "TEST" is one of the listed test name,'
> +	@echo '                         or a script name under $$QEMU_SRC/tests/docker/;'
> +	@echo '                         "IMAGE" is one of the listed container name."'
> +	@echo '    docker-@IMAGE:       Run all tests in container "IMAGE".'
> +	@echo '    docker-image:        Build all images.'
> +	@echo '    docker-image-IMAGE:  Build image "IMG".'
> +	@echo
> +	@echo 'Available container images:'
> +	@echo '    $(DOCKER_IMAGES)'
> +	@echo
> +	@echo 'Available tests:'
> +	@echo '    $(DOCKER_TESTS)'
> +	@echo
> +	@echo 'Available tools:'
> +	@echo '    $(DOCKER_TOOLS)'
> +	@echo
> +	@echo 'Special variables:'
> +	@echo '    IMAGES="a b c ..":   Filters which images to build or run.'
> +	@echo '    TESTS="x y z .."     Filters which tests to run (for docker-test).'
> +	@echo '    J=[0..9]*            Overrides the -jN parameter for make commands'
> +	@echo '                         (default is 1)'

OK none of these test targets seem to be working for me:

  COPY SRC /tmp/qemu-src.JCUng
  RUN test-clang in centos6
Prerequisite 'clang' not present, skip
  RUN test-mingw in centos6
Prerequisite 'mingw' not present, skip
  RUN test-quick in centos6
make: *** [docker-run-test-quick@centos6] Error 2

Running with V=1 doesn't elucidate me much further:

/home/alex/lsrc/qemu/qemu.git/rules.mak:178: warning: overriding commands for target `clean-timestamp'
/home/alex/lsrc/qemu/qemu.git/rules.mak:178: warning: ignoring old commands for target `clean-timestamp'
mkdir -p /tmp/qemu-src.HtY32 && (if git diff-index --quiet HEAD -- &>/dev/null; then git archive -1 HEAD --format=tar.gz; else git archive -1 $(git stash create) --format=tar.gz; fi) | tar -xz -C /tmp/qemu-src.HtY32
/home/alex/lsrc/qemu/qemu.git/tests/docker/docker_run --rm --privileged -t --net=none  -v $(realpath /home/alex/lsrc/qemu/qemu.git):/var/tmp/qemu -e QEMU_SRC=/var/tmp/qemu -e V=1 -e J= -e PAUSE= -v /var/tmp/qemu-docker-ccache:/var/tmp/ccache -e CCACHE_DIR=/var/tmp/ccache qemu:centos6 /var/tmp/qemu/tests/docker/run /var/tmp/qemu/tests/docker/test-clang;
Prerequisite 'clang' not present, skip
/home/alex/lsrc/qemu/qemu.git/tests/docker/docker_run --rm --privileged -t --net=none  -v $(realpath /home/alex/lsrc/qemu/qemu.git):/var/tmp/qemu -e QEMU_SRC=/var/tmp/qemu -e V=1 -e J= -e PAUSE= -v /var/tmp/qemu-docker-ccache:/var/tmp/ccache -e CCACHE_DIR=/var/tmp/ccache qemu:centos6 /var/tmp/qemu/tests/docker/run /var/tmp/qemu/tests/docker/test-mingw;
Prerequisite 'mingw' not present, skip
/home/alex/lsrc/qemu/qemu.git/tests/docker/docker_run --rm --privileged -t --net=none  -v $(realpath /home/alex/lsrc/qemu/qemu.git):/var/tmp/qemu -e QEMU_SRC=/var/tmp/qemu -e V=1 -e J= -e PAUSE= -v /var/tmp/qemu-docker-ccache:/var/tmp/ccache -e CCACHE_DIR=/var/tmp/ccache qemu:centos6 /var/tmp/qemu/tests/docker/run /var/tmp/qemu/tests/docker/test-quick;
make: *** [docker-run-test-quick@centos6] Error 2

If I drop to the shell using:

make docker-test-quick@centos6 V=1 PAUSE=1

And run:

/var/tmp/qemu/tests/docker/test-quick

I get a cryptic silent fail. I think we need more verbosity (select-able
when required) to see whats going on in the depths.

> +
> +docker-image-%:
> +	@if test -z "$(IMAGE)"; then echo "Invalid target"; exit 1; fi
> +	$(if $(filter $(IMAGES),$(IMAGE)), $(call quiet-command,\
> +		$(SRC_PATH)/tests/docker/docker_build qemu:$(IMAGE) \
> +			$(SRC_PATH)/tests/docker/dockerfiles/$(IMAGE).docker \
> +			$(if $V,-v,), "  BUILD $(IMAGE)"))
> +
> +
> +docker-run-%: CMD = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\1/')
> +docker-run-%: IMAGE = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\2/')
> +docker-run-%:
> +	@if test -z "$(IMAGE)" || test -z "$(CMD)"; \
> +		then echo "Invalid target"; exit 1; \
> +	fi
> +	$(if $(filter $(TESTS),$(CMD)),$(if $(filter $(IMAGES),$(IMAGE)), \
> +		$(call quiet-command,\
> +			$(SRC_PATH)/tests/docker/docker_run $(if $(KEEP),,--rm) \
> +				--privileged -t --net=none \
> +				-v $$(realpath $(SRC_PATH)):/var/tmp/qemu \
> +				-e QEMU_SRC=/var/tmp/qemu \
> +				-e V=$V -e J=$J \
> +				-v /var/tmp/qemu-docker-ccache:/var/tmp/ccache \
> +				-e CCACHE_DIR=/var/tmp/ccache \
> +				qemu:$(IMAGE) \
> +				/var/tmp/qemu/tests/docker/run \
> +				/var/tmp/qemu/tests/docker/$(CMD); \
> +			, "  RUN $(CMD) in $(IMAGE)")))
> +
> +docker-clean:
> +	$(call quiet-command, $(SRC_PATH)/tests/docker/docker_clean)


--
Alex Bennée