tests/Makefile.inc

   1 # SPDX-License-Identifier: GPL-2.0-only
   2
   3 # Place the build output in one of two places depending on COV, so that code
   4 # built with code coverage never mixes with code built without code coverage.
   5 ifeq ($(COV),1)
   6 testobj := $(obj)/coverage
   7 else
   8 testobj := $(obj)/tests
   9 endif
  10
  11 include $(top)/tests/Makefile.common
  12
  13 # Enable code coverage if COV=1
  14 ifeq ($(COV),1)
  15 TEST_CFLAGS += --coverage
  16 TEST_LDFLAGS += --coverage
  17 endif
  18
  19 stages := decompressor bootblock romstage smm verstage
  20 stages += ramstage rmodule postcar libagesa
  21
  22 alltests :=
  23 subdirs := tests/arch tests/acpi tests/commonlib tests/console tests/cpu
  24 subdirs += tests/device tests/drivers tests/ec tests/lib tests/mainboard
  25 subdirs += tests/northbridge tests/security tests/soc tests/southbridge
  26 subdirs += tests/superio tests/vendorcode
  27
  28 define tests-handler
  29 alltests += $(1)$(2)
  30 $(foreach attribute,$(attributes),
  31         $(eval $(1)$(2)-$(attribute) += $($(2)-$(attribute))))
  32 $(foreach attribute,$(attributes),
  33         $(eval $(2)-$(attribute) := ))
  34
  35 # Sanity check for stage attribute value
  36 $(eval $(1)$(2)-stage := $(if $($(1)$(2)-stage),$($(1)$(2)-stage),ramstage))
  37 $(if $(findstring $($(1)$(2)-stage), $(stages)),,
  38         $(error Wrong $(1)$(2)-stage value $($(1)$(2)-stage). \
  39                 Check your $(dir $(1)$(2))Makefile.inc))
  40 endef
  41
  42 $(call add-special-class, tests)
  43 $(call evaluate_subdirs)
  44
  45 $(foreach test, $(alltests), \
  46         $(eval $(test)-srcobjs := $(addprefix $(testobj)/$(test)/, \
  47                 $(patsubst %.c,%.o,$(filter src/%,$($(test)-srcs))))) \
  48         $(eval $(test)-objs := $(addprefix $(testobj)/$(test)/, \
  49                 $(patsubst %.c,%.o,$($(test)-srcs)))))
  50 $(foreach test, $(alltests), \
  51         $(eval $(test)-bin := $(testobj)/$(test)/run))
  52 $(foreach test, $(alltests), \
  53         $(eval $(call TEST_CC_template,$(test))))
  54
  55 $(foreach test, $(alltests), \
  56         $(eval all-test-objs += $($(test)-objs)))
  57 $(foreach test, $(alltests), \
  58         $(eval test-bins += $($(test)-bin)))
  59
  60 DEPENDENCIES += $(addsuffix .d,$(basename $(all-test-objs)))
  61 -include $(DEPENDENCIES)
  62
  63 .PHONY: $(alltests) $(addprefix clean-,$(alltests)) $(addprefix try-,$(alltests))
  64 .PHONY: $(addprefix build-,$(alltests)) $(addprefix run-,$(alltests))
  65 .PHONY: unit-tests build-unit-tests run-unit-tests clean-unit-tests
  66 .PHONY: junit.xml-unit-tests clean-junit.xml-unit-tests
  67
  68 # %g in CMOCKA_XML_FILE will be replaced with "__TEST_NAME__(<test-group-name>)"
  69 # by macro cb_run_group_tests(), which should be used for running tests.
  70 # __TEST_NAME__ contains test name including path e.g. tests_lib_rtc-test
  71 ifeq ($(JUNIT_OUTPUT),y)
  72 $(addprefix run-,$(alltests)): export CMOCKA_MESSAGE_OUTPUT=xml
  73 $(addprefix run-,$(alltests)): export CMOCKA_XML_FILE=$(testobj)/junit-%g.xml
  74 endif
  75
  76 $(addprefix run-,$(alltests)): run-%: $$(%-bin)
  77         rm -f $(testobj)/junit-$(subst /,_,$(patsubst $(testobj)/%/,%,$(dir $^)))\(*\).xml
  78         rm -f $(testobj)/$(subst /,_,$^).failed
  79         -$^ || echo failed > $(testobj)/$(subst /,_,$^).failed
  80
  81 $(addprefix build-,$(alltests)): build-%: $$(%-bin)
  82
  83 $(alltests): run-$$(@)
  84
  85 $(addprefix try-,$(alltests)): try-%: clean-% $(TEST_COMMON_DEPENDENCIES)
  86         mkdir -p $(testobj)/$*
  87         echo "<testcase classname='coreboot_build_unit_test' name='$*'>" >> $(testobj)/$*.tmp; \
  88         $(MAKE) V=$(V) Q=$(Q) COV=$(COV) JUNIT_OUTPUT=y "build-$*" >> $(testobj)/$*.tmp.2 2>&1 \
  89                 && type="system-out" || type="failure"; \
  90         if [ $$type = "failure" ]; then \
  91                 echo "<failure type='buildFailed'>" >> $(testobj)/$*.tmp; \
  92         else \
  93                 echo "<$$type>" >> $(testobj)/$*.tmp; \
  94         fi; \
  95         echo '<![CDATA[' >> $(testobj)/$*.tmp; \
  96         cat $(testobj)/$*.tmp.2 >> $(testobj)/$*.tmp; \
  97         echo "]]></$$type>" >> $(testobj)/$*.tmp; \
  98         rm -f $(testobj)/$*.tmp.2; \
  99         echo "</testcase>" >> $(testobj)/$*.tmp; \
 100         if [ $$type != 'failure' ]; then \
 101                 $(MAKE) V=$(V) Q=$(Q) COV=$(COV) JUNIT_OUTPUT=y "run-$*"; \
 102         fi
 103
 104
 105 TESTS_BUILD_XML_FILE := $(testobj)/junit-tests-build.xml
 106
 107 $(TESTS_BUILD_XML_FILE): clean-junit.xml-unit-tests $(addprefix try-,$(alltests))
 108         mkdir -p $(dir $@)
 109         echo '<?xml version="1.0" encoding="utf-8"?><testsuite>' > $@
 110         for tst in $(alltests); do \
 111                 cat $(testobj)/$$tst.tmp >> $@; \
 112         done
 113         echo "</testsuite>" >> $@
 114
 115 junit.xml-unit-tests: $(TESTS_BUILD_XML_FILE)
 116
 117 clean-junit.xml-unit-tests:
 118         rm -f $(TESTS_BUILD_XML_FILE)
 119
 120
 121 # Build a code coverage report by collecting all the gcov files into a single
 122 # report. If COV is not set, this might be a user error, and they're trying
 123 # to generate a coverage report without first having built and run the code
 124 # with code coverage. So instead of silently correcting it by adding COV=1,
 125 # let's flag it to the user so they can be sure they're doing the thing they
 126 # want to do.
 127
 128 .PHONY: coverage-report clean-coverage-report
 129
 130 ifeq ($(COV),1)
 131 coverage-report:
 132         lcov -o $(testobj)/tests.info -c -d $(testobj) --exclude '$(testsrc)/*'
 133         genhtml -q -o $(testobj)/$(coverage_dir) -t "coreboot unit tests" \
 134         -s $(testobj)/tests.info
 135
 136 clean-coverage-report:
 137         rm -Rf $(testobj)/$(coverage_dir)
 138 else
 139 coverage-report:
 140         COV=1 V=$(V) $(MAKE) coverage-report
 141
 142 clean-coverage-report:
 143         COV=1 V=$(V) $(MAKE) clean-coverage-report
 144 endif
 145
 146 unit-tests: build-unit-tests run-unit-tests
 147
 148 build-unit-tests: $(test-bins)
 149
 150 run-unit-tests: $(alltests)
 151         if [ `find $(testobj) -name '*.failed' | wc -l` -gt 0 ]; then \
 152                 echo "**********************"; \
 153                 echo "     TESTS FAILED"; \
 154                 echo "**********************"; \
 155                 exit 1; \
 156         else \
 157                 echo "**********************"; \
 158                 echo "   ALL TESTS PASSED"; \
 159                 echo "**********************"; \
 160                 exit 0; \
 161         fi
 162
 163 $(addprefix clean-,$(alltests)): clean-%:
 164         rm -rf $(testobj)/$*
 165
 166 clean-unit-tests:
 167         rm -rf $(testobj)
 168
 169 list-unit-tests:
 170         @echo "unit-tests:"
 171         for t in $(sort $(alltests)); do \
 172                 echo "  $$t"; \
 173         done
 174
 175 help-unit-tests help::
 176         @echo  '*** coreboot unit-tests targets ***'
 177         @echo  '  Use "COV=1 make [target]" to enable code coverage for unit tests'
 178         @echo  '  unit-tests            - Run all unit-tests from tests/'
 179         @echo  '  clean-unit-tests      - Remove unit-tests build artifacts'
 180         @echo  '  list-unit-tests       - List all unit-tests'
 181         @echo  '  <unit-test>           - Build and run single unit-test'
 182         @echo  '  clean-<unit-test>     - Remove single unit-test build artifacts'
 183         @echo  '  coverage-report       - Generate a code coverage report'
 184         @echo  '  clean-coverage-report - Remove the code coverage report'
 185         @echo