xref: /qemu/tests/docker/Makefile.include (revision 2c533c54) 
1# Makefile for Docker tests
2
3.PHONY: docker docker-test docker-clean docker-image docker-qemu-src
4
5DOCKER_SUFFIX := .docker
6DOCKER_FILES_DIR := $(SRC_PATH)/tests/docker/dockerfiles
7DOCKER_IMAGES := $(notdir $(basename $(wildcard $(DOCKER_FILES_DIR)/*.docker)))
8DOCKER_TARGETS := $(patsubst %,docker-image-%,$(DOCKER_IMAGES))
9# Use a global constant ccache directory to speed up repetitive builds
10DOCKER_CCACHE_DIR := $$HOME/.cache/qemu-docker-ccache
11
12DOCKER_TESTS := $(notdir $(shell \
13	find $(SRC_PATH)/tests/docker/ -name 'test-*' -type f))
14
15DOCKER_TOOLS := travis
16
17TESTS ?= %
18IMAGES ?= %
19
20# Make archive from git repo $1 to tar.gz $2
21make-archive-maybe = $(if $(wildcard $1/*), \
22	$(call quiet-command, \
23		(cd $1; if git diff-index --quiet HEAD -- &>/dev/null; then \
24			git archive -1 HEAD --format=tar.gz; \
25		else \
26			git archive -1 $$(git stash create) --format=tar.gz; \
27		fi) > $2, \
28		"  ARCHIVE $(notdir $2)"))
29
30CUR_TIME := $(shell date +%Y-%m-%d-%H.%M.%S.$$$$)
31DOCKER_SRC_COPY := docker-src.$(CUR_TIME)
32
33$(DOCKER_SRC_COPY):
34	@mkdir $@
35	$(call make-archive-maybe, $(SRC_PATH), $@/qemu.tgz)
36	$(call make-archive-maybe, $(SRC_PATH)/dtc, $@/dtc.tgz)
37	$(call make-archive-maybe, $(SRC_PATH)/pixman, $@/pixman.tgz)
38	$(call quiet-command, cp $(SRC_PATH)/tests/docker/run $@/run, \
39		"  COPY RUNNER")
40
41docker-qemu-src: $(DOCKER_SRC_COPY)
42
43docker-image: ${DOCKER_TARGETS}
44
45# General rule for building docker images
46docker-image-%: $(DOCKER_FILES_DIR)/%.docker
47	$(call quiet-command,\
48		$(SRC_PATH)/tests/docker/docker.py build qemu:$* $< \
49		$(if $V,,--quiet) $(if $(NOCACHE),--no-cache) \
50		$(if $(EXECUTABLE),--include-executable=$(EXECUTABLE)),\
51		"  BUILD $*")
52
53# Expand all the pre-requistes for each docker image and test combination
54$(foreach i,$(DOCKER_IMAGES), \
55	$(foreach t,$(DOCKER_TESTS) $(DOCKER_TOOLS), \
56		$(eval .PHONY: docker-$t@$i) \
57		$(eval docker-$t@$i: docker-image-$i docker-run-$t@$i) \
58	) \
59	$(foreach t,$(DOCKER_TESTS), \
60		$(eval docker-test: docker-$t@$i) \
61	) \
62)
63
64docker:
65	@echo 'Build QEMU and run tests inside Docker containers'
66	@echo
67	@echo 'Available targets:'
68	@echo
69	@echo '    docker:              Print this help.'
70	@echo '    docker-test:         Run all image/test combinations.'
71	@echo '    docker-clean:        Kill and remove residual docker testing containers.'
72	@echo '    docker-TEST@IMAGE:   Run "TEST" in container "IMAGE".'
73	@echo '                         Note: "TEST" is one of the listed test name,'
74	@echo '                         or a script name under $$QEMU_SRC/tests/docker/;'
75	@echo '                         "IMAGE" is one of the listed container name."'
76	@echo '    docker-image:        Build all images.'
77	@echo '    docker-image-IMAGE:  Build image "IMAGE".'
78	@echo
79	@echo 'Available container images:'
80	@echo '    $(DOCKER_IMAGES)'
81	@echo
82	@echo 'Available tests:'
83	@echo '    $(DOCKER_TESTS)'
84	@echo
85	@echo 'Available tools:'
86	@echo '    $(DOCKER_TOOLS)'
87	@echo
88	@echo 'Special variables:'
89	@echo '    TARGET_LIST=a,b,c    Override target list in builds.'
90	@echo '    EXTRA_CONFIGURE_OPTS="..."'
91	@echo '                         Extra configure options.'
92	@echo '    IMAGES="a b c ..":   Filters which images to build or run.'
93	@echo '    TESTS="x y z .."     Filters which tests to run (for docker-test).'
94	@echo '    J=[0..9]*            Overrides the -jN parameter for make commands'
95	@echo '                         (default is 1)'
96	@echo '    DEBUG=1              Stop and drop to shell in the created container'
97	@echo '                         before running the command.'
98	@echo '    NOCACHE=1            Ignore cache when build images.'
99	@echo '    EXECUTABLE=<path>    Include executable in image.'
100
101docker-run-%: CMD = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\1/')
102docker-run-%: IMAGE = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\2/')
103docker-run-%: docker-qemu-src
104	@mkdir -p "$(DOCKER_CCACHE_DIR)"
105	@if test -z "$(IMAGE)" || test -z "$(CMD)"; \
106		then echo "Invalid target"; exit 1; \
107	fi
108	$(if $(filter $(TESTS),$(CMD)),$(if $(filter $(IMAGES),$(IMAGE)), \
109		$(call quiet-command,\
110			if $(SRC_PATH)/tests/docker/docker.py images \
111				--format={{.Repository}}:{{.Tag}} | \
112					grep -qx qemu:$(IMAGE); then \
113				$(SRC_PATH)/tests/docker/docker.py run $(if $V,,--rm) \
114				-t \
115				$(if $(DEBUG),-i,--net=none) \
116				-e TARGET_LIST=$(TARGET_LIST) \
117				-e EXTRA_CONFIGURE_OPTS=$(EXTRA_CONFIGURE_OPTS) \
118				-e V=$V -e J=$J -e DEBUG=$(DEBUG)\
119				-e CCACHE_DIR=/var/tmp/ccache \
120				-v $$(realpath $(DOCKER_SRC_COPY)):/var/tmp/qemu:z$(COMMA)ro \
121				-v $(DOCKER_CCACHE_DIR):/var/tmp/ccache:z \
122				qemu:$(IMAGE) \
123				/var/tmp/qemu/run \
124				$(CMD); \
125			fi \
126			, "  RUN $(CMD) in $(IMAGE)")))
127
128docker-clean:
129	$(call quiet-command, $(SRC_PATH)/tests/docker/docker.py clean)
130