Re: [PATCH v3 3/7] overlay: add fsck.overlay redirect directory test

Amir Goldstein
2018-01-12T21:32:19Z

On Fri, Jan 12, 2018 at 2:05 PM, zhangyi (F) <yi.zhang@huawei.com> wrote:
> Add fsck.overlay test case to test it how to deal with invalid/valid/
> duplicate redirect xattr in underlying directories of overlayfs.
>
> Signed-off-by: zhangyi (F) <yi.zhang@huawei.com>

Looks good, with some minor comments

> ---
> tests/overlay/202 | 240 ++++++++++++++++++++++++++++++++++++++++++++++++++
> tests/overlay/202.out | 10 +++
> tests/overlay/group | 1 +
> 3 files changed, 251 insertions(+)
> create mode 100755 tests/overlay/202
> create mode 100644 tests/overlay/202.out
>
> diff --git a/tests/overlay/202 b/tests/overlay/202
> new file mode 100755
> index 0000000..84a7bad
> --- /dev/null
> +++ b/tests/overlay/202
> @@ -0,0 +1,240 @@
> +#! /bin/bash
> +# FS QA Test 202
> +#
> +# Test fsck.overlay how to deal with redirect xattr in overlayfs.
> +#
> +#-----------------------------------------------------------------------
> +# Copyright (c) 2017 Huawei. All Rights Reserved.
> +# Author: zhangyi (F) <yi.zhang@huawei.com>
> +#
> +# 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
> +. ./common/attr
> +
> +# remove previous $seqres.full before test
> +rm -f $seqres.full
> +
> +# real QA test starts here
> +_supported_fs overlay
> +_supported_os Linux
> +_require_scratch
> +_require_attrs
> +_require_command "$FSCK_OVERLAY_PROG" fsck.overlay
> +
> +# remove all files from previous tests
> +_scratch_mkfs
> +
> +OVL_REDIRECT_XATTR="trusted.overlay.redirect"
> +OVL_OPAQUE_XATTR="trusted.overlay.opaque"
> +OVL_OPAQUE_XATTR_VAL="y"
> +
> +# Create a redirect directory
> +make_redirect_dir()
> +{
> + local target=$1
> + local value=$2
> +
> + mkdir -p $target
> + $SETFATTR_PROG -n $OVL_REDIRECT_XATTR -v $value $target
> +}
> +
> +# Check redirect xattr
> +check_redirect()
> +{
> + local target=$1
> + local expect=$2
> +
> + value=$($GETFATTR_PROG --absolute-names --only-values -n \
> + $OVL_REDIRECT_XATTR $target)
> +
> + [[ $value == $expect ]] || echo "Redirect xattr incorrect"
> +}
> +
> +check_no_redirect()
> +{
> + local target=$1
> +
> + value=$($GETFATTR_PROG --absolute-names -d -m \
> + $OVL_REDIRECT_XATTR $target)
> +
> + [[ -z "$value" ]] || echo "Redirect xattr not empty"
> +}
> +
> +# Check opaque xattr
> +check_opaque()
> +{
> + local target=$1
> +
> + value=$($GETFATTR_PROG --absolute-names --only-values -n \
> + $OVL_OPAQUE_XATTR $target)
> +
> + [[ $value == $OVL_OPAQUE_XATTR_VAL ]] || echo "Opaque xattr incorrect"
> +}
> +
> +# Check whiteout
> +check_whiteout()
> +{
> + local target=$1
> +
> + target_type=`stat -c "%F:%t,%T" $target`
> +
> + [[ $target_type == "character special file:0,0" ]] || \
> + echo "Whiteout missing"
> +}
> +
> +# 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
> +
> +make_test_dirs()
> +{
> + rm -rf $lowerdir $lowerdir2 $upperdir $workdir
> + mkdir -p $lowerdir $lowerdir2 $upperdir $workdir
> +}
> +
> +# Test invalid redirect xattr point to a nonexistent origin, should remove
> +echo "+ Invalid redirect"
> +make_test_dirs
> +make_redirect_dir $upperdir/testdir "invalid"
> +
> +_overlay_fsck_dirs $lowerdir $upperdir $workdir -p >> $seqres.full 2>&1 || \
> + _fail "fsck should not fail"
> +check_no_redirect $upperdir/testdir
> +
> +# Test invalid redirect xattr point to a file origin, should remove
> +echo "+ Invalid redirect(2)"
> +make_test_dirs
> +touch $lowerdir/origin
> +make_redirect_dir $upperdir/testdir "origin"
> +
> +_overlay_fsck_dirs $lowerdir $upperdir $workdir -p >> $seqres.full 2>&1 || \
> + _fail "fsck should not fail"
> +check_no_redirect $upperdir/testdir
> +
> +# Test valid redirect xattr point to a directory origin in the same directory,
> +# should not remove
> +echo "+ Valid redirect"
> +make_test_dirs
> +mkdir $lowerdir/origin
> +mknod $upperdir/origin c 0 0

I got spoiled from previous tests ;-) please use make_whiteout helper
here as well.

