From: Johannes Schindelin <Johannes.Schindelin@gmx.de>
To: Patrick Steinhardt <ps@pks.im>
Cc: git@vger.kernel.org, Stan Hu <stanhu@gmail.com>
Subject: Re: [PATCH 1/2] t9902: verify that completion does not print anything
Date: Fri, 12 Jan 2024 14:12:43 +0100 (CET) [thread overview]
Message-ID: <27edf445-d7fa-7aaf-7682-4ecc03366ef0@gmx.de> (raw)
In-Reply-To: <ZaEZar9OTVgfkD9r@framework>
Hi Patrick,
On Fri, 12 Jan 2024, Patrick Steinhardt wrote:
> On Fri, Jan 12, 2024 at 11:08:21AM +0100, Johannes Schindelin wrote:
>
> > On Thu, 11 Jan 2024, Patrick Steinhardt wrote:
> >
> > > The Bash completion script must not print anything to either stdout or
> > > stderr. Instead, it is only expected to populate certain variables.
> > > Tighten our `test_completion ()` test helper to verify this requirement.
> > >
> > > Signed-off-by: Patrick Steinhardt <ps@pks.im>
> > > ---
> > > t/t9902-completion.sh | 6 ++++--
> > > 1 file changed, 4 insertions(+), 2 deletions(-)
> > >
> > > diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh
> > > index aa9a614de3..78cb93bea7 100755
> > > --- a/t/t9902-completion.sh
> > > +++ b/t/t9902-completion.sh
> > > @@ -87,9 +87,11 @@ test_completion ()
> > > else
> > > sed -e 's/Z$//' |sort >expected
> > > fi &&
> > > - run_completion "$1" &&
> > > + run_completion "$1" >"$TRASH_DIRECTORY"/output 2>&1 &&
> > > sort out >out_sorted &&
> > > - test_cmp expected out_sorted
> > > + test_cmp expected out_sorted &&
> > > + test_must_be_empty "$TRASH_DIRECTORY"/output &&
> >
> > It seems that this fails CI on macOS, most likely because we're running
> > with `set -x` and that output somehow ends up in `output`, see e.g. here:
> > https://github.com/git/git/actions/runs/7496790359/job/20409405194#step:4:1880
> >
> > [...]
> > ++ test_completion 'git switch '
> > ++ test 1 -gt 1
> > ++ sed -e 's/Z$//'
> > ++ sort
> > ++ run_completion 'git switch '
> > ++ sort out
> > ++ test_cmp expected out_sorted
> > ++ test 2 -ne 2
> > ++ eval 'diff -u' '"$@"'
> > +++ diff -u expected out_sorted
> > ++ test_must_be_empty '/Users/runner/work/git/git/t/trash directory.t9902-completion/output'
> > ++ test 1 -ne 1
> > ++ test_path_is_file '/Users/runner/work/git/git/t/trash directory.t9902-completion/output'
> > ++ test 1 -ne 1
> > ++ test -f '/Users/runner/work/git/git/t/trash directory.t9902-completion/output'
> > ++ test -s '/Users/runner/work/git/git/t/trash directory.t9902-completion/output'
> > ++ echo ''\''/Users/runner/work/git/git/t/trash directory.t9902-completion/output'\'' is not empty, it contains:'
> > '/Users/runner/work/git/git/t/trash directory.t9902-completion/output' is not empty, it contains:
> > ++ cat '/Users/runner/work/git/git/t/trash directory.t9902-completion/output'
> > ++ local -a COMPREPLY _words
> > ++ local _cword
> > [...]
> >
> > Maybe this is running in Dash and therefore `BASH_XTRACEFD=4` in
> > `test-lib.sh` has not the intended effect?
>
> Meh, thanks for the heads up. Another test gap in GitLab CI which I'm
> going to address soon via a new macOS job.
>
> In any case, Dash indeed does not honor the above envvar.
Hmm. I had a closer look and now I am thoroughly confused. In
`t/lib-bash.exe`, we make sure that this test is run in Bash. And indeed,
when I call
BASH=1 POSIXLY_CORRECT=1 TEST_SHELL_PATH=/bin/dash dash t9902-completion.sh -iVx
I am greeted by this error message:
git-completion.bash: Syntax error: "(" unexpected (expecting "fi")
So something else must be going on here.
> I also could not find any alternate solutions to redirect the tracing
> output. So for all I can see there are a few ways to handle this:
>
> - `set -x` and then restore the previous value after having called
> `run_completion`.
>
> - Filter the output so that any line starting with "${PS4}" gets
> removed.
>
> - Don't test for this bug.
>
> Not sure which way to go, but the first alternative feels a bit more
> sensible to me. It does remove the ability to see what's going on in the
> completion script though in case one wants to debug it.
Personally, I would go for option 2, filtering out the xtrace output. This
here seems to work:
-- snip --
diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh
index b14ae4de14e..23cd1cd9508 100755
--- a/t/t9902-completion.sh
+++ b/t/t9902-completion.sh
@@ -87,11 +87,14 @@ test_completion ()
else
sed -e 's/Z$//' |sort >expected
fi &&
+ PS4=+ &&
run_completion "$1" >"$TRASH_DIRECTORY"/output 2>&1 &&
+ sed "/^+/{:1;s/'[^']*'//g;/'/{N;b1};d}" \
+ <"$TRASH_DIRECTORY"/output >"$TRASH_DIRECTORY"/output.x &&
+ test_must_be_empty "$TRASH_DIRECTORY"/output.x &&
+ rm "$TRASH_DIRECTORY"/output "$TRASH_DIRECTORY"/output.x &&
sort out >out_sorted &&
- test_cmp expected out_sorted &&
- test_must_be_empty "$TRASH_DIRECTORY"/output &&
- rm "$TRASH_DIRECTORY"/output
+ test_cmp expected out_sorted
}
# Test __gitcomp.
-- snap --
It is a bit ugly, in particular the `sed` expression (which is a bit
complex because the `output` file can contain multi-line strings enclosed
in single-quotes), and we could probably lose the `"$TRASH_DIRECTORY"/`
part to improve the reading experience somewhat.
But my main concern is: Why does this happen in the first place? If we are
running with Bash, why does `BASH_XTRACEFD` to work as intended here and
makes it necessary to filter out the traced commands?
Ciao,
Johannes
next prev parent reply other threads:[~2024-01-12 13:13 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-11 10:41 [PATCH 0/2] completion: silence pseudo-ref existence check Patrick Steinhardt
2024-01-11 10:41 ` [PATCH 1/2] t9902: verify that completion does not print anything Patrick Steinhardt
2024-01-11 20:29 ` Junio C Hamano
2024-01-12 10:08 ` Johannes Schindelin
2024-01-12 10:50 ` Patrick Steinhardt
2024-01-12 13:12 ` Johannes Schindelin [this message]
2024-01-12 15:16 ` Jeff King
2024-01-12 18:17 ` Junio C Hamano
2024-01-15 9:02 ` Patrick Steinhardt
2024-01-11 10:41 ` [PATCH 2/2] completion: silence pseudoref existence check Patrick Steinhardt
2024-01-11 21:03 ` Junio C Hamano
2024-01-13 19:17 ` SZEDER Gábor
2024-01-15 10:35 ` [PATCH v2 0/5] completion: silence pseudo-ref " Patrick Steinhardt
2024-01-15 10:35 ` [PATCH v2 1/5] completion: discover repo path in `__git_pseudoref_exists ()` Patrick Steinhardt
2024-01-15 10:36 ` [PATCH v2 2/5] t9902: verify that completion does not print anything Patrick Steinhardt
2024-01-15 10:36 ` [PATCH v2 3/5] completion: improve existence check for pseudo-refs Patrick Steinhardt
2024-01-15 10:36 ` [PATCH v2 4/5] completion: silence pseudoref existence check Patrick Steinhardt
2024-01-15 10:36 ` [PATCH v2 5/5] completion: treat dangling symrefs as existing pseudorefs Patrick Steinhardt
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=27edf445-d7fa-7aaf-7682-4ecc03366ef0@gmx.de \
--to=johannes.schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=ps@pks.im \
--cc=stanhu@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.
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).