1 # Makefile for Docker tests
3 .PHONY: docker docker-test docker-clean docker-image docker-qemu-src
5 DOCKER_SUFFIX := .docker
6 DOCKER_FILES_DIR := $(SRC_PATH)/tests/docker/dockerfiles
7 DOCKER_DEPRECATED_IMAGES := debian
8 # we don't run tests on intermediate images (used as base by another image)
9 DOCKER_PARTIAL_IMAGES := debian debian8 debian9 debian8-mxe debian-ports debian-sid debian-bootstrap
10 DOCKER_IMAGES := $(filter-out $(DOCKER_DEPRECATED_IMAGES),$(sort $(notdir $(basename $(wildcard $(DOCKER_FILES_DIR)/*.docker)))))
11 DOCKER_TARGETS := $(patsubst %,docker-image-%,$(DOCKER_IMAGES))
12 # Use a global constant ccache directory to speed up repetitive builds
13 DOCKER_CCACHE_DIR := $$HOME/.cache/qemu-docker-ccache
15 DOCKER_TESTS := $(notdir $(shell \
16 find $(SRC_PATH)/tests/docker/ -name 'test-*' -type f))
18 DOCKER_TOOLS := travis
20 DOCKER_SCRIPT=$(SRC_PATH)/tests/docker/docker.py
25 CUR_TIME := $(shell date +%Y-%m-%d-%H.%M.%S.$$$$)
26 DOCKER_SRC_COPY := $(BUILD_DIR)/docker-src.$(CUR_TIME)
30 $(call quiet-command, cd $(SRC_PATH) && scripts/archive-source.sh $@/qemu.tar, \
32 $(call quiet-command, cp $(SRC_PATH)/tests/docker/run $@/run, \
35 docker-qemu-src: $(DOCKER_SRC_COPY)
37 docker-image: ${DOCKER_TARGETS}
39 # General rule for building docker images. If we are a sub-make
40 # invoked with SKIP_DOCKER_BUILD we still check the image is upto date
42 ifdef SKIP_DOCKER_BUILD
43 docker-image-%: $(DOCKER_FILES_DIR)/%.docker
44 $(call quiet-command, \
45 $(DOCKER_SCRIPT) check --quiet qemu:$* $<, \
48 docker-image-%: $(DOCKER_FILES_DIR)/%.docker
49 $(call quiet-command,\
50 $(DOCKER_SCRIPT) build qemu:$* $< \
51 $(if $V,,--quiet) $(if $(NOCACHE),--no-cache) \
52 $(if $(NOUSER),,--add-current-user) \
53 $(if $(EXTRA_FILES),--extra-files $(EXTRA_FILES))\
54 $(if $(EXECUTABLE),--include-executable=$(EXECUTABLE)),\
57 # Special rule for debootstraped binfmt linux-user images
58 docker-binfmt-image-debian-%: $(DOCKER_FILES_DIR)/debian-bootstrap.docker
60 $(error EXECUTABLE not set, debootstrap of debian-$* would fail))
61 $(if $(wildcard $(EXECUTABLE)),,\
62 $(error Please build $(EXECUTABLE) first))
64 $(error DEB_ARCH not set, debootstrap of debian-$* would fail))
66 $(error DEB_TYPE not set, debootstrap of debian-$* would fail))
67 $(if $(filter $(QEMU_TARGET),$(TARGET_DIRS)), \
68 $(call quiet-command, \
69 DEB_ARCH=$(DEB_ARCH) \
70 DEB_TYPE=$(DEB_TYPE) \
71 $(DOCKER_SCRIPT) build qemu:debian-$* $< \
72 $(if $V,,--quiet) $(if $(NOCACHE),--no-cache) \
73 $(if $(NOUSER),,--add-current-user) \
74 $(if $(EXTRA_FILES),--extra-files $(EXTRA_FILES)) \
75 $(if $(EXECUTABLE),--include-executable=$(EXECUTABLE)), \
76 "BUILD","binfmt debian-$* (debootstrapped)"), \
77 $(call quiet-command, \
78 $(DOCKER_SCRIPT) check --quiet qemu:debian-$* $<, \
79 "CHECK", "debian-$* exists"))
83 # Enforce dependencies for composite images
84 docker-image-debian: docker-image-debian9
85 docker-image-debian8-mxe: docker-image-debian8
86 docker-image-debian-amd64: docker-image-debian9
87 docker-image-debian-armel-cross: docker-image-debian9
88 docker-image-debian-armhf-cross: docker-image-debian9
89 docker-image-debian-arm64-cross: docker-image-debian9
90 docker-image-debian-mips-cross: docker-image-debian9
91 docker-image-debian-mipsel-cross: docker-image-debian9
92 docker-image-debian-mips64el-cross: docker-image-debian9
93 docker-image-debian-ppc64el-cross: docker-image-debian9
94 docker-image-debian-s390x-cross: docker-image-debian9
95 docker-image-debian-win32-cross: docker-image-debian8-mxe
96 docker-image-debian-win64-cross: docker-image-debian8-mxe
98 # Debian SID images - we are tracking a rolling distro so we want to
99 # force a re-build of the base image if we ever need to build one of
101 ifndef SKIP_DOCKER_BUILD
102 ifeq ($(HAVE_USER_DOCKER),y)
103 SID_AGE=$(shell $(DOCKER_SCRIPT) check --checktype=age --olderthan=180 --quiet qemu:debian-sid)
106 docker-image-debian-sid: NOCACHE=1
111 docker-image-debian-alpha-cross: docker-image-debian-sid
112 docker-image-debian-hppa-cross: docker-image-debian-sid
113 docker-image-debian-m68k-cross: docker-image-debian-sid
114 docker-image-debian-sh4-cross: docker-image-debian-sid
115 docker-image-debian-sparc64-cross: docker-image-debian-sid
116 docker-image-debian-mips64-cross: docker-image-debian-sid
117 docker-image-debian-riscv64-cross: docker-image-debian-sid
118 docker-image-debian-powerpc-cross: docker-image-debian-sid
119 docker-image-travis: NOUSER=1
121 # Specialist build images, sometimes very limited tools
122 docker-image-tricore-cross: docker-image-debian9
124 # These images may be good enough for building tests but not for test builds
125 DOCKER_PARTIAL_IMAGES += debian-alpha-cross debian-hppa-cross debian-m68k-cross debian-sh4-cross
126 DOCKER_PARTIAL_IMAGES += debian-sparc64-cross debian-mips64-cross debian-riscv64-cross
127 DOCKER_PARTIAL_IMAGES += debian-tricore-cross debian-powerpc-cross fedora-i386-cross
129 # Rules for building linux-user powered images
131 # These are slower than using native cross compiler setups but can
132 # work around issues with poorly working multi-arch systems and broken
135 # Jessie is the last supported release for powerpc, but multi-arch is
136 # broken so we need a qemu-linux-user for this target
137 docker-binfmt-image-debian-powerpc-user: DEB_ARCH = powerpc
138 docker-binfmt-image-debian-powerpc-user: DEB_TYPE = jessie
139 docker-binfmt-image-debian-powerpc-user: QEMU_TARGET = ppc-linux-user
140 docker-binfmt-image-debian-powerpc-user: EXECUTABLE = ${BUILD_DIR}/ppc-linux-user/qemu-ppc
141 docker-image-debian-powerpc-user-cross: docker-binfmt-image-debian-powerpc-user
142 DOCKER_USER_IMAGES += debian-powerpc-user
144 # Expand all the pre-requistes for each docker image and test combination
145 $(foreach i,$(filter-out $(DOCKER_PARTIAL_IMAGES),$(DOCKER_IMAGES) $(DOCKER_DEPRECATED_IMAGES)), \
146 $(foreach t,$(DOCKER_TESTS) $(DOCKER_TOOLS), \
147 $(eval .PHONY: docker-$t@$i) \
148 $(eval docker-$t@$i: docker-image-$i docker-run-$t@$i) \
150 $(foreach t,$(DOCKER_TESTS), \
151 $(eval docker-test: docker-$t@$i) \
156 @echo 'Build QEMU and run tests inside Docker containers'
158 @echo 'Available targets:'
160 @echo ' docker: Print this help.'
161 @echo ' docker-test: Run all image/test combinations.'
162 @echo ' docker-clean: Kill and remove residual docker testing containers.'
163 @echo ' docker-TEST@IMAGE: Run "TEST" in container "IMAGE".'
164 @echo ' Note: "TEST" is one of the listed test name,'
165 @echo ' or a script name under $$QEMU_SRC/tests/docker/;'
166 @echo ' "IMAGE" is one of the listed container name."'
167 @echo ' docker-image: Build all images.'
168 @echo ' docker-image-IMAGE: Build image "IMAGE".'
169 @echo ' docker-run: For manually running a "TEST" with "IMAGE"'
171 @echo 'Available container images:'
172 @echo ' $(DOCKER_IMAGES)'
173 ifneq ($(DOCKER_USER_IMAGES),)
175 @echo 'Available linux-user images (docker-binfmt-image-debian-%):'
176 @echo ' $(DOCKER_USER_IMAGES)'
179 @echo 'Available tests:'
180 @echo ' $(DOCKER_TESTS)'
182 @echo 'Available tools:'
183 @echo ' $(DOCKER_TOOLS)'
185 @echo 'Special variables:'
186 @echo ' TARGET_LIST=a,b,c Override target list in builds.'
187 @echo ' EXTRA_CONFIGURE_OPTS="..."'
188 @echo ' Extra configure options.'
189 @echo ' IMAGES="a b c ..": Filters which images to build or run.'
190 @echo ' TESTS="x y z .." Filters which tests to run (for docker-test).'
191 @echo ' J=[0..9]* Overrides the -jN parameter for make commands'
192 @echo ' (default is 1)'
193 @echo ' DEBUG=1 Stop and drop to shell in the created container'
194 @echo ' before running the command.'
195 @echo ' NETWORK=1 Enable virtual network interface with default backend.'
196 @echo ' NETWORK=$$BACKEND Enable virtual network interface with $$BACKEND.'
197 @echo ' NOUSER Define to disable adding current user to containers passwd.'
198 @echo ' NOCACHE=1 Ignore cache when build images.'
199 @echo ' EXECUTABLE=<path> Include executable in image.'
200 @echo ' EXTRA_FILES="<path> [... <path>]"'
201 @echo ' Include extra files in image.'
203 # This rule if for directly running against an arbitrary docker target.
204 # It is called by the expanded docker targets (e.g. make
205 # docker-test-foo@bar) which will do additional verification.
207 # For example: make docker-run TEST="test-quick" IMAGE="debian:arm64" EXECUTABLE=./aarch64-linux-user/qemu-aarch64
209 docker-run: docker-qemu-src
210 @mkdir -p "$(DOCKER_CCACHE_DIR)"
211 @if test -z "$(IMAGE)" || test -z "$(TEST)"; \
212 then echo "Invalid target $(IMAGE)/$(TEST)"; exit 1; \
214 $(if $(EXECUTABLE), \
215 $(call quiet-command, \
216 $(DOCKER_SCRIPT) update \
217 $(IMAGE) $(EXECUTABLE), \
218 " COPYING $(EXECUTABLE) to $(IMAGE)"))
219 $(call quiet-command, \
220 $(DOCKER_SCRIPT) run \
221 $(if $(NOUSER),,-u $(shell id -u)) \
222 --security-opt seccomp=unconfined \
224 $(if $(DEBUG),-ti,) \
225 $(if $(NETWORK),$(if $(subst $(NETWORK),,1),--net=$(NETWORK)),--net=none) \
226 -e TARGET_LIST=$(subst $(SPACE),$(COMMA),$(TARGET_LIST)) \
227 -e EXTRA_CONFIGURE_OPTS="$(EXTRA_CONFIGURE_OPTS)" \
228 -e V=$V -e J=$J -e DEBUG=$(DEBUG) \
229 -e SHOW_ENV=$(SHOW_ENV) \
231 -e CCACHE_DIR=/var/tmp/ccache \
232 -v $(DOCKER_CCACHE_DIR):/var/tmp/ccache:z \
234 -v $$(readlink -e $(DOCKER_SRC_COPY)):/var/tmp/qemu:z$(COMMA)ro \
237 $(TEST), " RUN $(TEST) in ${IMAGE}")
238 $(call quiet-command, rm -r $(DOCKER_SRC_COPY), \
239 " CLEANUP $(DOCKER_SRC_COPY)")
243 # Of the form docker-TEST-FOO@IMAGE-BAR which will then be expanded into a call to "make docker-run"
244 docker-run-%: CMD = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\1/')
245 docker-run-%: IMAGE = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\2/')
247 @$(MAKE) docker-run TEST=$(CMD) IMAGE=qemu:$(IMAGE)
250 $(call quiet-command, $(DOCKER_SCRIPT) clean)