Re: [RFC PATCH 1/6] t0066: improve readablity of dir-iterator tests

[Plato Kiorpelidis <kioplato@gmail.com>]

On 22/04/11 02:16PM, Phillip Wood wrote:
> Hi Plato
> 
> On 10/04/2022 12:18, Plato Kiorpelidis wrote:
> > Be consistent throughout the dir-iterator tests regarding the order in
> > which we:
> >    * create test directories
> >    * create expected outputs
> >    * test if actual and expected outputs differ
> 
> When writing a commit message it is important to explain why you are making
> the changes in the patch, rather than just describe the changes themselves.
> 
> In general modernizing or standardizing existing tests before adding new
> ones is a good idea. However it is important to do it in a way that lets
> reviewers see there are no unintended changes. In this patch so much is
> changed it's really hard to tell if you have changed any of the tests or
> not. It would be much easier if you had not renamed all the directories and
> files that are created and renamed the tests as well.
> 
> I think that having separate setup tests makes sense as we're going to want
> to test different iteration schemes over the same hierarchy but it would be
> helpful to have the "expect" files written in the same test that calls
> test_cmp. That way it is much easier to debug test failures in the CI as it
> one can see the contents of "expect" as well as the diff from test_cmp in
> the CI output.

I agree. All three points have been adopted in the upcoming v2:
1. Explain _why_ I'm making these changes.
2. Create targeted commits with smaller diffs. (This commit has been splitted)
3. Write "expected-*" files in the same test that calls test_cmp.

Thanks,
Plato

