aboutsummaryrefslogtreecommitdiffstats
path: root/tests/zfs-tests/tests/functional/xattr/xattr_common.kshlib
blob: bc06f4716867bd43a63b1b0374c255a1534ebd2d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
# or http://www.opensolaris.org/os/licensing.
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#

#
# Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
# Use is subject to license terms.
#

#
# Copyright (c) 2013, 2016 by Delphix. All rights reserved.
#

. $STF_SUITE/include/libtest.shlib
. $STF_SUITE/tests/functional/xattr/xattr.cfg

# a function that takes a file, then creates and verifies
# an xattr on that file. The xattr_contents is the file
# that should appear in the xattr namespace.
function create_xattr { # filename xattr_name xattr_contents
	typeset FILE=$1
	typeset XATTR_NAME=$2
	typeset XATTR_CONTENTS=$3

	if is_illumos; then
		# read any empty xattr on that file
		log_must runat $FILE ls
		# create the xattr
		log_must runat $FILE cp $XATTR_CONTENTS $XATTR_NAME
	else
		log_mustnot get_xattr $XATTR_NAME $FILE
		log_must set_xattr_stdin $XATTR_NAME $FILE < $XATTR_CONTENTS
	fi

	verify_xattr $FILE $XATTR_NAME $XATTR_CONTENTS
}

# a function that compares the a single xattr between two files
# and checks to see if their contents are identical
function compare_xattrs { # filename1 filename2 xattr_name
	typeset FILE1=$1
	typeset FILE2=$2
	typeset XATTR_NAME=$3

	if is_illumos; then
		runat $FILE1 cat $XATTR_NAME > $TEST_BASE_DIR/file1.$$
		runat $FILE2 cat $XATTR_NAME > $TEST_BASE_DIR/file2.$$
	else
		get_xattr $XATTR_NAME $FILE1 > $TEST_BASE_DIR/file1.$$
		get_xattr $XATTR_NAME $FILE2 > $TEST_BASE_DIR/file2.$$
	fi

	log_must diff $TEST_BASE_DIR/file1.$$ $TEST_BASE_DIR/file2.$$
	log_must rm $TEST_BASE_DIR/file1.$$ $TEST_BASE_DIR/file2.$$
}

function verify_xattr { # filename xattr_name xattr_contents
	typeset FILE=$1
	typeset XATTR_NAME=$2
	typeset XATTR_CONTENTS=$3

	# read the xattr, writing it to a temp file
	if is_illumos; then
		log_must eval \
		    "runat $FILE cat $XATTR_NAME > $TEST_BASE_DIR/$XATTR_NAME.$$ 2>&1"
	else
		log_must eval \
		    "get_xattr $XATTR_NAME $FILE > $TEST_BASE_DIR/$XATTR_NAME.$$"
	fi

	log_must diff $XATTR_CONTENTS $TEST_BASE_DIR/$XATTR_NAME.$$
	rm $TEST_BASE_DIR/$XATTR_NAME.$$
}

function delete_xattr { # filename xattr_name
        typeset FILE=$1
        typeset XATTR_NAME=$2

        # delete the xattr
        if is_illumos; then
	        log_must runat $FILE rm $XATTR_NAME
	        log_mustnot eval "runat $FILE ls $XATTR_NAME > /dev/null 2>&1"
	else
		log_must rm_xattr $XATTR_NAME $FILE
		log_mustnot get_xattr $XATTR_NAME $FILE
	fi
}

# not sure about this : really this should be testing write/append
function verify_write_xattr { # filename xattr_name
        typeset FILE=$1
        typeset XATTR_NAME=$2

	if is_illumos; then
	        log_must eval "runat $FILE dd if=/etc/passwd of=$XATTR_NAME"
	        log_must eval \
		    "runat $FILE cat $XATTR_NAME > $TEST_BASE_DIR/$XATTR_NAME.$$ 2>&1"
	else
		log_must set_xattr_stdin $XATTR_NAME $FILE < /etc/passwd
		log_must eval \
		    "get_xattr $XATTR_NAME $FILE > $TEST_BASE_DIR/$XATTR_NAME.$$"
	fi
        log_must dd if=/etc/passwd of=$TEST_BASE_DIR/passwd_dd.$$
        log_must diff $TEST_BASE_DIR/passwd_dd.$$ $TEST_BASE_DIR/$XATTR_NAME.$$
        log_must rm $TEST_BASE_DIR/passwd_dd.$$ $TEST_BASE_DIR/$XATTR_NAME.$$
}

# this function is to create the expected output
function create_expected_output { # expected_output_file  contents_of_the_output
	typeset FILE=$1
	shift
	if [[ -f $FILE ]]; then
		log_must rm $FILE
	fi

	for line in $@
	do
		log_must eval "echo $line >> $FILE"
	done
}