share/mk/atf.test.mk

   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.
  21 ATF_TESTS_C?=
  22 ATF_TESTS_CXX?=
  23 ATF_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.
  29 ALLOW_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.
  41 ATFFILE?= 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.
  48 ATF_PREFIX?= /usr/local
  49
  50 # C compiler passed to ATF tests that need to build code.
  51 ATF_BUILD_CC?= ${DESTDIR}/usr/bin/cc
  52 TESTS_ENV+= ATF_BUILD_CC=${ATF_BUILD_CC}
  53
  54 # C preprocessor passed to ATF tests that need to build code.
  55 ATF_BUILD_CPP?= ${DESTDIR}/usr/bin/cpp
  56 TESTS_ENV+= ATF_BUILD_CPP=${ATF_BUILD_CPP}
  57
  58 # C++ compiler passed to ATF tests that need to build code.
  59 ATF_BUILD_CXX?= ${DESTDIR}/usr/bin/c++
  60 TESTS_ENV+= ATF_BUILD_CXX=${ATF_BUILD_CXX}
  61
  62 # Shell interpreter used to run atf-sh(1) based tests.
  63 ATF_SHELL?= ${DESTDIR}/bin/sh
  64 TESTS_ENV+= ATF_SHELL=${ATF_SHELL}
  65
  66 .if !empty(ATF_TESTS_C)
  67 PROGS+= ${ATF_TESTS_C}
  68 _TESTS+= ${ATF_TESTS_C}
  69 .for _T in ${ATF_TESTS_C}
  70 BINDIR.${_T}= ${TESTSDIR}
  71 MAN.${_T}?= # empty
  72 SRCS.${_T}?= ${_T}.c
  73 DPADD.${_T}+= ${LIBATF_C}
  74 LDADD.${_T}+= -latf-c
  75 USEPRIVATELIB+= atf-c
  76 TEST_INTERFACE.${_T}= atf
  77 .endfor
  78 .endif
  79
  80 .if !empty(ATF_TESTS_CXX)
  81 PROGS_CXX+= ${ATF_TESTS_CXX}
  82 _TESTS+= ${ATF_TESTS_CXX}
  83 .for _T in ${ATF_TESTS_CXX}
  84 BINDIR.${_T}= ${TESTSDIR}
  85 MAN.${_T}?= # empty
  86 SRCS.${_T}?= ${_T}${CXX_SUFFIX:U.cc}
  87 DPADD.${_T}+= ${LIBATF_CXX} ${LIBATF_C}
  88 LDADD.${_T}+= -latf-c++ -latf-c
  89 USEPRIVATELIB+= atf-c++
  90 TEST_INTERFACE.${_T}= atf
  91 .endfor
  92 .endif
  93
  94 .if !empty(ATF_TESTS_SH)
  95 SCRIPTS+= ${ATF_TESTS_SH}
  96 _TESTS+= ${ATF_TESTS_SH}
  97 .for _T in ${ATF_TESTS_SH}
  98 SCRIPTSDIR_${_T}= ${TESTSDIR}
  99 TEST_INTERFACE.${_T}= atf
 100 CLEANFILES+= ${_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.
 104 ATF_TESTS_SH_SED_${_T}?= # empty
 105 ATF_TESTS_SH_SRC_${_T}?= ${_T}.sh
 106 ${_T}: ${ATF_TESTS_SH_SRC_${_T}}
 107         echo '#! /usr/libexec/atf-sh' > ${.TARGET}.tmp
 108         cat ${.ALLSRC:N*Makefile*} \
 109             | sed ${ATF_TESTS_SH_SED_${_T}} >>${.TARGET}.tmp
 110         chmod +x ${.TARGET}.tmp
 111         mv ${.TARGET}.tmp ${.TARGET}
 112 .endfor
 113 .endif
 114
 115 .if ${ALLOW_DEPRECATED_ATF_TOOLS} != "no"
 116
 117 .if ${ATFFILE:tl} != "no"
 118 FILES+= Atffile
 119 FILESDIR_Atffile= ${TESTSDIR}
 120
 121 .if ${ATFFILE:tl} == "auto"
 122 CLEANFILES+= Atffile Atffile.tmp
 123
 124 Atffile: Makefile
 125         @{ echo 'Content-Type: application/X-atf-atffile; version="1"'; \
 126         echo; \
 127         echo '# Automatically generated by atf-test.mk.'; \
 128         echo; \
 129         echo 'prop: test-suite = "'${TESTSUITE}'"'; \
 130         echo; \
 131         for tp in ${ATF_TESTS_C} ${ATF_TESTS_CXX} ${ATF_TESTS_SH} \
 132             ${TESTS_SUBDIRS}; \
 133         do \
 134             echo "tp: $${tp}"; \
 135         done; } >Atffile.tmp
 136         @mv Atffile.tmp Atffile
 137 .endif
 138 .endif
 139
 140 ATF_REPORT?= ${ATF_PREFIX}/bin/atf-report
 141 ATF_RUN?= ${ATF_PREFIX}/bin/atf-run
 142 .if exists(${ATF_RUN}) && exists(${ATF_REPORT})
 143 # Definition of the "make test" target and supporting variables.
 144 #
 145 # This target, by necessity, can only work for native builds (i.e. a freeBSD
 146 # host building a release for the same system).  The target runs ATF, which is
 147 # not in the toolchain, and the tests execute code built for the target host.
 148 #
 149 # Due to the dependencies of the binaries built by the source tree and how they
 150 # are used by tests, it is highly possible for a execution of "make test" to
 151 # report bogus results unless the new binaries are put in place.
 152 _TESTS_FIFO= ${.OBJDIR}/atf-run.fifo
 153 _TESTS_LOG= ${.OBJDIR}/atf-run.log
 154 CLEANFILES+= ${_TESTS_FIFO} ${_TESTS_LOG}
 155 realtest: .PHONY
 156         @set -e; \
 157         if [ -z "${TESTSDIR}" ]; then \
 158             echo "*** No TESTSDIR defined; nothing to do."; \
 159             exit 0; \
 160         fi; \
 161         cd ${DESTDIR}${TESTSDIR}; \
 162         rm -f ${_TESTS_FIFO}; \
 163         mkfifo ${_TESTS_FIFO}; \
 164         tee ${_TESTS_LOG} < ${_TESTS_FIFO} | ${TESTS_ENV} ${ATF_REPORT} & \
 165         set +e; \
 166         ${TESTS_ENV} ${ATF_RUN} >> ${_TESTS_FIFO}; \
 167         result=$${?}; \
 168         wait; \
 169         rm -f ${_TESTS_FIFO}; \
 170         echo; \
 171         echo "*** The verbatim output of atf-run has been saved to ${_TESTS_LOG}"; \
 172         echo "***"; \
 173         echo "*** WARNING: atf-run is deprecated; please install kyua instead"; \
 174         exit $${result}
 175 .endif
 176
 177 .endif