atf.test.mk revision 285092
1# $FreeBSD: stable/10/share/mk/atf.test.mk 285092 2015-07-03 14:22:44Z bapt $ 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 75USEPRIVATELIB+= atf-c 76TEST_INTERFACE.${_T}= atf 77.endfor 78.endif 79 80.if !empty(ATF_TESTS_CXX) 81PROGS_CXX+= ${ATF_TESTS_CXX} 82_TESTS+= ${ATF_TESTS_CXX} 83.for _T in ${ATF_TESTS_CXX} 84BINDIR.${_T}= ${TESTSDIR} 85MAN.${_T}?= # empty 86SRCS.${_T}?= ${_T}${CXX_SUFFIX:U.cc} 87DPADD.${_T}+= ${LIBATF_CXX} ${LIBATF_C} 88LDADD.${_T}+= -latf-c++ -latf-c 89USEPRIVATELIB+= atf-c++ 90TEST_INTERFACE.${_T}= atf 91.endfor 92.endif 93 94.if !empty(ATF_TESTS_SH) 95SCRIPTS+= ${ATF_TESTS_SH} 96_TESTS+= ${ATF_TESTS_SH} 97.for _T in ${ATF_TESTS_SH} 98SCRIPTSDIR_${_T}= ${TESTSDIR} 99TEST_INTERFACE.${_T}= atf 100CLEANFILES+= ${_T} ${_T}.tmp 101# TODO(jmmv): It seems to me that this SED and SRC functionality should 102# exist in bsd.prog.mk along the support for SCRIPTS. Move it there if 103# this proves to be useful within the tests. 104ATF_TESTS_SH_SED_${_T}?= # empty 105ATF_TESTS_SH_SRC_${_T}?= ${_T}.sh 106${_T}: ${ATF_TESTS_SH_SRC_${_T}} 107 echo '#! /usr/bin/env atf-sh' > ${.TARGET}.tmp 108.if empty(ATF_TESTS_SH_SED_${_T}) 109 cat ${.ALLSRC:N*Makefile*} >>${.TARGET}.tmp 110.else 111 cat ${.ALLSRC:N*Makefile*} \ 112 | sed ${ATF_TESTS_SH_SED_${_T}} >>${.TARGET}.tmp 113.endif 114 chmod +x ${.TARGET}.tmp 115 mv ${.TARGET}.tmp ${.TARGET} 116.endfor 117.endif 118 119.if ${ALLOW_DEPRECATED_ATF_TOOLS} != "no" 120 121.if ${ATFFILE:tl} != "no" 122FILES+= Atffile 123FILESDIR_Atffile= ${TESTSDIR} 124 125.if ${ATFFILE:tl} == "auto" 126CLEANFILES+= Atffile Atffile.tmp 127 128Atffile: Makefile 129 @{ echo 'Content-Type: application/X-atf-atffile; version="1"'; \ 130 echo; \ 131 echo '# Automatically generated by atf-test.mk.'; \ 132 echo; \ 133 echo 'prop: test-suite = "'${TESTSUITE}'"'; \ 134 echo; \ 135 for tp in ${ATF_TESTS_C} ${ATF_TESTS_CXX} ${ATF_TESTS_SH} \ 136 ${TESTS_SUBDIRS}; \ 137 do \ 138 echo "tp: $${tp}"; \ 139 done; } >Atffile.tmp 140 @mv Atffile.tmp Atffile 141.endif 142.endif 143 144ATF_REPORT?= ${ATF_PREFIX}/bin/atf-report 145ATF_RUN?= ${ATF_PREFIX}/bin/atf-run 146.if exists(${ATF_RUN}) && exists(${ATF_REPORT}) 147# Definition of the "make test" target and supporting variables. 148# 149# This target, by necessity, can only work for native builds (i.e. a freeBSD 150# host building a release for the same system). The target runs ATF, which is 151# not in the toolchain, and the tests execute code built for the target host. 152# 153# Due to the dependencies of the binaries built by the source tree and how they 154# are used by tests, it is highly possible for a execution of "make test" to 155# report bogus results unless the new binaries are put in place. 156_TESTS_FIFO= ${.OBJDIR}/atf-run.fifo 157_TESTS_LOG= ${.OBJDIR}/atf-run.log 158CLEANFILES+= ${_TESTS_FIFO} ${_TESTS_LOG} 159realtest: .PHONY 160 @set -e; \ 161 if [ -z "${TESTSDIR}" ]; then \ 162 echo "*** No TESTSDIR defined; nothing to do."; \ 163 exit 0; \ 164 fi; \ 165 cd ${DESTDIR}${TESTSDIR}; \ 166 rm -f ${_TESTS_FIFO}; \ 167 mkfifo ${_TESTS_FIFO}; \ 168 tee ${_TESTS_LOG} < ${_TESTS_FIFO} | ${TESTS_ENV} ${ATF_REPORT} & \ 169 set +e; \ 170 ${TESTS_ENV} ${ATF_RUN} >> ${_TESTS_FIFO}; \ 171 result=$${?}; \ 172 wait; \ 173 rm -f ${_TESTS_FIFO}; \ 174 echo; \ 175 echo "*** The verbatim output of atf-run has been saved to ${_TESTS_LOG}"; \ 176 echo "***"; \ 177 echo "*** WARNING: atf-run is deprecated; please install kyua instead"; \ 178 exit $${result} 179.endif 180 181.endif 182