tests/qapi-schema/doc-good: Improve a comment
[qemu/armbru.git] / tests / Makefile.include
bloba4de0ad5a252a6d2e07b9513b2c159d72eba3055
1 # -*- Mode: makefile -*-
3 .PHONY: check-help
4 check-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"
15 ifneq ($(filter $(all-check-targets), check-softfloat),)
16         @echo " $(MAKE) check-tcg              Run TCG tests"
17         @echo " $(MAKE) check-softfloat        Run FPU emulation tests"
18 endif
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."
34 ifneq ($(wildcard config-host.mak),)
35 export SRC_PATH
37 SPEED = quick
39 # Per guest TCG tests
40 BUILD_TCG_TARGET_RULES=$(patsubst %,build-tcg-tests-%, $(TCG_TESTS_TARGETS))
41 CLEAN_TCG_TARGET_RULES=$(patsubst %,clean-tcg-tests-%, $(TCG_TESTS_TARGETS))
42 DISTCLEAN_TCG_TARGET_RULES=$(patsubst %,distclean-tcg-tests-%, $(TCG_TESTS_TARGETS))
43 RUN_TCG_TARGET_RULES=$(patsubst %,run-tcg-tests-%, $(TCG_TESTS_TARGETS))
45 $(foreach TARGET,$(TCG_TESTS_TARGETS), \
46         $(eval $(BUILD_DIR)/tests/tcg/config-$(TARGET).mak: config-host.mak))
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")
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")
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")
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")
72 .PHONY: build-tcg
73 build-tcg: $(BUILD_TCG_TARGET_RULES)
75 .PHONY: check-tcg
76 .ninja-goals.check-tcg = all $(if $(CONFIG_PLUGIN),test-plugins)
77 check-tcg: $(RUN_TCG_TARGET_RULES)
79 .PHONY: clean-tcg
80 clean-tcg: $(CLEAN_TCG_TARGET_RULES)
82 .PHONY: distclean-tcg
83 distclean-tcg: $(DISTCLEAN_TCG_TARGET_RULES)
85 # Python venv for running tests
87 .PHONY: check-venv check-avocado check-acceptance check-acceptance-deprecated-warning
89 # Build up our target list from the filtered list of ninja targets
90 TARGETS=$(patsubst libqemu-%.fa, %, $(filter libqemu-%.fa, $(ninja-targets)))
92 TESTS_VENV_DIR=$(BUILD_DIR)/tests/venv
93 TESTS_VENV_REQ=$(SRC_PATH)/tests/requirements.txt
94 TESTS_RESULTS_DIR=$(BUILD_DIR)/tests/results
95 TESTS_PYTHON=$(TESTS_VENV_DIR)/bin/python3
96 ifndef AVOCADO_TESTS
97         AVOCADO_TESTS=tests/avocado
98 endif
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".
102 AVOCADO_SHOW=app
103 ifndef AVOCADO_TAGS
104         AVOCADO_CMDLINE_TAGS=$(patsubst %-softmmu,-t arch:%, \
105                                                  $(filter %-softmmu,$(TARGETS)))
106 else
107         AVOCADO_CMDLINE_TAGS=$(addprefix -t , $(AVOCADO_TAGS))
108 endif
110 quiet-venv-pip = $(quiet-@)$(call quiet-command-run, \
111     $(TESTS_PYTHON) -m pip -q --disable-pip-version-check $1, \
112     "VENVPIP","$1")
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 $@)
120 $(TESTS_RESULTS_DIR):
121         $(call quiet-command, mkdir -p $@, \
122             MKDIR, $@)
124 check-venv: $(TESTS_VENV_DIR)
126 FEDORA_31_ARCHES_TARGETS=$(patsubst %-softmmu,%, $(filter %-softmmu,$(TARGETS)))
127 FEDORA_31_ARCHES_CANDIDATES=$(patsubst ppc64,ppc64le,$(FEDORA_31_ARCHES_TARGETS))
128 FEDORA_31_ARCHES := x86_64 aarch64 ppc64le s390x
129 FEDORA_31_DOWNLOAD=$(filter $(FEDORA_31_ARCHES),$(FEDORA_31_ARCHES_CANDIDATES))
131 # download one specific Fedora 31 image
132 get-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 $*")
138 # download all vm images, according to defined targets
139 get-vm-images: check-venv $(patsubst %,get-vm-image-fedora-31-%, $(FEDORA_31_DOWNLOAD))
141 JOBS_OPTION=$(lastword -j1 $(filter-out -j, $(filter -j%,$(MAKEFLAGS))))
143 check-avocado: check-venv $(TESTS_RESULTS_DIR) get-vm-images
144         $(call quiet-command,                                                   \
145             $(TESTS_PYTHON) -m avocado                                          \
146             --show=$(AVOCADO_SHOW) run --job-results-dir=$(TESTS_RESULTS_DIR)   \
147             $(if $(AVOCADO_TAGS),,                                              \
148                         --filter-by-tags-include-empty                          \
149                         --filter-by-tags-include-empty-key)                     \
150                 --max-parallel-tasks $(JOBS_OPTION:-j%=%)                       \
151             $(AVOCADO_CMDLINE_TAGS)                                             \
152             $(if $(GITLAB_CI),,--failfast) $(AVOCADO_TESTS),                    \
153             "AVOCADO", "tests/avocado")
155 check-acceptance-deprecated-warning:
156         @echo
157         @echo "Note '$(MAKE) check-acceptance' is deprecated, use '$(MAKE) check-avocado' instead."
158         @echo
160 check-acceptance: check-acceptance-deprecated-warning | check-avocado
162 # Consolidated targets
164 .PHONY: check check-clean get-vm-images
165 check:
167 check-build: run-ninja
169 check-clean:
170         rm -rf $(TESTS_VENV_DIR) $(TESTS_RESULTS_DIR)
172 clean: check-clean clean-tcg
173 distclean: distclean-tcg
175 endif