# $NetBSD: t_mtree.sh,v 1.7 2017/01/14 20:45:16 christos Exp $
#
# Copyright (c) 2009, 2012 The NetBSD Foundation, 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:
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 2. 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
#

# Postprocess mtree output, canonicalising portions that
# are expected to differ from one run to another.
#

h_postprocess()
{
	sed -e '
		/^#	   user: /s/:.*/: x/
		/^#	machine: /s/:.*/: x/
		/^#	   tree: /s/:.*/: x/
		/^#	   date: /s/:.*/: x/
		' \
	    -e '/type=dir/s/ size=[0-9]*//'
}

h_check()
{
        diff -Nru "$1" "$2" || atf_fail "files $1 and $2 differ"
}


atf_test_case mtree_create
atf_test_case netbsd6_create
create_head()
{
	atf_set "descr" "Create a specfile describing a directory tree"
}

create_setup()
{
	# create some directories
	rm -fr create
	mkdir -p create/a/1 create/a/2 create/b
	# create some files
	for file in create/top.file.1 \
		    create/a/a.file.1 \
		    create/a/a.file.2 \
		    create/a/1/a1.file.1 \
		    create/b/b.file.1 \
		    create/b/b.file.2
	do
		echo "$file" >$file
	done
	# hard link to file in same dir
	ln create/b/b.file.1 create/b/b.hardlink.1
	# hard link to file in another dir
	ln create/b/b.file.2 create/a/a.hardlink.b2
	# symlink to file
	ln -s a.file.1 create/a.symlink.1
	# symlink to dir
	ln -s b create/top.symlink.b
	# dangling symlink
	ln -s nonexistent create/top.dangling
}

create_body()
{
	create_setup

	# run mtree and check output
	( cd create && mtree -F ${FLAVOR} -c -k type,nlink,link,size,sha256 ) >output.raw \
	|| atf_fail "mtree exit status $?"
	h_postprocess <output.raw >output
	h_check "$(atf_get_srcdir)/${FLAVOR}_d_create.out" output
}

mtree_create_head() 
{
	FLAVOR=mtree create_head
}
netbsd6_create_head() 
{
	FLAVOR=netbsd6 create_head
}

mtree_create_body() 
{
	FLAVOR=mtree create_body
}
netbsd6_create_body() 
{
	FLAVOR=netbsd6 create_body
}


atf_test_case mtree_check
atf_test_case netbsd6_check
check_head()
{
	atf_set "descr" "Check a directory tree against a specfile"
}

check_body()
{
	# we use the same directory tree and specfile as in the "create" test
	create_setup

	# run mtree and check output
	( cd create && mtree -F ${FLAVOR}  ) <"$(atf_get_srcdir)/${FLAVOR}_d_create.out" >output \
	|| atf_fail "mtree exit status $?"
	h_check /dev/null output
}

mtree_check_head() 
{
	FLAVOR=mtree check_head
}
netbsd6_check_head() 
{
	FLAVOR=netbsd6 check_head
}

mtree_check_body() 
{
	FLAVOR=mtree check_body
}
netbsd6_check_body() 
{
	FLAVOR=netbsd6 check_body
}


atf_test_case mtree_convert_C
atf_test_case netbsd6_convert_C
convert_C_head()
{
	atf_set "descr" "Convert a specfile to mtree -C format, unsorted"
}

convert_C_body()
{
	mtree -F ${FLAVOR} -C -K all <"$(atf_get_srcdir)/d_convert.in" >output
	h_check "$(atf_get_srcdir)/d_convert_C.out" output
}

mtree_convert_C_head() 
{
	FLAVOR=mtree convert_C_head
}
netbsd6_convert_C_head() 
{
	FLAVOR=netbsd6 convert_C_head
}

mtree_convert_C_body() 
{
	FLAVOR=mtree convert_C_body
}
netbsd6_convert_C_body() 
{
	FLAVOR=netbsd6 convert_C_body
}


atf_test_case mtree_convert_C_S
atf_test_case netbsd6_convert_C_S
convert_C_S_head()
{
	atf_set "descr" "Convert a specfile to mtree -C format, sorted"
}