> 
> Best Wishes
> 
> Phillip
> 
> > Signed-off-by: Plato Kiorpelidis <kioplato@gmail.com>
> > ---
> >   t/t0066-dir-iterator.sh | 227 +++++++++++++++++++++-------------------
> >   1 file changed, 118 insertions(+), 109 deletions(-)
> > 
> > diff --git a/t/t0066-dir-iterator.sh b/t/t0066-dir-iterator.sh
> > index 63a1a45cd3..fb20219487 100755
> > --- a/t/t0066-dir-iterator.sh
> > +++ b/t/t0066-dir-iterator.sh
> > @@ -5,145 +5,154 @@ test_description='Test the dir-iterator functionality'
> >   TEST_PASSES_SANITIZE_LEAK=true
> >   . ./test-lib.sh
> > -test_expect_success 'setup' '
> > -	mkdir -p dir &&
> > -	mkdir -p dir/a/b/c/ &&
> > -	>dir/b &&
> > -	>dir/c &&
> > -	mkdir -p dir/d/e/d/ &&
> > -	>dir/a/b/c/d &&
> > -	>dir/a/e &&
> > -	>dir/d/e/d/a &&
> > -
> > -	mkdir -p dir2/a/b/c/ &&
> > -	>dir2/a/b/c/d
> > +test_expect_success 'setup -- dir w/ three nested dirs w/ file' '
> > +	mkdir -p dir6/a/b/c &&
> > +	>dir6/a/b/c/d &&
> > +
> > +
> > +	cat >expected-out <<-EOF
> > +	[d] (a) [a] ./dir6/a
> > +	[d] (a/b) [b] ./dir6/a/b
> > +	[d] (a/b/c) [c] ./dir6/a/b/c
> > +	[f] (a/b/c/d) [d] ./dir6/a/b/c/d
> > +	EOF
> > +'
> > +test_expect_success 'iteration of dir w/ three nested dirs w/ file' '
> > +	test-tool dir-iterator ./dir6 >actual-out &&
> > +	test_cmp expected-out actual-out
> >   '
> > -test_expect_success 'dir-iterator should iterate through all files' '
> > -	cat >expected-iteration-sorted-output <<-EOF &&
> > -	[d] (a) [a] ./dir/a
> > -	[d] (a/b) [b] ./dir/a/b
> > -	[d] (a/b/c) [c] ./dir/a/b/c
> > -	[d] (d) [d] ./dir/d
> > -	[d] (d/e) [e] ./dir/d/e
> > -	[d] (d/e/d) [d] ./dir/d/e/d
> > -	[f] (a/b/c/d) [d] ./dir/a/b/c/d
> > -	[f] (a/e) [e] ./dir/a/e
> > -	[f] (b) [b] ./dir/b
> > -	[f] (c) [c] ./dir/c
> > -	[f] (d/e/d/a) [a] ./dir/d/e/d/a
> > +test_expect_success 'setup -- dir w/ complex structure w/o symlinks' '
> > +	mkdir -p dir11/a/b/c/ &&
> > +	>dir11/b &&
> > +	>dir11/c &&
> > +	>dir11/a/e &&
> > +	>dir11/a/b/c/d &&
> > +	mkdir -p dir11/d/e/d/ &&
> > +	>dir11/d/e/d/a &&
> > +
> > +
> > +	cat >expected-sorted-out <<-EOF
> > +	[d] (a) [a] ./dir11/a
> > +	[d] (a/b) [b] ./dir11/a/b
> > +	[d] (a/b/c) [c] ./dir11/a/b/c
> > +	[d] (d) [d] ./dir11/d
> > +	[d] (d/e) [e] ./dir11/d/e
> > +	[d] (d/e/d) [d] ./dir11/d/e/d
> > +	[f] (a/b/c/d) [d] ./dir11/a/b/c/d
> > +	[f] (a/e) [e] ./dir11/a/e
> > +	[f] (b) [b] ./dir11/b
> > +	[f] (c) [c] ./dir11/c
> > +	[f] (d/e/d/a) [a] ./dir11/d/e/d/a
> >   	EOF
> > +'
> > +test_expect_success 'iteration of dir w/ complex structure w/o symlinks' '
> > +	test-tool dir-iterator ./dir11 >actual-out &&
> > +	sort actual-out >actual-sorted-out &&
> > -	test-tool dir-iterator ./dir >out &&
> > -	sort out >./actual-iteration-sorted-output &&
> > +	test_cmp expected-sorted-out actual-sorted-out
> > +'
> > -	test_cmp expected-iteration-sorted-output actual-iteration-sorted-output
> > +test_expect_success 'dir_iterator_begin() should fail upon inexistent paths' '
> > +	echo "dir_iterator_begin failure: ENOENT" >expected-inexistent-path-out &&
> > +
> > +	test_must_fail test-tool dir-iterator ./inexistent-path >actual-out &&
> > +	test_cmp expected-inexistent-path-out actual-out
> >   '
> > -test_expect_success 'dir-iterator should list files in the correct order' '
> > -	cat >expected-pre-order-output <<-EOF &&
> > -	[d] (a) [a] ./dir2/a
> > -	[d] (a/b) [b] ./dir2/a/b
> > -	[d] (a/b/c) [c] ./dir2/a/b/c
> > -	[f] (a/b/c/d) [d] ./dir2/a/b/c/d
> > -	EOF
> > +test_expect_success 'dir_iterator_begin() should fail upon non directory paths' '
> > +	>some-file &&
> > -	test-tool dir-iterator ./dir2 >actual-pre-order-output &&
> > -	test_cmp expected-pre-order-output actual-pre-order-output
> > -'
> > +	echo "dir_iterator_begin failure: ENOTDIR" >expected-non-dir-out &&
> > -test_expect_success 'begin should fail upon inexistent paths' '
> > -	test_must_fail test-tool dir-iterator ./inexistent-path \
> > -		>actual-inexistent-path-output &&
> > -	echo "dir_iterator_begin failure: ENOENT" >expected-inexistent-path-output &&
> > -	test_cmp expected-inexistent-path-output actual-inexistent-path-output
> > -'
> > +	test_must_fail test-tool dir-iterator ./some-file >actual-out &&
> > +	test_cmp expected-non-dir-out actual-out &&
> > -test_expect_success 'begin should fail upon non directory paths' '
> > -	test_must_fail test-tool dir-iterator ./dir/b >actual-non-dir-output &&
> > -	echo "dir_iterator_begin failure: ENOTDIR" >expected-non-dir-output &&
> > -	test_cmp expected-non-dir-output actual-non-dir-output
> > +	test_must_fail test-tool dir-iterator --pedantic ./some-file >actual-out &&
> > +	test_cmp expected-non-dir-out actual-out
> >   '
> > -test_expect_success POSIXPERM,SANITY 'advance should not fail on errors by default' '
> > -	cat >expected-no-permissions-output <<-EOF &&
> > -	[d] (a) [a] ./dir3/a
> > -	EOF
> > +test_expect_success POSIXPERM,SANITY \
> > +'dir_iterator_advance() should not fail on errors by default' '
> > -	mkdir -p dir3/a &&
> > -	>dir3/a/b &&
> > -	chmod 0 dir3/a &&
> > +	mkdir -p dir13/a &&
> > +	>dir13/a/b &&
> > +	chmod 0 dir13/a &&
> > -	test-tool dir-iterator ./dir3 >actual-no-permissions-output &&
> > -	test_cmp expected-no-permissions-output actual-no-permissions-output &&
> > -	chmod 755 dir3/a &&
> > -	rm -rf dir3
> > -'
> > -test_expect_success POSIXPERM,SANITY 'advance should fail on errors, w/ pedantic flag' '
> > -	cat >expected-no-permissions-pedantic-output <<-EOF &&
> > -	[d] (a) [a] ./dir3/a
> > -	dir_iterator_advance failure
> > +	cat >expected-no-permissions-out <<-EOF &&
> > +	[d] (a) [a] ./dir13/a
> >   	EOF
> > -	mkdir -p dir3/a &&
> > -	>dir3/a/b &&
> > -	chmod 0 dir3/a &&
> > +	test-tool dir-iterator ./dir13 >actual-out &&
> > +	test_cmp expected-no-permissions-out actual-out &&
> > -	test_must_fail test-tool dir-iterator --pedantic ./dir3 \
> > -		>actual-no-permissions-pedantic-output &&
> > -	test_cmp expected-no-permissions-pedantic-output \
> > -		actual-no-permissions-pedantic-output &&
> > -	chmod 755 dir3/a &&
> > -	rm -rf dir3
> > +	chmod 755 dir13/a &&
> > +	rm -rf dir13
> >   '
> > -test_expect_success SYMLINKS 'setup dirs with symlinks' '
> > -	mkdir -p dir4/a &&
> > -	mkdir -p dir4/b/c &&
> > -	>dir4/a/d &&
> > -	ln -s d dir4/a/e &&
> > -	ln -s ../b dir4/a/f &&
> > -
> > -	mkdir -p dir5/a/b &&
> > -	mkdir -p dir5/a/c &&
> > -	ln -s ../c dir5/a/b/d &&
> > -	ln -s ../ dir5/a/b/e &&
> > -	ln -s ../../ dir5/a/b/f
> > -'
> > +test_expect_success POSIXPERM,SANITY \
> > +'dir_iterator_advance() should fail on errors, w/ pedantic flag' '
> > -test_expect_success SYMLINKS 'dir-iterator should not follow symlinks by default' '
> > -	cat >expected-no-follow-sorted-output <<-EOF &&
> > -	[d] (a) [a] ./dir4/a
> > -	[d] (b) [b] ./dir4/b
> > -	[d] (b/c) [c] ./dir4/b/c
> > -	[f] (a/d) [d] ./dir4/a/d
> > -	[s] (a/e) [e] ./dir4/a/e
> > -	[s] (a/f) [f] ./dir4/a/f
> > +	mkdir -p dir13/a &&
> > +	>dir13/a/b &&
> > +	chmod 0 dir13/a &&
> > +
> > +
> > +	cat >expected-no-permissions-pedantic-out <<-EOF &&
> > +	[d] (a) [a] ./dir13/a
> > +	dir_iterator_advance failure
> >   	EOF
> > -	test-tool dir-iterator ./dir4 >out &&
> > -	sort out >actual-no-follow-sorted-output &&
> > +	test_must_fail test-tool dir-iterator --pedantic ./dir13 >actual-out &&
> > +	test_cmp expected-no-permissions-pedantic-out actual-out &&
> > -	test_cmp expected-no-follow-sorted-output actual-no-follow-sorted-output
> > +	chmod 755 dir13/a &&
> > +	rm -rf dir13
> >   '
> > -test_expect_success SYMLINKS 'dir-iterator should follow symlinks w/ follow flag' '
> > -	cat >expected-follow-sorted-output <<-EOF &&
> > -	[d] (a) [a] ./dir4/a
> > -	[d] (a/f) [f] ./dir4/a/f
> > -	[d] (a/f/c) [c] ./dir4/a/f/c
> > -	[d] (b) [b] ./dir4/b
> > -	[d] (b/c) [c] ./dir4/b/c
> > -	[f] (a/d) [d] ./dir4/a/d
> > -	[f] (a/e) [e] ./dir4/a/e
> > +test_expect_success SYMLINKS 'setup -- dir w/ symlinks w/o cycle' '
> > +	mkdir -p dir14/a &&
> > +	mkdir -p dir14/b/c &&
> > +	>dir14/a/d &&
> > +	ln -s d dir14/a/e &&
> > +	ln -s ../b dir14/a/f &&
> > +
> > +
> > +	cat >expected-dont-follow-sorted-out <<-EOF &&
> > +	[d] (a) [a] ./dir14/a
> > +	[d] (b) [b] ./dir14/b
> > +	[d] (b/c) [c] ./dir14/b/c
> > +	[f] (a/d) [d] ./dir14/a/d
> > +	[s] (a/e) [e] ./dir14/a/e
> > +	[s] (a/f) [f] ./dir14/a/f
> >   	EOF
> > +	cat >expected-follow-sorted-out <<-EOF
> > +	[d] (a) [a] ./dir14/a
> > +	[d] (a/f) [f] ./dir14/a/f
> > +	[d] (a/f/c) [c] ./dir14/a/f/c
> > +	[d] (b) [b] ./dir14/b
> > +	[d] (b/c) [c] ./dir14/b/c
> > +	[f] (a/d) [d] ./dir14/a/d
> > +	[f] (a/e) [e] ./dir14/a/e
> > +	EOF
> > +'
> > +test_expect_success SYMLINKS \
> > +'dont-follow-symlinks of dir w/ symlinks w/o cycle' '
> > +
> > +	test-tool dir-iterator ./dir14 >actual-out &&
> > +	sort actual-out >actual-sorted-out &&
> > +
> > +	test_cmp expected-dont-follow-sorted-out actual-sorted-out
> > +'
> > +test_expect_success SYMLINKS \
> > +'follow-symlinks of dir w/ symlinks w/o cycle' '
> > -	test-tool dir-iterator --follow-symlinks ./dir4 >out &&
> > -	sort out >actual-follow-sorted-output &&
> > +	test-tool dir-iterator --follow-symlinks ./dir14 >actual-out &&
> > +	sort actual-out >actual-sorted-out &&
> > -	test_cmp expected-follow-sorted-output actual-follow-sorted-output
> > +	test_cmp expected-follow-sorted-out actual-sorted-out
> >   '
> >   test_done
>