blob: 74fd51c22c72f42fa00c0fb9d5d1d4292317f91d [file] [log] [blame]
Fam Zheng324027c2016-06-01 12:25:17 +08001# 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
Philippe Mathieu-Daudébcaf4572018-01-15 11:34:53 -03007DOCKER_DEPRECATED_IMAGES := debian
8DOCKER_IMAGES := $(filter-out $(DOCKER_DEPRECATED_IMAGES),$(sort $(notdir $(basename $(wildcard $(DOCKER_FILES_DIR)/*.docker)))))
Fam Zheng324027c2016-06-01 12:25:17 +08009DOCKER_TARGETS := $(patsubst %,docker-image-%,$(DOCKER_IMAGES))
10# Use a global constant ccache directory to speed up repetitive builds
11DOCKER_CCACHE_DIR := $$HOME/.cache/qemu-docker-ccache
12
13DOCKER_TESTS := $(notdir $(shell \
14 find $(SRC_PATH)/tests/docker/ -name 'test-*' -type f))
15
16DOCKER_TOOLS := travis
17
18TESTS ?= %
19IMAGES ?= %
20
Fam Zheng324027c2016-06-01 12:25:17 +080021CUR_TIME := $(shell date +%Y-%m-%d-%H.%M.%S.$$$$)
Paolo Bonzinibc739b82017-10-18 15:06:29 +020022DOCKER_SRC_COPY := $(BUILD_DIR)/docker-src.$(CUR_TIME)
Fam Zheng324027c2016-06-01 12:25:17 +080023
24$(DOCKER_SRC_COPY):
25 @mkdir $@
Paolo Bonzinibc739b82017-10-18 15:06:29 +020026 $(call quiet-command, cd $(SRC_PATH) && scripts/archive-source.sh $@/qemu.tar, \
Fam Zhengb7f40422017-09-05 10:12:01 +080027 "GEN", "$@/qemu.tar")
Fam Zheng324027c2016-06-01 12:25:17 +080028 $(call quiet-command, cp $(SRC_PATH)/tests/docker/run $@/run, \
Peter Maydell0bdb12c2016-10-04 17:27:21 +010029 "COPY","RUNNER")
Fam Zheng324027c2016-06-01 12:25:17 +080030
31docker-qemu-src: $(DOCKER_SRC_COPY)
32
33docker-image: ${DOCKER_TARGETS}
34
35# General rule for building docker images
36docker-image-%: $(DOCKER_FILES_DIR)/%.docker
Sascha Silbea351b4b2016-09-06 22:05:48 +020037 @if test "$@" = docker-image-debian-bootstrap -a -z "$(EXECUTABLE)"; then \
38 echo WARNING: EXECUTABLE is not set, debootstrap may fail. 2>&1 ; \
39 fi
Fam Zheng324027c2016-06-01 12:25:17 +080040 $(call quiet-command,\
41 $(SRC_PATH)/tests/docker/docker.py build qemu:$* $< \
Alex Bennéeb7c851b2016-07-19 21:20:45 +080042 $(if $V,,--quiet) $(if $(NOCACHE),--no-cache) \
Alex Bennée414a8ce2017-02-20 10:51:36 +000043 $(if $(NOUSER),,--add-current-user) \
Philippe Mathieu-Daudé4c84f662017-06-02 15:56:08 -030044 $(if $(EXTRA_FILES),--extra-files $(EXTRA_FILES))\
Alex Bennéeb7c851b2016-07-19 21:20:45 +080045 $(if $(EXECUTABLE),--include-executable=$(EXECUTABLE)),\
Peter Maydell0bdb12c2016-10-04 17:27:21 +010046 "BUILD","$*")
Fam Zheng324027c2016-06-01 12:25:17 +080047
Greg Kurz1dc17002017-10-19 13:40:42 +020048docker-image-debian-powerpc-cross: EXTRA_FILES:=$(SRC_PATH)/tests/docker/dockerfiles/debian-apt-fake.sh
Alex Bennée16dcece2017-07-17 21:31:51 -030049
Philippe Mathieu-Daudé9d5e5462018-05-08 11:43:58 -030050# Enforce dependencies for composite images
Philippe Mathieu-Daudé3e119742017-07-17 23:47:12 -030051docker-image-debian: docker-image-debian9
Philippe Mathieu-Daudé982e7582017-07-17 23:47:09 -030052docker-image-debian8-mxe: docker-image-debian8
Philippe Mathieu-Daudé15288042017-07-17 21:31:40 -030053docker-image-debian-amd64: docker-image-debian9
Philippe Mathieu-Daudé31e205d2017-07-17 21:31:38 -030054docker-image-debian-armel-cross: docker-image-debian9
Philippe Mathieu-Daudé24044d42017-07-17 21:31:33 -030055docker-image-debian-armhf-cross: docker-image-debian9
56docker-image-debian-arm64-cross: docker-image-debian9
Philippe Mathieu-Daudé4319db72017-07-17 21:31:53 -030057docker-image-debian-mips-cross: docker-image-debian9
Philippe Mathieu-Daudéfd7b2842017-07-17 21:31:55 -030058docker-image-debian-mips64el-cross: docker-image-debian9
Alex Bennée16dcece2017-07-17 21:31:51 -030059docker-image-debian-powerpc-cross: docker-image-debian8
Philippe Mathieu-Daudé2b1c10b2017-07-17 21:31:39 -030060docker-image-debian-ppc64el-cross: docker-image-debian9
Philippe Mathieu-Daudé7d2bcf22017-07-17 21:31:35 -030061docker-image-debian-s390x-cross: docker-image-debian9
Philippe Mathieu-Daudé982e7582017-07-17 23:47:09 -030062docker-image-debian-win32-cross: docker-image-debian8-mxe
63docker-image-debian-win64-cross: docker-image-debian8-mxe
Alex Bennée1fddbf72017-07-25 14:34:20 +010064docker-image-travis: NOUSER=1
Alex Bennée24e01312017-02-20 10:51:37 +000065
Philippe Mathieu-Daudé36dc5fe2018-05-01 21:21:43 -030066# Specialist build images, sometimes very limited tools
67docker-image-tricore-cross: docker-image-debian9
68
Fam Zheng324027c2016-06-01 12:25:17 +080069# Expand all the pre-requistes for each docker image and test combination
Philippe Mathieu-Daudébcaf4572018-01-15 11:34:53 -030070$(foreach i,$(DOCKER_IMAGES) $(DOCKER_DEPRECATED_IMAGES), \
Fam Zheng324027c2016-06-01 12:25:17 +080071 $(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
80docker:
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".'
Alex Bennéee86c9a62016-10-11 17:16:24 +010094 @echo ' docker-run: For manually running a "TEST" with "IMAGE"'
Fam Zheng324027c2016-06-01 12:25:17 +080095 @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.'
Fam Zheng35e0f952016-06-01 12:25:27 +0800107 @echo ' EXTRA_CONFIGURE_OPTS="..."'
108 @echo ' Extra configure options.'
Fam Zheng324027c2016-06-01 12:25:17 +0800109 @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.'
Daniel P. Berrange8a2390a2017-07-13 15:43:52 +0100115 @echo ' NETWORK=1 Enable virtual network interface with default backend.'
Philippe Mathieu-Daudé64237952017-11-07 23:47:19 -0300116 @echo ' NETWORK=$$BACKEND Enable virtual network interface with $$BACKEND.'
Alex Bennée414a8ce2017-02-20 10:51:36 +0000117 @echo ' NOUSER Define to disable adding current user to containers passwd.'
Fam Zheng324027c2016-06-01 12:25:17 +0800118 @echo ' NOCACHE=1 Ignore cache when build images.'
Alex Bennéeb7c851b2016-07-19 21:20:45 +0800119 @echo ' EXECUTABLE=<path> Include executable in image.'
Philippe Mathieu-Daudé4c84f662017-06-02 15:56:08 -0300120 @echo ' EXTRA_FILES="<path> [... <path>]"'
121 @echo ' Include extra files in image.'
Fam Zheng324027c2016-06-01 12:25:17 +0800122
Alex Bennéee86c9a62016-10-11 17:16:24 +0100123# 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#
129docker-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 \
Fam Zheng4b2c6bc2017-10-13 09:19:54 +0800141 $(if $(NOUSER),,-u $(shell id -u)) \
Fam Zheng44707492017-09-05 10:56:11 +0800142 --security-opt seccomp=unconfined \
Alex Bennéee86c9a62016-10-11 17:16:24 +0100143 $(if $V,,--rm) \
Fam Zheng4b2c6bc2017-10-13 09:19:54 +0800144 $(if $(DEBUG),-ti,) \
Daniel P. Berrange8a2390a2017-07-13 15:43:52 +0100145 $(if $(NETWORK),$(if $(subst $(NETWORK),,1),--net=$(NETWORK)),--net=none) \
Alex Bennée5609c512018-05-21 11:35:04 +0100146 -e TARGET_LIST=$(subst $(SPACE),$(COMMA),$(TARGET_LIST)) \
Alex Bennéee86c9a62016-10-11 17:16:24 +0100147 -e EXTRA_CONFIGURE_OPTS="$(EXTRA_CONFIGURE_OPTS)" \
148 -e V=$V -e J=$J -e DEBUG=$(DEBUG) \
149 -e SHOW_ENV=$(SHOW_ENV) \
Fam Zheng36ac78e2017-09-25 15:54:58 +0800150 $(if $(NOUSER),, \
151 -e CCACHE_DIR=/var/tmp/ccache \
152 -v $(DOCKER_CCACHE_DIR):/var/tmp/ccache:z \
153 ) \
Alex Bennéee86c9a62016-10-11 17:16:24 +0100154 -v $$(readlink -e $(DOCKER_SRC_COPY)):/var/tmp/qemu:z$(COMMA)ro \
Alex Bennéee86c9a62016-10-11 17:16:24 +0100155 $(IMAGE) \
156 /var/tmp/qemu/run \
157 $(TEST), " RUN $(TEST) in ${IMAGE}")
Peter Xu08c3f6d2017-10-17 15:12:46 +0800158 $(call quiet-command, rm -r $(DOCKER_SRC_COPY), \
159 " CLEANUP $(DOCKER_SRC_COPY)")
Alex Bennéee86c9a62016-10-11 17:16:24 +0100160
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"
Fam Zheng324027c2016-06-01 12:25:17 +0800164docker-run-%: CMD = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\1/')
165docker-run-%: IMAGE = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\2/')
Alex Bennéee86c9a62016-10-11 17:16:24 +0100166docker-run-%:
167 @$(MAKE) docker-run TEST=$(CMD) IMAGE=qemu:$(IMAGE)
Fam Zheng324027c2016-06-01 12:25:17 +0800168
169docker-clean:
170 $(call quiet-command, $(SRC_PATH)/tests/docker/docker.py clean)