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

Re: [PATCH v2 2/2] tests: replace mingw_test_cmp with a helper in C

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Sep 7, 2022, 12:24 UTC
Message-ID
<220907.86r10nl63s.gmgdl@evledraar.gmail.com>
In-Reply-To
<220907.86v8pzl6jz.gmgdl@evledraar.gmail.com>
On Wed, Sep 07 2022, Ævar Arnfjörð Bjarmason wrote:
Show 90 quoted lines
> On Tue, Sep 06 2022, Johannes Schindelin via GitGitGadget wrote:
>
>> From: Johannes Schindelin <johannes.schindelin@gmx.de>
>> [...]
>> +++ b/t/helper/test-text-cmp.c
>> @@ -0,0 +1,78 @@
>> +#include "test-tool.h"
>> +#include "git-compat-util.h"
>> +#include "strbuf.h"
>> +#include "gettext.h"
>
> Superflous header? Compiles without gettext.h for me (and we shouldn't
> use i18n in test helpers).
>
>> [...]
>> +int cmd__text_cmp(int argc, const char **argv)
>> +{
>> +	FILE *f0, *f1;
>> +	struct strbuf b0 = STRBUF_INIT, b1 = STRBUF_INIT;
>> +
>> +	if (argc != 3)
>> +		die("Require exactly 2 arguments, got %d", argc);
>
> Here you conflate the argc v.s. arguments minus the "text-cmp",
> resulting in:
>
> 	helper/test-tool text-cmp 2
>         fatal: Require exactly 2 arguments, got 2
>
> An argc-- argv++ at the beginning seems like the easiest way out of
> this. Also s/Require/require/ per CodingGuidelines.
>
>> +	if (!strcmp(argv[1], "-") && !strcmp(argv[2], "-"))
>> +		die("only one parameter can refer to `stdin` but not both");
>> +
>> +	if (!(f0 = !strcmp(argv[1], "-") ? stdin : fopen(argv[1], "r")))
>> +		return error_errno("could not open '%s'", argv[1]);
>> +	if (!(f1 = !strcmp(argv[2], "-") ? stdin : fopen(argv[2], "r"))) {
>> +		fclose(f0);
>> +		return error_errno("could not open '%s'", argv[2]);
>> +	}
>
> Faithfully emulating the old version. I do wonder if we couldn't simply
> adjust the handful of tests that actually make use of the "-" diff(1)
> feature. AFAICT there's around 10 of those at most, and they all seem
> like cases where it would be easy to change:
>
> 	(echo foo) | test_cmp - actual
>
> Or whatever, to:
>
> 	echo foo >expected &&
> 	test_cmp expected actual
>
> ...
>
>> +			if (!strcmp(argv[1], "-") || !strcmp(argv[2], "-"))
>> +				warning("cannot show diff because `stdin` was already consumed");
>
> ...
>
> Which means we wouldn't need to punt on this.
>
>> +			else if (!run_diff(argv[1], argv[2]))
>> +				die("Huh? 'diff --no-index %s %s' succeeded",
>> +				    argv[1], argv[2]);
>
> I tried manually testing this with:
>
> 	GIT_TRACE=1 GIT_TEST_CMP="/home/avar/g/git/git diff --no-index --" ./t0021-conversion.sh  -vixd
>
> v.s.:
>
> 	GIT_TRACE=1 GIT_TEST_CMP="$PWD/helper/test-tool text-cmp" ./t0021-conversion.sh  -vixd
>
> Your version doesn't get confused by the same, but AFAICT this is by
> fragile accident.
>
> I.e. you run your own equivalent of "cmp", so because the files are the
> same in that case we don't run the "diff --no-index".
>
> But the "diff --no-index" in that t0021*.sh case *would* report
> differences, even though the files are byte-for-byte identical.
>
> So the "cmp"-a-like here isn't just an optimization to avoid forking the
> "git diff" process, it's an entirely different comparison method in
> cases where we have a "filter".
>
> It just so happens that our test suite doesn't currently combine them in
> a way that causes a current failure.

Ah (partially?) I spoke too soon on this part. I.e. the GIT_DIR=/dev/null precludes reading the filter/repo in this case. So I *think* we're out of the woods as far as this is concerned.

Still, it would be nice to document in a code comment or commit message that the "not read the local repo's filter" is absolutely critical here.

But I think that re-raises the point René had in: https://lore.kernel.org/git/b21d2b60-428f-58ec-28b6-3c617b9f2e45@web.de/

I ran the full test suite with:
	GIT_TEST_CMP='GIT_DIR=/dev/null HOME=/dev/null /usr/bin/git diff --no-index --ignore-cr-at-eol --'
And all of it passes, except for a test in t0001-init.sh which we could
fix up as:
	
	diff --git a/t/t0001-init.sh b/t/t0001-init.sh
	index d479303efa0..d65afe7cceb 100755
	--- a/t/t0001-init.sh
	+++ b/t/t0001-init.sh
	@@ -426,7 +426,7 @@ test_expect_success SYMLINKS 're-init to move gitdir symlink' '
	 	git init --separate-git-dir ../realgitdir
	 	) &&
	 	echo "gitdir: $(pwd)/realgitdir" >expected &&
	-	test_cmp expected newdir/.git &&
	+	test "$(test_readlink newdir/.git)" = here &&
	 	test_cmp expected newdir/here &&
	 	test_path_is_dir realgitdir/refs
	 '

