xref: /openbmc/qemu/tests/Makefile.include (revision 3cc70a99)
1# -*- Mode: makefile -*-
2
3.PHONY: check-help
4check-help:
5	@echo "Regression testing targets:"
6	@echo " $(MAKE) check                  Run block, qapi-schema, unit, softfloat, qtest and decodetree tests"
7	@echo " $(MAKE) bench                  Run speed tests"
8	@echo
9	@echo "Individual test suites:"
10	@echo " $(MAKE) check-qtest-TARGET     Run qtest tests for given target"
11	@echo " $(MAKE) check-qtest            Run qtest tests"
12	@echo " $(MAKE) check-unit             Run qobject tests"
13	@echo " $(MAKE) check-qapi-schema      Run QAPI schema tests"
14	@echo " $(MAKE) check-block            Run block tests"
15ifneq ($(filter $(all-check-targets), check-softfloat),)
16	@echo " $(MAKE) check-tcg              Run TCG tests"
17	@echo " $(MAKE) check-softfloat        Run FPU emulation tests"
18endif
19	@echo " $(MAKE) check-avocado          Run avocado (integration) tests for currently configured targets"
20	@echo
21	@echo " $(MAKE) check-report.junit.xml Generates an aggregated XML test report"
22	@echo " $(MAKE) check-venv             Creates a Python venv for tests"
23	@echo " $(MAKE) check-clean            Clean the tests and related data"
24	@echo
25	@echo "The following are useful for CI builds"
26	@echo " $(MAKE) check-build            Build most test binaries"
27	@echo " $(MAKE) get-vm-images          Downloads all images used by avocado tests, according to configured targets (~350 MB each, 1.5 GB max)"
28	@echo
29	@echo
30	@echo "The variable SPEED can be set to control the gtester speed setting."
31	@echo "Default options are -k and (for $(MAKE) V=1) --verbose; they can be"
32	@echo "changed with variable GTESTER_OPTIONS."
33
34ifneq ($(wildcard config-host.mak),)
35export SRC_PATH
36
37SPEED = quick
38
39# Per guest TCG tests
40BUILD_TCG_TARGET_RULES=$(patsubst %,build-tcg-tests-%, $(TCG_TESTS_TARGETS))
41CLEAN_TCG_TARGET_RULES=$(patsubst %,clean-tcg-tests-%, $(TCG_TESTS_TARGETS))
42DISTCLEAN_TCG_TARGET_RULES=$(patsubst %,distclean-tcg-tests-%, $(TCG_TESTS_TARGETS))
43RUN_TCG_TARGET_RULES=$(patsubst %,run-tcg-tests-%, $(TCG_TESTS_TARGETS))
44
45$(foreach TARGET,$(TCG_TESTS_TARGETS), \
46        $(eval $(BUILD_DIR)/tests/tcg/config-$(TARGET).mak: config-host.mak))
47
48.PHONY: $(TCG_TESTS_TARGETS:%=build-tcg-tests-%)
49$(TCG_TESTS_TARGETS:%=build-tcg-tests-%): build-tcg-tests-%: $(BUILD_DIR)/tests/tcg/config-%.mak
50	$(call quiet-command, \
51            $(MAKE) -C tests/tcg/$* $(SUBDIR_MAKEFLAGS), \
52        "BUILD","$* guest-tests")
53
54.PHONY: $(TCG_TESTS_TARGETS:%=run-tcg-tests-%)
55$(TCG_TESTS_TARGETS:%=run-tcg-tests-%): run-tcg-tests-%: build-tcg-tests-%
56	$(call quiet-command, \
57           $(MAKE) -C tests/tcg/$* $(SUBDIR_MAKEFLAGS) SPEED=$(SPEED) run, \
58        "RUN", "$* guest-tests")
59
60.PHONY: $(TCG_TESTS_TARGETS:%=clean-tcg-tests-%)
61$(TCG_TESTS_TARGETS:%=clean-tcg-tests-%): clean-tcg-tests-%:
62	$(call quiet-command, \
63           $(MAKE) -C tests/tcg/$* $(SUBDIR_MAKEFLAGS) clean, \
64        "CLEAN", "$* guest-tests")
65
66.PHONY: $(TCG_TESTS_TARGETS:%=distclean-tcg-tests-%)
67$(TCG_TESTS_TARGETS:%=distclean-tcg-tests-%): distclean-tcg-tests-%:
68	$(call quiet-command, \
69           $(MAKE) -C tests/tcg/$* $(SUBDIR_MAKEFLAGS) distclean, \
70        "CLEAN", "$* guest-tests")
71
72.PHONY: build-tcg
73build-tcg: $(BUILD_TCG_TARGET_RULES)
74
75.PHONY: check-tcg
76.ninja-goals.check-tcg = all $(if $(CONFIG_PLUGIN),test-plugins)
77check-tcg: $(RUN_TCG_TARGET_RULES)
78
79.PHONY: clean-tcg
80clean-tcg: $(CLEAN_TCG_TARGET_RULES)
81
82.PHONY: distclean-tcg
83distclean-tcg: $(DISTCLEAN_TCG_TARGET_RULES)
84
85# Python venv for running tests
86
87.PHONY: check-venv check-avocado check-acceptance check-acceptance-deprecated-warning
88
89# Build up our target list from the filtered list of ninja targets
90TARGETS=$(patsubst libqemu-%.fa, %, $(filter libqemu-%.fa, $(ninja-targets)))
91
92TESTS_VENV_DIR=$(BUILD_DIR)/tests/venv
93TESTS_VENV_REQ=$(SRC_PATH)/tests/requirements.txt
94TESTS_RESULTS_DIR=$(BUILD_DIR)/tests/results
95TESTS_PYTHON=$(TESTS_VENV_DIR)/bin/python3
96ifndef AVOCADO_TESTS
97	AVOCADO_TESTS=tests/avocado
98endif
99# Controls the output generated by Avocado when running tests.
100# Any number of command separated loggers are accepted.  For more
101# information please refer to "avocado --help".
102AVOCADO_SHOW=app
103ifndef AVOCADO_TAGS
104	AVOCADO_CMDLINE_TAGS=$(patsubst %-softmmu,-t arch:%, \
105						 $(filter %-softmmu,$(TARGETS)))
106else
107	AVOCADO_CMDLINE_TAGS=$(addprefix -t , $(AVOCADO_TAGS))
108endif
109
110quiet-venv-pip = $(quiet-@)$(call quiet-command-run, \
111    $(TESTS_PYTHON) -m pip -q --disable-pip-version-check $1, \
112    "VENVPIP","$1")
113
114$(TESTS_VENV_DIR): $(TESTS_VENV_REQ)
115	$(call quiet-command, $(PYTHON) -m venv $@, VENV, $@)
116	$(call quiet-venv-pip,install -e "$(SRC_PATH)/python/")
117	$(call quiet-venv-pip,install -r $(TESTS_VENV_REQ))
118	$(call quiet-command, touch $@)
119
120$(TESTS_RESULTS_DIR):
121	$(call quiet-command, mkdir -p $@, \
122            MKDIR, $@)
123
124check-venv: $(TESTS_VENV_DIR)
125
126FEDORA_31_ARCHES_TARGETS=$(patsubst %-softmmu,%, $(filter %-softmmu,$(TARGETS)))
127FEDORA_31_ARCHES_CANDIDATES=$(patsubst ppc64,ppc64le,$(FEDORA_31_ARCHES_TARGETS))
128FEDORA_31_ARCHES := x86_64 aarch64 ppc64le s390x
129FEDORA_31_DOWNLOAD=$(filter $(FEDORA_31_ARCHES),$(FEDORA_31_ARCHES_CANDIDATES))
130
131# download one specific Fedora 31 image
132get-vm-image-fedora-31-%: check-venv
133	$(call quiet-command, \
134             $(TESTS_PYTHON) -m avocado vmimage get \
135             --distro=fedora --distro-version=31 --arch=$*, \
136	"AVOCADO", "Downloading avocado tests VM image for $*")
137
138# download all vm images, according to defined targets
139get-vm-images: check-venv $(patsubst %,get-vm-image-fedora-31-%, $(FEDORA_31_DOWNLOAD))
140
141check-avocado: check-venv $(TESTS_RESULTS_DIR) get-vm-images
142	$(call quiet-command, \
143            $(TESTS_PYTHON) -m avocado \
144            --show=$(AVOCADO_SHOW) run --job-results-dir=$(TESTS_RESULTS_DIR) \
145            $(if $(AVOCADO_TAGS),, --filter-by-tags-include-empty \
146			--filter-by-tags-include-empty-key) \
147            $(AVOCADO_CMDLINE_TAGS) \
148            $(if $(GITLAB_CI),,--failfast) $(AVOCADO_TESTS), \
149            "AVOCADO", "tests/avocado")
150
151check-acceptance-deprecated-warning:
152	@echo
153	@echo "Note '$(MAKE) check-acceptance' is deprecated, use '$(MAKE) check-avocado' instead."
154	@echo
155
156check-acceptance: check-acceptance-deprecated-warning | check-avocado
157
158# Consolidated targets
159
160.PHONY: check check-clean get-vm-images
161check:
162
163check-build: run-ninja
164
165check-clean:
166	rm -rf $(TESTS_VENV_DIR) $(TESTS_RESULTS_DIR)
167
168clean: check-clean clean-tcg
169distclean: distclean-tcg
170
171endif
172