xref: /qemu/tests/docker/Makefile.include (revision 814bb12a) 
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_IMAGES := $(notdir $(basename $(wildcard $(DOCKER_FILES_DIR)/*.docker)))
8DOCKER_TARGETS := $(patsubst %,docker-image-%,$(DOCKER_IMAGES))
9# Use a global constant ccache directory to speed up repetitive builds
10DOCKER_CCACHE_DIR := $$HOME/.cache/qemu-docker-ccache
11
12DOCKER_TESTS := $(notdir $(shell \
13	find $(SRC_PATH)/tests/docker/ -name 'test-*' -type f))
14
15DOCKER_TOOLS := travis
16
17TESTS ?= %
18IMAGES ?= %
19
20# Make archive from git repo $1 to tar.gz $2
21make-archive-maybe = $(if $(wildcard $1/*), \
22	$(call quiet-command, \
23		(cd $1; if git diff-index --quiet HEAD -- &>/dev/null; then \
24			git archive -1 HEAD --format=tar.gz; \
25		else \
26			git archive -1 $$(git stash create) --format=tar.gz; \
27		fi) > $2, \
28		"ARCHIVE","$(notdir $2)"))
29
30CUR_TIME := $(shell date +%Y-%m-%d-%H.%M.%S.$$$$)
31DOCKER_SRC_COPY := docker-src.$(CUR_TIME)
32
33$(DOCKER_SRC_COPY):
34	@mkdir $@
35	$(call make-archive-maybe, $(SRC_PATH), $@/qemu.tgz)
36	$(call make-archive-maybe, $(SRC_PATH)/dtc, $@/dtc.tgz)
37	$(call make-archive-maybe, $(SRC_PATH)/pixman, $@/pixman.tgz)
38	$(call quiet-command, cp $(SRC_PATH)/tests/docker/run $@/run, \
39		"COPY","RUNNER")
40
41docker-qemu-src: $(DOCKER_SRC_COPY)
42
43docker-image: ${DOCKER_TARGETS}
44
45# General rule for building docker images
46docker-image-%: $(DOCKER_FILES_DIR)/%.docker
47	@if test "$@" = docker-image-debian-bootstrap -a -z "$(EXECUTABLE)"; then \
48		echo WARNING: EXECUTABLE is not set, debootstrap may fail. 2>&1 ; \
49	fi
50	$(call quiet-command,\
51		$(SRC_PATH)/tests/docker/docker.py build qemu:$* $< \
52		$(if $V,,--quiet) $(if $(NOCACHE),--no-cache) \
53		$(if $(EXECUTABLE),--include-executable=$(EXECUTABLE)),\
54		"BUILD","$*")
55
56# Expand all the pre-requistes for each docker image and test combination
57$(foreach i,$(DOCKER_IMAGES), \
58	$(foreach t,$(DOCKER_TESTS) $(DOCKER_TOOLS), \
59		$(eval .PHONY: docker-$t@$i) \
60		$(eval docker-$t@$i: docker-image-$i docker-run-$t@$i) \
61	) \
62	$(foreach t,$(DOCKER_TESTS), \
63		$(eval docker-test: docker-$t@$i) \
64	) \
65)
66
67docker:
68	@echo 'Build QEMU and run tests inside Docker containers'
69	@echo
70	@echo 'Available targets:'
71	@echo
72	@echo '    docker:              Print this help.'
73	@echo '    docker-test:         Run all image/test combinations.'
74	@echo '    docker-clean:        Kill and remove residual docker testing containers.'
75	@echo '    docker-TEST@IMAGE:   Run "TEST" in container "IMAGE".'
76	@echo '                         Note: "TEST" is one of the listed test name,'
77	@echo '                         or a script name under $$QEMU_SRC/tests/docker/;'
78	@echo '                         "IMAGE" is one of the listed container name."'
79	@echo '    docker-image:        Build all images.'
80	@echo '    docker-image-IMAGE:  Build image "IMAGE".'
81	@echo '    docker-run:          For manually running a "TEST" with "IMAGE"'
82	@echo
83	@echo 'Available container images:'
84	@echo '    $(DOCKER_IMAGES)'
85	@echo
86	@echo 'Available tests:'
87	@echo '    $(DOCKER_TESTS)'
88	@echo
89	@echo 'Available tools:'
90	@echo '    $(DOCKER_TOOLS)'
91	@echo
92	@echo 'Special variables:'
93	@echo '    TARGET_LIST=a,b,c    Override target list in builds.'
94	@echo '    EXTRA_CONFIGURE_OPTS="..."'
95	@echo '                         Extra configure options.'
96	@echo '    IMAGES="a b c ..":   Filters which images to build or run.'
97	@echo '    TESTS="x y z .."     Filters which tests to run (for docker-test).'
98	@echo '    J=[0..9]*            Overrides the -jN parameter for make commands'
99	@echo '                         (default is 1)'
100	@echo '    DEBUG=1              Stop and drop to shell in the created container'
101	@echo '                         before running the command.'
102	@echo '    NOCACHE=1            Ignore cache when build images.'
103	@echo '    EXECUTABLE=<path>    Include executable in image.'
104
105# This rule if for directly running against an arbitrary docker target.
106# It is called by the expanded docker targets (e.g. make
107# docker-test-foo@bar) which will do additional verification.
108#
109# For example: make docker-run TEST="test-quick" IMAGE="debian:arm64" EXECUTABLE=./aarch64-linux-user/qemu-aarch64
110#
111docker-run: docker-qemu-src
112	@mkdir -p "$(DOCKER_CCACHE_DIR)"
113	@if test -z "$(IMAGE)" || test -z "$(TEST)"; \
114		then echo "Invalid target $(IMAGE)/$(TEST)"; exit 1; \
115	fi
116	$(if $(EXECUTABLE),						\
117		$(call quiet-command,					\
118			$(SRC_PATH)/tests/docker/docker.py update 	\
119			$(IMAGE) $(EXECUTABLE),				\
120			"  COPYING $(EXECUTABLE) to $(IMAGE)"))
121	$(call quiet-command,						\
122		$(SRC_PATH)/tests/docker/docker.py run 			\
123			-t 						\
124			$(if $V,,--rm) 					\
125			$(if $(DEBUG),-i,--net=none) 			\
126			-e TARGET_LIST=$(TARGET_LIST) 			\
127			-e EXTRA_CONFIGURE_OPTS="$(EXTRA_CONFIGURE_OPTS)" \
128			-e V=$V -e J=$J -e DEBUG=$(DEBUG)		\
129			-e SHOW_ENV=$(SHOW_ENV) 			\
130			-e CCACHE_DIR=/var/tmp/ccache 			\
131			-v $$(readlink -e $(DOCKER_SRC_COPY)):/var/tmp/qemu:z$(COMMA)ro \
132			-v $(DOCKER_CCACHE_DIR):/var/tmp/ccache:z 	\
133			$(IMAGE) 					\
134			/var/tmp/qemu/run 				\
135			$(TEST), "  RUN $(TEST) in ${IMAGE}")
136
137# Run targets:
138#
139# Of the form docker-TEST-FOO@IMAGE-BAR which will then be expanded into a call to "make docker-run"
140docker-run-%: CMD = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\1/')
141docker-run-%: IMAGE = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\2/')
142docker-run-%:
143	@$(MAKE) docker-run TEST=$(CMD) IMAGE=qemu:$(IMAGE)
144
145docker-clean:
146	$(call quiet-command, $(SRC_PATH)/tests/docker/docker.py clean)
147