Add placeholder test programs for share/mk files.

The main goal of this change is to simplify the further addition of test
cases for the share/mk infrastructure by adding a few placeholder test
programs to the tests tree.

To not leave these test programs empty, I have added a bunch of extremely
simple test cases to them.

distrib/sets/lists/tests/mi

@@ -1,4 +1,4 @@
-# $NetBSD: mi,v 1.489 2012/08/24 20:24:39 jmmv Exp $
+# $NetBSD: mi,v 1.490 2012/08/26 23:03:21 jmmv Exp $
 #
 # Note: don't delete entries from here - mark them as "obsolete" instead.
 #
@@ -2931,6 +2931,14 @@
 ./usr/tests/sbin/sysctl/Atffile			tests-sbin-tests	atf
 ./usr/tests/sbin/sysctl/t_perm			tests-sbin-tests	atf
 ./usr/tests/sbin/sysctl/t_sysctl		tests-sbin-tests	atf
+./usr/tests/share				tests-sys-tests
+./usr/tests/share/Atffile			tests-sys-tests		atf
+./usr/tests/share/mk				tests-mk-tests
+./usr/tests/share/mk/Atffile			tests-mk-tests		atf
+./usr/tests/share/mk/t_lib			tests-mk-tests		atf
+./usr/tests/share/mk/t_own			tests-mk-tests		atf
+./usr/tests/share/mk/t_prog			tests-mk-tests		atf
+./usr/tests/share/mk/t_test			tests-mk-tests		atf
 ./usr/tests/sys					tests-sys-tests
 ./usr/tests/sys/Atffile				tests-sys-tests	atf
 ./usr/tests/sys/rc				tests-sys-tests

doc/CHANGES

@@ -1,4 +1,4 @@
-# LIST OF CHANGES FROM LAST RELEASE:			<$Revision: 1.1739 $>
+# LIST OF CHANGES FROM LAST RELEASE:			<$Revision: 1.1740 $>
 #
 #
 # [Note: This file does not mention every change made to the NetBSD source tree.
@@ -107,3 +107,5 @@ Changes from NetBSD 6.0 to NetBSD 7.0:
 	mfi(8): Added support for LSI SAS2208-based controllers.
 		[bouyer 20120823]
 	mkdep(1): Add -P option.  [jmmv 20120826]
+	share/mk: Add placeholder test programs (with some very basic test
+		cases within) for common bsd.*.mk modules.  [jmmv 20120826]

etc/mtree/NetBSD.dist.tests

@@ -1,4 +1,4 @@
-#	$NetBSD: NetBSD.dist.tests,v 1.82 2012/08/14 19:13:54 alnsn Exp $
+#	$NetBSD: NetBSD.dist.tests,v 1.83 2012/08/26 23:03:22 jmmv Exp $
 
 ./usr/libdata/debug/usr/tests
 ./usr/libdata/debug/usr/tests/atf
@@ -269,6 +269,8 @@
 ./usr/tests/sbin/resize_ffs
 ./usr/tests/sbin/route
 ./usr/tests/sbin/sysctl
+./usr/tests/share
+./usr/tests/share/mk
 ./usr/tests/sys
 ./usr/tests/sys/rc
 ./usr/tests/usr.bin

tests/Makefile

@@ -1,4 +1,4 @@
-# $NetBSD: Makefile,v 1.38 2012/08/08 13:57:05 christos Exp $
+# $NetBSD: Makefile,v 1.39 2012/08/26 23:03:20 jmmv Exp $
 
 .include <bsd.own.mk>
 
@@ -26,6 +26,10 @@ SUBDIR+=	crypto
 SUBDIR+=	ipf
 . endif
 
+. if ${MKSHARE} != "no"
+SUBDIR+=	share
+. endif
+
 .include <bsd.test.mk>
 
 .else

tests/share/Makefile

@@ -0,0 +1,9 @@
+# $NetBSD: Makefile,v 1.1 2012/08/26 23:03:21 jmmv Exp $
+
+.include <bsd.own.mk>
+
+TESTSDIR=	${TESTSBASE}/share
+
+TESTS_SUBDIRS=	mk
+
+.include <bsd.test.mk>

