From: Jeff King <peff@peff.net>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: git@vger.kernel.org, Elijah Newren <newren@gmail.com>,
Junio C Hamano <gitster@pobox.com>,
Shourya Shukla <shouryashukla.oo@gmail.com>
Subject: Re: [PATCH v2] test_cmp: diagnose incorrect arguments
Date: Thu, 15 Oct 2020 20:17:04 -0400 [thread overview]
Message-ID: <20201016001704.GA2937048@coredump.intra.peff.net> (raw)
In-Reply-To: <20200809174209.15466-1-sunshine@sunshineco.com>
On Sun, Aug 09, 2020 at 01:42:09PM -0400, Eric Sunshine wrote:
> Under normal circumstances, if a test author misspells a filename passed
> to test_cmp(), the error is quickly discovered when the test fails
> unexpectedly due to test_cmp() being unable to find the file. However,
> if the test is expected to fail, as with test_expect_failure(), a
> misspelled filename as argument to test_cmp() will go unnoticed since
> the test will indeed fail, but for the wrong reason. Make it easier for
> test authors to discover such problems early by sanity-checking the
> arguments to test_cmp(). To avoid penalizing all clients of test_cmp()
> in the general case, only check for missing files if the comparison
> fails.
This patch caused some interesting confusion for me today.
I was looking at the patch from [1] which causes a test failure (and I
wanted to see where it failed, etc). And I got:
$ ./t5601-clone.sh
ok 1 - setup
ok 2 - clone with excess parameters (1)
ok 3 - clone with excess parameters (2)
ok 4 - output from clone
ok 5 - clone does not keep pack
ok 6 - clone checks out files
ok 7 - clone respects GIT_WORK_TREE
error: bug in the test script: test_cmp 'r2/.git/HEAD' missing
which was somewhat unhelpful (or at least less helpful than a regular
test failure). The test in question does this:
test_cmp r0/.git/HEAD r2/.git/HEAD &&
and expects to fail if an earlier step didn't correctly create r2. Is it
a bug or misuse of test_cmp for it to do so? I could see an argument
that it is, but I'm also not sure if there's a convenient alternative.
The best I could come up with is:
test_path_is_file r2/.git/HEAD &&
test_cmp r0/.git/HEAD r2/.git/HEAD
which isn't that great.
-Peff
[1] https://lore.kernel.org/git/20200130102933.GE840531@coredump.intra.peff.net/
next prev parent reply other threads:[~2020-10-16 0:17 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-08-09 6:08 [PATCH] test_cmp: diagnose incorrect arguments Eric Sunshine
2020-08-09 8:32 ` Shourya Shukla
2020-08-09 8:49 ` Eric Sunshine
2020-08-09 17:42 ` [PATCH v2] " Eric Sunshine
2020-08-09 19:12 ` Junio C Hamano
2020-08-09 19:34 ` Eric Sunshine
2020-08-10 15:22 ` Junio C Hamano
2020-08-11 18:32 ` Taylor Blau
2020-08-11 19:25 ` Eric Sunshine
2020-08-11 21:03 ` Taylor Blau
2020-08-12 15:37 ` Jeff King
2020-08-12 16:15 ` Eric Sunshine
2020-08-12 16:39 ` Eric Sunshine
2020-08-12 17:10 ` Jeff King
2020-10-16 0:17 ` Jeff King [this message]
2020-10-16 2:18 ` Eric Sunshine
2020-10-16 18:36 ` Junio C Hamano
2020-10-16 20:56 ` Junio C Hamano
2020-10-16 23:14 ` Junio C Hamano
2020-10-17 6:06 ` Eric Sunshine
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201016001704.GA2937048@coredump.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=newren@gmail.com \
--cc=shouryashukla.oo@gmail.com \
--cc=sunshine@sunshineco.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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).