f5fd950e35
Change {atf,plain,tap}.test.mk to be internal implementation details of
bsd.test.mk. Makefiles that build tests should now only include bsd.test.mk
and declaratively specify what they want to build, without worrying about
the internal implementation of the mk files.
The reason for this change is to permit building test programs of different
interfaces from a single directory, which is something I had a need for
while porting tests over from src/tools/regression/.
Additionally, this change makes it possible to perform some other requested
changes to bsd.test.mk in an easier manner. Coming soon.
200 lines
6.2 KiB
Makefile
200 lines
6.2 KiB
Makefile
# $FreeBSD$
|
|
#
|
|
# Generic build infrastructure for test programs.
|
|
#
|
|
# This is the only public file that should be included by Makefiles when
|
|
# tests are to be built. All other *.test.mk files are internal and not
|
|
# to be included directly.
|
|
|
|
.include <bsd.init.mk>
|
|
|
|
__<bsd.test.mk>__:
|
|
|
|
# Directory in which to install tests defined by the current Makefile.
|
|
# Makefiles have to override this to point to a subdirectory of TESTSBASE.
|
|
TESTSDIR?= .
|
|
|
|
# Name of the test suite these tests belong to. Should rarely be changed for
|
|
# Makefiles built into the FreeBSD src tree.
|
|
TESTSUITE?= FreeBSD
|
|
|
|
# List of subdirectories containing tests into which to recurse. This has the
|
|
# same semantics as SUBDIR at build-time. However, the directories listed here
|
|
# get registered into the run-time test suite definitions so that the test
|
|
# engines know to recurse into these directories.
|
|
#
|
|
# In other words: list here any directories that contain test programs but use
|
|
# SUBDIR for directories that may contain helper binaries and/or data files.
|
|
TESTS_SUBDIRS?=
|
|
|
|
# Knob to control the handling of the Kyuafile for this Makefile.
|
|
#
|
|
# If 'yes', a Kyuafile exists in the source tree and is installed into
|
|
# TESTSDIR.
|
|
#
|
|
# If 'auto', a Kyuafile is automatically generated based on the list of test
|
|
# programs built by the Makefile and is installed into TESTSDIR. This is the
|
|
# default and is sufficient in the majority of the cases.
|
|
#
|
|
# If 'no', no Kyuafile is installed.
|
|
KYUAFILE?= auto
|
|
|
|
# Per-test program interface definition.
|
|
#
|
|
# The name provided here must match one of the interface names supported by
|
|
# Kyua as this is later encoded in the Kyuafile test program definitions.
|
|
#TEST_INTERFACE.<test-program>= interface-name
|
|
|
|
# Per-test program metadata properties as a list of key/value pairs.
|
|
#
|
|
# All the variables for a particular program are appended to the program's
|
|
# definition in the Kyuafile. This feature can be used to avoid having to
|
|
# explicitly supply a Kyuafile in the source directory, allowing the caller
|
|
# Makefile to rely on the KYUAFILE=auto behavior defined here.
|
|
#TEST_METADATA.<test-program>+= key="value"
|
|
|
|
# List of variables to pass to the tests at run-time via the environment.
|
|
TESTS_ENV?=
|
|
|
|
# Ordered list of directories to construct the PATH for the tests.
|
|
TESTS_PATH+= ${DESTDIR}/bin ${DESTDIR}/sbin \
|
|
${DESTDIR}/usr/bin ${DESTDIR}/usr/sbin
|
|
TESTS_ENV+= PATH=${TESTS_PATH:tW:C/ +/:/g}
|
|
|
|
# Ordered list of directories to construct the LD_LIBRARY_PATH for the tests.
|
|
TESTS_LD_LIBRARY_PATH+= ${DESTDIR}/lib ${DESTDIR}/usr/lib
|
|
TESTS_ENV+= LD_LIBRARY_PATH=${TESTS_LD_LIBRARY_PATH:tW:C/ +/:/g}
|
|
|
|
# Path to the prefix of the installed Kyua CLI, if any.
|
|
#
|
|
# If kyua is installed from ports, we automatically define a realtest target
|
|
# below to run the tests using this tool. The tools are searched for in the
|
|
# hierarchy specified by this variable.
|
|
KYUA_PREFIX?= /usr/local
|
|
|
|
# List of all tests being built. The various *.test.mk modules extend this
|
|
# variable as needed.
|
|
_TESTS=
|
|
|
|
# Pull in the definitions of all supported test interfaces.
|
|
.include <atf.test.mk>
|
|
.include <plain.test.mk>
|
|
.include <tap.test.mk>
|
|
|
|
.if !empty(TESTS_SUBDIRS)
|
|
SUBDIR+= ${TESTS_SUBDIRS}
|
|
.endif
|
|
|
|
# it is rare for test cases to have man pages
|
|
.if !defined(MAN)
|
|
WITHOUT_MAN=yes
|
|
.export WITHOUT_MAN
|
|
.endif
|
|
|
|
# tell progs.mk we might want to install things
|
|
PROG_VARS+= BINDIR
|
|
PROGS_TARGETS+= install
|
|
|
|
.if ${KYUAFILE:tl} == "yes"
|
|
FILES+= Kyuafile
|
|
FILESDIR_Kyuafile= ${TESTSDIR}
|
|
|
|
CLEANFILES+= Kyuafile.auto Kyuafile.auto.tmp
|
|
.elif ${KYUAFILE:tl} == "auto"
|
|
FILES+= Kyuafile.auto
|
|
FILESDIR_Kyuafile.auto= ${TESTSDIR}
|
|
FILESNAME_Kyuafile.auto= Kyuafile
|
|
|
|
CLEANFILES+= Kyuafile.auto Kyuafile.auto.tmp
|
|
|
|
.NOPATH: Kyuafile.auto
|
|
Kyuafile.auto: Makefile
|
|
@{ \
|
|
echo '-- Automatically generated by bsd.test.mk.'; \
|
|
echo; \
|
|
echo 'syntax(2)'; \
|
|
echo; \
|
|
echo 'test_suite("${TESTSUITE}")'; \
|
|
echo; \
|
|
} >Kyuafile.auto.tmp
|
|
.for _T in ${_TESTS}
|
|
@echo '${TEST_INTERFACE.${_T}}_test_program{name="${_T}"${TEST_METADATA.${_T}:C/$/,/:tW:C/^/, /W:C/,$//W}}' \
|
|
>>Kyuafile.auto.tmp
|
|
.endfor
|
|
.for _T in ${TESTS_SUBDIRS:N.WAIT}
|
|
@echo "include(\"${_T}/Kyuafile\")" >>Kyuafile.auto.tmp
|
|
.endfor
|
|
@mv Kyuafile.auto.tmp Kyuafile.auto
|
|
.endif
|
|
|
|
KYUA?= ${KYUA_PREFIX}/bin/kyua
|
|
.if exists(${KYUA})
|
|
# Definition of the "make test" target and supporting variables.
|
|
#
|
|
# This target, by necessity, can only work for native builds (i.e. a FreeBSD
|
|
# host building a release for the same system). The target runs Kyua, which is
|
|
# not in the toolchain, and the tests execute code built for the target host.
|
|
#
|
|
# Due to the dependencies of the binaries built by the source tree and how they
|
|
# are used by tests, it is highly possible for a execution of "make test" to
|
|
# report bogus results unless the new binaries are put in place.
|
|
realtest: .PHONY
|
|
@echo "*** WARNING: make test is experimental"
|
|
@echo "***"
|
|
@echo "*** Using this test does not preclude you from running the tests"
|
|
@echo "*** installed in ${TESTSBASE}. This test run may raise false"
|
|
@echo "*** positives and/or false negatives."
|
|
@echo
|
|
@set -e; \
|
|
${KYUA} test -k ${DESTDIR}${TESTSDIR}/Kyuafile; \
|
|
result=0; \
|
|
echo; \
|
|
echo "*** Once again, note that "make test" is unsupported."; \
|
|
test $${result} -eq 0
|
|
.endif
|
|
|
|
beforetest: .PHONY
|
|
.if defined(TESTSDIR)
|
|
.if ${TESTSDIR} == ${TESTSBASE}
|
|
# Forbid running from ${TESTSBASE}. It can cause false positives/negatives and
|
|
# it does not cover all the tests (e.g. it misses testing software in external).
|
|
@echo "*** Sorry, you cannot use make test from src/tests. Install the"
|
|
@echo "*** tests into their final location and run them from ${TESTSBASE}"
|
|
@false
|
|
.else
|
|
@echo "*** Using this test does not preclude you from running the tests"
|
|
@echo "*** installed in ${TESTSBASE}. This test run may raise false"
|
|
@echo "*** positives and/or false negatives."
|
|
.endif
|
|
.else
|
|
@echo "*** No TESTSDIR defined; nothing to do."
|
|
@false
|
|
.endif
|
|
@echo
|
|
|
|
.if !target(realtest)
|
|
realtest: .PHONY
|
|
@echo "$@ not defined; skipping"
|
|
.endif
|
|
|
|
test: .PHONY
|
|
.ORDER: beforetest realtest
|
|
test: beforetest realtest
|
|
|
|
.if target(aftertest)
|
|
.ORDER: realtest aftertest
|
|
test: aftertest
|
|
.endif
|
|
|
|
.if !empty(SUBDIR)
|
|
.include <bsd.subdir.mk>
|
|
.endif
|
|
|
|
.if !empty(PROGS) || !empty(PROGS_CXX) || !empty(SCRIPTS)
|
|
.include <bsd.progs.mk>
|
|
.elif !empty(FILES)
|
|
.include <bsd.files.mk>
|
|
.endif
|
|
|
|
.include <bsd.obj.mk>
|