Integrate the tests from libxo into the FreeBSD test suite

The functional_test.sh harness for each test subdir was inspired
by the version in bin/sh/tests/functional_test.sh

Some gymnastics were required to deal with implicit rules for
.c / .o -> .out as the suffix transformation rules were
incorrectly trying to create the test outputs from some of the
source files

Sponsored by: EMC / Isilon Storage Division

7 files changed, 457 insertions, 0 deletions

diff --git a/etc/mtree/BSD.tests.dist b/etc/mtree/BSD.tests.dist
index 8ff6189..7e7b8b5 100644
--- a/etc/mtree/BSD.tests.dist
+++ b/etc/mtree/BSD.tests.dist
@@ -310,6 +310,8 @@
         ..
         libutil
         ..
+        libxo
+        ..
         msun
         ..
     ..
@@ -568,6 +570,8 @@
         ..
         xargs
         ..
+        xo
+        ..
         yacc
             yacc
             ..
diff --git a/lib/libxo/Makefile b/lib/libxo/Makefile
index 05f5f27..fd0ba91 100644
--- a/lib/libxo/Makefile
+++ b/lib/libxo/Makefile
@@ -1,5 +1,7 @@
 # $FreeBSD$
 
+.include <src.opts.mk>
+
 LIBXOSRC=	${SRCTOP}/contrib/libxo
 
 .PATH:	${LIBXOSRC}/libxo
@@ -102,4 +104,8 @@ MLINKS=	xo_attr.3 xo_attr_h.3 \
 	xo_syslog.3 xo_set_logmask.3 \
 	xo_syslog.3 xo_vsyslog.3
 
+.if ${MK_TESTS} != "no"
+SUBDIR+=	tests
+.endif
+
 .include <bsd.lib.mk>
