| Message ID | 715a160903be6dc8873a7215c55f90894e62f589.1689960606.git.me@ttaylorr.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | commit-graph: test cleanup and modernization | expand |
On Fri, Jul 21, 2023 at 1:32 PM Taylor Blau <me@ttaylorr.com> wrote: > The `graph_git_behavior()` helper asserts that a number of common Git > operations (such as `git log --oneline`, `git log --topo-order`, etc.) > produce identical output regardless of whether or not a commit-graph is > in use. > > This helper takes as its second argument the location (relative to the > `$TRASH_DIRECTORY`) of the Git repostiory under test. In order to run > each of its commands within that repository, it first changes into that > directory, without the use of a sub-shell. > > This pollutes future tests which expect to be run in the top-level > `$TRASH_DIRECTORY` as usual. We could wrap `graph_git_behavior()` in a > sub-shell, like: > > graph_git_behavior() { > # ... > ( > cd "$TRASH_DIRECTORY/$DIR" && > graph_git_two_modesl > ) > } > > , but since we're invoking git directly, we can pass along a "-C $DIR" > when "$DIR" is non-empty. > > Note, however, that until the remaining callers are cleaned up to avoid > changing working directories outside of a sub-shell, that we need to > ensure that we are operating in the top-level $TRASH_DIRECTORY. The > inner-subshell will go away in a future commit once it is no longer > necessary. > > Signed-off-by: Taylor Blau <me@ttaylorr.com> > --- > diff --git a/t/lib-commit-graph.sh b/t/lib-commit-graph.sh > @@ -20,12 +20,14 @@ graph_git_behavior() { > test_expect_success "check normal git operations: $MSG" ' > - cd "$TRASH_DIRECTORY/$DIR" && > - graph_git_two_modes "log --oneline $BRANCH" && > - graph_git_two_modes "log --topo-order $BRANCH" && > - graph_git_two_modes "log --graph $COMPARE..$BRANCH" && > - graph_git_two_modes "branch -vv" && > - graph_git_two_modes "merge-base -a $BRANCH $COMPARE" > + ( > + cd "$TRASH_DIRECTORY" && > + graph_git_two_modes "${DIR:+-C $DIR} log --oneline $BRANCH" && > + graph_git_two_modes "${DIR:+-C $DIR} log --topo-order $BRANCH" && > + graph_git_two_modes "${DIR:+-C $DIR} log --graph $COMPARE..$BRANCH" && > + graph_git_two_modes "${DIR:+-C $DIR} branch -vv" && > + graph_git_two_modes "${DIR:+-C $DIR} merge-base -a $BRANCH $COMPARE" > + ) > ' > } As mentioned in my review of patch [1/5], for safety, you'd probably want to quote the expansion of DIR in case it ever contains whitespace (or other weird characters). The obvious POSIX-correct way to do this would be: graph_git_two_modes "${DIR:+-C \"$DIR\"} log ..." && Unfortunately, however, some older broken shells incorrectly expand this to a single argument ("-C <dir>") rather than the expected two arguments (-C and "<dir>")[1,2,3,4]. The workaround is unsightly but doable: graph_git_two_modes "${DIR:+-C} ${DIR:+\"$DIR\"} log ..." && [1]: https://lore.kernel.org/git/20160517215214.GA16905@sigill.intra.peff.net/ [2]: https://lore.kernel.org/git/e3bfc53363b14826d828e1adffbbeea@74d39fa044aa309eaea14b9f57fe79c/ [3]: https://lore.kernel.org/git/20160518010609.Horde.sM8QUFek6WMAAwho56DDob8@webmail.informatik.kit.edu/ [4]: https://lore.kernel.org/git/1240044459-57227-1-git-send-email-ben@ben.com/
On Fri, Jul 21, 2023 at 02:01:58PM -0400, Eric Sunshine wrote: > > diff --git a/t/lib-commit-graph.sh b/t/lib-commit-graph.sh > > @@ -20,12 +20,14 @@ graph_git_behavior() { > > test_expect_success "check normal git operations: $MSG" ' > > - cd "$TRASH_DIRECTORY/$DIR" && > > - graph_git_two_modes "log --oneline $BRANCH" && > > - graph_git_two_modes "log --topo-order $BRANCH" && > > - graph_git_two_modes "log --graph $COMPARE..$BRANCH" && > > - graph_git_two_modes "branch -vv" && > > - graph_git_two_modes "merge-base -a $BRANCH $COMPARE" > > + ( > > + cd "$TRASH_DIRECTORY" && > > + graph_git_two_modes "${DIR:+-C $DIR} log --oneline $BRANCH" && > > + graph_git_two_modes "${DIR:+-C $DIR} log --topo-order $BRANCH" && > > + graph_git_two_modes "${DIR:+-C $DIR} log --graph $COMPARE..$BRANCH" && > > + graph_git_two_modes "${DIR:+-C $DIR} branch -vv" && > > + graph_git_two_modes "${DIR:+-C $DIR} merge-base -a $BRANCH $COMPARE" > > + ) > > ' > > } > > As mentioned in my review of patch [1/5], for safety, you'd probably > want to quote the expansion of DIR in case it ever contains whitespace > (or other weird characters). The obvious POSIX-correct way to do this > would be: > > graph_git_two_modes "${DIR:+-C \"$DIR\"} log ..." && > > Unfortunately, however, some older broken shells incorrectly expand > this to a single argument ("-C <dir>") rather than the expected two > arguments (-C and "<dir>")[1,2,3,4]. The workaround is unsightly but > doable: > > graph_git_two_modes "${DIR:+-C} ${DIR:+\"$DIR\"} log ..." && Hmm. I get what you're saying, but I think in this case we're OK, since this all goes to `graph_git_two_modes`, whose implementation looks like: graph_git_two_modes() { git -c core.commitGraph=true $1 >output } So I think we really do want everything smashed together into a single argument. (Just to sure, here's the diff of what I applied on top of [2/5] before replying to your message): --- 8< --- diff --git a/t/lib-commit-graph.sh b/t/lib-commit-graph.sh index c93969ae74..d60e64cb0b 100755 --- a/t/lib-commit-graph.sh +++ b/t/lib-commit-graph.sh @@ -22,11 +22,11 @@ graph_git_behavior() { test_expect_success "check normal git operations: $MSG" ' ( cd "$TRASH_DIRECTORY" && - graph_git_two_modes "${DIR:+-C $DIR} log --oneline $BRANCH" && - graph_git_two_modes "${DIR:+-C $DIR} log --topo-order $BRANCH" && - graph_git_two_modes "${DIR:+-C $DIR} log --graph $COMPARE..$BRANCH" && - graph_git_two_modes "${DIR:+-C $DIR} branch -vv" && - graph_git_two_modes "${DIR:+-C $DIR} merge-base -a $BRANCH $COMPARE" + graph_git_two_modes "${DIR:+-C} ${DIR:+\"$DIR\"} log --oneline $BRANCH" && + graph_git_two_modes "${DIR:+-C} ${DIR:+\"$DIR\"} log --topo-order $BRANCH" && + graph_git_two_modes "${DIR:+-C} ${DIR:+\"$DIR\"} log --graph $COMPARE..$BRANCH" && + graph_git_two_modes "${DIR:+-C} ${DIR:+\"$DIR\"} branch -vv" && + graph_git_two_modes "${DIR:+-C} ${DIR:+\"$DIR\"} merge-base -a $BRANCH $COMPARE" ) ' } --- >8 --- > [1]: https://lore.kernel.org/git/20160517215214.GA16905@sigill.intra.peff.net/ > [2]: https://lore.kernel.org/git/e3bfc53363b14826d828e1adffbbeea@74d39fa044aa309eaea14b9f57fe79c/ > [3]: https://lore.kernel.org/git/20160518010609.Horde.sM8QUFek6WMAAwho56DDob8@webmail.informatik.kit.edu/ > [4]: https://lore.kernel.org/git/1240044459-57227-1-git-send-email-ben@ben.com/ Thanks, Taylor
Taylor Blau <me@ttaylorr.com> writes: >> graph_git_two_modes "${DIR:+-C \"$DIR\"} log ..." && >> >> Unfortunately, however, some older broken shells incorrectly expand >> this to a single argument ("-C <dir>") rather than the expected two >> arguments (-C and "<dir>")[1,2,3,4]. The workaround is unsightly but >> doable: >> >> graph_git_two_modes "${DIR:+-C} ${DIR:+\"$DIR\"} log ..." && > > Hmm. I get what you're saying, but I think in this case we're OK, since > this all goes to `graph_git_two_modes`, whose implementation looks like: > > graph_git_two_modes() { > git -c core.commitGraph=true $1 >output > } > > So I think we really do want everything smashed together into a single > argument. This is not a scripted Porcelain that must cope with any funnies the end users may throw at us, after all. How about adding a new prominent note at the beginning of graph_git_behavior helper to declare that it is a bug if DIR contains any characters (e.g. $IFS) that may make the shell misbehave, and then stop worrying about quoting of this one? That would keep the end result slightly more readable ;-)
diff --git a/t/lib-commit-graph.sh b/t/lib-commit-graph.sh index c50553df0ed..c93969ae74d 100755 --- a/t/lib-commit-graph.sh +++ b/t/lib-commit-graph.sh @@ -20,12 +20,14 @@ graph_git_behavior() { BRANCH=$3 COMPARE=$4 test_expect_success "check normal git operations: $MSG" ' - cd "$TRASH_DIRECTORY/$DIR" && - graph_git_two_modes "log --oneline $BRANCH" && - graph_git_two_modes "log --topo-order $BRANCH" && - graph_git_two_modes "log --graph $COMPARE..$BRANCH" && - graph_git_two_modes "branch -vv" && - graph_git_two_modes "merge-base -a $BRANCH $COMPARE" + ( + cd "$TRASH_DIRECTORY" && + graph_git_two_modes "${DIR:+-C $DIR} log --oneline $BRANCH" && + graph_git_two_modes "${DIR:+-C $DIR} log --topo-order $BRANCH" && + graph_git_two_modes "${DIR:+-C $DIR} log --graph $COMPARE..$BRANCH" && + graph_git_two_modes "${DIR:+-C $DIR} branch -vv" && + graph_git_two_modes "${DIR:+-C $DIR} merge-base -a $BRANCH $COMPARE" + ) ' }
The `graph_git_behavior()` helper asserts that a number of common Git operations (such as `git log --oneline`, `git log --topo-order`, etc.) produce identical output regardless of whether or not a commit-graph is in use. This helper takes as its second argument the location (relative to the `$TRASH_DIRECTORY`) of the Git repostiory under test. In order to run each of its commands within that repository, it first changes into that directory, without the use of a sub-shell. This pollutes future tests which expect to be run in the top-level `$TRASH_DIRECTORY` as usual. We could wrap `graph_git_behavior()` in a sub-shell, like: graph_git_behavior() { # ... ( cd "$TRASH_DIRECTORY/$DIR" && graph_git_two_modesl ) } , but since we're invoking git directly, we can pass along a "-C $DIR" when "$DIR" is non-empty. Note, however, that until the remaining callers are cleaned up to avoid changing working directories outside of a sub-shell, that we need to ensure that we are operating in the top-level $TRASH_DIRECTORY. The inner-subshell will go away in a future commit once it is no longer necessary. Signed-off-by: Taylor Blau <me@ttaylorr.com> --- t/lib-commit-graph.sh | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-)