[v3] t7300-clean.sh: use test_path_* helper functions for error logging

From: Abraham Samuel Adekunle <abrahamadekunle50@gmail.com>

From: Abraham Samuel Adekunle <abrahamadekunle50@gmail.com>

This test script uses "test - [def]", but when a test fails because
the file passed to it does not exist,
it fails silently without an error message.
Use test_path_* helper functions, which are designed to give better
error messages when their expectations are not met.

I have added a mechanical validation that applies the same transformation
done in this patch, when the test script is passed to a sed script as shown
below.

sed -e 's/^\(	*\)test -f /\1test_path_is_file /' \
    -e 's/^\(	*\)test -d /\1test_path_is_dir /' \
    -e 's/^\(	*\)test -e /\1test_path_exists /' \
    -e 's/^\(	*\)! test -[edf] /\1test_path_is_missing /' \
    -e 's/^\(	*\)test ! -[edf] /\1test_path_is_missing /' \
       "$1" >foo.sh

Reviewers can use the sed script to tranform the original test script and
compare the result in foo.sh with the results of applying the patch.
You will see an instance of "!(test -e 3)" which was manually replaced with
""test_path_is_missing 3", and everything else should match.

Careful and deliberate observation was done to check instances where
"test ! - [df] foo" was used in the test script to make sure that the test
instances were expecting foo to EITHER be a file or a directory, and NOT a
possibility of being both as this would make replacing "test ! -f foo" with
"test_path_is_missing foo" unreasonable.
In the tests control flow, foo has been created as EITHER a
reguar file OR a directory and should NOT exist
after "git clean" or "git clean -d", as the case maybe, has been called.
This made it reasonable to replace
"test ! -[df] foo" with "test_path_is_missing foo".
Examples for each case is shown below

test_expect_success 'git clean with prefix' '
	mkdir -p build docs src/test &&
	touch a.out src/part3.c docs/manual.txt obj.o build/lib.so src/test/1.c &&
	(cd src/ && git clean) &&
	test -f Makefile &&
	test -f README &&
	test -f src/part1.c &&
	test -f src/part2.c &&
	test -f a.out &&
	test ! -f src/part3.c &&

test_expect_success 'git clean -d -x with ignored tracked directory' '
	mkdir -p build docs &&
	touch a.out src/part3.c docs/manual.txt obj.o build/lib.so &&
	git clean -d -X -e src &&
	test -f Makefile &&
	test -f README &&
	test -f src/part1.c &&
	test -f src/part2.c &&
	test -f a.out &&
	test ! -f src/part3.c &&
	test -f docs/manual.txt &&
	test ! -f obj.o &&

and

test_expect_success 'git clean -d -x with ignored tracked directory' '
	mkdir -p build docs &&
	touch a.out src/part3.c docs/manual.txt obj.o build/lib.so &&
	git clean -d -x -e src &&
	test -f Makefile &&
	test -f README &&
	test -f src/part1.c &&
	test -f src/part2.c &&
	test ! -f a.out &&
	test -f src/part3.c &&
	test ! -d docs &&
	test ! -f obj.o &&
	test ! -d build

and

test_expect_success 'should clean things that almost look like git ...'
	test_expect_success 'force removal of nested git work tree' '
		test_commit deeply.nested deeper.world
		) &&
	git clean -f -f -d &&
	! test -d foo &&
	! test -d bar &&
	! test -d baz

Signed-off-by: Abraham Samuel Adekunle <abrahamadekunle50@gmail.com>
---
    [Outreachy][PATCH] t7300-clean.sh: use test_path_* helper functions for
    error logging

    This test script uses "test - [def]", but when a test fails because the
    file passed to it does not exist, it fails silently without an error
    message.

    Use test_path_* helper functions, which are designed to give better
    error messages when their expectations are not met.

    I have added a mechanical validation that applies the same
    transformation done in this patch, when the script is passed to a sed
    script as shown below

    #!/bin/bash
    sed -e 's/^\(	*\)test -f /\1test_path_is_file /' \
        -e 's/^\(	*\)test -d /\1test_path_is_dir /' \
        -e 's/^\(	*\)test -e /\1test_path_exists /' \
        -e 's/^\(	*\)! test -[edf] /\1test_path_is_missing /' \
        -e 's/^\(	*\)test ! -[edf] /\1test_path_is_missing /' \
           "$1" >foo.sh

    Reviewers can use the sed script to transform the original test script
    and compare the results in foo.sh with the results of applying this
    patch You will see an instance of "! (test -e 3)" which was manually
    replaced with "test_path_is_missing", and everything else should match.
    I have carefully studied the instances where "test ! - [df] foo" were
    used in the script to make sure that the test instances were expecting a
    file or a directory to not exist as the case may be before replacing
    with "test_path_is_missing".

    Signed-off-by: Abraham Samuel Adekunle abrahamadekunle50@gmail.com

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1811%2Fdevdekunle%2Fupdate_tests-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1811/devdekunle/update_tests-v3
Pull-Request: https://github.com/gitgitgadget/git/pull/1811

