Merge remote-tracking branch 'remotes/jasowang/tags/net-pull-request' into staging
[qemu.git] / tests / docker / Makefile.include
1 # Makefile for Docker tests
2
3 .PHONY: docker docker-help docker-test docker-clean docker-image docker-qemu-src
4
5 NULL :=
6 SPACE := $(NULL) #
7 COMMA := ,
8
9 HOST_ARCH = $(if $(ARCH),$(ARCH),$(shell uname -m))
10
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 ifeq ($(HOST_ARCH),x86_64)
20 DOCKER_DEFAULT_REGISTRY := registry.gitlab.com/qemu-project/qemu
21 endif
22 DOCKER_REGISTRY := $(if $(REGISTRY),$(REGISTRY),$(DOCKER_DEFAULT_REGISTRY))
23
24 DOCKER_TESTS := $(notdir $(shell \
25         find $(SRC_PATH)/tests/docker/ -name 'test-*' -type f))
26
27 ENGINE := auto
28
29 DOCKER_SCRIPT=$(SRC_PATH)/tests/docker/docker.py --engine $(ENGINE)
30
31 TESTS ?= %
32 IMAGES ?= %
33
34 CUR_TIME := $(shell date +%Y-%m-%d-%H.%M.%S.$$$$)
35 DOCKER_SRC_COPY := $(BUILD_DIR)/docker-src.$(CUR_TIME)
36
37 .DELETE_ON_ERROR: $(DOCKER_SRC_COPY)
38 $(DOCKER_SRC_COPY):
39         @mkdir $@
40         $(if $(SRC_ARCHIVE), \
41                 $(call quiet-command, cp "$(SRC_ARCHIVE)" $@/qemu.tar, \
42                         "CP", "$@/qemu.tar"), \
43                 $(call quiet-command, cd $(SRC_PATH) && scripts/archive-source.sh $@/qemu.tar, \
44                         "GEN", "$@/qemu.tar"))
45         $(call quiet-command, cp $(SRC_PATH)/tests/docker/run $@/run, \
46                 "COPY","RUNNER")
47
48 docker-qemu-src: $(DOCKER_SRC_COPY)
49
50 docker-image: ${DOCKER_TARGETS}
51
52 # General rule for building docker images. If we are a sub-make
53 # invoked with SKIP_DOCKER_BUILD we still check the image is up to date
54 # though
55 ifdef SKIP_DOCKER_BUILD
56 docker-image-%: $(DOCKER_FILES_DIR)/%.docker
57         $(call quiet-command, \
58                 $(DOCKER_SCRIPT) check --quiet qemu/$* $<, \
59                 "CHECK", "$*")
60 else
61 docker-image-%: $(DOCKER_FILES_DIR)/%.docker
62         $(call quiet-command,\
63                 $(DOCKER_SCRIPT) build -t qemu/$* -f $< \
64                 $(if $V,,--quiet) \
65                 $(if $(NOCACHE),--no-cache, \
66                         $(if $(DOCKER_REGISTRY),--registry $(DOCKER_REGISTRY))) \
67                 $(if $(NOUSER),,--add-current-user) \
68                 $(if $(EXTRA_FILES),--extra-files $(EXTRA_FILES))\
69                 $(if $(EXECUTABLE),--include-executable=$(EXECUTABLE)),\
70                 "BUILD","$*")
71
72 # Special rule for debootstraped binfmt linux-user images
73 docker-binfmt-image-debian-%: $(DOCKER_FILES_DIR)/debian-bootstrap.docker
74         $(if $(EXECUTABLE),,\
75                 $(error EXECUTABLE not set, debootstrap of debian-$* would fail))
76         $(if $(DEB_ARCH),,\
77                 $(error DEB_ARCH not set, debootstrap of debian-$* would fail))
78         $(if $(DEB_TYPE),,\
79                 $(error DEB_TYPE not set, debootstrap of debian-$* would fail))
80         $(if $(wildcard $(EXECUTABLE)),                                         \
81                 $(call quiet-command,                                           \
82                         DEB_ARCH=$(DEB_ARCH)                                    \
83                         DEB_TYPE=$(DEB_TYPE)                                    \
84                         $(if $(DEB_URL),DEB_URL=$(DEB_URL),)                    \
85                         $(DOCKER_SCRIPT) build -t qemu/debian-$* -f $<          \
86                         $(if $V,,--quiet) $(if $(NOCACHE),--no-cache)           \
87                         $(if $(NOUSER),,--add-current-user)                     \
88                         $(if $(EXTRA_FILES),--extra-files $(EXTRA_FILES))       \
89                         $(if $(EXECUTABLE),--include-executable=$(EXECUTABLE)), \
90                         "BUILD","binfmt debian-$* (debootstrapped)"),           \
91                 $(call quiet-command,                                           \
92                         $(DOCKER_SCRIPT) check --quiet qemu/debian-$* $< ||     \
93                         { echo "You will need to build $(EXECUTABLE)"; exit 1;},\
94                         "CHECK", "debian-$* exists"))
95
96 # These are test targets
97 USER_TCG_TARGETS=$(patsubst %-linux-user,qemu-%,$(filter %-linux-user,$(TARGET_DIRS)))
98 EXEC_COPY_TESTS=$(patsubst %,docker-exec-copy-test-%, $(USER_TCG_TARGETS))
99
100 $(EXEC_COPY_TESTS): docker-exec-copy-test-%: $(DOCKER_FILES_DIR)/empty.docker
101         $(call quiet-command,                                                   \
102                 $(DOCKER_SCRIPT) build -t qemu/exec-copy-test-$* -f $<          \
103                         $(if $V,,--quiet) --no-cache                            \
104                         --include-executable=$*                                 \
105                         --skip-binfmt,                                          \
106                         "TEST","copy $* to container")
107         $(call quiet-command,                                                   \
108                 $(DOCKER_SCRIPT) run qemu/exec-copy-test-$*                     \
109                         /$* -version > tests/docker-exec-copy-test-$*.out,      \
110                         "TEST","check $* works in container")
111
112 docker-exec-copy-test: $(EXEC_COPY_TESTS)
113
114 endif
115
116 # Enforce dependencies for composite images
117 ifeq ($(HOST_ARCH),x86_64)
118 docker-image-debian-amd64: docker-image-debian10
119 DOCKER_PARTIAL_IMAGES += debian-amd64-cross
120 else
121 docker-image-debian-amd64-cross: docker-image-debian10
122 DOCKER_PARTIAL_IMAGES += debian-amd64
123 endif
124
125 # For non-x86 hosts not all cross-compilers have been packaged
126 ifneq ($(HOST_ARCH),x86_64)
127 DOCKER_PARTIAL_IMAGES += debian-mips-cross debian-mipsel-cross debian-mips64el-cross
128 DOCKER_PARTIAL_IMAGES += debian-ppc64el-cross
129 DOCKER_PARTIAL_IMAGES += debian-s390x-cross
130 DOCKER_PARTIAL_IMAGES += fedora
131 endif
132
133 docker-image-debian-alpha-cross: docker-image-debian10
134 docker-image-debian-arm64-cross: docker-image-debian10
135 docker-image-debian-armel-cross: docker-image-debian10
136 docker-image-debian-armhf-cross: docker-image-debian10
137 docker-image-debian-hppa-cross: docker-image-debian10
138 docker-image-debian-m68k-cross: docker-image-debian10
139 docker-image-debian-mips-cross: docker-image-debian10
140 docker-image-debian-mips64-cross: docker-image-debian10
141 docker-image-debian-mips64el-cross: docker-image-debian10
142 docker-image-debian-mipsel-cross: docker-image-debian10
143 docker-image-debian-ppc64el-cross: docker-image-debian10
144 docker-image-debian-riscv64-cross: docker-image-debian10
145 docker-image-debian-s390x-cross: docker-image-debian10
146 docker-image-debian-sh4-cross: docker-image-debian10
147 docker-image-debian-sparc64-cross: docker-image-debian10
148
149 #
150 # The build rule for hexagon-cross is special in so far for most of
151 # the time we don't want to build it. While dockers caching does avoid
152 # this most of the time sometimes we want to force the issue.
153 #
154 docker-image-debian-hexagon-cross: $(DOCKER_FILES_DIR)/debian-hexagon-cross.docker
155         $(if $(NOCACHE),                                                                \
156                 $(call quiet-command,                                                   \
157                         $(DOCKER_SCRIPT) build -t qemu/debian-hexagon-cross -f $<       \
158                         $(if $V,,--quiet) --no-cache                                    \
159                         --registry $(DOCKER_REGISTRY) --extra-files                     \
160                         $(DOCKER_FILES_DIR)/debian-hexagon-cross.docker.d/build-toolchain.sh, \
161                         "BUILD", "debian-hexagon-cross"),                               \
162                 $(call quiet-command,                                                   \
163                         $(DOCKER_SCRIPT) fetch $(if $V,,--quiet)                        \
164                                 qemu/debian-hexagon-cross $(DOCKER_REGISTRY),           \
165                         "FETCH", "debian-hexagon-cross")                                \
166                 $(call quiet-command,                                                   \
167                         $(DOCKER_SCRIPT) update $(if $V,,--quiet)                       \
168                                 qemu/debian-hexagon-cross --add-current-user,           \
169                         "PREPARE", "debian-hexagon-cross"))
170
171 # Specialist build images, sometimes very limited tools
172 docker-image-debian-tricore-cross: docker-image-debian10
173 docker-image-debian-all-test-cross: docker-image-debian10
174 docker-image-debian-arm64-test-cross: docker-image-debian11
175 docker-image-debian-powerpc-test-cross: docker-image-debian11
176
177 # These images may be good enough for building tests but not for test builds
178 DOCKER_PARTIAL_IMAGES += debian-alpha-cross
179 DOCKER_PARTIAL_IMAGES += debian-arm64-test-cross
180 DOCKER_PARTIAL_IMAGES += debian-powerpc-test-cross
181 DOCKER_PARTIAL_IMAGES += debian-hppa-cross
182 DOCKER_PARTIAL_IMAGES += debian-m68k-cross debian-mips64-cross
183 DOCKER_PARTIAL_IMAGES += debian-riscv64-cross
184 DOCKER_PARTIAL_IMAGES += debian-sh4-cross debian-sparc64-cross
185 DOCKER_PARTIAL_IMAGES += debian-tricore-cross
186 DOCKER_PARTIAL_IMAGES += debian-xtensa-cross
187 DOCKER_PARTIAL_IMAGES += fedora-i386-cross fedora-cris-cross
188
189 # Rules for building linux-user powered images
190 #
191 # These are slower than using native cross compiler setups but can
192 # work around issues with poorly working multi-arch systems and broken
193 # packages.
194
195 # Expand all the pre-requistes for each docker image and test combination
196 $(foreach i,$(filter-out $(DOCKER_PARTIAL_IMAGES),$(DOCKER_IMAGES)), \
197         $(foreach t,$(DOCKER_TESTS), \
198                 $(eval .PHONY: docker-$t@$i) \
199                 $(eval docker-$t@$i: docker-image-$i docker-run-$t@$i) \
200         ) \
201         $(foreach t,$(DOCKER_TESTS), \
202                 $(eval docker-all-tests: docker-$t@$i) \
203                 $(eval docker-$t: docker-$t@$i) \
204         ) \
205 )
206
207 docker:
208         @echo 'Build QEMU and run tests inside Docker or Podman containers'
209         @echo
210         @echo 'Available targets:'
211         @echo
212         @echo '    docker:              Print this help.'
213         @echo '    docker-all-tests:    Run all image/test combinations.'
214         @echo '    docker-TEST:         Run "TEST" on all image combinations.'
215         @echo '    docker-clean:        Kill and remove residual docker testing containers.'
216         @echo '    docker-TEST@IMAGE:   Run "TEST" in container "IMAGE".'
217         @echo '                         Note: "TEST" is one of the listed test name,'
218         @echo '                         or a script name under $$QEMU_SRC/tests/docker/;'
219         @echo '                         "IMAGE" is one of the listed container name.'
220         @echo '    docker-image:        Build all images.'
221         @echo '    docker-image-IMAGE:  Build image "IMAGE".'
222         @echo '    docker-run:          For manually running a "TEST" with "IMAGE".'
223         @echo
224         @echo 'Available container images:'
225         @echo '    $(DOCKER_IMAGES)'
226 ifneq ($(DOCKER_USER_IMAGES),)
227         @echo
228         @echo 'Available linux-user images (docker-binfmt-image-debian-%):'
229         @echo '    $(DOCKER_USER_IMAGES)'
230 endif
231         @echo
232         @echo 'Available tests:'
233         @echo '    $(DOCKER_TESTS)'
234         @echo
235         @echo 'Special variables:'
236         @echo '    TARGET_LIST=a,b,c    Override target list in builds.'
237         @echo '    EXTRA_CONFIGURE_OPTS="..."'
238         @echo '                         Extra configure options.'
239         @echo '    IMAGES="a b c ..":   Filters which images to build or run.'
240         @echo '    TESTS="x y z .."     Filters which tests to run (for docker-test).'
241         @echo '    J=[0..9]*            Overrides the -jN parameter for make commands'
242         @echo '                         (default is 1)'
243         @echo '    DEBUG=1              Stop and drop to shell in the created container'
244         @echo '                         before running the command.'
245         @echo '    NETWORK=1            Enable virtual network interface with default backend.'
246         @echo '    NETWORK=$$BACKEND     Enable virtual network interface with $$BACKEND.'
247         @echo '    NOUSER=1             Define to disable adding current user to containers passwd.'
248         @echo '    NOCACHE=1            Ignore cache when build images.'
249         @echo '    EXECUTABLE=<path>    Include executable in image.'
250         @echo '    EXTRA_FILES="<path> [... <path>]"'
251         @echo '                         Include extra files in image.'
252         @echo '    ENGINE=auto/docker/podman'
253         @echo '                         Specify which container engine to run.'
254         @echo '    REGISTRY=url         Cache builds from registry (default:$(DOCKER_REGISTRY))'
255
256 docker-help: docker
257
258 # This rule if for directly running against an arbitrary docker target.
259 # It is called by the expanded docker targets (e.g. make
260 # docker-test-foo@bar) which will do additional verification.
261 #
262 # For example: make docker-run TEST="test-quick" IMAGE="debian:arm64" EXECUTABLE=./aarch64-linux-user/qemu-aarch64
263 #
264 docker-run: docker-qemu-src
265         @mkdir -p "$(DOCKER_CCACHE_DIR)"
266         @if test -z "$(IMAGE)" || test -z "$(TEST)"; \
267                 then echo "Invalid target $(IMAGE)/$(TEST)"; exit 1; \
268         fi
269         $(if $(EXECUTABLE),                                             \
270                 $(call quiet-command,                                   \
271                         $(DOCKER_SCRIPT) update                         \
272                         $(IMAGE) --executable $(EXECUTABLE),            \
273                         "  COPYING $(EXECUTABLE) to $(IMAGE)"))
274         $(call quiet-command,                                           \
275                 $(DOCKER_SCRIPT) run                                    \
276                         $(if $(NOUSER),,--run-as-current-user)          \
277                         --security-opt seccomp=unconfined               \
278                         $(if $(DEBUG),-ti,)                             \
279                         $(if $(NETWORK),$(if $(subst $(NETWORK),,1),--net=$(NETWORK)),--net=none) \
280                         -e TARGET_LIST=$(subst $(SPACE),$(COMMA),$(TARGET_LIST))        \
281                         -e EXTRA_CONFIGURE_OPTS="$(EXTRA_CONFIGURE_OPTS)" \
282                         -e V=$V -e J=$J -e DEBUG=$(DEBUG)               \
283                         -e SHOW_ENV=$(SHOW_ENV)                         \
284                         $(if $(NOUSER),,                                \
285                                 -e CCACHE_DIR=/var/tmp/ccache           \
286                                 -v $(DOCKER_CCACHE_DIR):/var/tmp/ccache:z \
287                         )                                               \
288                         -v $$(readlink -e $(DOCKER_SRC_COPY)):/var/tmp/qemu:z$(COMMA)ro \
289                         $(IMAGE)                                        \
290                         /var/tmp/qemu/run                               \
291                         $(TEST), "  RUN $(TEST) in ${IMAGE}")
292         $(call quiet-command, rm -r $(DOCKER_SRC_COPY), \
293                 "  CLEANUP $(DOCKER_SRC_COPY)")
294
295 # Run targets:
296 #
297 # Of the form docker-TEST-FOO@IMAGE-BAR which will then be expanded into a call to "make docker-run"
298 docker-run-%: CMD = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\1/')
299 docker-run-%: IMAGE = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\2/')
300 docker-run-%:
301         @$(MAKE) docker-run TEST=$(CMD) IMAGE=qemu/$(IMAGE)
302
303 docker-clean:
304         $(call quiet-command, $(DOCKER_SCRIPT) clean)