convert_C_S_body()
{
	mtree -F ${FLAVOR} -C -S -K all <"$(atf_get_srcdir)/d_convert.in" >output
	h_check "$(atf_get_srcdir)/d_convert_C_S.out" output
}

mtree_convert_C_S_head() 
{
	FLAVOR=mtree convert_C_S_head
}
netbsd6_convert_C_S_head() 
{
	FLAVOR=netbsd6 convert_C_S_head
}

mtree_convert_C_S_body() 
{
	FLAVOR=mtree convert_C_S_body
}
netbsd6_convert_C_S_body() 
{
	FLAVOR=netbsd6 convert_C_S_body
}


atf_test_case mtree_convert_D
atf_test_case netbsd6_convert_D
convert_D_head()
{
	atf_set "descr" "Convert a specfile to mtree -D format, unsorted"
}

convert_D_body()
{
	mtree -F ${FLAVOR} -D -K all <"$(atf_get_srcdir)/d_convert.in" >output
	h_check "$(atf_get_srcdir)/d_convert_D.out" output
}

mtree_convert_D_head() 
{
	FLAVOR=mtree convert_D_head
}
netbsd6_convert_D_head() 
{
	FLAVOR=netbsd6 convert_D_head
}

mtree_convert_D_body() 
{
	FLAVOR=mtree convert_D_body
}
netbsd6_convert_D_body() 
{
	FLAVOR=netbsd6 convert_D_body
}


atf_test_case mtree_convert_D_S
atf_test_case netbsd6_convert_D_S
convert_D_S_head()
{
	atf_set "descr" "Convert a specfile to mtree -D format, sorted"
}

convert_D_S_body()
{
	mtree -F ${FLAVOR} -D -S -K all <"$(atf_get_srcdir)/d_convert.in" >output
	h_check "$(atf_get_srcdir)/d_convert_D_S.out" output
}

mtree_convert_D_S_head() 
{
	FLAVOR=mtree convert_D_S_head
}
netbsd6_convert_D_S_head() 
{
	FLAVOR=netbsd6 convert_D_S_head
}

mtree_convert_D_S_body() 
{
	FLAVOR=mtree convert_D_S_body
}
netbsd6_convert_D_S_body() 
{
	FLAVOR=netbsd6 convert_D_S_body
}


atf_test_case mtree_ignore
atf_test_case netbs6_ignore
ignore_head()
{
	atf_set "descr" "Test that -d ignores symlinks (PR bin/41061)"
}

ignore_body()
{
	# Kyua 0.11 and above point TMPDIR to our work directory and atf-check
	# generates a temporary file, which confuses mtree.  Put the mtree files
	# into a subdirectory.
	#
	# See https://github.com/jmmv/kyua/issues/133 for details.
	mkdir root && cd root

	mkdir newdir
	mtree -F ${FLAVOR} -c | mtree -F ${FLAVOR} -Ck uid,gid,mode > mtree.spec
	ln -s newdir otherdir

	# This yields "extra: otherdir" even with -d.
	# (PR bin/41061)
	atf_check -s ignore -o empty -e empty -x "mtree -F ${FLAVOR} -d < mtree.spec"

	# Delete the symlink and re-verify.
	#
	rm otherdir
	atf_check -s ignore -o empty -e empty -x "mtree -F ${FLAVOR} -d < mtree.spec"
}

mtree_ignore_head() 
{
	FLAVOR=mtree ignore_head
}
netbsd6_ignore_head() 
{
	FLAVOR=netbsd6 ignore_head
}

mtree_ignore_body() 
{
	FLAVOR=mtree ignore_body
}
netbsd6_ignore_body() 
{
	# Kyua 0.11 and above point TMPDIR to our work directory and atf-check
	# generates a temporary file, which confuses mtree.  Put the mtree files
	# into a subdirectory.
	#
	# See https://github.com/jmmv/kyua/issues/133 for details.
	mkdir root && cd root

	FLAVOR=netbsd6 ignore_body
}