Range-diff vs v2:

 1:  62d57156dcf ! 1:  ca008b23a25 t7300-clean.sh: use test_path_* helper functions for error logging
     @@ Commit message
          Use test_path_* helper functions, which are designed to give better
          error messages when their expectations are not met.

     +    I have added a mechanical validation that applies the same transformation
     +    done in this patch, when the test script is passed to a sed script as shown
     +    below.
     +
     +    sed -e 's/^\(   *\)test -f /\1test_path_is_file /' \
     +        -e 's/^\(   *\)test -d /\1test_path_is_dir /' \
     +        -e 's/^\(   *\)test -e /\1test_path_exists /' \
     +        -e 's/^\(   *\)! test -[edf] /\1test_path_is_missing /' \
     +        -e 's/^\(   *\)test ! -[edf] /\1test_path_is_missing /' \
     +           "$1" >foo.sh
     +
     +    Reviewers can use the sed script to tranform the original test script and
     +    compare the result in foo.sh with the results of applying the patch.
     +    You will see an instance of "!(test -e 3)" which was manually replaced with
     +    ""test_path_is_missing 3", and everything else should match.
     +
     +    Careful and deliberate observation was done to check instances where
     +    "test ! - [df] foo" was used in the test script to make sure that the test
     +    instances were expecting foo to EITHER be a file or a directory, and NOT a
     +    possibility of being both as this would make replacing "test ! -f foo" with
     +    "test_path_is_missing foo" unreasonable.
     +    In the tests control flow, foo has been created as EITHER a
     +    reguar file OR a directory and should NOT exist
     +    after "git clean" or "git clean -d", as the case maybe, has been called.
     +    This made it reasonable to replace
     +    "test ! -[df] foo" with "test_path_is_missing foo".
     +    Examples for each case is shown below
     +
     +    test_expect_success 'git clean with prefix' '
     +            mkdir -p build docs src/test &&
     +            touch a.out src/part3.c docs/manual.txt obj.o build/lib.so src/test/1.c &&
     +            (cd src/ && git clean) &&
     +            test -f Makefile &&
     +            test -f README &&
     +            test -f src/part1.c &&
     +            test -f src/part2.c &&
     +            test -f a.out &&
     +            test ! -f src/part3.c &&
     +
     +    test_expect_success 'git clean -d -x with ignored tracked directory' '
     +            mkdir -p build docs &&
     +            touch a.out src/part3.c docs/manual.txt obj.o build/lib.so &&
     +            git clean -d -X -e src &&
     +            test -f Makefile &&
     +            test -f README &&
     +            test -f src/part1.c &&
     +            test -f src/part2.c &&
     +            test -f a.out &&
     +            test ! -f src/part3.c &&
     +            test -f docs/manual.txt &&
     +            test ! -f obj.o &&
     +
     +    and
     +
     +    test_expect_success 'git clean -d -x with ignored tracked directory' '
     +            mkdir -p build docs &&
     +            touch a.out src/part3.c docs/manual.txt obj.o build/lib.so &&
     +            git clean -d -x -e src &&
     +            test -f Makefile &&
     +            test -f README &&
     +            test -f src/part1.c &&
     +            test -f src/part2.c &&
     +            test ! -f a.out &&
     +            test -f src/part3.c &&
     +            test ! -d docs &&
     +            test ! -f obj.o &&
     +            test ! -d build
     +
     +    and
     +
     +    test_expect_success 'should clean things that almost look like git ...'
     +            test_expect_success 'force removal of nested git work tree' '
     +                    test_commit deeply.nested deeper.world
     +                    ) &&
     +            git clean -f -f -d &&
     +            ! test -d foo &&
     +            ! test -d bar &&
     +            ! test -d baz
     +
          Signed-off-by: Abraham Samuel Adekunle <abrahamadekunle50@gmail.com>

       ## t/t7300-clean.sh ##

 t/t7300-clean.sh | 370 +++++++++++++++++++++++------------------------
 1 file changed, 185 insertions(+), 185 deletions(-)

base-commit: 90fe3800b92a49173530828c0a17951abd30f0e1

Message ID	pull.1811.v3.git.1728493350545.gitgitgadget@gmail.com (mailing list archive)
State	Superseded
Headers	show Received: from mail-ej1-f48.google.com (mail-ej1-f48.google.com [209.85.218.48]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 6C7E71DF759 for <git@vger.kernel.org>; Wed, 9 Oct 2024 17:02:35 +0000 (UTC) Message-Id: <pull.1811.v3.git.1728493350545.gitgitgadget@gmail.com> In-Reply-To: <pull.1811.v2.git.1728390135644.gitgitgadget@gmail.com> References: <pull.1811.v2.git.1728390135644.gitgitgadget@gmail.com> Date: Wed, 09 Oct 2024 17:02:30 +0000 Subject: [PATCH v3] t7300-clean.sh: use test_path_* helper functions for error logging Fcc: Sent Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Precedence: bulk MIME-Version: 1.0 To: git@vger.kernel.org Cc: Usman Akinyemi <usmanakinyemi202@gmail.com>, Patrick Steinhardt <ps@pks.im>, Junio C Hamano <gitster@pobox.com>, Samuel Adekunle Abraham <abrahamadekunle50@gmail.com>, Abraham Samuel Adekunle <abrahamadekunle50@gmail.com> From: Abraham Samuel Adekunle <abrahamadekunle50@gmail.com>
Series	[v3] t7300-clean.sh: use test_path_* helper functions for error logging \| expand [v3] t7300-clean.sh: use test_path_* helper functions for error logging

[v3] t7300-clean.sh: use test_path_* helper functions for error logging

Commit Message

Comments

Patch