> +make_redirect_dir $upperdir/testdir "origin"
> +
> +_overlay_fsck_dirs $lowerdir $upperdir $workdir -p >> $seqres.full 2>&1 || \
> + _fail "fsck should not fail"
> +check_redirect $upperdir/testdir "origin"
> +
> +# Test valid redirect xattr point to a directory origin in different directories
> +# should not remove
> +echo "+ Valid redirect(2)"
> +make_test_dirs
> +mkdir $lowerdir/origin
> +mknod $upperdir/origin c 0 0
> +make_redirect_dir $upperdir/testdir1/testdir2 "/origin"
> +
> +_overlay_fsck_dirs $lowerdir $upperdir $workdir -p >> $seqres.full 2>&1 || \
> + _fail "fsck should not fail"
> +check_redirect $upperdir/testdir1/testdir2 "/origin"
> +
> +# Test valid redirect xattr but missing whiteout to cover lower target,
> +# should fix whiteout
> +echo "+ Missing whiteout"
> +make_test_dirs
> +mkdir $lowerdir/origin
> +make_redirect_dir $upperdir/testdir "origin"
> +
> +_overlay_fsck_dirs $lowerdir $upperdir $workdir -p >> $seqres.full 2>&1 || \
> + _fail "fsck should not fail"
> +check_redirect $upperdir/testdir "origin"
> +check_whiteout $upperdir/origin
> +
> +# Test valid redirect xattrs exchanged by rename, should not remove
> +echo "+ Valid redirect(3)"
> +make_test_dirs
> +mkdir $lowerdir/{testdir1,testdir2}
> +make_redirect_dir $upperdir/testdir1 "testdir2"
> +make_redirect_dir $upperdir/testdir2 "testdir1"
> +
> +_overlay_fsck_dirs $lowerdir $upperdir $workdir -p >> $seqres.full 2>&1 || \
> + _fail "fsck should not fail"
> +check_redirect $upperdir/testdir1 "testdir2"
> +check_redirect $upperdir/testdir2 "testdir1"
> +
> +# Test invalid redirect xattr with lower same name directory exists,
> +# should remove invalid redirect xattr and set opaque in yes mode
> +echo "+ Invalid redirect(3)"
> +make_test_dirs
> +mkdir $lowerdir/testdir
> +make_redirect_dir $upperdir/testdir "invalid"
> +
> +_overlay_fsck_dirs $lowerdir $upperdir $workdir -y >> $seqres.full 2>&1 || \

When using -y, better add a comment with the expected questions
for whom Yes is the answer (even though one might deduce that from the
expected results)

> + _fail "fsck should not fail"
> +check_no_redirect $upperdir/testdir
> +check_opaque $upperdir/testdir
> +
> +# Test duplicate redirect xattrs point to one origin, should fail in
> +# auto mode, and should remove the duplicate one in yes mode

Better say "either of the duplicates" for clarity

> +echo "+ Duplicate redirect"
> +make_test_dirs
> +mkdir $lowerdir2/origin
> +make_redirect_dir $lowerdir/testdir1 "origin"
> +make_redirect_dir $lowerdir/testdir2 "origin"
> +make_redirect_dir $upperdir/testdir3 "origin"
> +
> +_overlay_fsck_dirs "$lowerdir:$lowerdir2" $upperdir $workdir -p >> \
> + $seqres.full 2>&1 && _fail "fsck should fail"
> +_overlay_fsck_dirs "$lowerdir:$lowerdir2" $upperdir $workdir -y >> \
> + $seqres.full 2>&1 || _fail "fsck should not fail"
> +redirect_1=`check_redirect $lowerdir/testdir1 "origin" 2>/dev/null`
> +redirect_2=`check_redirect $lowerdir/testdir2 "origin" 2>/dev/null`
> +[[ $redirect_1 == $redirect_2 ]] && echo "Redirect xattr incorrect"
> +check_no_redirect $upperdir/testdir3
> +
> +# Test duplicate redirect xattr duplicate with merge directory, should
> +# fail in auto mode, and should remove the redirect directory in yes mode
> +echo "+ Duplicate redirect(2)"
> +make_test_dirs
> +mkdir $lowerdir/origin $upperdir/origin
> +make_redirect_dir $upperdir/testdir "origin"
> +
> +_overlay_fsck_dirs $lowerdir $upperdir $workdir -p >> $seqres.full 2>&1 && \
> + _fail "fsck should fail"
> +_overlay_fsck_dirs $lowerdir $upperdir $workdir -y >> $seqres.full 2>&1 || \
> + _fail "fsck should not fail"
> +check_no_redirect $upperdir/testdir

Maybe also worth to have $lowerdir/testdir and check_opaque $upperdir/testdir
in this case? or add another case?

> +
> +# success, all done
> +status=0
> +exit
> diff --git a/tests/overlay/202.out b/tests/overlay/202.out
> new file mode 100644
> index 0000000..8473336
> --- /dev/null
> +++ b/tests/overlay/202.out
> @@ -0,0 +1,10 @@
> +QA output created by 202
> ++ Invalid redirect
> ++ Invalid redirect(2)
> ++ Valid redirect
> ++ Valid redirect(2)
> ++ Missing whiteout
> ++ Valid redirect(3)
> ++ Invalid redirect(3)
> ++ Duplicate redirect
> ++ Duplicate redirect(2)
> diff --git a/tests/overlay/group b/tests/overlay/group
> index 7c5fcbb..e39b5e0 100644
> --- a/tests/overlay/group
> +++ b/tests/overlay/group
> @@ -50,3 +50,4 @@
> 047 auto quick copyup hardlink
> 048 auto quick copyup hardlink
> 201 auto quick fsck
> +202 auto quick fsck
> --
> 2.9.5
>