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