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