tests/overlay/060

#! /bin/bash
# FS QA Test No. 060
#
# Test metadata only copy up functionality.
#
#-----------------------------------------------------------------------
# Copyright (C) 2018 Red Hat, Inc. All Rights Reserved.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it would be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write the Free Software Foundation,
# Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
#-----------------------------------------------------------------------
#

seq=`basename $0`
seqres=$RESULT_DIR/$seq
echo "QA output created by $seq"

here=`pwd`
tmp=/tmp/$$
status=1	# failure is the default!
trap "_cleanup; exit \$status" 0 1 2 3 15

_cleanup()
{
	cd /
	rm -f $tmp.*
}

# get standard environment, filters and checks
. ./common/rc
. ./common/filter

# remove previous $seqres.full before test
rm -f $seqres.full

# real QA test starts here
_supported_fs overlay
_supported_os Linux
# We use non-default scratch underlying overlay dirs, we need to check
# them explicity after test.
_require_scratch_nocheck
_require_scratch_overlay_features index redirect_dir metacopy

# remove all files from previous tests
_scratch_mkfs

# File size on lower
lowername="lowerfile"
lowerlink="lowerfile-link"
lowerdata="lower"
lowersize="4096"

# Number of blocks allocated by filesystem on lower. Will be queried later.
lowerblocks=""

udirname="pureupper"
ufile="upperfile"

# Check metacopy xattr
check_metacopy()
{
        local target=$1 exist=$2
	local out_f target_f
	local msg

        out_f=$($GETFATTR_PROG --absolute-names --only-values -n \
		$OVL_XATTR_METACOPY $target 2>&1 | _filter_scratch)

	if [ "$exist" == "y" ];then
		[ "$out_f" == "" ] && return
		echo "Metacopy xattr does not exist on ${target}. stdout=$out_f"
		return
	fi

	if [ "$out_f" == "" ];then
		echo "Metacopy xattr exists on ${target} unexpectedly."
		return
	fi

	target_f=`echo $target | _filter_scratch`
	msg="$target_f: trusted.overlay.metacopy: No such attribute"

	[ "$out_f" == "$msg" ] && return

	echo "Error while checking xattr on ${target}. stdout=$out"
}

# Check redirect xattr
check_redirect()
{
	local target=$1
	local expect=$2

	value=$($GETFATTR_PROG --absolute-names --only-values -n \
		$OVL_XATTR_REDIRECT $target)

	[[ "$value" == "$expect" ]] || echo "Redirect xattr incorrect. Expected=\"$expect\", actual=\"$value\""
}

# Check size
check_file_size()
{
	local target=$1 expected_size=$2 actual_size

	actual_size=$(stat -c "%s" $target)

	[ "$actual_size" == "$expected_size" ] || echo "Expected file size $expected_size but actual size is $actual_size"
}

check_file_blocks()
{
	local target=$1 expected_blocks=$2 nr_blocks

	nr_blocks=$(stat -c "%b" $target)

	[ "$nr_blocks" == "$expected_blocks" ] || echo "Expected $expected_blocks blocks but actual number of blocks is ${nr_blocks}."
}

check_file_contents()
{
	local target=$1 expected=$2
	local actual target_f

	target_f=`echo $target | _filter_scratch`

	read actual<$target

	[ "$actual" == "$expected" ] || echo "Expected file $target_f contents to be \"$expected\" but actual contents are \"$actual\""
}

check_file_size_contents()
{
	local target=$1 expected_size=$2 expected_content=$3

	check_file_size $target $expected_size
	check_file_contents $target $expected_content
}

mount_overlay()
{
	local _lowerdir=$1

	_overlay_scratch_mount_dirs "$_lowerdir" $upperdir $workdir -o redirect_dir=on,index=on,metacopy=on
}

umount_overlay()
{
	$UMOUNT_PROG $SCRATCH_MNT
}

# Assumes it is called with overlay mounted.
test_common()
{
	local _lowerdir=$1 _target=$2 _size=$3 _blocks=$4 _data="$5"
	local _redirect=$6

	echo "check properties of metadata copied up file"
	check_file_size_contents $SCRATCH_MNT/$_target $_size "$_data"
	check_file_blocks $SCRATCH_MNT/$_target $_blocks

	# Do a mount cycle and check size and contents again.
	echo "Unmount and Mount again"
	umount_overlay
	mount_overlay $_lowerdir
	echo "check properties of metadata copied up file"
	check_file_size_contents $SCRATCH_MNT/$_target $_size "$_data"
	check_file_blocks $SCRATCH_MNT/$_target $_blocks

	# Make sure copied up file is a metacopy file.
	umount_overlay
	check_metacopy $upperdir/$_target "y"
	check_file_size_contents $upperdir/$_target $_size ""
	[ -n "$_redirect" ] && check_redirect $upperdir/$_target "$_redirect"

	# Trigger data copy up and check absence of metacopy xattr.
	mount_overlay $_lowerdir
	$XFS_IO_PROG -c "open -a $SCRATCH_MNT/$_target"
	echo "check properties of data copied up file"
	check_file_size_contents $SCRATCH_MNT/$_target $_size "$_data"
	umount_overlay
	check_metacopy $upperdir/$_target "n"
	check_file_size_contents $upperdir/$_target $_size "$_data"
}

