[mirror_qemu.git] / tests / docker / Makefile.include

# Makefile for Docker tests

.PHONY: docker docker-test docker-clean docker-image docker-qemu-src

DOCKER_SUFFIX := .docker
DOCKER_FILES_DIR := $(SRC_PATH)/tests/docker/dockerfiles
DOCKER_IMAGES := $(notdir $(basename $(wildcard $(DOCKER_FILES_DIR)/*.docker)))
DOCKER_TARGETS := $(patsubst %,docker-image-%,$(DOCKER_IMAGES))
# Use a global constant ccache directory to speed up repetitive builds
DOCKER_CCACHE_DIR := $$HOME/.cache/qemu-docker-ccache

DOCKER_TESTS := $(notdir $(shell \
	find $(SRC_PATH)/tests/docker/ -name 'test-*' -type f))

DOCKER_TOOLS := travis

TESTS ?= %
IMAGES ?= %

# Make archive from git repo $1 to tar.gz $2
make-archive-maybe = $(if $(wildcard $1/*), \
	$(call quiet-command, \
		(cd $1; if git diff-index --quiet HEAD -- &>/dev/null; then \
			git archive -1 HEAD --format=tar.gz; \
		else \
			git archive -1 $$(git stash create) --format=tar.gz; \
		fi) > $2, \
		"ARCHIVE","$(notdir $2)"))

CUR_TIME := $(shell date +%Y-%m-%d-%H.%M.%S.$$$$)
DOCKER_SRC_COPY := docker-src.$(CUR_TIME)

$(DOCKER_SRC_COPY):
	@mkdir $@
	$(call make-archive-maybe, $(SRC_PATH), $@/qemu.tgz)
	$(call make-archive-maybe, $(SRC_PATH)/dtc, $@/dtc.tgz)
	$(call make-archive-maybe, $(SRC_PATH)/pixman, $@/pixman.tgz)
	$(call quiet-command, cp $(SRC_PATH)/tests/docker/run $@/run, \
		"COPY","RUNNER")

docker-qemu-src: $(DOCKER_SRC_COPY)

docker-image: ${DOCKER_TARGETS}

# General rule for building docker images
docker-image-%: $(DOCKER_FILES_DIR)/%.docker
	@if test "$@" = docker-image-debian-bootstrap -a -z "$(EXECUTABLE)"; then \
		echo WARNING: EXECUTABLE is not set, debootstrap may fail. 2>&1 ; \
	fi
	$(call quiet-command,\
		$(SRC_PATH)/tests/docker/docker.py build qemu:$* $< \
		$(if $V,,--quiet) $(if $(NOCACHE),--no-cache) \
		$(if $(NOUSER),,--add-current-user) \
		$(if $(EXTRA_FILES),--extra-files $(EXTRA_FILES))\
		$(if $(EXECUTABLE),--include-executable=$(EXECUTABLE)),\
		"BUILD","$*")

# Enforce dependancies for composite images
docker-image-debian-armhf-cross: docker-image-debian
docker-image-debian-arm64-cross: docker-image-debian
docker-image-debian-mipsel-cross: docker-image-debian

# Expand all the pre-requistes for each docker image and test combination
$(foreach i,$(DOCKER_IMAGES), \
	$(foreach t,$(DOCKER_TESTS) $(DOCKER_TOOLS), \
		$(eval .PHONY: docker-$t@$i) \
		$(eval docker-$t@$i: docker-image-$i docker-run-$t@$i) \
	) \
	$(foreach t,$(DOCKER_TESTS), \
		$(eval docker-test: docker-$t@$i) \
	) \
)

docker:
	@echo 'Build QEMU and run tests inside Docker containers'
	@echo
	@echo 'Available targets:'
	@echo
	@echo '    docker:              Print this help.'
	@echo '    docker-test:         Run all image/test combinations.'
	@echo '    docker-clean:        Kill and remove residual docker testing containers.'
	@echo '    docker-TEST@IMAGE:   Run "TEST" in container "IMAGE".'
	@echo '                         Note: "TEST" is one of the listed test name,'
	@echo '                         or a script name under $$QEMU_SRC/tests/docker/;'
	@echo '                         "IMAGE" is one of the listed container name."'
	@echo '    docker-image:        Build all images.'
	@echo '    docker-image-IMAGE:  Build image "IMAGE".'
	@echo '    docker-run:          For manually running a "TEST" with "IMAGE"'
	@echo
	@echo 'Available container images:'
	@echo '    $(DOCKER_IMAGES)'
	@echo
	@echo 'Available tests:'
	@echo '    $(DOCKER_TESTS)'
	@echo
	@echo 'Available tools:'
	@echo '    $(DOCKER_TOOLS)'
	@echo
	@echo 'Special variables:'
	@echo '    TARGET_LIST=a,b,c    Override target list in builds.'
	@echo '    EXTRA_CONFIGURE_OPTS="..."'
	@echo '                         Extra configure options.'
	@echo '    IMAGES="a b c ..":   Filters which images to build or run.'
	@echo '    TESTS="x y z .."     Filters which tests to run (for docker-test).'
	@echo '    J=[0..9]*            Overrides the -jN parameter for make commands'
	@echo '                         (default is 1)'
	@echo '    DEBUG=1              Stop and drop to shell in the created container'
	@echo '                         before running the command.'
	@echo '    NETWORK=1            Enable virtual network interface with default backend.'
	@echo '    NETWORK=$BACKEND     Enable virtual network interface with $BACKEND.'
	@echo '    NOUSER               Define to disable adding current user to containers passwd.'
	@echo '    NOCACHE=1            Ignore cache when build images.'
	@echo '    EXECUTABLE=<path>    Include executable in image.'
	@echo '    EXTRA_FILES="<path> [... <path>]"'
	@echo '                         Include extra files in image.'

# This rule if for directly running against an arbitrary docker target.
# It is called by the expanded docker targets (e.g. make
# docker-test-foo@bar) which will do additional verification.
#
# For example: make docker-run TEST="test-quick" IMAGE="debian:arm64" EXECUTABLE=./aarch64-linux-user/qemu-aarch64
#
docker-run: docker-qemu-src
	@mkdir -p "$(DOCKER_CCACHE_DIR)"
	@if test -z "$(IMAGE)" || test -z "$(TEST)"; \
		then echo "Invalid target $(IMAGE)/$(TEST)"; exit 1; \
	fi
	$(if $(EXECUTABLE),						\
		$(call quiet-command,					\
			$(SRC_PATH)/tests/docker/docker.py update 	\
			$(IMAGE) $(EXECUTABLE),				\
			"  COPYING $(EXECUTABLE) to $(IMAGE)"))
	$(call quiet-command,						\
		$(SRC_PATH)/tests/docker/docker.py run 			\
			$(if $(NOUSER),,-u $(shell id -u)) -t 		\
			$(if $V,,--rm) 					\
			$(if $(DEBUG),-i,)				\
			$(if $(NETWORK),$(if $(subst $(NETWORK),,1),--net=$(NETWORK)),--net=none) \
			-e TARGET_LIST=$(TARGET_LIST) 			\
			-e EXTRA_CONFIGURE_OPTS="$(EXTRA_CONFIGURE_OPTS)" \
			-e V=$V -e J=$J -e DEBUG=$(DEBUG)		\
			-e SHOW_ENV=$(SHOW_ENV) 			\
			-e CCACHE_DIR=/var/tmp/ccache 			\
			-v $$(readlink -e $(DOCKER_SRC_COPY)):/var/tmp/qemu:z$(COMMA)ro \
			-v $(DOCKER_CCACHE_DIR):/var/tmp/ccache:z 	\
			$(IMAGE) 					\
			/var/tmp/qemu/run 				\
			$(TEST), "  RUN $(TEST) in ${IMAGE}")

# Run targets:
#
# Of the form docker-TEST-FOO@IMAGE-BAR which will then be expanded into a call to "make docker-run"
docker-run-%: CMD = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\1/')
docker-run-%: IMAGE = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\2/')
docker-run-%:
	@$(MAKE) docker-run TEST=$(CMD) IMAGE=qemu:$(IMAGE)

docker-clean:
	$(call quiet-command, $(SRC_PATH)/tests/docker/docker.py clean)
Commit	Line	Data
324027c2 FZ	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 \
34c98c54	24	git archive -1 HEAD --format=tar.gz; \
324027c2	25	else \
34c98c54 PB	26	git archive -1 $$(git stash create) --format=tar.gz; \
34c98c54 PB	27	fi) > $2, \
0bdb12c7	28	"ARCHIVE","$(notdir $2)"))
324027c2 FZ	29
324027c2 FZ	30	CUR_TIME := $(shell date +%Y-%m-%d-%H.%M.%S.$$$$)
d5aebef8	31	DOCKER_SRC_COPY := docker-src.$(CUR_TIME)
324027c2 FZ	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, \
0bdb12c7	39	"COPY","RUNNER")
324027c2 FZ	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
a351b4b0 SS	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
324027c2 FZ	50	$(call quiet-command,\
324027c2 FZ	51	$(SRC_PATH)/tests/docker/docker.py build qemu:$* $< \
b7c851b2	52	$(if $V,,--quiet) $(if $(NOCACHE),--no-cache) \
414a8ce5	53	$(if $(NOUSER),,--add-current-user) \
4c84f662	54	$(if $(EXTRA_FILES),--extra-files $(EXTRA_FILES))\
b7c851b2	55	$(if $(EXECUTABLE),--include-executable=$(EXECUTABLE)),\
0bdb12c7	56	"BUILD","$*")
324027c2	57
24e0131f AB	58	# Enforce dependancies for composite images
	59	docker-image-debian-armhf-cross: docker-image-debian
	60	docker-image-debian-arm64-cross: docker-image-debian
2e1d6bdc	61	docker-image-debian-mipsel-cross: docker-image-debian
24e0131f	62
324027c2 FZ	63	# Expand all the pre-requistes for each docker image and test combination
	64	$(foreach i,$(DOCKER_IMAGES), \
	65	$(foreach t,$(DOCKER_TESTS) $(DOCKER_TOOLS), \
	66	$(eval .PHONY: docker-$t@$i) \
	67	$(eval docker-$t@$i: docker-image-$i docker-run-$t@$i) \
	68	) \
	69	$(foreach t,$(DOCKER_TESTS), \
	70	$(eval docker-test: docker-$t@$i) \
	71	) \
	72	)
	73
	74	docker:
	75	@echo 'Build QEMU and run tests inside Docker containers'
	76	@echo
	77	@echo 'Available targets:'
	78	@echo
	79	@echo ' docker: Print this help.'
	80	@echo ' docker-test: Run all image/test combinations.'
	81	@echo ' docker-clean: Kill and remove residual docker testing containers.'
	82	@echo ' docker-TEST@IMAGE: Run "TEST" in container "IMAGE".'
	83	@echo ' Note: "TEST" is one of the listed test name,'
	84	@echo ' or a script name under $$QEMU_SRC/tests/docker/;'
	85	@echo ' "IMAGE" is one of the listed container name."'
	86	@echo ' docker-image: Build all images.'
	87	@echo ' docker-image-IMAGE: Build image "IMAGE".'
e86c9a64	88	@echo ' docker-run: For manually running a "TEST" with "IMAGE"'
324027c2 FZ	89	@echo
	90	@echo 'Available container images:'
	91	@echo ' $(DOCKER_IMAGES)'
	92	@echo
	93	@echo 'Available tests:'
	94	@echo ' $(DOCKER_TESTS)'
	95	@echo
	96	@echo 'Available tools:'
	97	@echo ' $(DOCKER_TOOLS)'
	98	@echo
	99	@echo 'Special variables:'
	100	@echo ' TARGET_LIST=a,b,c Override target list in builds.'
35e0f959 FZ	101	@echo ' EXTRA_CONFIGURE_OPTS="..."'
35e0f959 FZ	102	@echo ' Extra configure options.'
324027c2 FZ	103	@echo ' IMAGES="a b c ..": Filters which images to build or run.'
	104	@echo ' TESTS="x y z .." Filters which tests to run (for docker-test).'
	105	@echo ' J=[0..9]* Overrides the -jN parameter for make commands'
	106	@echo ' (default is 1)'
	107	@echo ' DEBUG=1 Stop and drop to shell in the created container'
	108	@echo ' before running the command.'
8a2390a4 DB	109	@echo ' NETWORK=1 Enable virtual network interface with default backend.'
8a2390a4 DB	110	@echo ' NETWORK=$BACKEND Enable virtual network interface with $BACKEND.'
414a8ce5	111	@echo ' NOUSER Define to disable adding current user to containers passwd.'
324027c2	112	@echo ' NOCACHE=1 Ignore cache when build images.'
b7c851b2	113	@echo ' EXECUTABLE=<path> Include executable in image.'
4c84f662 PMD	114	@echo ' EXTRA_FILES="<path> [... <path>]"'
4c84f662 PMD	115	@echo ' Include extra files in image.'
324027c2	116
e86c9a64 AB	117	# This rule if for directly running against an arbitrary docker target.
	118	# It is called by the expanded docker targets (e.g. make
	119	# docker-test-foo@bar) which will do additional verification.
	120	#
	121	# For example: make docker-run TEST="test-quick" IMAGE="debian:arm64" EXECUTABLE=./aarch64-linux-user/qemu-aarch64
	122	#
	123	docker-run: docker-qemu-src
324027c2	124	@mkdir -p "$(DOCKER_CCACHE_DIR)"
e86c9a64 AB	125	@if test -z "$(IMAGE)" \|\| test -z "$(TEST)"; \
e86c9a64 AB	126	then echo "Invalid target $(IMAGE)/$(TEST)"; exit 1; \
324027c2	127	fi
e86c9a64 AB	128	$(if $(EXECUTABLE), \
	129	$(call quiet-command, \
	130	$(SRC_PATH)/tests/docker/docker.py update \
	131	$(IMAGE) $(EXECUTABLE), \
	132	" COPYING $(EXECUTABLE) to $(IMAGE)"))
	133	$(call quiet-command, \
	134	$(SRC_PATH)/tests/docker/docker.py run \
f9f65a4a	135	$(if $(NOUSER),,-u $(shell id -u)) -t \
e86c9a64	136	$(if $V,,--rm) \
8a2390a4 DB	137	$(if $(DEBUG),-i,) \
8a2390a4 DB	138	$(if $(NETWORK),$(if $(subst $(NETWORK),,1),--net=$(NETWORK)),--net=none) \
e86c9a64 AB	139	-e TARGET_LIST=$(TARGET_LIST) \
	140	-e EXTRA_CONFIGURE_OPTS="$(EXTRA_CONFIGURE_OPTS)" \
	141	-e V=$V -e J=$J -e DEBUG=$(DEBUG) \
	142	-e SHOW_ENV=$(SHOW_ENV) \
	143	-e CCACHE_DIR=/var/tmp/ccache \
	144	-v $$(readlink -e $(DOCKER_SRC_COPY)):/var/tmp/qemu:z$(COMMA)ro \
	145	-v $(DOCKER_CCACHE_DIR):/var/tmp/ccache:z \
	146	$(IMAGE) \
	147	/var/tmp/qemu/run \
	148	$(TEST), " RUN $(TEST) in ${IMAGE}")
	149
	150	# Run targets:
	151	#
	152	# Of the form docker-TEST-FOO@IMAGE-BAR which will then be expanded into a call to "make docker-run"
	153	docker-run-%: CMD = $(shell echo '$@' \| sed -e 's/docker-run-\([^@]\)@\(.\)/\1/')
	154	docker-run-%: IMAGE = $(shell echo '$@' \| sed -e 's/docker-run-\([^@]\)@\(.\)/\2/')
	155	docker-run-%:
	156	@$(MAKE) docker-run TEST=$(CMD) IMAGE=qemu:$(IMAGE)
324027c2 FZ	157
	158	docker-clean:
	159	$(call quiet-command, $(SRC_PATH)/tests/docker/docker.py clean)