git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [RFC PATCH v2 3/3] t1300: add tests for missing keys

From
Junio C Hamano <gitster@pobox.com>
Date
Apr 18, 2023, 19:31 UTC
Message-ID
<xmqqr0shc7i7.fsf@gitster.g>
In-Reply-To
<20230418175034.982433-4-rybak.a.v@gmail.com>
Andrei Rybak <rybak.a.v@gmail.com> writes:
Show 9 quoted lines
> +test_missing_key () {
> +	local key=$1
> +	local title=$2
> +	test_expect_success "value for $title is not printed" "
> +		test_must_fail git config $key >out 2>err &&
> +		test_must_be_empty out &&
> +		test_must_be_empty err
> +	"
> +}

In this case it would not make any difference only because no caller will feed $key that can be split at $IFS, but it is a good practice to enclose the executed body of test_expect_* script inside a single quote *and* let variable substitution to happen inside eval; in other words, you should write the above like so:

(GOOD)	test_expect_success "value for $title is not printed" '
		test_must_fail git config "$key" >out 2>err &&
		test_must_be_empty out &&
		test_must_be_empty err
	'

The difference is a bit subtle. In the original version, the string fed to "eval" when "test_expect_success" runs has $key already substituted. So if $key has $IFS whitespace in it, the command line arguments of the "git config" would not be what you think your callers are feeding. An attempt to keep it together by enclosing inside a double quote, still trying to salvage the pattern to enclose the executed body inside a pair of double quotes, i.e.

(BAD)	test_expect_success "value for $title is not printed" "
		test_must_fail git config \"$key\" >out 2>err &&
		test_must_be_empty out &&
		test_must_be_empty err
	"

would fail when $key has an unbalanced double quotes and cause a syntax error.

Again, in this case it would be OK due to the limited callers, but it is a good discipline to follow, as others less familiar with our tests scripts than you would copy from what you write in your patches.

The title string (e.g. "value for $title is not printed") does not go through eval, and it needs to be quoted with double quotes for the $title to be substituted, by the way.

> +test_missing_key 'missingsection.missingkey' 'missing section and missing key'
> +test_missing_key 'missingsection.penguin' 'missing section and existing key'
> +test_missing_key 'section.missingkey' 'existing section and missing key'
Previous: Andrei RybakNext: Andrei Rybak
Message 40 of 58 in “t: fix unused files, part 2”
  1. 0/6 t: fix unused files, part 2Andrei Rybak, Apr 1, 2023
  2. 1/6 t0300: don't create unused fileAndrei Rybak, Apr 1, 2023
  3. Eric SunshineApr 2, 2023
  4. 5/6 t1502: don't create unused filesAndrei Rybak, Apr 1, 2023
  5. 2/6 t1300: fix config file syntax error descriptionsAndrei Rybak, Apr 1, 2023
  6. 3/6 t1300: don't create unused filesAndrei Rybak, Apr 1, 2023
  7. 4/6 t1450: don't create unused filesAndrei Rybak, Apr 1, 2023
  8. 6/6 t2019: don't create unused filesAndrei Rybak, Apr 1, 2023
  9. 0/6 t: fix unused files, part 2Andrei Rybak, Apr 3, 2023
  10. 1/6 t0300: don't create unused fileAndrei Rybak, Apr 3, 2023
  11. Ævar Arnfjörð BjarmasonApr 6, 2023
  12. Andrei RybakApr 6, 2023
  13. 2/6 t1300: fix config file syntax error descriptionsAndrei Rybak, Apr 3, 2023
  14. 4/6 t1450: don't create unused filesAndrei Rybak, Apr 3, 2023
  15. Ævar Arnfjörð BjarmasonApr 6, 2023
  16. Andrei RybakApr 6, 2023
  17. 6/6 t2019: don't create unused filesAndrei Rybak, Apr 3, 2023
  18. Ævar Arnfjörð BjarmasonApr 6, 2023
  19. Andrei RybakApr 7, 2023
  20. t2024: fix loose/strict local base branch DWIM testAndrei Rybak, Apr 8, 2023
  21. Junio C HamanoApr 10, 2023
  22. 5/6 t1502: don't create unused filesAndrei Rybak, Apr 3, 2023
  23. Øystein WalleApr 6, 2023
  24. Ævar Arnfjörð BjarmasonApr 6, 2023
  25. Andrei RybakApr 6, 2023
  26. 3/6 t1300: don't create unused filesAndrei Rybak, Apr 3, 2023
  27. Ævar Arnfjörð BjarmasonApr 6, 2023
  28. Andrei RybakApr 6, 2023
  29. git config tests for "'git config ignores pairs ..." (was Re: [PATCH v2 3/6] t1300: don't create unused files)Andrei Rybak, Apr 6, 2023
  30. 0/2 git config tests for "'git config ignores pairs ..."Andrei Rybak, Apr 14, 2023
  31. 1/2 t1300: drop duplicate testAndrei Rybak, Apr 14, 2023
  32. 2/2 t1300: check stderr for "ignores pairs" testsAndrei Rybak, Apr 14, 2023
  33. Andrei RybakApr 14, 2023
  34. 0/3 git config tests for "'git config ignores pairs ..."Andrei Rybak, Apr 18, 2023
  35. 1/3 t1300: drop duplicate testAndrei Rybak, Apr 18, 2023
  36. Junio C HamanoApr 18, 2023
  37. 2/3 t1300: check stderr for "ignores pairs" testsAndrei Rybak, Apr 18, 2023
  38. Junio C HamanoApr 18, 2023
  39. 3/3 t1300: add tests for missing keysAndrei Rybak, Apr 18, 2023
  40. Junio C HamanoApr 18, 2023
  41. Andrei RybakApr 18, 2023
  42. 0/3 git config tests for "'git config ignores pairs ..."Andrei Rybak, Apr 23, 2023
  43. 1/3 t1300: drop duplicate testAndrei Rybak, Apr 23, 2023
  44. 2/3 t1300: check stderr for "ignores pairs" testsAndrei Rybak, Apr 23, 2023
  45. 3/3 t1300: add tests for missing keysAndrei Rybak, Apr 23, 2023
  46. Junio C HamanoMay 1, 2023
  47. Andrei RybakMay 2, 2023
  48. 0/6 t: fix unused files, part 2Andrei Rybak, Apr 17, 2023
  49. 1/6 t0300: don't create unused fileAndrei Rybak, Apr 17, 2023
  50. 2/6 t1300: fix config file syntax error descriptionsAndrei Rybak, Apr 17, 2023
  51. 3/6 t1300: don't create unused filesAndrei Rybak, Apr 17, 2023
  52. 4/6 t1450: don't create unused filesAndrei Rybak, Apr 17, 2023
  53. 5/6 t1502: don't create unused filesAndrei Rybak, Apr 17, 2023
  54. 6/6 t2019: don't create unused filesAndrei Rybak, Apr 17, 2023
  55. Junio C HamanoMay 1, 2023
  56. Andrei RybakMay 2, 2023
  57. Elijah NewrenMay 3, 2023
  58. Junio C HamanoMay 3, 2023

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.