tests: modernize the test script t0010-racy-git.sh

Commit Message

Aryan Gupta Feb. 29, 2024, 12:23 p.m. UTC

From: aryangupta701 <[e-mail]>

Modernize the formatting of the test script to align with current
standards and improve its overall readability.

Signed-off-by: Aryan Gupta <[e-mail]>
---
    [GSOC] [PATCH] Modernize a test script

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1675%2Faryangupta701%2Ftest-modernize-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1675/aryangupta701/test-modernize-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1675

 t/t0010-racy-git.sh | 15 +++++++--------
 1 file changed, 7 insertions(+), 8 deletions(-)


base-commit: 3c2a3fdc388747b9eaf4a4a4f2035c1c9ddb26d0

Comments

Eric Sunshine Feb. 29, 2024, 6:11 p.m. UTC | #1

On Thu, Feb 29, 2024 at 7:24 AM Aryan Gupta via GitGitGadget
<[e-mail]> wrote:
> From: aryangupta701 <[e-mail]>

The name in the "From:" header should match the name in the
"Signed-off-by:" trailer.

> Modernize the formatting of the test script to align with current
> standards and improve its overall readability.

The aim of this patch makes sense, but the implementation isn't quite correct.

> Signed-off-by: Aryan Gupta <[e-mail]>
> ---
> diff --git a/t/t0010-racy-git.sh b/t/t0010-racy-git.sh> @@ -16,19 +16,18 @@ do
>         files=$(git diff-files -p)
> -       test_expect_success \
> -       "Racy GIT trial #$trial part A" \
> -       'test "" != "$files"'
> +       test_expect_success 'Racy git trial #$trial part A' '
> +               test "" != "$files"
> +       '

The variable `trial` takes on values 0-4, and that value is meant to
appear in the test title as the script runs:

    Racy GIT trial #0 part A
    Racy GIT trial #0 part B
    Racy GIT trial #1 part A
    Racy GIT trial #1 part B
    ...

However, by changing the title from a double-quote string to a
single-quote string, you inhibit interpolation of the `trial` variable
into the title, hence the test titles instead show up as:

    Racy GIT trial #$trial part A
    Racy GIT trial #$trial part B
    Racy GIT trial #$trial part A
    Racy GIT trial #$trial part B

which is undesirable.

So, the title should continue using double-quotes, and not be changed
to single-quotes.

The other change, which fixes the style of the test's body, appears correct.

Patch

diff --git a/t/t0010-racy-git.sh b/t/t0010-racy-git.sh
index 837c8b7228b..04dc1cf3ff5 100755
--- a/t/t0010-racy-git.sh
+++ b/t/t0010-racy-git.sh
@@ -1,6 +1,6 @@ 
 #!/bin/sh
 
-test_description='racy GIT'
+test_description='racy git'
 
 TEST_PASSES_SANITIZE_LEAK=true
 . ./test-lib.sh
@@ -16,19 +16,18 @@  do
 	echo xyzzy >infocom
 
 	files=$(git diff-files -p)
-	test_expect_success \
-	"Racy GIT trial #$trial part A" \
-	'test "" != "$files"'
+	test_expect_success 'Racy git trial #$trial part A' '
+		test "" != "$files"
+	'
 
 	sleep 1
 	echo xyzzy >cornerstone
 	git update-index --add cornerstone
 
 	files=$(git diff-files -p)
-	test_expect_success \
-	"Racy GIT trial #$trial part B" \
-	'test "" != "$files"'
-
+	test_expect_success 'Racy git trial #$trial part B' '
+		test "" != "$files"
+	'
 done
 
 test_done