atf_test_case mtree_merge
atf_test_case netbsd6_merge
merge_head()
{
	atf_set "descr" "Merge records of different type"
}

merge_body()
{
	mtree -F ${FLAVOR} -C -M -K all <"$(atf_get_srcdir)/d_merge.in" >output
	h_check "$(atf_get_srcdir)/d_merge_C_M.out" output
	# same again, with sorting
	mtree -F ${FLAVOR} -C -M -S -K all <"$(atf_get_srcdir)/d_merge.in" >output
	h_check "$(atf_get_srcdir)/d_merge_C_M_S.out" output
}

mtree_merge_head() 
{
	FLAVOR=mtree merge_head
}
netbsd6_merge_head() 
{
	FLAVOR=netbsd6 merge_head
}

mtree_merge_body() 
{
	FLAVOR=mtree merge_body
}
netbsd6_merge_body() 
{
	FLAVOR=netbsd6 merge_body
}


atf_test_case mtree_nonemptydir
atf_test_case netbsd6_nonemptydir
nonemptydir_head()
{
	atf_set "descr" "Test that new non-empty " \
			"directories are recorded (PR bin/25693)"
}

nonemptydir_body()
{
	mkdir testdir
	cd testdir

	mtree -F ${FLAVOR} -c > mtree.spec

	if [ ! -f mtree.spec ]; then
		atf_fail "mtree failed"
	fi

	touch bar
	atf_check -s ignore -o save:output -x "mtree -F ${FLAVOR} -f mtree.spec"

	if [ ! -n "$(egrep "extra: bar" output)" ]; then
		atf_fail "mtree did not record changes (PR bin/25693)"
	fi
}

mtree_nonemptydir_head() 
{
	FLAVOR=mtree nonemptydir_head
}
netbsd6_nonemptydir_head() 
{
	FLAVOR=netbsd6 nonemptydir_head
}

mtree_nonemptydir_body() 
{
	FLAVOR=mtree nonemptydir_body
}
netbsd6_nonemptydir_body() 
{
	FLAVOR=netbsd6 nonemptydir_body
}

atf_test_case mtree_specspec_type
mtree_specspec_type_head()
{
	atf_set "descr" "Test that spec comparisons detect type changes"
}

mtree_specspec_type_body()
{
	mkdir testdir

	touch testdir/bar
	mtree -c -p testdir > mtree1.spec

	if [ ! -f mtree1.spec ]; then
		atf_fail "mtree failed"
	fi

	rm -f testdir/bar
	ln -s foo testdir/bar
	# uid change is expected to be ignored as done in -C
	chown -h operator testdir/bar
	mtree -c -p testdir > mtree2.spec

	if [ ! -f mtree2.spec ]; then
		atf_fail "mtree failed"
	fi

	atf_check -s ignore -o save:output \
	    -x "mtree -f mtree1.spec -f mtree2.spec"

	if ! cut -f 3 output | egrep -q "bar file" || \
	    ! cut -f 3 output | egrep -q "bar link"; then
		atf_fail "mtree did not detect type change"
	fi
}

atf_init_test_cases()
{
	atf_add_test_case mtree_create
	atf_add_test_case mtree_check
	atf_add_test_case mtree_convert_C
	atf_add_test_case mtree_convert_C_S
	atf_add_test_case mtree_convert_D
	atf_add_test_case mtree_convert_D_S
	atf_add_test_case mtree_ignore
	atf_add_test_case mtree_merge
	atf_add_test_case mtree_nonemptydir
	atf_add_test_case mtree_specspec_type

	atf_add_test_case netbsd6_create
	atf_add_test_case netbsd6_check
	atf_add_test_case netbsd6_convert_C
	atf_add_test_case netbsd6_convert_C_S
	atf_add_test_case netbsd6_convert_D
	atf_add_test_case netbsd6_convert_D_S
	atf_add_test_case netbsd6_ignore
	atf_add_test_case netbsd6_merge
	atf_add_test_case netbsd6_nonemptydir
}