create_basic_files()
{
	_scratch_mkfs
	mkdir -p $lowerdir $lowerdir2 $upperdir $workdir $workdir2
	mkdir -p $upperdir/$udirname
	echo "$lowerdata" > $lowerdir/$lowername
	chmod 600 $lowerdir/$lowername
	# Create a file of size lowersize.
	$XFS_IO_PROG -c "falloc 0 $lowersize" $lowerdir/$lowername
	$XFS_IO_PROG -c "fsync" $lowerdir/$lowername

	# Query number of lower
	lowerblocks=$(stat -c "%b" $lowerdir/$lowername)
}

create_lower_link()
{
	ln $lowerdir/$lowername $lowerdir/$lowerlink
}

prepare_midlayer()
{
	_scratch_mkfs
	create_basic_files
	# Create midlayer
	_overlay_scratch_mount_dirs $lowerdir $lowerdir2 $workdir2 -o redirect_dir=on,index=on,metacopy=on
	# Trigger a metacopy
	chmod 400 $SCRATCH_MNT/$lowername
	umount_overlay
}

# Create test directories
lowerdir=$OVL_BASE_SCRATCH_MNT/lower
lowerdir2=$OVL_BASE_SCRATCH_MNT/lower2
upperdir=$OVL_BASE_SCRATCH_MNT/upper
workdir=$OVL_BASE_SCRATCH_MNT/workdir
workdir2=$OVL_BASE_SCRATCH_MNT/workdir2

# Tests start here
echo "== Check Simple Metacopy =="
create_basic_files
mount_overlay $lowerdir
chmod 400 $SCRATCH_MNT/$lowername
test_common $lowerdir $lowername $lowersize $lowerblocks "$lowerdata"

# Test midlayer metacopy
echo -e "\n== Check Midlayer Metacopy =="
prepare_midlayer
mount_overlay "$lowerdir2:$lowerdir"
chmod 400 $SCRATCH_MNT/$lowername
test_common "$lowerdir2:$lowerdir" $lowername $lowersize $lowerblocks \
		"$lowerdata"

# Test Rename Redirect
echo -e "\n== Check Rename Redirect =="
create_basic_files
mount_overlay $lowerdir
mv $SCRATCH_MNT/$lowername $SCRATCH_MNT/$ufile
test_common $lowerdir $ufile $lowersize $lowerblocks "$lowerdata" "$lowername"

# Test midlayer rename redirect
echo -e "\n== Check Midlayer Rename Redirect =="
prepare_midlayer
mount_overlay "$lowerdir2:$lowerdir"
mv $SCRATCH_MNT/$lowername $SCRATCH_MNT/$ufile
test_common "$lowerdir2:$lowerdir" $ufile $lowersize $lowerblocks "$lowerdata" \
		"$lowername"

# Test Link Redirect
echo -e "\n== Check Link Redirect =="
create_basic_files
mount_overlay $lowerdir
ln $SCRATCH_MNT/$lowername $SCRATCH_MNT/$udirname/$ufile
test_common $lowerdir $udirname/$ufile $lowersize $lowerblocks "$lowerdata" \
		"/$lowername"

# Test midlayer link redirect
echo -e "\n== Check Midlayer Link Redirect =="
prepare_midlayer
mount_overlay "$lowerdir2:$lowerdir"
ln $SCRATCH_MNT/$lowername $SCRATCH_MNT/$udirname/$ufile
test_common "$lowerdir2:$lowerdir" $udirname/$ufile $lowersize $lowerblocks \
		"$lowerdata" "/$lowername"

# Test lower link file gets absolute redirect upon rename
echo -e "\n== Check Lower Link Rename Absolute Redirect =="
create_basic_files
create_lower_link
mount_overlay $lowerdir
mv $SCRATCH_MNT/$lowerlink $SCRATCH_MNT/$ufile
test_common $lowerdir $ufile $lowersize $lowerblocks "$lowerdata" "/$lowerlink"

# success, all done
status=0
exit