From 7d9ade5da19faff73191fa7fc3e09c2ab3b5e6bf Mon Sep 17 00:00:00 2001 From: Enji Cooper Date: Fri, 3 Mar 2017 20:15:22 +0000 Subject: [PATCH] Integrate indent tests added in r313544 into ATF/Kyua and the FreeBSD test suite This change does the following: - Introduces symmetry in the test inputs/outputs by adding the exit code to the files. This simplified the test driver notably by requiring less filename/test name manipulation. - Adds a test driver for the testcases added in r313544, patterned after bin/sh/tests/functional_test.sh . The driver calls indent as noted in r313544, with an exception: The $FreeBSD$ RCS keyword's expansion is reindented with indent, which means that the output differs from the expected output. Thus, all lines with $FreeBSD$ in them are deleted on the fly, both in the input file and the output file. The test inputs/outputs are copied to the kyua sandbox before the test is run as the pathing in some of the files relies on pathing normalized to the current directory (copying the files is the easiest way to resolve the issue). Approved by: pstef (maintainer) Reviewed by: pstef X-MFC with: r313544 Sponsored by: Dell EMC Isilon Differential Revision: https://reviews.freebsd.org/D9682 --- etc/mtree/BSD.tests.dist | 2 + usr.bin/indent/Makefile | 6 ++ usr.bin/indent/tests/Makefile | 43 +++++++++ .../{elsecomment.pro => elsecomment.0.pro} | 0 usr.bin/indent/tests/functional_test.sh | 90 +++++++++++++++++++ .../indent/tests/{label.pro => label.0.pro} | 0 usr.bin/indent/tests/{nsac.pro => nsac.0.pro} | 0 usr.bin/indent/tests/{sac.pro => sac.0.pro} | 0 .../{surplusbad.pro => surplusbad.0.pro} | 0 ..._from_file.list => types_from_file.0.list} | 0 usr.bin/indent/tests/types_from_file.0.pro | 2 + usr.bin/indent/tests/types_from_file.pro | 2 - 12 files changed, 143 insertions(+), 2 deletions(-) create mode 100644 usr.bin/indent/tests/Makefile rename usr.bin/indent/tests/{elsecomment.pro => elsecomment.0.pro} (100%) create mode 100755 usr.bin/indent/tests/functional_test.sh rename usr.bin/indent/tests/{label.pro => label.0.pro} (100%) rename usr.bin/indent/tests/{nsac.pro => nsac.0.pro} (100%) rename usr.bin/indent/tests/{sac.pro => sac.0.pro} (100%) rename usr.bin/indent/tests/{surplusbad.pro => surplusbad.0.pro} (100%) rename usr.bin/indent/tests/{types_from_file.list => types_from_file.0.list} (100%) create mode 100644 usr.bin/indent/tests/types_from_file.0.pro delete mode 100644 usr.bin/indent/tests/types_from_file.pro diff --git a/etc/mtree/BSD.tests.dist b/etc/mtree/BSD.tests.dist index c2ae1e79779..90065b8e2fe 100644 --- a/etc/mtree/BSD.tests.dist +++ b/etc/mtree/BSD.tests.dist @@ -620,6 +620,8 @@ .. ident .. + indent + .. join .. jot diff --git a/usr.bin/indent/Makefile b/usr.bin/indent/Makefile index dcd7e391857..2eb1c32657c 100644 --- a/usr.bin/indent/Makefile +++ b/usr.bin/indent/Makefile @@ -1,9 +1,15 @@ # @(#)Makefile 8.1 (Berkeley) 6/6/93 # $FreeBSD$ +.include + PROG= indent SRCS= indent.c io.c lexi.c parse.c pr_comment.c args.c NO_WMISSING_VARIABLE_DECLARATIONS= +.if ${MK_TESTS} != "no" +SUBDIR+= tests +.endif + .include diff --git a/usr.bin/indent/tests/Makefile b/usr.bin/indent/tests/Makefile new file mode 100644 index 00000000000..1b6abb83582 --- /dev/null +++ b/usr.bin/indent/tests/Makefile @@ -0,0 +1,43 @@ +# $FreeBSD$ + +PACKAGE= tests + +${PACKAGE}FILES+= comments.0 +${PACKAGE}FILES+= comments.0.stdout +${PACKAGE}FILES+= declarations.0 +${PACKAGE}FILES+= declarations.0.stdout +${PACKAGE}FILES+= elsecomment.0 +${PACKAGE}FILES+= elsecomment.0.stdout +${PACKAGE}FILES+= elsecomment.0.pro +${PACKAGE}FILES+= float.0 +${PACKAGE}FILES+= float.0.stdout +${PACKAGE}FILES+= label.0 +${PACKAGE}FILES+= label.0.stdout +${PACKAGE}FILES+= label.0.pro +${PACKAGE}FILES+= list_head.0 +${PACKAGE}FILES+= list_head.0.stdout +${PACKAGE}FILES+= nsac.0 +${PACKAGE}FILES+= nsac.0.stdout +${PACKAGE}FILES+= nsac.0.pro +${PACKAGE}FILES+= offsetof.0 +${PACKAGE}FILES+= offsetof.0.stdout +${PACKAGE}FILES+= sac.0 +${PACKAGE}FILES+= sac.0.stdout +${PACKAGE}FILES+= sac.0.pro +${PACKAGE}FILES+= struct.0 +${PACKAGE}FILES+= struct.0.stdout +${PACKAGE}FILES+= surplusbad.0 +${PACKAGE}FILES+= surplusbad.0.stdout +${PACKAGE}FILES+= surplusbad.0.pro +${PACKAGE}FILES+= types_from_file.0 +${PACKAGE}FILES+= types_from_file.0.stdout +${PACKAGE}FILES+= types_from_file.0.list +${PACKAGE}FILES+= types_from_file.0.pro +${PACKAGE}FILES+= wchar.0 +${PACKAGE}FILES+= wchar.0.stdout + +ATF_TESTS_SH+= functional_test + +BINDIR= ${TESTSDIR} + +.include diff --git a/usr.bin/indent/tests/elsecomment.pro b/usr.bin/indent/tests/elsecomment.0.pro similarity index 100% rename from usr.bin/indent/tests/elsecomment.pro rename to usr.bin/indent/tests/elsecomment.0.pro diff --git a/usr.bin/indent/tests/functional_test.sh b/usr.bin/indent/tests/functional_test.sh new file mode 100755 index 00000000000..e7b00393e4f --- /dev/null +++ b/usr.bin/indent/tests/functional_test.sh @@ -0,0 +1,90 @@ +# +# Copyright 2016 Dell EMC +# 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 indent=$(atf_config_get usr.bin.indent.test_indent /usr/bin/indent) + + # All of the files need to be in the ATF sandbox in order for the tests + # to pass. + atf_check cp ${SRCDIR}/${tc}* . + + # Remove $FreeBSD$ RCS expansions because they get re-indented, which + # changes the output + local out_file="${tc}.stdout" + if [ -f "${out_file}" ]; then + parsed_file=output_file.parsed + + atf_check -o save:$parsed_file sed -e '/\$FreeBSD.*\$/d' \ + ${tc}.stdout + out_flag="-o file:$parsed_file" + fi + local profile_file="${tc}.pro" + if [ -f "${profile_file}" ]; then + profile_flag="-P${profile_file}" + else + # Make sure we don't implicitly use ~/.indent.pro from the test + # host, for determinism purposes. + profile_flag="-npro" + fi + sed -e '/\$FreeBSD.*\$/d' ${tc} > input_file.parsed + atf_check -s exit:${tc##*.} ${out_flag} ${indent} ${profile_flag} < input_file.parsed +} + +add_testcase() +{ + local tc=${1} + local tc_escaped word + + case "${tc%.*}" in + *-*) + local IFS="-" + for word in ${tc%.*}; do + tc_escaped="${tc_escaped:+${tc_escaped}_}${word}" + done + ;; + *) + tc_escaped=${tc%.*} + ;; + esac + + atf_test_case ${tc_escaped} + eval "${tc_escaped}_body() { check ${tc}; }" + atf_add_test_case ${tc_escaped} +} + +atf_init_test_cases() +{ + for path in $(find -Es "${SRCDIR}" -regex '.*\.[0-9]+$'); do + add_testcase ${path##*/} + done +} diff --git a/usr.bin/indent/tests/label.pro b/usr.bin/indent/tests/label.0.pro similarity index 100% rename from usr.bin/indent/tests/label.pro rename to usr.bin/indent/tests/label.0.pro diff --git a/usr.bin/indent/tests/nsac.pro b/usr.bin/indent/tests/nsac.0.pro similarity index 100% rename from usr.bin/indent/tests/nsac.pro rename to usr.bin/indent/tests/nsac.0.pro diff --git a/usr.bin/indent/tests/sac.pro b/usr.bin/indent/tests/sac.0.pro similarity index 100% rename from usr.bin/indent/tests/sac.pro rename to usr.bin/indent/tests/sac.0.pro diff --git a/usr.bin/indent/tests/surplusbad.pro b/usr.bin/indent/tests/surplusbad.0.pro similarity index 100% rename from usr.bin/indent/tests/surplusbad.pro rename to usr.bin/indent/tests/surplusbad.0.pro diff --git a/usr.bin/indent/tests/types_from_file.list b/usr.bin/indent/tests/types_from_file.0.list similarity index 100% rename from usr.bin/indent/tests/types_from_file.list rename to usr.bin/indent/tests/types_from_file.0.list diff --git a/usr.bin/indent/tests/types_from_file.0.pro b/usr.bin/indent/tests/types_from_file.0.pro new file mode 100644 index 00000000000..eeca804be08 --- /dev/null +++ b/usr.bin/indent/tests/types_from_file.0.pro @@ -0,0 +1,2 @@ +/* $FreeBSD$ */ +-Utypes_from_file.0.list diff --git a/usr.bin/indent/tests/types_from_file.pro b/usr.bin/indent/tests/types_from_file.pro deleted file mode 100644 index 571b673697d..00000000000 --- a/usr.bin/indent/tests/types_from_file.pro +++ /dev/null @@ -1,2 +0,0 @@ -/* $FreeBSD$ */ --Utypes_from_file.list