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 DOCKER_IMAGES := $(filter-out $(DOCKER_DEPRECATED_IMAGES),$(sort $(notdir $(basename $(wildcard $(DOCKER_FILES_DIR)/*.docker)))))
   9 DOCKER_TARGETS := $(patsubst %,docker-image-%,$(DOCKER_IMAGES))
  10 # Use a global constant ccache directory to speed up repetitive builds
  11 DOCKER_CCACHE_DIR := $$HOME/.cache/qemu-docker-ccache
  12
  13 DOCKER_TESTS := $(notdir $(shell \
  14         find $(SRC_PATH)/tests/docker/ -name 'test-*' -type f))
  15
  16 DOCKER_TOOLS := travis
  17
  18 TESTS ?= %
  19 IMAGES ?= %
  20
  21 CUR_TIME := $(shell date +%Y-%m-%d-%H.%M.%S.$$$$)
  22 DOCKER_SRC_COPY := $(BUILD_DIR)/docker-src.$(CUR_TIME)
  23
  24 $(DOCKER_SRC_COPY):
  25         @mkdir $@
  26         $(call quiet-command, cd $(SRC_PATH) && scripts/archive-source.sh $@/qemu.tar, \
  27                 "GEN", "$@/qemu.tar")
  28         $(call quiet-command, cp $(SRC_PATH)/tests/docker/run $@/run, \
  29                 "COPY","RUNNER")
  30
  31 docker-qemu-src: $(DOCKER_SRC_COPY)
  32
  33 docker-image: ${DOCKER_TARGETS}
  34
  35 # General rule for building docker images
  36 docker-image-%: $(DOCKER_FILES_DIR)/%.docker
  37         @if test "$@" = docker-image-debian-bootstrap -a -z "$(EXECUTABLE)"; then \
  38                 echo WARNING: EXECUTABLE is not set, debootstrap may fail. 2>&1 ; \
  39         fi
  40         $(call quiet-command,\
  41                 $(SRC_PATH)/tests/docker/docker.py build qemu:$* $< \
  42                 $(if $V,,--quiet) $(if $(NOCACHE),--no-cache) \
  43                 $(if $(NOUSER),,--add-current-user) \
  44                 $(if $(EXTRA_FILES),--extra-files $(EXTRA_FILES))\
  45                 $(if $(EXECUTABLE),--include-executable=$(EXECUTABLE)),\
  46                 "BUILD","$*")
  47
  48 docker-image-debian-powerpc-cross: EXTRA_FILES:=$(SRC_PATH)/tests/docker/dockerfiles/debian-apt-fake.sh
  49
  50 # Enforce dependencies for composite images
  51 docker-image-debian: docker-image-debian9
  52 docker-image-debian8-mxe: docker-image-debian8
  53 docker-image-debian-amd64: docker-image-debian9
  54 docker-image-debian-armel-cross: docker-image-debian9
  55 docker-image-debian-armhf-cross: docker-image-debian9
  56 docker-image-debian-arm64-cross: docker-image-debian9
  57 docker-image-debian-mips-cross: docker-image-debian9
  58 docker-image-debian-mips64el-cross: docker-image-debian9
  59 docker-image-debian-powerpc-cross: docker-image-debian8
  60 docker-image-debian-ppc64el-cross: docker-image-debian9
  61 docker-image-debian-s390x-cross: docker-image-debian9
  62 docker-image-debian-win32-cross: docker-image-debian8-mxe
  63 docker-image-debian-win64-cross: docker-image-debian8-mxe
  64 docker-image-travis: NOUSER=1
  65
  66 # Specialist build images, sometimes very limited tools
  67 docker-image-tricore-cross: docker-image-debian9
  68
  69 # Expand all the pre-requistes for each docker image and test combination
  70 $(foreach i,$(DOCKER_IMAGES) $(DOCKER_DEPRECATED_IMAGES), \
  71         $(foreach t,$(DOCKER_TESTS) $(DOCKER_TOOLS), \
  72                 $(eval .PHONY: docker-$t@$i) \
  73                 $(eval docker-$t@$i: docker-image-$i docker-run-$t@$i) \
  74         ) \
  75         $(foreach t,$(DOCKER_TESTS), \
  76                 $(eval docker-test: docker-$t@$i) \
  77         ) \
  78 )
  79
  80 docker:
  81         @echo 'Build QEMU and run tests inside Docker containers'
  82         @echo
  83         @echo 'Available targets:'
  84         @echo
  85         @echo '    docker:              Print this help.'
  86         @echo '    docker-test:         Run all image/test combinations.'
  87         @echo '    docker-clean:        Kill and remove residual docker testing containers.'
  88         @echo '    docker-TEST@IMAGE:   Run "TEST" in container "IMAGE".'
  89         @echo '                         Note: "TEST" is one of the listed test name,'
  90         @echo '                         or a script name under $$QEMU_SRC/tests/docker/;'
  91         @echo '                         "IMAGE" is one of the listed container name."'
  92         @echo '    docker-image:        Build all images.'
  93         @echo '    docker-image-IMAGE:  Build image "IMAGE".'
  94         @echo '    docker-run:          For manually running a "TEST" with "IMAGE"'
  95         @echo
  96         @echo 'Available container images:'
  97         @echo '    $(DOCKER_IMAGES)'
  98         @echo
  99         @echo 'Available tests:'
 100         @echo '    $(DOCKER_TESTS)'
 101         @echo
 102         @echo 'Available tools:'
 103         @echo '    $(DOCKER_TOOLS)'
 104         @echo
 105         @echo 'Special variables:'
 106         @echo '    TARGET_LIST=a,b,c    Override target list in builds.'
 107         @echo '    EXTRA_CONFIGURE_OPTS="..."'
 108         @echo '                         Extra configure options.'
 109         @echo '    IMAGES="a b c ..":   Filters which images to build or run.'
 110         @echo '    TESTS="x y z .."     Filters which tests to run (for docker-test).'
 111         @echo '    J=[0..9]*            Overrides the -jN parameter for make commands'
 112         @echo '                         (default is 1)'
 113         @echo '    DEBUG=1              Stop and drop to shell in the created container'
 114         @echo '                         before running the command.'
 115         @echo '    NETWORK=1            Enable virtual network interface with default backend.'
 116         @echo '    NETWORK=$$BACKEND     Enable virtual network interface with $$BACKEND.'
 117         @echo '    NOUSER               Define to disable adding current user to containers passwd.'
 118         @echo '    NOCACHE=1            Ignore cache when build images.'
 119         @echo '    EXECUTABLE=<path>    Include executable in image.'
 120         @echo '    EXTRA_FILES="<path> [... <path>]"'
 121         @echo '                         Include extra files in image.'
 122
 123 # This rule if for directly running against an arbitrary docker target.
 124 # It is called by the expanded docker targets (e.g. make
 125 # docker-test-foo@bar) which will do additional verification.
 126 #
 127 # For example: make docker-run TEST="test-quick" IMAGE="debian:arm64" EXECUTABLE=./aarch64-linux-user/qemu-aarch64
 128 #
 129 docker-run: docker-qemu-src
 130         @mkdir -p "$(DOCKER_CCACHE_DIR)"
 131         @if test -z "$(IMAGE)" || test -z "$(TEST)"; \
 132                 then echo "Invalid target $(IMAGE)/$(TEST)"; exit 1; \
 133         fi
 134         $(if $(EXECUTABLE),                                             \
 135                 $(call quiet-command,                                   \
 136                         $(SRC_PATH)/tests/docker/docker.py update       \
 137                         $(IMAGE) $(EXECUTABLE),                         \
 138                         "  COPYING $(EXECUTABLE) to $(IMAGE)"))
 139         $(call quiet-command,                                           \
 140                 $(SRC_PATH)/tests/docker/docker.py run                  \
 141                         $(if $(NOUSER),,-u $(shell id -u))              \
 142                         --security-opt seccomp=unconfined               \
 143                         $(if $V,,--rm)                                  \
 144                         $(if $(DEBUG),-ti,)                             \
 145                         $(if $(NETWORK),$(if $(subst $(NETWORK),,1),--net=$(NETWORK)),--net=none) \
 146                         -e TARGET_LIST=$(subst $(SPACE),$(COMMA),$(TARGET_LIST))        \
 147                         -e EXTRA_CONFIGURE_OPTS="$(EXTRA_CONFIGURE_OPTS)" \
 148                         -e V=$V -e J=$J -e DEBUG=$(DEBUG)               \
 149                         -e SHOW_ENV=$(SHOW_ENV)                         \
 150                         $(if $(NOUSER),,                                \
 151                                 -e CCACHE_DIR=/var/tmp/ccache           \
 152                                 -v $(DOCKER_CCACHE_DIR):/var/tmp/ccache:z \
 153                         )                                               \
 154                         -v $$(readlink -e $(DOCKER_SRC_COPY)):/var/tmp/qemu:z$(COMMA)ro \
 155                         $(IMAGE)                                        \
 156                         /var/tmp/qemu/run                               \
 157                         $(TEST), "  RUN $(TEST) in ${IMAGE}")
 158         $(call quiet-command, rm -r $(DOCKER_SRC_COPY), \
 159                 "  CLEANUP $(DOCKER_SRC_COPY)")
 160
 161 # Run targets:
 162 #
 163 # Of the form docker-TEST-FOO@IMAGE-BAR which will then be expanded into a call to "make docker-run"
 164 docker-run-%: CMD = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\1/')
 165 docker-run-%: IMAGE = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\2/')
 166 docker-run-%:
 167         @$(MAKE) docker-run TEST=$(CMD) IMAGE=qemu:$(IMAGE)
 168
 169 docker-clean:
 170         $(call quiet-command, $(SRC_PATH)/tests/docker/docker.py clean)