git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Patrick Steinhardt <ps@pks.im>
Cc: git@vger.kernel.org, "SZEDER Gábor" <szeder.dev@gmail.com>
Subject: Re: [PATCH 3/3] t/README: document how to loop around test cases
Date: Thu, 21 Mar 2024 10:12:40 -0700	[thread overview]
Message-ID: <xmqqzfur8q5z.fsf@gitster.g> (raw)
In-Reply-To: <326fb7965036fccc1c23ad02f200251f6388e6dd.1711028473.git.ps@pks.im> (Patrick Steinhardt's message of "Thu, 21 Mar 2024 14:47:33 +0100")

Patrick Steinhardt <ps@pks.im> writes:

> In some cases it makes sense to loop around test cases so that we can
> execute the same test with slightly different arguments. There are some
> gotchas around quoting here though that are easy to miss and that may
> lead to easy-to-miss errors and portability issues.
>
> Document the proper way to do this in "t/README".
>
> Signed-off-by: Patrick Steinhardt <ps@pks.im>
> ---
>  t/README | 19 +++++++++++++++++++
>  1 file changed, 19 insertions(+)
>
> diff --git a/t/README b/t/README
> index 36463d0742..d56401a254 100644
> --- a/t/README
> +++ b/t/README
> @@ -721,6 +721,25 @@ The "do's:"
>     Note that we still &&-chain the loop to propagate failures from
>     earlier commands.
>  
> + - Repeat tests with slightly different arguments in a loop.
> +
> +   In some cases it may make sense to re-run the same set of tests with
> +   different options or commands to ensure that the command behaves
> +   despite the different parameters. This can be achieved by looping
> +   around a specific parameter:
> +
> +	for arg in '' "--foo"
> +	do
> +		test_expect_success "test command ${arg:-without arguments}" '
> +			command $arg
> +		'
> +	done
> +
> +  Note that while the test title uses double quotes ("), the test body
> +  should continue to use single quotes ('). The loop variable will be
> +  accessible regardless of the single quotes as the test body is passed
> +  to `eval`.

We also want to say that they are not equivalent, don't we?

        for var in '' a 'b"c'
        do
                test_expect_success "with dq <$var>" "
                        echo \"$var\"
                "
        done

breaks, but if we use

                test_expect_success "with sq <$var>" '
                        echo "$var"
                '

in the loop, it works as expected.

Other than that, all three patches do make sense.

Thanks.

  reply	other threads:[~2024-03-21 17:12 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-21 13:47 [PATCH 0/3] t7800: fix quoting of looped test bodies Patrick Steinhardt
2024-03-21 13:47 ` [PATCH 1/3] t7800: improve test descriptions with empty arguments Patrick Steinhardt
2024-03-21 13:47 ` [PATCH 2/3] t7800: use single quotes for test bodies Patrick Steinhardt
2024-03-21 13:47 ` [PATCH 3/3] t/README: document how to loop around test cases Patrick Steinhardt
2024-03-21 17:12   ` Junio C Hamano [this message]
2024-03-22  2:05     ` Patrick Steinhardt
2024-03-22  2:12       ` Junio C Hamano
2024-03-21 13:48 ` [PATCH 0/3] t7800: fix quoting of looped test bodies Patrick Steinhardt
2024-03-22  2:23 ` [PATCH v2 " Patrick Steinhardt
2024-03-22  2:23   ` [PATCH v2 1/3] t7800: improve test descriptions with empty arguments Patrick Steinhardt
2024-03-22  2:23   ` [PATCH v2 2/3] t7800: use single quotes for test bodies Patrick Steinhardt
2024-03-22  2:23   ` [PATCH v2 3/3] t/README: document how to loop around test cases Patrick Steinhardt
2024-03-22 14:37   ` [PATCH v2 0/3] t7800: fix quoting of looped test bodies Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqzfur8q5z.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=ps@pks.im \
    --cc=szeder.dev@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).