1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-05-11 17:06:08 +02:00

t/README: document how to loop around test cases

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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Patrick Steinhardt 2024-03-22 03:23:46 +01:00 committed by Junio C Hamano
parent c559677c1f
commit 7c4449eb31

View File

@ -721,6 +721,26 @@ 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 (') to avoid breakage in case the
values contain e.g. quoting characters. The loop variable will be
accessible regardless of the single quotes as the test body is passed
to `eval`.
And here are the "don'ts:"