diff --git a/lib/libxo/tests/Makefile b/lib/libxo/tests/Makefile
new file mode 100644
index 0000000..bf27552
--- /dev/null
+++ b/lib/libxo/tests/Makefile
@@ -0,0 +1,253 @@
+# $FreeBSD$
+
+.include <bsd.own.mk>
+
+LIBXOSRC=	${SRCTOP}/contrib/libxo
+
+# Override the default suffix transformation rules for .c/.o -> .out
+.SUFFIXES:
+.SUFFIXES: .c .err .o .out .sh
+
+.PATH:
+.PATH.c: ${LIBXOSRC}/libxo ${LIBXOSRC}/tests/core
+.PATH.err: ${LIBXOSRC}/tests/core/saved
+.PATH.out: ${LIBXOSRC}/tests/core/saved
+
+.c.out .o.out:
+
+TESTSDIR=	${TESTSBASE}/lib/libxo
+
+ATF_TESTS_SH+=	functional_test
+
+BINDIR=	${TESTSDIR}
+
+FILES+= test_01.E.err
+FILES+= test_01.E.out
+FILES+= test_01.H.err
+FILES+= test_01.H.out
+FILES+= test_01.HIPx.err
+FILES+= test_01.HIPx.out
+FILES+= test_01.HP.err
+FILES+= test_01.HP.out
+FILES+= test_01.J.err
+FILES+= test_01.J.out
+FILES+= test_01.JP.err
+FILES+= test_01.JP.out
+FILES+= test_01.T.err
+FILES+= test_01.T.out
+FILES+= test_01.X.err
+FILES+= test_01.X.out
+FILES+= test_01.XP.err
+FILES+= test_01.XP.out
+FILES+= test_01.err
+FILES+= test_01.out
+FILES+= test_02.E.err
+FILES+= test_02.E.out
+FILES+= test_02.H.err
+FILES+= test_02.H.out
+FILES+= test_02.HIPx.err
+FILES+= test_02.HIPx.out
+FILES+= test_02.HP.err
+FILES+= test_02.HP.out
+FILES+= test_02.J.err
+FILES+= test_02.J.out
+FILES+= test_02.JP.err
+FILES+= test_02.JP.out
+FILES+= test_02.T.err
+FILES+= test_02.T.out
+FILES+= test_02.X.err
+FILES+= test_02.X.out
+FILES+= test_02.XP.err
+FILES+= test_02.XP.out
+FILES+= test_02.err
+FILES+= test_02.out
+FILES+= test_03.E.err
+FILES+= test_03.E.out
+FILES+= test_03.H.err
+FILES+= test_03.H.out
+FILES+= test_03.HIPx.err
+FILES+= test_03.HIPx.out
+FILES+= test_03.HP.err
+FILES+= test_03.HP.out
+FILES+= test_03.J.err
+FILES+= test_03.J.out
+FILES+= test_03.JP.err
+FILES+= test_03.JP.out
+FILES+= test_03.T.err
+FILES+= test_03.T.out
+FILES+= test_03.X.err
+FILES+= test_03.X.out
+FILES+= test_03.XP.err
+FILES+= test_03.XP.out
+FILES+= test_03.err
+FILES+= test_03.out
+FILES+= test_04.E.err
+FILES+= test_04.E.out
+FILES+= test_04.H.err
+FILES+= test_04.H.out
+FILES+= test_04.HIPx.err
+FILES+= test_04.HIPx.out
+FILES+= test_04.HP.err
+FILES+= test_04.HP.out
+FILES+= test_04.J.err
+FILES+= test_04.J.out
+FILES+= test_04.JP.err
+FILES+= test_04.JP.out
+FILES+= test_04.T.err
+FILES+= test_04.T.out
+FILES+= test_04.X.err
+FILES+= test_04.X.out
+FILES+= test_04.XP.err
+FILES+= test_04.XP.out
+FILES+= test_05.E.err
+FILES+= test_05.E.out
+FILES+= test_05.H.err
+FILES+= test_05.H.out
+FILES+= test_05.HIPx.err
+FILES+= test_05.HIPx.out
+FILES+= test_05.HP.err
+FILES+= test_05.HP.out
+FILES+= test_05.J.err
+FILES+= test_05.J.out
+FILES+= test_05.JP.err
+FILES+= test_05.JP.out
+FILES+= test_05.T.err
+FILES+= test_05.T.out
+FILES+= test_05.X.err
+FILES+= test_05.X.out
+FILES+= test_05.XP.err
+FILES+= test_05.XP.out
+FILES+= test_06.E.err
+FILES+= test_06.E.out
+FILES+= test_06.H.err
+FILES+= test_06.H.out
+FILES+= test_06.HIPx.err
+FILES+= test_06.HIPx.out
+FILES+= test_06.HP.err
+FILES+= test_06.HP.out
+FILES+= test_06.J.err
+FILES+= test_06.J.out
+FILES+= test_06.JP.err
+FILES+= test_06.JP.out
+FILES+= test_06.T.err
+FILES+= test_06.T.out
+FILES+= test_06.X.err
+FILES+= test_06.X.out
+FILES+= test_06.XP.err
+FILES+= test_06.XP.out
+FILES+= test_07.E.err
+FILES+= test_07.E.out
+FILES+= test_07.H.err
+FILES+= test_07.H.out
+FILES+= test_07.HIPx.err
+FILES+= test_07.HIPx.out
+FILES+= test_07.HP.err
+FILES+= test_07.HP.out
+FILES+= test_07.J.err
+FILES+= test_07.J.out
+FILES+= test_07.JP.err
+FILES+= test_07.JP.out
+FILES+= test_07.T.err
+FILES+= test_07.T.out
+FILES+= test_07.X.err
+FILES+= test_07.X.out
+FILES+= test_07.XP.err
+FILES+= test_07.XP.out
+FILES+= test_08.E.err
+FILES+= test_08.E.out
+FILES+= test_08.H.err
+FILES+= test_08.H.out
+FILES+= test_08.HIPx.err
+FILES+= test_08.HIPx.out
+FILES+= test_08.HP.err
+FILES+= test_08.HP.out
+FILES+= test_08.J.err
+FILES+= test_08.J.out
+FILES+= test_08.JP.err
+FILES+= test_08.JP.out
+FILES+= test_08.T.err
+FILES+= test_08.T.out
+FILES+= test_08.X.err
+FILES+= test_08.X.out
+FILES+= test_08.XP.err
+FILES+= test_08.XP.out
+FILES+= test_09.E.err
+FILES+= test_09.E.out
+FILES+= test_09.H.err
+FILES+= test_09.H.out
+FILES+= test_09.HIPx.err
+FILES+= test_09.HIPx.out
+FILES+= test_09.HP.err
+FILES+= test_09.HP.out
+FILES+= test_09.J.err
+FILES+= test_09.J.out
+FILES+= test_09.JP.err
+FILES+= test_09.JP.out
+FILES+= test_09.T.err
+FILES+= test_09.T.out
+FILES+= test_09.X.err
+FILES+= test_09.X.out
+FILES+= test_09.XP.err
+FILES+= test_09.XP.out
+FILES+= test_10.E.err
+FILES+= test_10.E.out
+FILES+= test_10.H.err
+FILES+= test_10.H.out
+FILES+= test_10.HIPx.err
+FILES+= test_10.HIPx.out
+FILES+= test_10.HP.err
+FILES+= test_10.HP.out
+FILES+= test_10.J.err
+FILES+= test_10.J.out
+FILES+= test_10.JP.err
+FILES+= test_10.JP.out
+FILES+= test_10.T.err
+FILES+= test_10.T.out
+FILES+= test_10.X.err
+FILES+= test_10.X.out
+FILES+= test_10.XP.err
+FILES+= test_10.XP.out
+FILES+= test_10.err
+FILES+= test_10.out
+FILES+= test_11.E.err
+FILES+= test_11.E.out
+FILES+= test_11.H.err
+FILES+= test_11.H.out
+FILES+= test_11.HIPx.err
+FILES+= test_11.HIPx.out
+FILES+= test_11.HP.err
+FILES+= test_11.HP.out
+FILES+= test_11.J.err
+FILES+= test_11.J.out
+FILES+= test_11.JP.err
+FILES+= test_11.JP.out
+FILES+= test_11.T.err
+FILES+= test_11.T.out
+FILES+= test_11.X.err
+FILES+= test_11.X.out
+FILES+= test_11.XP.err
+FILES+= test_11.XP.out
+
+# XXX: the `E` format testcases don't appear to match the expected format.
+#FILES:=	${FILES:N*.E.*}
+
+PROGS+= test_01
+PROGS+= test_02
+PROGS+= test_03
+PROGS+= test_04
+PROGS+= test_05
+PROGS+= test_06
+PROGS+= test_07
+PROGS+= test_08
+PROGS+= test_09
+PROGS+= test_10
+PROGS+= test_11
+
+CFLAGS+=	-I${LIBXOSRC}/libxo
+
+DPADD=		${LIBXO} ${LIBUTIL}
+LDADD=		-lxo -lutil
+
+SUBDIR+=	encoder
+
+.include <bsd.test.mk>
diff --git a/lib/libxo/tests/functional_test.sh b/lib/libxo/tests/functional_test.sh
new file mode 100755
index 0000000..b61e947
--- /dev/null
+++ b/lib/libxo/tests/functional_test.sh
@@ -0,0 +1,76 @@
+#
+# Copyright 2015 EMC Corp.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# * Redistributions of source code must retain the above copyright
+#   notice, this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# $FreeBSD$
+
+SRCDIR=$(atf_get_srcdir)
+
+check()
+{
+	local tc=${1}; shift
+	local xo_fmt=${1}; shift
+
+	local err_file="${SRCDIR}/${tc}${xo_fmt:+.${xo_fmt}}.err"
+	[ -s "${err_file}" ] && err_flag="-e file:${err_file}"
+	local out_file="${SRCDIR}/${tc}${xo_fmt:+.${xo_fmt}}.out"
+	[ -s "${out_file}" ] && out_flag="-o file:${out_file}"
+
+	if [ "$xo_fmt" = "E" ]; then
+		LIBXO_OPTIONS="warn,encoder=test"
+	else
+		LIBXO_OPTIONS=":W${xo_fmt}"
+	fi
+
+	atf_check -s exit:0 -e file:${err_file} -o file:${out_file} \
+	    env LC_ALL=en_US.UTF-8 \
+	        LIBXO_OPTIONS="${LIBXO_OPTIONS}" TZ="EST" "${SRCDIR}/${tc}" \
+
+}
+
+add_testcase()
+{
+	local tc=${1}
+	local tc_escaped
+
+	oldIFS=$IFS
+	IFS='.'
+	set -- $tc
+	tc_script=${1}
+	[ $# -eq 3 ] && xo_fmt=${2} # Don't set xo_fmt to `out'
+	IFS=$oldIFS
+	tc_escaped="${tc_script}${xo_fmt:+__${xo_fmt}}"
+
+	atf_test_case ${tc_escaped}
+	eval "${tc_escaped}_body() { check ${tc_script} ${xo_fmt}; }"
+	atf_add_test_case ${tc_escaped}
+}
+
+atf_init_test_cases()
+{
+	for path in $(find -Es "${SRCDIR}" -name '*.out'); do
+		add_testcase ${path##*/}
+	done
+}
diff --git a/usr.bin/xo/Makefile b/usr.bin/xo/Makefile
index a287608..92692e5 100644
--- a/usr.bin/xo/Makefile
+++ b/usr.bin/xo/Makefile
@@ -1,5 +1,7 @@
 # $FreeBSD$
 
+.include <src.opts.mk>
+
 LIBXOSRC=	${SRCTOP}/contrib/libxo
 
 .PATH:	${LIBXOSRC}/xo
@@ -12,4 +14,8 @@ CFLAGS+=-I${LIBXOSRC}/libxo
 
 LIBADD=	xo util
 
+.if ${MK_TESTS} != "no"
+SUBDIR+=	tests
+.endif
+
 .include <bsd.prog.mk>
diff --git a/usr.bin/xo/tests/Makefile b/usr.bin/xo/tests/Makefile
new file mode 100644
index 0000000..ea4916d
--- /dev/null
+++ b/usr.bin/xo/tests/Makefile
@@ -0,0 +1,40 @@
+# $FreeBSD$
+
+.include <bsd.own.mk>
+
+LIBXOSRC=	${SRCTOP}/contrib/libxo
+
+.PATH: ${LIBXOSRC}/tests/xo ${LIBXOSRC}/tests/xo/saved
+
+.c.out .o.out:
+
+TESTSDIR=	${TESTSBASE}/usr.bin/xo
+
+BINDIR=		${TESTSDIR}
+
+ATF_TESTS_SH+=	functional_test
+
+FILES+=		xo_01.H.err
+FILES+=		xo_01.H.out
+FILES+=		xo_01.HIPx.err
+FILES+=		xo_01.HIPx.out
+FILES+=		xo_01.HP.err
+FILES+=		xo_01.HP.out
+FILES+=		xo_01.J.err
+FILES+=		xo_01.J.out
+FILES+=		xo_01.JP.err
+FILES+=		xo_01.JP.out
+FILES+=		xo_01.T.err
+FILES+=		xo_01.T.out
+FILES+=		xo_01.X.err
+FILES+=		xo_01.X.out
+FILES+=		xo_01.XP.err
+FILES+=		xo_01.XP.out
+
+SCRIPTS+=	xo_01
+
+LIBADD+=	xo
+
+.include <bsd.test.mk>
+
+.SUFFIXES: .sh
diff --git a/usr.bin/xo/tests/functional_test.sh b/usr.bin/xo/tests/functional_test.sh
new file mode 100755
index 0000000..2a26faa
--- /dev/null
+++ b/usr.bin/xo/tests/functional_test.sh
@@ -0,0 +1,72 @@
+#
+# Copyright 2015 EMC Corp.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# * Redistributions of source code must retain the above copyright
+#   notice, this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# $FreeBSD$
+
+SRCDIR=$(atf_get_srcdir)
+
+check()
+{
+	local tc=${1}; shift
+	local xo_fmt=${1}; shift
+
+	XO=$(atf_config_get usr.bin.xo.test_xo /usr/bin/xo)
+
+	local err_file="${SRCDIR}/${tc}${xo_fmt:+.${xo_fmt}}.err"
+	[ -s "${err_file}" ] && err_flag="-e file:${err_file}"
+	local out_file="${SRCDIR}/${tc}${xo_fmt:+.${xo_fmt}}.out"
+	[ -s "${out_file}" ] && out_flag="-o file:${out_file}"
+
+	atf_check -s exit:0 -e file:${err_file} -o file:${out_file} \
+	    env LC_ALL=en_US.UTF-8 \
+	        LIBXO_OPTIONS=":W${xo_fmt}" TZ="EST" "${SRCDIR}/${tc}" \
+		${XO}
+}
+
+add_testcase()
+{
+	local tc=${1}
+	local tc_escaped
+
+	oldIFS=$IFS
+	IFS='.'
+	set -- $tc
+	tc_script=${1}
+	[ $# -eq 3 ] && xo_fmt=${2} # Don't set xo_fmt to `out'
+	IFS=$oldIFS
+	tc_escaped="${tc_script}${xo_fmt:+__${xo_fmt}}"
+
+	atf_test_case ${tc_escaped}
+	eval "${tc_escaped}_body() { check ${tc_script} ${xo_fmt}; }"
+	atf_add_test_case ${tc_escaped}
+}
+
+atf_init_test_cases()
+{
+	for path in $(find -Es "${SRCDIR}" -name '*.out'); do
+		add_testcase ${path##*/}
+	done
+}