MFC refactoring of the *.test.mk files.

- r263161 Make bsd.test.mk the only public mk fragment for the building of tests.
- r263172 Move FreeBSD Test Suite-specific code to a suite.test.mk file.
- r263204 Add some documentation for bsd.test.mk.
- r263217 Document support for TAP-compliant Perl test programs.

This is "make tinderbox" clean.

1 files changed, 17 insertions, 124 deletions

diff --git a/share/mk/bsd.test.mk b/share/mk/bsd.test.mk
index ee96f77..2e4b49d 100644
--- a/share/mk/bsd.test.mk
+++ b/share/mk/bsd.test.mk
@@ -2,23 +2,13 @@
 #
 # Generic build infrastructure for test programs.
 #
-# The code in this file is independent of the implementation of the test
-# programs being built; this file just provides generic infrastructure for the
-# build and the definition of various helper variables and targets.
-#
-# Makefiles should never include this file directly.  Instead, they should
-# include one of the various *.test.mk depending on the specific test programs
-# being built.
+# 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>
 
-# 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
+__<bsd.test.mk>__:
 
 # List of subdirectories containing tests into which to recurse.  This has the
 # same semantics as SUBDIR at build-time.  However, the directories listed here
@@ -29,31 +19,10 @@ TESTSUITE?= FreeBSD
 # 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"
+# If defined, indicates that the tests built by the Makefile are not part of
+# the FreeBSD Test Suite.  The implication of this is that the tests won't be
+# installed under /usr/tests/ and that Kyua won't be able to run them.
+#NOT_FOR_TEST_SUITE=
 
 # List of variables to pass to the tests at run-time via the environment.
 TESTS_ENV?=
@@ -67,17 +36,14 @@ TESTS_ENV+= PATH=${TESTS_PATH:tW:C/ +/:/g}
 TESTS_LD_LIBRARY_PATH+= ${DESTDIR}/lib ${DESTDIR}/usr/lib
 TESTS_ENV+= LD_LIBRARY_PATH=${TESTS_LD_LIBRARY_PATH:tW:C/ +/:/g}
 
-# List of all tests being built.  This variable is internal should not be
-# defined by the Makefile.  The various *.test.mk modules extend this variable
-# as needed.
-_TESTS?=
+# List of all tests being built.  The various *.test.mk modules extend this
+# variable as needed.
+_TESTS=
 
-# 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
+# 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}
@@ -93,82 +59,9 @@ WITHOUT_MAN=yes
 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
+.if !defined(NOT_FOR_TEST_SUITE)
+.include <suite.test.mk>
 .endif
-	@echo
 
 .if !target(realtest)
 realtest: .PHONY