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