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