xref: /freebsd/share/mk/atf.test.mk (revision 38f0b757fd84d17d0fc24739a7cda160c4516d81)
1# $FreeBSD$
2#
3# You must include bsd.test.mk instead of this file from your Makefile.
4#
5# Logic to build and install ATF test programs; i.e. test programs linked
6# against the ATF libraries.
7
8.if !target(__<bsd.test.mk>__)
9.error atf.test.mk cannot be included directly.
10.endif
11
12# List of C, C++ and shell test programs to build.
13#
14# Programs listed here are built using PROGS, PROGS_CXX and SCRIPTS,
15# respectively, from bsd.prog.mk.  However, the build rules are tweaked to
16# require the ATF libraries.
17#
18# Test programs registered in this manner are set to be installed into TESTSDIR
19# (which should be overriden by the Makefile) and are not required to provide a
20# manpage.
21ATF_TESTS_C?=
22ATF_TESTS_CXX?=
23ATF_TESTS_SH?=
24
25# Whether to allow using the deprecated ATF tools or not.
26#
27# If 'yes', this file will generate Atffiles when requested and will also
28# support using the deprecated atf-run tool to execute the tests.
29ALLOW_DEPRECATED_ATF_TOOLS?= no
30
31# Knob to control the handling of the Atffile for this Makefile.
32#
33# If 'yes', an Atffile exists in the source tree and is installed into
34# TESTSDIR.
35#
36# If 'auto', an Atffile is automatically generated based on the list of test
37# programs built by the Makefile and is installed into TESTSDIR.  This is the
38# default and is sufficient in the majority of the cases.
39#
40# If 'no', no Atffile is installed.
41ATFFILE?= auto
42
43# Path to the prefix of the installed ATF tools, if any.
44#
45# If atf-run and atf-report are installed from ports, we automatically define a
46# realtest target below to run the tests using these tools.  The tools are
47# searched for in the hierarchy specified by this variable.
48ATF_PREFIX?= /usr/local
49
50# C compiler passed to ATF tests that need to build code.
51ATF_BUILD_CC?= ${DESTDIR}/usr/bin/cc
52TESTS_ENV+= ATF_BUILD_CC=${ATF_BUILD_CC}
53
54# C preprocessor passed to ATF tests that need to build code.
55ATF_BUILD_CPP?= ${DESTDIR}/usr/bin/cpp
56TESTS_ENV+= ATF_BUILD_CPP=${ATF_BUILD_CPP}
57
58# C++ compiler passed to ATF tests that need to build code.
59ATF_BUILD_CXX?= ${DESTDIR}/usr/bin/c++
60TESTS_ENV+= ATF_BUILD_CXX=${ATF_BUILD_CXX}
61
62# Shell interpreter used to run atf-sh(1) based tests.
63ATF_SHELL?= ${DESTDIR}/bin/sh
64TESTS_ENV+= ATF_SHELL=${ATF_SHELL}
65
66.if !empty(ATF_TESTS_C)
67PROGS+= ${ATF_TESTS_C}
68_TESTS+= ${ATF_TESTS_C}
69.for _T in ${ATF_TESTS_C}
70BINDIR.${_T}= ${TESTSDIR}
71MAN.${_T}?= # empty
72SRCS.${_T}?= ${_T}.c
73DPADD.${_T}+= ${LIBATF_C}
74LDADD.${_T}+= -latf-c
75TEST_INTERFACE.${_T}= atf
76.endfor
77.endif
78
79.if !empty(ATF_TESTS_CXX)
80PROGS_CXX+= ${ATF_TESTS_CXX}
81_TESTS+= ${ATF_TESTS_CXX}
82.for _T in ${ATF_TESTS_CXX}
83BINDIR.${_T}= ${TESTSDIR}
84MAN.${_T}?= # empty
85SRCS.${_T}?= ${_T}${CXX_SUFFIX:U.cc}
86DPADD.${_T}+= ${LIBATF_CXX} ${LIBATF_C}
87LDADD.${_T}+= -latf-c++ -latf-c
88TEST_INTERFACE.${_T}= atf
89.endfor
90.endif
91
92.if !empty(ATF_TESTS_SH)
93SCRIPTS+= ${ATF_TESTS_SH}
94_TESTS+= ${ATF_TESTS_SH}
95.for _T in ${ATF_TESTS_SH}
96SCRIPTSDIR_${_T}= ${TESTSDIR}
97TEST_INTERFACE.${_T}= atf
98CLEANFILES+= ${_T} ${_T}.tmp
99ATF_TESTS_SH_SRC_${_T}?= ${_T}.sh
100${_T}: ${ATF_TESTS_SH_SRC_${_T}}
101	echo '#! /usr/bin/atf-sh' > ${.TARGET}.tmp
102	cat ${.ALLSRC} >> ${.TARGET}.tmp
103	chmod +x ${.TARGET}.tmp
104	mv ${.TARGET}.tmp ${.TARGET}
105.endfor
106.endif
107
108.if ${ALLOW_DEPRECATED_ATF_TOOLS} != "no"
109
110.if ${ATFFILE:tl} != "no"
111FILES+=	Atffile
112FILESDIR_Atffile= ${TESTSDIR}
113
114.if ${ATFFILE:tl} == "auto"
115CLEANFILES+= Atffile Atffile.tmp
116
117Atffile: Makefile
118	@{ echo 'Content-Type: application/X-atf-atffile; version="1"'; \
119	echo; \
120	echo '# Automatically generated by atf-test.mk.'; \
121	echo; \
122	echo 'prop: test-suite = "'${TESTSUITE}'"'; \
123	echo; \
124	for tp in ${ATF_TESTS_C} ${ATF_TESTS_CXX} ${ATF_TESTS_SH} \
125	    ${TESTS_SUBDIRS}; \
126	do \
127	    echo "tp: $${tp}"; \
128	done; } >Atffile.tmp
129	@mv Atffile.tmp Atffile
130.endif
131.endif
132
133ATF_REPORT?= ${ATF_PREFIX}/bin/atf-report
134ATF_RUN?= ${ATF_PREFIX}/bin/atf-run
135.if exists(${ATF_RUN}) && exists(${ATF_REPORT})
136# Definition of the "make test" target and supporting variables.
137#
138# This target, by necessity, can only work for native builds (i.e. a freeBSD
139# host building a release for the same system).  The target runs ATF, which is
140# not in the toolchain, and the tests execute code built for the target host.
141#
142# Due to the dependencies of the binaries built by the source tree and how they
143# are used by tests, it is highly possible for a execution of "make test" to
144# report bogus results unless the new binaries are put in place.
145_TESTS_FIFO= ${.OBJDIR}/atf-run.fifo
146_TESTS_LOG= ${.OBJDIR}/atf-run.log
147CLEANFILES+= ${_TESTS_FIFO} ${_TESTS_LOG}
148realtest: .PHONY
149	@set -e; \
150	if [ -z "${TESTSDIR}" ]; then \
151	    echo "*** No TESTSDIR defined; nothing to do."; \
152	    exit 0; \
153	fi; \
154	cd ${DESTDIR}${TESTSDIR}; \
155	rm -f ${_TESTS_FIFO}; \
156	mkfifo ${_TESTS_FIFO}; \
157	tee ${_TESTS_LOG} < ${_TESTS_FIFO} | ${TESTS_ENV} ${ATF_REPORT} & \
158	set +e; \
159	${TESTS_ENV} ${ATF_RUN} >> ${_TESTS_FIFO}; \
160	result=$${?}; \
161	wait; \
162	rm -f ${_TESTS_FIFO}; \
163	echo; \
164	echo "*** The verbatim output of atf-run has been saved to ${_TESTS_LOG}"; \
165	echo "***"; \
166	echo "*** WARNING: atf-run is deprecated; please install kyua instead"; \
167	exit $${result}
168.endif
169
170.endif
171