Which without this series is more correct, as all we're re-testing there is whether the symlink is pointing to what we expect. A hypothetical "--dereference" to "git diff" would also take care of it (the equivalent of "--no-dereference" being the default).

But with that all tests pass for me, so I'm puzzled as to the need for
the new helper, as opposed to just constructing the command above and
sticking it in GIT_TEST_CMP ...
	
Previous: Ævar Arnfjörð BjarmasonNext: Junio C Hamano
Message 18 of 58 in “tests: replace mingw_test_cmp with a helper in C”
  1. tests: replace mingw_test_cmp with a helper in CJohannes Schindelin via GitGitGadget, Jul 29, 2022
  2. Johannes SchindelinJul 29, 2022
  3. Junio C HamanoJul 29, 2022
  4. Johannes SchindelinSep 6, 2022
  5. René ScharfeSep 7, 2022
  6. Junio C HamanoSep 7, 2022
  7. Re* [PATCH] tests: replace mingw_test_cmp with a helper in CJunio C Hamano, Sep 7, 2022
  8. René ScharfeSep 7, 2022
  9. Junio C HamanoSep 8, 2022
  10. René ScharfeSep 8, 2022
  11. Ævar Arnfjörð BjarmasonSep 8, 2022
  12. Johannes SchindelinSep 8, 2022
  13. Junio C HamanoSep 8, 2022
  14. 0/2 tests: replace mingw_test_cmp with a helper in CJohannes Schindelin via GitGitGadget, Sep 6, 2022
  15. 1/2 t0021: use Windows-friendly `pwd`Johannes Schindelin via GitGitGadget, Sep 6, 2022
  16. 2/2 tests: replace mingw_test_cmp with a helper in CJohannes Schindelin via GitGitGadget, Sep 6, 2022
  17. Ævar Arnfjörð BjarmasonSep 7, 2022
  18. Ævar Arnfjörð BjarmasonSep 7, 2022
  19. Junio C HamanoSep 7, 2022
  20. Johannes SchindelinSep 7, 2022
  21. 0/2 tests: replace mingw_test_cmp with a helper in CJohannes Schindelin via GitGitGadget, Nov 12, 2022
  22. 1/2 t0021: use Windows-friendly `pwd`Johannes Schindelin via GitGitGadget, Nov 12, 2022
  23. 2/2 tests(mingw): avoid very slow `mingw_test_cmp`Johannes Schindelin via GitGitGadget, Nov 12, 2022
  24. Taylor BlauNov 13, 2022
  25. Johannes SchindelinNov 14, 2022
  26. Junio C HamanoNov 18, 2022
  27. Taylor BlauNov 19, 2022
  28. Ævar Arnfjörð BjarmasonNov 19, 2022
  29. Johannes SixtNov 19, 2022
  30. René ScharfeNov 19, 2022
  31. Torsten BögershausenNov 20, 2022
  32. Johannes SixtNov 21, 2022
  33. Junio C HamanoNov 21, 2022
  34. Phillip WoodNov 14, 2022
  35. Johannes SchindelinNov 14, 2022
  36. Ævar Arnfjörð BjarmasonNov 14, 2022
  37. Johannes SchindelinNov 14, 2022
  38. Ævar Arnfjörð BjarmasonNov 14, 2022
  39. Junio C HamanoNov 18, 2022
  40. Taylor BlauNov 19, 2022
  41. Ævar Arnfjörð BjarmasonNov 19, 2022
  42. Junio C HamanoNov 21, 2022
  43. 0/2 tests(mingw): avoid super-slow mingw_test_cmpJohannes Schindelin via GitGitGadget, Nov 14, 2022
  44. 1/2 t0021: use Windows-friendly `pwd`Johannes Schindelin via GitGitGadget, Nov 14, 2022
  45. 2/2 tests(mingw): avoid very slow `mingw_test_cmp`Johannes Schindelin via GitGitGadget, Nov 14, 2022
  46. Taylor BlauNov 14, 2022
  47. Johannes SchindelinNov 18, 2022
  48. Taylor BlauNov 18, 2022
  49. Johannes SchindelinNov 20, 2022
  50. Taylor BlauNov 21, 2022
  51. 0/2 tests(mingw): avoid super-slow mingw_test_cmpJohannes Schindelin via GitGitGadget, Dec 6, 2022
  52. 2/2 tests(mingw): avoid very slow `mingw_test_cmp`Johannes Schindelin via GitGitGadget, Dec 6, 2022
  53. Ævar Arnfjörð BjarmasonDec 6, 2022
  54. Johannes SixtDec 6, 2022
  55. René ScharfeDec 6, 2022
  56. Junio C HamanoDec 7, 2022
  57. Taylor BlauDec 7, 2022
  58. 1/2 t0021: use Windows-friendly `pwd`Johannes Schindelin via GitGitGadget, Dec 6, 2022

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.