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