1 # Makefile for Docker tests
3 .PHONY: docker docker-help docker-test docker-clean docker-image docker-qemu-src
9 HOST_ARCH = $(if $(ARCH),$(ARCH),$(shell uname -m))
11 DOCKER_SUFFIX := .docker
12 DOCKER_FILES_DIR := $(SRC_PATH)/tests/docker/dockerfiles
13 # we don't run tests on intermediate images (used as base by another image)
14 DOCKER_PARTIAL_IMAGES := debian10 debian11 debian-bootstrap empty
15 DOCKER_IMAGES := $(sort $(notdir $(basename $(wildcard $(DOCKER_FILES_DIR)/*.docker))))
16 DOCKER_TARGETS := $(patsubst %,docker-image-%,$(DOCKER_IMAGES))
17 # Use a global constant ccache directory to speed up repetitive builds
18 DOCKER_CCACHE_DIR := $$HOME/.cache/qemu-docker-ccache
19 DOCKER_REGISTRY := $(if $(REGISTRY),$(REGISTRY),registry.gitlab.com/qemu-project/qemu)
21 DOCKER_TESTS := $(notdir $(shell \
22 find $(SRC_PATH)/tests/docker/ -name 'test-*' -type f))
26 DOCKER_SCRIPT=$(SRC_PATH)/tests/docker/docker.py --engine $(ENGINE)
31 CUR_TIME := $(shell date +%Y-%m-%d-%H.%M.%S.$$$$)
32 DOCKER_SRC_COPY := $(BUILD_DIR)/docker-src.$(CUR_TIME)
34 .DELETE_ON_ERROR: $(DOCKER_SRC_COPY)
37 $(if $(SRC_ARCHIVE), \
38 $(call quiet-command, cp "$(SRC_ARCHIVE)" $@/qemu.tar, \
39 "CP", "$@/qemu.tar"), \
40 $(call quiet-command, cd $(SRC_PATH) && scripts/archive-source.sh $@/qemu.tar, \
41 "GEN", "$@/qemu.tar"))
42 $(call quiet-command, cp $(SRC_PATH)/tests/docker/run $@/run, \
45 docker-qemu-src: $(DOCKER_SRC_COPY)
47 docker-image: ${DOCKER_TARGETS}
49 # General rule for building docker images. If we are a sub-make
50 # invoked with SKIP_DOCKER_BUILD we still check the image is up to date
52 ifdef SKIP_DOCKER_BUILD
53 docker-image-%: $(DOCKER_FILES_DIR)/%.docker
54 $(call quiet-command, \
55 $(DOCKER_SCRIPT) check --quiet qemu/$* $<, \
58 docker-image-%: $(DOCKER_FILES_DIR)/%.docker
59 $(call quiet-command,\
60 $(DOCKER_SCRIPT) build -t qemu/$* -f $< \
62 $(if $(NOCACHE),--no-cache, \
63 $(if $(DOCKER_REGISTRY),--registry $(DOCKER_REGISTRY))) \
64 $(if $(NOUSER),,--add-current-user) \
65 $(if $(EXTRA_FILES),--extra-files $(EXTRA_FILES))\
66 $(if $(EXECUTABLE),--include-executable=$(EXECUTABLE)),\
69 # Special rule for debootstraped binfmt linux-user images
70 docker-binfmt-image-debian-%: $(DOCKER_FILES_DIR)/debian-bootstrap.docker
72 $(error EXECUTABLE not set, debootstrap of debian-$* would fail))
74 $(error DEB_ARCH not set, debootstrap of debian-$* would fail))
76 $(error DEB_TYPE not set, debootstrap of debian-$* would fail))
77 $(if $(wildcard $(EXECUTABLE)), \
78 $(call quiet-command, \
79 DEB_ARCH=$(DEB_ARCH) \
80 DEB_TYPE=$(DEB_TYPE) \
81 $(if $(DEB_URL),DEB_URL=$(DEB_URL),) \
82 $(DOCKER_SCRIPT) build -t qemu/debian-$* -f $< \
83 $(if $V,,--quiet) $(if $(NOCACHE),--no-cache) \
84 $(if $(NOUSER),,--add-current-user) \
85 $(if $(EXTRA_FILES),--extra-files $(EXTRA_FILES)) \
86 $(if $(EXECUTABLE),--include-executable=$(EXECUTABLE)), \
87 "BUILD","binfmt debian-$* (debootstrapped)"), \
88 $(call quiet-command, \
89 $(DOCKER_SCRIPT) check --quiet qemu/debian-$* $< || \
90 { echo "You will need to build $(EXECUTABLE)"; exit 1;},\
91 "CHECK", "debian-$* exists"))
93 # These are test targets
94 USER_TCG_TARGETS=$(patsubst %-linux-user,qemu-%,$(filter %-linux-user,$(TARGET_DIRS)))
95 EXEC_COPY_TESTS=$(patsubst %,docker-exec-copy-test-%, $(USER_TCG_TARGETS))
97 $(EXEC_COPY_TESTS): docker-exec-copy-test-%: $(DOCKER_FILES_DIR)/empty.docker
98 $(call quiet-command, \
99 $(DOCKER_SCRIPT) build -t qemu/exec-copy-test-$* -f $< \
100 $(if $V,,--quiet) --no-cache \
101 --include-executable=$* \
103 "TEST","copy $* to container")
104 $(call quiet-command, \
105 $(DOCKER_SCRIPT) run qemu/exec-copy-test-$* \
106 /$* -version > tests/docker-exec-copy-test-$*.out, \
107 "TEST","check $* works in container")
109 docker-exec-copy-test: $(EXEC_COPY_TESTS)
113 # Enforce dependencies for composite images
114 ifeq ($(HOST_ARCH),x86_64)
115 docker-image-debian-amd64: docker-image-debian10
116 DOCKER_PARTIAL_IMAGES += debian-amd64-cross
118 docker-image-debian-amd64-cross: docker-image-debian10
119 DOCKER_PARTIAL_IMAGES += debian-amd64
122 # For non-x86 hosts not all cross-compilers have been packaged
123 ifneq ($(HOST_ARCH),x86_64)
124 DOCKER_PARTIAL_IMAGES += debian-mips-cross debian-mipsel-cross debian-mips64el-cross
125 DOCKER_PARTIAL_IMAGES += debian-ppc64el-cross
126 DOCKER_PARTIAL_IMAGES += debian-s390x-cross
127 DOCKER_PARTIAL_IMAGES += fedora
130 docker-image-debian-alpha-cross: docker-image-debian10
131 docker-image-debian-arm64-cross: docker-image-debian10
132 docker-image-debian-armel-cross: docker-image-debian10
133 docker-image-debian-armhf-cross: docker-image-debian10
134 docker-image-debian-hppa-cross: docker-image-debian10
135 docker-image-debian-m68k-cross: docker-image-debian10
136 docker-image-debian-mips-cross: docker-image-debian10
137 docker-image-debian-mips64-cross: docker-image-debian10
138 docker-image-debian-mips64el-cross: docker-image-debian10
139 docker-image-debian-mipsel-cross: docker-image-debian10
140 docker-image-debian-powerpc-cross: docker-image-debian10
141 docker-image-debian-ppc64-cross: docker-image-debian10
142 docker-image-debian-ppc64el-cross: docker-image-debian10
143 docker-image-debian-riscv64-cross: docker-image-debian10
144 docker-image-debian-s390x-cross: docker-image-debian10
145 docker-image-debian-sh4-cross: docker-image-debian10
146 docker-image-debian-sparc64-cross: docker-image-debian10
148 # Specialist build images, sometimes very limited tools
149 docker-image-debian-tricore-cross: docker-image-debian10
150 docker-image-debian-all-test-cross: docker-image-debian10
151 docker-image-debian-arm64-test-cross: docker-image-debian11
153 # These images may be good enough for building tests but not for test builds
154 DOCKER_PARTIAL_IMAGES += debian-alpha-cross
155 DOCKER_PARTIAL_IMAGES += debian-arm64-test-cross
156 DOCKER_PARTIAL_IMAGES += debian-hppa-cross
157 DOCKER_PARTIAL_IMAGES += debian-m68k-cross debian-mips64-cross
158 DOCKER_PARTIAL_IMAGES += debian-powerpc-cross debian-ppc64-cross
159 DOCKER_PARTIAL_IMAGES += debian-riscv64-cross
160 DOCKER_PARTIAL_IMAGES += debian-sh4-cross debian-sparc64-cross
161 DOCKER_PARTIAL_IMAGES += debian-tricore-cross
162 DOCKER_PARTIAL_IMAGES += debian-xtensa-cross
163 DOCKER_PARTIAL_IMAGES += fedora-i386-cross fedora-cris-cross
165 # Rules for building linux-user powered images
167 # These are slower than using native cross compiler setups but can
168 # work around issues with poorly working multi-arch systems and broken
171 # Expand all the pre-requistes for each docker image and test combination
172 $(foreach i,$(filter-out $(DOCKER_PARTIAL_IMAGES),$(DOCKER_IMAGES)), \
173 $(foreach t,$(DOCKER_TESTS), \
174 $(eval .PHONY: docker-$t@$i) \
175 $(eval docker-$t@$i: docker-image-$i docker-run-$t@$i) \
177 $(foreach t,$(DOCKER_TESTS), \
178 $(eval docker-all-tests: docker-$t@$i) \
179 $(eval docker-$t: docker-$t@$i) \
184 @echo 'Build QEMU and run tests inside Docker or Podman containers'
186 @echo 'Available targets:'
188 @echo ' docker: Print this help.'
189 @echo ' docker-all-tests: Run all image/test combinations.'
190 @echo ' docker-TEST: Run "TEST" on all image combinations.'
191 @echo ' docker-clean: Kill and remove residual docker testing containers.'
192 @echo ' docker-TEST@IMAGE: Run "TEST" in container "IMAGE".'
193 @echo ' Note: "TEST" is one of the listed test name,'
194 @echo ' or a script name under $$QEMU_SRC/tests/docker/;'
195 @echo ' "IMAGE" is one of the listed container name.'
196 @echo ' docker-image: Build all images.'
197 @echo ' docker-image-IMAGE: Build image "IMAGE".'
198 @echo ' docker-run: For manually running a "TEST" with "IMAGE".'
200 @echo 'Available container images:'
201 @echo ' $(DOCKER_IMAGES)'
202 ifneq ($(DOCKER_USER_IMAGES),)
204 @echo 'Available linux-user images (docker-binfmt-image-debian-%):'
205 @echo ' $(DOCKER_USER_IMAGES)'
208 @echo 'Available tests:'
209 @echo ' $(DOCKER_TESTS)'
211 @echo 'Special variables:'
212 @echo ' TARGET_LIST=a,b,c Override target list in builds.'
213 @echo ' EXTRA_CONFIGURE_OPTS="..."'
214 @echo ' Extra configure options.'
215 @echo ' IMAGES="a b c ..": Filters which images to build or run.'
216 @echo ' TESTS="x y z .." Filters which tests to run (for docker-test).'
217 @echo ' J=[0..9]* Overrides the -jN parameter for make commands'
218 @echo ' (default is 1)'
219 @echo ' DEBUG=1 Stop and drop to shell in the created container'
220 @echo ' before running the command.'
221 @echo ' NETWORK=1 Enable virtual network interface with default backend.'
222 @echo ' NETWORK=$$BACKEND Enable virtual network interface with $$BACKEND.'
223 @echo ' NOUSER=1 Define to disable adding current user to containers passwd.'
224 @echo ' NOCACHE=1 Ignore cache when build images.'
225 @echo ' EXECUTABLE=<path> Include executable in image.'
226 @echo ' EXTRA_FILES="<path> [... <path>]"'
227 @echo ' Include extra files in image.'
228 @echo ' ENGINE=auto/docker/podman'
229 @echo ' Specify which container engine to run.'
230 @echo ' REGISTRY=url Cache builds from registry (default:$(DOCKER_REGISTRY))'
234 # This rule if for directly running against an arbitrary docker target.
235 # It is called by the expanded docker targets (e.g. make
236 # docker-test-foo@bar) which will do additional verification.
238 # For example: make docker-run TEST="test-quick" IMAGE="debian:arm64" EXECUTABLE=./aarch64-linux-user/qemu-aarch64
240 docker-run: docker-qemu-src
241 @mkdir -p "$(DOCKER_CCACHE_DIR)"
242 @if test -z "$(IMAGE)" || test -z "$(TEST)"; \
243 then echo "Invalid target $(IMAGE)/$(TEST)"; exit 1; \
245 $(if $(EXECUTABLE), \
246 $(call quiet-command, \
247 $(DOCKER_SCRIPT) update \
248 $(IMAGE) $(EXECUTABLE), \
249 " COPYING $(EXECUTABLE) to $(IMAGE)"))
250 $(call quiet-command, \
251 $(DOCKER_SCRIPT) run \
252 $(if $(NOUSER),,--run-as-current-user) \
253 --security-opt seccomp=unconfined \
254 $(if $(DEBUG),-ti,) \
255 $(if $(NETWORK),$(if $(subst $(NETWORK),,1),--net=$(NETWORK)),--net=none) \
256 -e TARGET_LIST=$(subst $(SPACE),$(COMMA),$(TARGET_LIST)) \
257 -e EXTRA_CONFIGURE_OPTS="$(EXTRA_CONFIGURE_OPTS)" \
258 -e V=$V -e J=$J -e DEBUG=$(DEBUG) \
259 -e SHOW_ENV=$(SHOW_ENV) \
261 -e CCACHE_DIR=/var/tmp/ccache \
262 -v $(DOCKER_CCACHE_DIR):/var/tmp/ccache:z \
264 -v $$(readlink -e $(DOCKER_SRC_COPY)):/var/tmp/qemu:z$(COMMA)ro \
267 $(TEST), " RUN $(TEST) in ${IMAGE}")
268 $(call quiet-command, rm -r $(DOCKER_SRC_COPY), \
269 " CLEANUP $(DOCKER_SRC_COPY)")
273 # Of the form docker-TEST-FOO@IMAGE-BAR which will then be expanded into a call to "make docker-run"
274 docker-run-%: CMD = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\1/')
275 docker-run-%: IMAGE = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\2/')
277 @$(MAKE) docker-run TEST=$(CMD) IMAGE=qemu/$(IMAGE)
280 $(call quiet-command, $(DOCKER_SCRIPT) clean)