#
# Copyright (c) 2016 Spectra Logic 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:
# 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 AUTHOR 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 AUTHOR 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: stable/11/usr.sbin/extattr/tests/extattr_test.sh 319555 2017-06-03 20:39:48Z ngie $

atf_test_case bad_namespace
proc bad_namespace_head {
	atf_set "descr" "Can't set attributes for nonexistent namespaces"
}
proc bad_namespace_body {
	check_fs
	touch foo
	atf_check -s not-exit:0 -e match:"Invalid argument" \
		setextattr badnamespace myattr X foo
	atf_check -s not-exit:0 -e match:"Invalid argument" \
		lsextattr -q badnamespace foo
}

atf_test_case hex
proc hex_head {
	atf_set "descr" "Set and get attribute values in hexadecimal"
}
proc hex_body {
	check_fs
	touch foo
	atf_check -s exit:0 -o empty setextattr user myattr XYZ foo
	atf_check -s exit:0 -o inline:"58 59 5a\n" \
		getextattr -qx user myattr foo
}

atf_test_case hex_nonascii
proc hex_nonascii_head {
	atf_set "descr" "Get binary attribute values in hexadecimal"
}
proc hex_nonascii_body {
	check_fs
	touch foo
	setglobal BINSTUFF = $[echo $'\x20\x30\x40\x55\x66\x70\x81\xa2\xb3\xee\xff]
	atf_check -s exit:0 -o empty setextattr user myattr $BINSTUFF foo
	getextattr user myattr foo
	atf_check -s exit:0 -o inline:"20 30 40 55 66 70 81 a2 b3 ee ff\n" \
		getextattr -qx user myattr foo
}

atf_test_case long_name
proc long_name_head {
	atf_set "descr" "A maximum length attribute name"
}
proc long_name_body {
	check_fs

	if ! setglobal NAME_MAX = $[getconf NAME_MAX .] {
		atf_skip "Filesystem not reporting NAME_MAX; skipping testcase"
	}

	# https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=208965
	atf_expect_fail "BUG 208965 extattr(2) doesn't allow maxlen attr names"

	setglobal ATTRNAME = $[jot -b X -s "" $NAME_MAX 0]
	touch foo
	atf_check -s exit:0 -o empty setextattr user $ATTRNAME myvalue foo
	atf_check -s exit:0 -o inline:"$(ATTRNAME)\n" lsextattr -q user foo
	atf_check -s exit:0 -o inline:"myvalue\n" \
		getextattr -q user $(ATTRNAME) foo
	atf_check -s exit:0 -o empty rmextattr user $(ATTRNAME) foo
	atf_check -s exit:0 -o empty lsextattr -q user foo
}

atf_test_case loud
proc loud_head {
	atf_set "descr" "Loud (non -q) output for each command"
}
proc loud_body {
	check_fs
	touch foo
	# setextattr(8) and friends print hard tabs.  Use printf to convert
	# them to spaces before checking the output.
	atf_check -s exit:0 -o empty setextattr user myattr myvalue foo
	atf_check -s exit:0 -o inline:"foo myattr" \
		printf "%s %s" $[lsextattr user foo]
	atf_check -s exit:0 -o inline:"foo myvalue" \
		printf "%s %s" $[getextattr user myattr foo]
	atf_check -s exit:0 -o empty rmextattr user myattr foo
	atf_check -s exit:0 -o inline:"foo" printf %s $[lsextattr user foo]
}

atf_test_case noattrs
proc noattrs_head {
	atf_set "descr" "A file with no extended attributes"
}
proc noattrs_body {
	check_fs
	touch foo
	atf_check -s exit:0 -o empty lsextattr -q user foo
}

atf_test_case nonexistent_file
proc nonexistent_file_head {
	atf_set "descr" "A file that does not exist"
}
proc nonexistent_file_body {
	check_fs
	atf_check -s exit:1 -e match:"No such file or directory" \
		lsextattr user foo
	atf_check -s exit:1 -e match:"No such file or directory" \
		setextattr user myattr myvalue foo
	atf_check -s exit:1 -e match:"No such file or directory" \
		getextattr user myattr foo
	atf_check -s exit:1 -e match:"No such file or directory" \
		rmextattr user myattr foo
}

atf_test_case null
proc null_head {
	atf_set "descr" "NUL-terminate an attribute value"
}
proc null_body {
	check_fs
	touch foo
	atf_check -s exit:0 -o empty setextattr -n user myattr myvalue foo
	atf_check -s exit:0 -o inline:"myvalue\0\n" getextattr -q user myattr foo
}

atf_test_case one_user_attr
proc one_user_attr_head {
	atf_set "descr" "A file with one extended attribute"
}
proc one_user_attr_body {
	check_fs
	touch foo
	atf_check -s exit:0 -o empty setextattr user myattr myvalue foo
	atf_check -s exit:0 -o inline:"myattr\n" lsextattr -q user foo
	atf_check -s exit:0 -o inline:"myvalue\n" getextattr -q user myattr foo
	atf_check -s exit:0 -o empty rmextattr user myattr foo
	atf_check -s exit:0 -o empty lsextattr -q user foo
}

atf_test_case one_system_attr
proc one_system_attr_head {
	atf_set "descr" "A file with one extended attribute"
	atf_set "require.user" "root"
}
proc one_system_attr_body {
	check_fs
	touch foo
	atf_check -s exit:0 -o empty setextattr system myattr myvalue foo
	atf_check -s exit:0 -o inline:"myattr\n" lsextattr -q system foo
	atf_check -s exit:0 -o inline:"myvalue\n" getextattr -q system myattr foo
	atf_check -s exit:0 -o empty rmextattr system myattr foo
	atf_check -s exit:0 -o empty lsextattr -q system foo
}

atf_test_case stdin
proc stdin_head {
	atf_set "descr" "Set attribute value from stdin"
}
proc stdin_body {
	check_fs
	dd if=/dev/random of=infile bs=1k count=8
	touch foo
	setextattr -i user myattr foo < infile || atf_fail "setextattr failed"
	atf_check -s exit:0 -o inline:"myattr\n" lsextattr -q user foo
	getextattr -qq user myattr foo > outfile || atf_fail "getextattr failed"
	atf_check -s exit:0 cmp -s infile outfile
}

atf_test_case stringify
proc stringify_head {
	atf_set "descr" "Stringify the output of getextattr"
}
proc stringify_body {
	check_fs
	touch foo
	atf_check -s exit:0 -o empty setextattr user myattr "my value" foo
	atf_check -s exit:0 -o inline:"\"my\\\040value\"\n" \
		getextattr -qs user myattr foo
}

atf_test_case symlink
proc symlink_head {
	atf_set "descr" "A symlink to an ordinary file"
}
proc symlink_body {
	check_fs
	touch foo
	ln -s foo foolink
	atf_check -s exit:0 -o empty setextattr user myattr myvalue foolink
	atf_check -s exit:0 -o inline:"myvalue\n" \
		getextattr -q user myattr foolink
	atf_check -s exit:0 -o inline:"myvalue\n" getextattr -q user myattr foo
}

atf_test_case symlink_nofollow
proc symlink_nofollow_head {
	atf_set "descr" "Operating directly on a symlink"
}
proc symlink_nofollow_body {
	check_fs
	touch foo
	ln -s foo foolink
	# Check that with -h we can operate directly on the link
	atf_check -s exit:0 -o empty setextattr -h user myattr myvalue foolink
	atf_check -s exit:0 -o inline:"myvalue\n" \
		getextattr -qh user myattr foolink
	atf_check -s exit:1 -e match:"Attribute not found" \
		getextattr user myattr foolink
	atf_check -s exit:1 -e match:"Attribute not found" \
		getextattr user myattr foo

	# Check that with -h we cannot operate on the destination file
	atf_check -s exit:0 -o empty setextattr user otherattr othervalue foo
	atf_check -s exit:1 getextattr -qh user otherattr foolink
}

atf_test_case system_and_user_attrs
proc system_and_user_attrs_head {
	atf_set "descr" "A file with both system and user extended attributes"
	atf_set "require.user" "root"
}
proc system_and_user_attrs_body {
	check_fs
	touch foo
	atf_check -s exit:0 -o empty setextattr user userattr userval foo
	atf_check -s exit:0 -o empty setextattr system sysattr sysval foo
	atf_check -s exit:0 -o inline:"userattr\n" lsextattr -q user foo
	atf_check -s exit:0 -o inline:"sysattr\n" lsextattr -q system foo

	atf_check -s exit:0 -o inline:"userval\n" getextattr -q user userattr foo
	atf_check -s exit:0 -o inline:"sysval\n" getextattr -q system sysattr foo
	atf_check -s exit:0 -o empty rmextattr user userattr foo
	atf_check -s exit:0 -o empty rmextattr system sysattr foo
	atf_check -s exit:0 -o empty lsextattr -q user foo
	atf_check -s exit:0 -o empty lsextattr -q system foo
}

atf_test_case two_files
proc two_files_head {
	atf_set "descr" "Manipulate two files"
}
proc two_files_body {
	check_fs
	touch foo bar
	atf_check -s exit:0 -o empty setextattr user myattr myvalue foo bar
	atf_check -s exit:0 -o inline:"foo\tmyattr\nbar\tmyattr\n" \
		lsextattr user foo bar
	atf_check -s exit:0 \
		-o inline:"foo\tmyvalue\nbar\tmyvalue\n" \
		getextattr user myattr foo bar
	atf_check -s exit:0 -o empty rmextattr user myattr foo bar
	atf_check -s exit:0 -o empty lsextattr -q user foo bar
}

atf_test_case two_files_force
proc two_files_force_head {
	atf_set "descr" "Manipulate two files.  The first does not exist"
}
proc two_files_force_body {
	check_fs
	touch bar
	atf_check -s exit:1 -e match:"No such file or directory" \
		setextattr user myattr myvalue foo bar
	atf_check -s exit:0 -e ignore setextattr -f user myattr myvalue foo bar
	atf_check -s exit:1 -e match:"No such file or directory" \
		lsextattr user foo bar
	atf_check -s exit:0 -e ignore -o inline:"bar\tmyattr\n" \
		lsextattr -f user foo bar
	atf_check -s exit:1 -e match:"No such file or directory" \
		getextattr user myattr foo bar
	atf_check -s exit:0 -e ignore \
		-o inline:"bar\tmyvalue\n" \
		getextattr -f user myattr foo bar
	atf_check -s exit:1 -e match:"No such file or directory" \
		rmextattr user myattr foo bar
	atf_check -s exit:0 -e ignore \
		rmextattr -f user myattr foo bar
	atf_check -s exit:0 -o empty lsextattr -q user bar
}

atf_test_case two_user_attrs
proc two_user_attrs_head {
	atf_set "descr" "A file with two extended attributes"
}
proc two_user_attrs_body {
	check_fs
	touch foo
	atf_check -s exit:0 -o empty setextattr user myattr1 myvalue1 foo
	atf_check -s exit:0 -o empty setextattr user myattr2 myvalue2 foo
	# lsextattr could return the attributes in any order, so we must be
	# careful how we compare them.
	setglobal raw_output = $[lsextattr -q user foo] || atf_fail "lsextattr failed"
	setglobal tabless_output = $[printf "%s %s" $(raw_output)]
	if test "myattr1 myattr2" != $(tabless_output) -a \
	     "myattr2 myattr1" != $(tabless_output) {
		atf_fail "lsextattr printed $(tabless_output)"
	}
	atf_check -s exit:0 -o inline:"myvalue1\n" getextattr -q user myattr1 foo
	atf_check -s exit:0 -o inline:"myvalue2\n" getextattr -q user myattr2 foo
	atf_check -s exit:0 -o empty rmextattr user myattr2 foo
	atf_check -s exit:0 -o empty rmextattr user myattr1 foo
	atf_check -s exit:0 -o empty lsextattr -q user foo
}

atf_test_case unprivileged_user_cannot_set_system_attr
proc unprivileged_user_cannot_set_system_attr_head {
	atf_set "descr" "Unprivileged users can't set system attributes"
        atf_set "require.user" "unprivileged"
}
proc unprivileged_user_cannot_set_system_attr_body {
	check_fs
	touch foo
	atf_check -s exit:1 -e match:"Operation not permitted" \
		setextattr system myattr myvalue foo
}


proc atf_init_test_cases {
	atf_add_test_case bad_namespace
	atf_add_test_case hex
	atf_add_test_case hex_nonascii
	atf_add_test_case long_name
	atf_add_test_case loud
	atf_add_test_case noattrs
	atf_add_test_case nonexistent_file
	atf_add_test_case null
	atf_add_test_case symlink_nofollow
	atf_add_test_case one_user_attr
	atf_add_test_case one_system_attr
	atf_add_test_case stdin
	atf_add_test_case stringify
	atf_add_test_case symlink
	atf_add_test_case symlink_nofollow
	atf_add_test_case system_and_user_attrs
	atf_add_test_case two_files
	atf_add_test_case two_files_force
	atf_add_test_case two_user_attrs
	atf_add_test_case unprivileged_user_cannot_set_system_attr
}

proc check_fs {
	match $[df -T . | tail -n 1 | cut -wf 2] {
		with "ufs"  # UFS is fine
		with "zfs"  # ZFS is fine
		with "tmpfs" atf_skip "tmpfs does not support extended attributes"
	}
}