1# Makefile for Docker tests 2 3.PHONY: docker docker-help docker-test docker-clean docker-image docker-qemu-src 4 5NULL := 6SPACE := $(NULL) # 7COMMA := , 8 9HOST_ARCH = $(shell uname -m) 10USER = $(if $(NOUSER),,$(shell id -un)) 11UID = $(if $(NOUSER),,$(shell id -u)) 12 13DOCKER_FILES_DIR := $(SRC_PATH)/tests/docker/dockerfiles 14ifeq ($(HOST_ARCH),x86_64) 15DOCKER_DEFAULT_REGISTRY := registry.gitlab.com/qemu-project/qemu 16endif 17DOCKER_REGISTRY := $(if $(REGISTRY),$(REGISTRY),$(DOCKER_DEFAULT_REGISTRY)) 18 19RUNC ?= $(if $(shell command -v docker), docker, podman) 20DOCKER_SCRIPT=$(SRC_PATH)/tests/docker/docker.py --engine $(RUNC) 21 22CUR_TIME := $(shell date +%Y-%m-%d-%H.%M.%S.$$$$) 23DOCKER_SRC_COPY := $(BUILD_DIR)/docker-src.$(CUR_TIME) 24 25.DELETE_ON_ERROR: $(DOCKER_SRC_COPY) 26$(DOCKER_SRC_COPY): 27 @mkdir $@ 28 $(if $(SRC_ARCHIVE), \ 29 $(call quiet-command, cp "$(SRC_ARCHIVE)" $@/qemu.tar, \ 30 "CP", "$@/qemu.tar"), \ 31 $(call quiet-command, cd $(SRC_PATH) && scripts/archive-source.sh $@/qemu.tar, \ 32 "GEN", "$@/qemu.tar")) 33 $(call quiet-command, cp $(SRC_PATH)/tests/docker/run $@/run, \ 34 "COPY","RUNNER") 35 36docker-qemu-src: $(DOCKER_SRC_COPY) 37 38# General rule for building docker images. 39docker-image-%: $(DOCKER_FILES_DIR)/%.docker 40 $(call quiet-command, \ 41 DOCKER_BUILDKIT=1 $(RUNC) build \ 42 $(if $V,,--quiet) \ 43 $(if $(NOCACHE),--no-cache, \ 44 $(if $(DOCKER_REGISTRY),--cache-from $(DOCKER_REGISTRY)/qemu/$*)) \ 45 --build-arg BUILDKIT_INLINE_CACHE=1 \ 46 $(if $(NOUSER),, \ 47 --build-arg USER=$(USER) \ 48 --build-arg UID=$(UID)) \ 49 -t qemu/$* - < $< $(if $V,,> /dev/null),\ 50 "BUILD", $*) 51 52# General rule for inspecting registry images. 53docker-verify-%: $(DOCKER_FILES_DIR)/%.docker 54 $(call quiet-command, \ 55 skopeo inspect \ 56 --format '{{.Created}}' \ 57 docker://$(DOCKER_REGISTRY)/qemu/$* \ 58 $(if $V,,> /dev/null),\ 59 "VERIFY", $*) 60 61# Special rule for debootstraped binfmt linux-user images 62docker-binfmt-image-debian-%: $(DOCKER_FILES_DIR)/debian-bootstrap.docker 63 $(if $(EXECUTABLE),,\ 64 $(error EXECUTABLE not set, debootstrap of debian-$* would fail)) 65 $(if $(DEB_ARCH),,\ 66 $(error DEB_ARCH not set, debootstrap of debian-$* would fail)) 67 $(if $(DEB_TYPE),,\ 68 $(error DEB_TYPE not set, debootstrap of debian-$* would fail)) 69 $(if $(wildcard $(EXECUTABLE)), \ 70 $(call quiet-command, \ 71 DEB_ARCH=$(DEB_ARCH) \ 72 DEB_TYPE=$(DEB_TYPE) \ 73 $(if $(DEB_URL),DEB_URL=$(DEB_URL),) \ 74 $(DOCKER_SCRIPT) build -t qemu/debian-$* -f $< \ 75 $(if $V,,--quiet) $(if $(NOCACHE),--no-cache) \ 76 $(if $(NOUSER),,--add-current-user) \ 77 $(if $(EXTRA_FILES),--extra-files $(EXTRA_FILES)) \ 78 $(if $(EXECUTABLE),--include-executable=$(EXECUTABLE)), \ 79 "BUILD","binfmt debian-$* (debootstrapped)"), \ 80 $(call quiet-command, \ 81 $(DOCKER_SCRIPT) check --quiet qemu/debian-$* $< || \ 82 { echo "You will need to build $(EXECUTABLE)"; exit 1;},\ 83 "CHECK", "debian-$* exists")) 84 85# Special case cross-compiling x86_64 on non-x86_64 systems. 86ifeq ($(HOST_ARCH),x86_64) 87DOCKER_PARTIAL_IMAGES += debian-amd64-cross 88else 89DOCKER_PARTIAL_IMAGES += debian-amd64 90endif 91 92# For non-x86 hosts not all cross-compilers have been packaged 93ifneq ($(HOST_ARCH),x86_64) 94DOCKER_PARTIAL_IMAGES += debian-mipsel-cross debian-mips64el-cross 95DOCKER_PARTIAL_IMAGES += debian-ppc64el-cross 96DOCKER_PARTIAL_IMAGES += debian-s390x-cross 97DOCKER_PARTIAL_IMAGES += fedora 98endif 99 100# alpine has no adduser 101docker-image-alpine: NOUSER=1 102 103debian-toolchain-run = \ 104 $(if $(NOCACHE)$(NOFETCH), \ 105 $(call quiet-command, \ 106 $(DOCKER_SCRIPT) build -t qemu/$1 -f $< \ 107 $(if $V,,--quiet) $(if $(NOCACHE),--no-cache) \ 108 --registry $(DOCKER_REGISTRY) --extra-files \ 109 $(DOCKER_FILES_DIR)/$1.d/build-toolchain.sh, \ 110 "BUILD", $1), \ 111 $(call quiet-command, \ 112 $(DOCKER_SCRIPT) fetch $(if $V,,--quiet) \ 113 qemu/$1 $(DOCKER_REGISTRY), \ 114 "FETCH", $1) \ 115 $(call quiet-command, \ 116 $(DOCKER_SCRIPT) update $(if $V,,--quiet) \ 117 qemu/$1 \ 118 $(if $(NOUSER),,--add-current-user) \ 119 "PREPARE", $1)) 120debian-toolchain = $(call debian-toolchain-run,$(patsubst docker-image-%,%,$1)) 121 122docker-image-debian-microblaze-cross: $(DOCKER_FILES_DIR)/debian-toolchain.docker \ 123 $(DOCKER_FILES_DIR)/debian-microblaze-cross.d/build-toolchain.sh 124 $(call debian-toolchain, $@) 125 126# These images may be good enough for building tests but not for test builds 127DOCKER_PARTIAL_IMAGES += debian-microblaze-cross 128DOCKER_PARTIAL_IMAGES += debian-xtensa-cross 129 130# images that are only used to build other images 131DOCKER_VIRTUAL_IMAGES := debian-bootstrap debian-toolchain 132 133__IMAGES := $(sort $(filter-out $(DOCKER_VIRTUAL_IMAGES), $(notdir $(basename $(wildcard $(DOCKER_FILES_DIR)/*.docker))))) 134DOCKER_IMAGES := $(if $(IMAGES), $(filter $(IMAGES), $(__IMAGES)), $(__IMAGES)) 135 136__TESTS := $(notdir $(shell find $(SRC_PATH)/tests/docker/ -name 'test-*' -type f)) 137DOCKER_TESTS := $(if $(TESTS), $(filter $(TESTS), $(__TESTS)), $(__TESTS)) 138 139# Expand all the pre-requistes for each docker image and test combination 140$(foreach i,$(filter-out $(DOCKER_PARTIAL_IMAGES),$(DOCKER_IMAGES)), \ 141 $(foreach t,$(DOCKER_TESTS), \ 142 $(eval .PHONY: docker-$t@$i) \ 143 $(eval docker-$t@$i: docker-image-$i; @$(MAKE) docker-run TEST=$t IMAGE=qemu/$i) \ 144 ) \ 145 $(foreach t,$(DOCKER_TESTS), \ 146 $(eval docker-all-tests: docker-$t@$i) \ 147 $(eval docker-$t: docker-$t@$i) \ 148 ) \ 149) 150 151docker: 152 @echo 'Build QEMU and run tests inside $(RUNC) containers' 153 @echo 154 @echo 'Available targets:' 155 @echo 156 @echo ' docker: Print this help.' 157 @echo ' docker-all-tests: Run all image/test combinations.' 158 @echo ' docker-TEST: Run "TEST" on all image combinations.' 159 @echo ' docker-clean: Kill and remove residual docker testing containers.' 160 @echo ' docker-TEST@IMAGE: Run "TEST" in container "IMAGE".' 161 @echo ' Note: "TEST" is one of the listed test name,' 162 @echo ' or a script name under $$QEMU_SRC/tests/docker/;' 163 @echo ' "IMAGE" is one of the listed container name.' 164 @echo ' docker-image: Build all images.' 165 @echo ' docker-image-IMAGE: Build image "IMAGE".' 166 @echo ' docker-run: For manually running a "TEST" with "IMAGE".' 167 @echo 168 @echo 'Available container images:' 169 @echo ' $(DOCKER_IMAGES)' 170 @echo 171 @echo 'Available tests:' 172 @echo ' $(DOCKER_TESTS)' 173 @echo 174 @echo 'Special variables:' 175 @echo ' TARGET_LIST=a,b,c Override target list in builds.' 176 @echo ' EXTRA_CONFIGURE_OPTS="..."' 177 @echo ' Extra configure options.' 178 @echo ' TEST_COMMAND="..." Override the default `make check` target.' 179 @echo ' IMAGES="a b c ..": Restrict available images to subset.' 180 @echo ' TESTS="x y z .." Restrict available tests to subset.' 181 @echo ' J=[0..9]* Overrides the -jN parameter for make commands' 182 @echo ' (default is 1)' 183 @echo ' DEBUG=1 Stop and drop to shell in the created container' 184 @echo ' before running the command.' 185 @echo ' NETWORK=1 Enable virtual network interface with default backend.' 186 @echo ' NETWORK=$$BACKEND Enable virtual network interface with $$BACKEND.' 187 @echo ' NOUSER=1 Define to disable adding current user to containers passwd.' 188 @echo ' NOCACHE=1 Ignore cache when build images.' 189 @echo ' NOFETCH=1 Do not fetch from the registry.' 190 @echo ' EXECUTABLE=<path> Include executable in image.' 191 @echo ' EXTRA_FILES="<path> [... <path>]"' 192 @echo ' Include extra files in image.' 193 @echo ' REGISTRY=url Cache builds from registry (default:$(DOCKER_REGISTRY))' 194 195docker-help: docker 196 197# Where QEMU caches build artefacts 198DOCKER_QEMU_CACHE_DIR := $$HOME/.cache/qemu 199# Use a global constant ccache directory to speed up repetitive builds 200DOCKER_QEMU_CCACHE_DIR := DOCKER_QEMU_CACHE_DIR/docker-ccache 201 202# This rule if for directly running against an arbitrary docker target. 203# It is called by the expanded docker targets (e.g. make 204# docker-test-foo@bar) which will also ensure the image is up to date. 205# 206# For example: make docker-run TEST="test-quick" IMAGE="debian:arm64" EXECUTABLE=./aarch64-linux-user/qemu-aarch64 207# 208docker-run: docker-qemu-src 209 @mkdir -p "$(DOCKER_QEMU_CCACHE_DIR)" 210 @if test -z "$(IMAGE)" || test -z "$(TEST)"; \ 211 then echo "Invalid target $(IMAGE)/$(TEST)"; exit 1; \ 212 fi 213 $(if $(EXECUTABLE), \ 214 $(call quiet-command, \ 215 $(DOCKER_SCRIPT) update \ 216 $(IMAGE) --executable $(EXECUTABLE), \ 217 " COPYING $(EXECUTABLE) to $(IMAGE)")) 218 $(call quiet-command, \ 219 $(RUNC) run \ 220 --rm \ 221 $(if $(NOUSER),, \ 222 $(if $(filter docker,$(RUNC)), \ 223 -u $(UID), \ 224 --userns keep-id \ 225 ) \ 226 ) \ 227 --security-opt seccomp=unconfined \ 228 $(if $(DEBUG),-ti,) \ 229 $(if $(NETWORK),$(if $(subst $(NETWORK),,1),--net=$(NETWORK)),--net=none) \ 230 -e TARGET_LIST=$(subst $(SPACE),$(COMMA),$(TARGET_LIST)) \ 231 -e EXTRA_CONFIGURE_OPTS="$(EXTRA_CONFIGURE_OPTS)" \ 232 -e TEST_COMMAND="$(TEST_COMMAND)" \ 233 -e V=$V -e J=$J -e DEBUG=$(DEBUG) \ 234 -e SHOW_ENV=$(SHOW_ENV) \ 235 $(if $(NOUSER),, \ 236 -v $(DOCKER_QEMU_CACHE_DIR):$(DOCKER_QEMU_CACHE_DIR) \ 237 -e CCACHE_DIR=$(DOCKER_QEMU_CCACHE_DIR) \ 238 ) \ 239 -v $$(readlink -e $(DOCKER_SRC_COPY)):/var/tmp/qemu:z$(COMMA)ro \ 240 $(IMAGE) \ 241 /var/tmp/qemu/run \ 242 $(TEST), " RUN $(TEST) in ${IMAGE}") 243 $(call quiet-command, rm -r $(DOCKER_SRC_COPY), \ 244 " CLEANUP $(DOCKER_SRC_COPY)") 245 246docker-image: ${DOCKER_IMAGES:%=docker-image-%} 247 248docker-verify: ${DOCKER_IMAGES:%=docker-verify-%} 249 250docker-clean: 251 $(call quiet-command, $(DOCKER_SCRIPT) clean) 252 253# Overrides 254docker-test-rust%: NETWORK=1 255