[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
	$(call quiet-command,\
		$(SRC_PATH)/tests/docker/docker.py build qemu:$* $< \
		$(if $V,,--quiet) $(if $(NOCACHE),--no-cache),\
		"  BUILD $*")

# 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
	@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 '    NOCACHE=1            Ignore cache when build images.'

docker-run-%: CMD = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\1/')
docker-run-%: IMAGE = $(shell echo '$@' | sed -e 's/docker-run-\([^@]*\)@\(.*\)/\2/')
docker-run-%: docker-qemu-src
	@mkdir -p "$(DOCKER_CCACHE_DIR)"
	@if test -z "$(IMAGE)" || test -z "$(CMD)"; \
		then echo "Invalid target"; exit 1; \
	fi
	$(if $(filter $(TESTS),$(CMD)),$(if $(filter $(IMAGES),$(IMAGE)), \
		$(call quiet-command,\
			$(SRC_PATH)/tests/docker/docker.py run $(if $V,,--rm) \
				-t \
				$(if $(DEBUG),-i,--net=none) \
				-e TARGET_LIST=$(TARGET_LIST) \
				-e EXTRA_CONFIGURE_OPTS=$(EXTRA_CONFIGURE_OPTS) \
				-e V=$V -e J=$J -e DEBUG=$(DEBUG)\
				-e CCACHE_DIR=/var/tmp/ccache \
				-v $$(realpath $(DOCKER_SRC_COPY)):/var/tmp/qemu:z$(COMMA)ro \
				-v $(DOCKER_CCACHE_DIR):/var/tmp/ccache:z \
				qemu:$(IMAGE) \
				/var/tmp/qemu/run \
				$(CMD); \
			, "  RUN $(CMD) in $(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, \
324027c2 FZ	28	" ARCHIVE $(notdir $2)"))
	29
	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, \
	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	$(call quiet-command,\
	48	$(SRC_PATH)/tests/docker/docker.py build qemu:$* $< \
	49	$(if $V,,--quiet) $(if $(NOCACHE),--no-cache),\
	50	" BUILD $*")
	51
	52	# Expand all the pre-requistes for each docker image and test combination
	53	$(foreach i,$(DOCKER_IMAGES), \
	54	$(foreach t,$(DOCKER_TESTS) $(DOCKER_TOOLS), \
	55	$(eval .PHONY: docker-$t@$i) \
	56	$(eval docker-$t@$i: docker-image-$i docker-run-$t@$i) \
	57	) \
	58	$(foreach t,$(DOCKER_TESTS), \
	59	$(eval docker-test: docker-$t@$i) \
	60	) \
	61	)
	62
	63	docker:
	64	@echo 'Build QEMU and run tests inside Docker containers'
	65	@echo
	66	@echo 'Available targets:'
	67	@echo
	68	@echo ' docker: Print this help.'
	69	@echo ' docker-test: Run all image/test combinations.'
	70	@echo ' docker-clean: Kill and remove residual docker testing containers.'
	71	@echo ' docker-TEST@IMAGE: Run "TEST" in container "IMAGE".'
	72	@echo ' Note: "TEST" is one of the listed test name,'
	73	@echo ' or a script name under $$QEMU_SRC/tests/docker/;'
	74	@echo ' "IMAGE" is one of the listed container name."'
	75	@echo ' docker-image: Build all images.'
	76	@echo ' docker-image-IMAGE: Build image "IMAGE".'
	77	@echo
	78	@echo 'Available container images:'
	79	@echo ' $(DOCKER_IMAGES)'
	80	@echo
	81	@echo 'Available tests:'
	82	@echo ' $(DOCKER_TESTS)'
	83	@echo
	84	@echo 'Available tools:'
	85	@echo ' $(DOCKER_TOOLS)'
	86	@echo
	87	@echo 'Special variables:'
	88	@echo ' TARGET_LIST=a,b,c Override target list in builds.'
35e0f959 FZ	89	@echo ' EXTRA_CONFIGURE_OPTS="..."'
35e0f959 FZ	90	@echo ' Extra configure options.'
324027c2 FZ	91	@echo ' IMAGES="a b c ..": Filters which images to build or run.'
	92	@echo ' TESTS="x y z .." Filters which tests to run (for docker-test).'
	93	@echo ' J=[0..9]* Overrides the -jN parameter for make commands'
	94	@echo ' (default is 1)'
	95	@echo ' DEBUG=1 Stop and drop to shell in the created container'
	96	@echo ' before running the command.'
	97	@echo ' NOCACHE=1 Ignore cache when build images.'
	98
	99	docker-run-%: CMD = $(shell echo '$@' \| sed -e 's/docker-run-\([^@]\)@\(.\)/\1/')
	100	docker-run-%: IMAGE = $(shell echo '$@' \| sed -e 's/docker-run-\([^@]\)@\(.\)/\2/')
	101	docker-run-%: docker-qemu-src
	102	@mkdir -p "$(DOCKER_CCACHE_DIR)"
	103	@if test -z "$(IMAGE)" \|\| test -z "$(CMD)"; \
	104	then echo "Invalid target"; exit 1; \
	105	fi
	106	$(if $(filter $(TESTS),$(CMD)),$(if $(filter $(IMAGES),$(IMAGE)), \
	107	$(call quiet-command,\
	108	$(SRC_PATH)/tests/docker/docker.py run $(if $V,,--rm) \
	109	-t \
	110	$(if $(DEBUG),-i,--net=none) \
	111	-e TARGET_LIST=$(TARGET_LIST) \
35e0f959	112	-e EXTRA_CONFIGURE_OPTS=$(EXTRA_CONFIGURE_OPTS) \
324027c2 FZ	113	-e V=$V -e J=$J -e DEBUG=$(DEBUG)\
	114	-e CCACHE_DIR=/var/tmp/ccache \
	115	-v $$(realpath $(DOCKER_SRC_COPY)):/var/tmp/qemu:z$(COMMA)ro \
	116	-v $(DOCKER_CCACHE_DIR):/var/tmp/ccache:z \
324027c2	117	qemu:$(IMAGE) \
c8158513	118	/var/tmp/qemu/run \
324027c2 FZ	119	$(CMD); \
	120	, " RUN $(CMD) in $(IMAGE)")))
	121
	122	docker-clean:
	123	$(call quiet-command, $(SRC_PATH)/tests/docker/docker.py clean)