tests/share/mk/Makefile

@@ -0,0 +1,12 @@
+# $NetBSD: Makefile,v 1.1 2012/08/26 23:03:21 jmmv Exp $
+
+.include <bsd.own.mk>
+
+TESTSDIR=	${TESTSBASE}/share/mk
+
+TESTS_SH=	t_lib t_own t_prog t_test
+.for test in ${TESTS_SH}
+TESTS_SH_SRC_${test}=	${test}.sh common.subr
+.endfor
+
+.include <bsd.test.mk>

tests/share/mk/common.subr

@@ -0,0 +1,132 @@
+# Copyright 2012 Google Inc.
+# 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.
+# * Neither the name of Google Inc. nor the names of its contributors
+#   may be used to endorse or promote products derived from this software
+#   without specific prior written permission.
+#
+# 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.
+
+# Dumps a file to the test's stdout for debugging purposes.
+dump_file() {
+	local file="${1}"; shift
+
+	echo "==== BEGIN ${file}"
+	cat "${file}"
+	echo "==== END   ${file}"
+}
+
+# Creates a C source file with a single symbol in it.
+#
+# The file parameter specifies the path to the file to create, WITHOUT the
+# C extension.  Both a source file and a header file are created.  Any
+# intermediate directories are created too.
+#
+# The symbol parameter specifies the name of the symbol to place in the
+# module, which is defined as a string holding the name of the module.
+create_c_module() {
+	local file="${1}"; shift
+	local symbol="${1}"; shift
+
+	mkdir -p "$(dirname ${file})"
+	echo "extern const char *${symbol};" >"${file}.h"
+	echo "const char *${symbol} = \"${file}\";" >"${file}.c"
+
+	dump_file "${file}.h"
+	dump_file "${file}.c"
+}
+
+# Creates a main C source file that references a set of modules.
+#
+# The modules to be referenced should have been created with
+# create_c_module.  The generated source file ensures that all the modules
+# are referenced in some way, which helps in testing that the generated
+# binary holds all the necessary objects.
+#
+# The file parameter specifies the name of the file to create.
+#
+# The rest of the parameters are module:symbol pairs that specify the
+# module to include and the symbol within them to reference.
+create_main_using_modules() {
+	local file="${1}"; shift
+
+	local modules=
+	local symbols=
+	for spec in "${@}"; do
+		modules="${modules} $(echo ${spec} | cut -d : -f 1)"
+		symbols="${symbols} $(echo ${spec} | cut -d : -f 2)"
+	done
+
+	echo '#include <stdio.h>' >"${file}"
+	for module in ${modules}; do
+		echo "#include \"${module}\"" >>"${file}"
+	done
+	echo 'int main(void) {' >>"${file}"
+	for symbol in ${symbols}; do
+		echo "printf(\"%s\n\", ${symbol});" >>"${file}"
+	done
+	echo 'return 0; }' >>"${file}"
+
+	dump_file "${file}"
+}
+
+# Creates a mk.conf file and points MAKECONF to it.
+#
+# The first argument specifies the name of the configuration file to
+# create.
+#
+# The rest of the arguments include a collection of modifiers for the
+# generated configuration file and/or a collection of explicit variable
+# names and their values to set.
+#
+# The qualifiers can be one of:
+# - owngrp: Override the *OWN and *GRP variables to point to the current
+#   user.
+create_make_conf() {
+	local file="${1}"; shift
+
+	echo "# Test configuration file" >"${file}"
+	for arg in "${@}"; do
+		case "${arg}" in
+		*=*)
+			echo "${arg}" >>"${file}"
+			;;
+		owngrp)
+			for class in BIN DOC LIB LINKS MAN; do
+				echo "${class}OWN=$(id -un)" >>"${file}"
+				echo "${class}GRP=$(id -gn)" >>"${file}"
+			done
+			;;
+		esac
+	done
+
+	case "${file}" in
+	/*)
+		MAKECONF="${file}"; export MAKECONF
+		;;
+	*)
+		MAKECONF="$(pwd)/${file}"; export MAKECONF
+		;;
+	esac
+
+	dump_file "${file}"
+}

tests/share/mk/t_lib.sh

@@ -0,0 +1,54 @@
+# Copyright 2012 Google Inc.
+# 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.
+# * Neither the name of Google Inc. nor the names of its contributors
+#   may be used to endorse or promote products derived from this software
+#   without specific prior written permission.
+#
+# 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.
+
+atf_test_case defaults__build_and_install
+defaults__build_and_install_body() {
+	create_c_module module1 first
+	create_c_module module2 second
+
+	cat >Makefile <<EOF
+LIB = two-modules
+SRCS = module1.c module2.c
+.include <bsd.lib.mk>
+EOF
+
+	atf_check -o ignore make
+	mkdir -p root/usr/lib
+	mkdir -p root/usr/libdata/lint
+	create_make_conf mk.conf owngrp DESTDIR="$(pwd)/root"
+	atf_check -o ignore make install
+
+	create_main_using_modules main.c module1.h:first module2.h:second
+	atf_check -o ignore gcc -I. -Lroot/usr/lib -o main main.c -ltwo-modules
+
+	atf_check -o inline:'module1\nmodule2\n' ./main
+}
+
+atf_init_test_cases() {
+	atf_add_test_case defaults__build_and_install
+}

tests/share/mk/t_own.sh

@@ -0,0 +1,72 @@
+# Copyright 2012 Google Inc.
+# 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.
+# * Neither the name of Google Inc. nor the names of its contributors
+#   may be used to endorse or promote products derived from this software
+#   without specific prior written permission.
+#
+# 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.
+
+atf_test_case makeconf__ok
+makeconf__ok_body() {
+	cat >Makefile <<EOF
+A_TEST_CONFIG_VARIABLE = not overriden
+
+.PHONY: show-config-var
+show-config-var:
+	@echo \${A_TEST_CONFIG_VARIABLE}
+
+.include <bsd.own.mk>
+EOF
+
+	echo >empty.conf
+	cat >custom.conf <<EOF
+A_TEST_CONFIG_VARIABLE = 'a value'
+EOF
+	atf_check -o inline:'not overriden\n' \
+	    make MAKECONF="$(pwd)/empty.conf" show-config-var
+	atf_check -o inline:'a value\n' \
+	    make MAKECONF="$(pwd)/custom.conf" show-config-var
+}
+
+atf_test_case makeconf__missing
+makeconf__missing_body() {
+	cat >Makefile <<EOF
+.PHONY: hello
+hello:
+	@echo 'Did not error out on a missing file!'
+
+.include <bsd.own.mk>
+EOF
+
+	echo >empty.conf
+	cat >custom.conf <<EOF
+A_TEST_CONFIG_VARIABLE = 'a value'
+EOF
+	atf_check -o inline:'Did not error out on a missing file!\n' \
+	    make MAKECONF="$(pwd)/non-existent.conf" hello
+}
+
+atf_init_test_cases() {
+	atf_add_test_case makeconf__ok
+	atf_add_test_case makeconf__missing
+}

tests/share/mk/t_prog.sh

@@ -0,0 +1,84 @@
+# Copyright 2012 Google Inc.
+# 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.
+# * Neither the name of Google Inc. nor the names of its contributors
+#   may be used to endorse or promote products derived from this software
+#   without specific prior written permission.
+#
+# 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.
+
+atf_test_case defaults__build_and_install
+defaults__build_and_install_body() {
+	cat >hello.c <<EOF
+#include <stdio.h>
+int main(void) { printf("Hello, test!\n"); return 0; }
+EOF
+	cat >hello.1 <<EOF
+Manpage of hello(1).
+EOF
+
+	cat >Makefile <<EOF
+BINDIR = /the/bin/dir
+PROG = hello
+.include <bsd.prog.mk>
+EOF
+
+	atf_check -o ignore make
+	mkdir -p root/the/bin/dir
+	mkdir -p root/usr/share/man/man1
+	mkdir -p root/usr/share/man/html1
+	create_make_conf mk.conf owngrp DESTDIR="$(pwd)/root"
+	atf_check -o ignore make install
+
+	atf_check -o inline:'Hello, test!\n' ./root/the/bin/dir/hello
+	atf_check -o inline:'Manpage of hello(1).\n' \
+	    cat root/usr/share/man/man1/hello.1
+	atf_check -o match:'Manpage of hello' \
+	    cat root/usr/share/man/html1/hello.html
+}
+
+atf_test_case without_man__build_and_install
+without_man__build_and_install_body() {
+	cat >hello.c <<EOF
+#include <stdio.h>
+int main(void) { printf("Hello, test!\n"); return 0; }
+EOF
+
+	cat >Makefile <<EOF
+BINDIR = /the/bin/dir
+PROG = hello
+MAN =
+.include <bsd.prog.mk>
+EOF
+
+	atf_check -o ignore make
+	mkdir -p root/the/bin/dir
+	create_make_conf mk.conf owngrp DESTDIR="$(pwd)/root"
+	atf_check -o ignore make install
+
+	atf_check -o inline:'Hello, test!\n' ./root/the/bin/dir/hello
+}
+
+atf_init_test_cases() {
+	atf_add_test_case defaults__build_and_install
+	atf_add_test_case without_man__build_and_install
+}

tests/share/mk/t_test.sh

@@ -0,0 +1,111 @@
+# Copyright 2012 Google Inc.
+# 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.
+# * Neither the name of Google Inc. nor the names of its contributors
+#   may be used to endorse or promote products derived from this software
+#   without specific prior written permission.
+#
+# 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.
+
+# Helper function for the various one_* test cases.
+#
+# The first argument must be one of C, CXX or SH, and this indicates the
+# language of the test program.
+#
+# The second argument is the name of the test program, without an extension.
+# The corresponding source file must exist in the current directory.
+one_test() {
+	local lang="${1}"; shift
+	local name="${1}"; shift
+
+	cat >Makefile <<EOF
+.include <bsd.own.mk>
+TESTSDIR = \${TESTSBASE}/fake
+TESTS_${lang} = ${name}
+.include <bsd.test.mk>
+EOF
+
+	atf_check -o ignore make
+	mkdir -p root/usr/tests/fake
+	create_make_conf mk.conf owngrp DESTDIR="$(pwd)/root"
+	atf_check -o ignore make install
+
+	atf_check -o match:'ident: one_tc' "./root/usr/tests/fake/${name}" -l
+}
+
+atf_test_case one_c
+one_c_body() {
+	cat >t_fake.c <<EOF
+#include <atf-c.h>
+ATF_TC_WITHOUT_HEAD(one_tc);
+ATF_TC_BODY(one_tc, tc)
+{
+	atf_tc_fail("Failing explicitly");
+}
+
+ATF_TP_ADD_TCS(tp)
+{
+	ATF_TP_ADD_TC(tp, one_tc);
+	return atf_no_error();
+}
+EOF
+	one_test C t_fake
+}
+
+atf_test_case one_cxx
+one_cxx_body() {
+	cat >t_fake.cpp <<EOF
+#include <atf-c++.hpp>
+ATF_TEST_CASE_WITHOUT_HEAD(one_tc);
+ATF_TEST_CASE_BODY(one_tc)
+{
+	fail("Failing explicitly");
+}
+
+ATF_INIT_TEST_CASES(tcs)
+{
+	ATF_ADD_TEST_CASE(tcs, one_tc);
+}
+EOF
+	one_test CXX t_fake
+}
+
+atf_test_case one_sh
+one_sh_body() {
+	cat >t_fake.sh <<EOF
+atf_test_case one_tc
+one_tc_body() {
+	atf_fail "Failing explicitly"
+}
+
+atf_init_test_cases() {
+	atf_add_test_case one_tc
+}
+EOF
+	one_test SH t_fake
+}
+
+atf_init_test_cases() {
+	atf_add_test_case one_c
+	atf_add_test_case one_cxx
+	atf_add_test_case one_sh
+}