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