tests/docker/Makefile.include

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