tests/docker/Makefile.include

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