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