xref: /freebsd/share/mk/suite.test.mk (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
1# $FreeBSD$
2#
3# You must include bsd.test.mk instead of this file from your Makefile.
4#
5# Internal glue for the build of /usr/tests/.
6
7.if !target(__<bsd.test.mk>__)
8.error suite.test.mk cannot be included directly.
9.endif
10
11# Name of the test suite these tests belong to.  Should rarely be changed for
12# Makefiles built into the FreeBSD src tree.
13TESTSUITE?= FreeBSD
14
15# Knob to control the handling of the Kyuafile for this Makefile.
16#
17# If 'yes', a Kyuafile exists in the source tree and is installed into
18# TESTSDIR.
19#
20# If 'auto', a Kyuafile is automatically generated based on the list of test
21# programs built by the Makefile and is installed into TESTSDIR.  This is the
22# default and is sufficient in the majority of the cases.
23#
24# If 'no', no Kyuafile is installed.
25KYUAFILE?= auto
26
27# Per-test program interface definition.
28#
29# The name provided here must match one of the interface names supported by
30# Kyua as this is later encoded in the Kyuafile test program definitions.
31#TEST_INTERFACE.<test-program>= interface-name
32
33# Metadata properties applicable to all test programs.
34#
35# All the variables for a test program defined in the Makefile are appended
36# to the test program's definition in the Kyuafile.  This feature can be
37# used to avoid having to explicitly supply a Kyuafile in the source
38# directory, allowing the caller Makefile to rely on the KYUAFILE=auto
39# behavior defined here.
40#TEST_METADATA+= key="value"
41
42# Per-test program metadata properties as a list of key/value pairs.
43#
44# These per-test program settings _extend_ the values provided in the
45# unqualified TEST_METADATA variable.
46#TEST_METADATA.<test-program>+= key="value"
47
48.if ${KYUAFILE:tl} != "no"
49FILES+=	Kyuafile
50FILESDIR_Kyuafile= ${TESTSDIR}
51.endif
52
53.for _T in ${_TESTS}
54_TEST_METADATA.${_T}= ${TEST_METADATA} ${TEST_METADATA.${_T}}
55.endfor
56
57.if ${KYUAFILE:tl} == "auto"
58CLEANFILES+= Kyuafile Kyuafile.tmp
59Kyuafile: Makefile
60	@{ \
61	    echo '-- Automatically generated by bsd.test.mk.'; \
62	    echo; \
63	    echo 'syntax(2)'; \
64	    echo; \
65	    echo 'test_suite("${TESTSUITE}")'; \
66            echo; \
67	} > ${.TARGET}.tmp
68.for _T in ${_TESTS}
69	@echo '${TEST_INTERFACE.${_T}}_test_program{name="${_T}"${_TEST_METADATA.${_T}:C/$/,/:tW:C/^/, /W:C/,$//W}}' \
70	    >>${.TARGET}.tmp
71.endfor
72.for _T in ${TESTS_SUBDIRS:N.WAIT}
73	@echo "include(\"${_T}/${.TARGET}\")" >>${.TARGET}.tmp
74.endfor
75	@mv ${.TARGET}.tmp ${.TARGET}
76.endif
77
78CHECKDIR?=	${DESTDIR}${TESTSDIR}
79
80KYUA= ${LOCALBASE}/bin/kyua
81
82# Definition of the "make check" target and supporting variables.
83#
84# This target, by necessity, can only work for native builds (i.e. a FreeBSD
85# host building a release for the same system).  The target runs Kyua, which is
86# not in the toolchain, and the tests execute code built for the target host.
87#
88# Due to the dependencies of the binaries built by the source tree and how they
89# are used by tests, it is highly possible for a execution of "make test" to
90# report bogus results unless the new binaries are put in place.
91
92realcheck: .PHONY
93	@if [ ! -x ${KYUA} ]; then \
94		echo; \
95		echo "kyua binary not installed at expected location (${.TARGET})"; \
96		echo; \
97		echo "Please install via pkg install, or specify the path to the kyua"; \
98		echo "package via the \$${LOCALBASE} variable, e.g. "; \
99		echo "LOCALBASE=\"${LOCALBASE}\""; \
100		false; \
101	fi
102	@${KYUA} test -k ${CHECKDIR}/Kyuafile
103