| Message ID | 20210104162128.95281-7-rafaeloliveira.cs@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | teach `worktree list` verbose mode and prunable annotations | expand |
On Mon, Jan 4, 2021 at 11:22 AM Rafael Silva <rafaeloliveira.cs@gmail.com> wrote: > Add tests for "git worktree list" verbose mode, prunable and locked > annotations for both default and porcelain format and ensure the > "prunable" annotation is consistent with what "git worktree prune" > command will eventually remove. Additionally, add one test case to > ensure any newline characters are escaped from locked reason for the > porcelain format to prevent breaking the format. > > The c57b3367be (worktree: teach `list` to annotate locked worktree, > 2020-10-11) introduced a new test to ensure locked worktrees are listed > with "locked" annotation. However, the test does not remove the worktree > as the "git worktree prune" is not going to remove any locked worktrees. > Let's fix that by unlocking the worktree before the "prune" command. > > Signed-off-by: Rafael Silva <rafaeloliveira.cs@gmail.com> > --- > diff --git a/t/t2402-worktree-list.sh b/t/t2402-worktree-list.sh > @@ -62,7 +62,9 @@ test_expect_success '"list" all worktrees --porcelain' ' > test_expect_success '"list" all worktrees with locked annotation' ' > - test_when_finished "rm -rf locked unlocked out && git worktree prune" && > + test_when_finished "rm -rf locked unlocked out && > + git worktree unlock locked && > + git worktree prune" && > git worktree add --detach locked master && > git worktree add --detach unlocked master && > git worktree lock locked && You might need to be a bit more careful here. If the test fails before the worktree is locked, then the `git worktree unlock` in the cleanup code will return an error, which will make the code executed by test_when_finished() fail, as well, which makes it harder to debug problems. Moving the `unlock` cleanup after you know the lock succeeded will address this issue: test_when_finished "rm -rf locked unlocked out && git worktree prune" && git worktree add --detach locked master && git worktree add --detach unlocked master && git worktree lock locked && test_when_finished "git worktree unlock locked" && ... Same comment applies to other new tests added by this patch which lock worktrees. > @@ -71,6 +73,96 @@ test_expect_success '"list" all worktrees with locked annotation' ' > +test_expect_success '"list" all worktrees with prunable consistent with "prune"' ' > + test_when_finished "rm -rf prunable out && git worktree prune" && > + git worktree add --detach prunable && > + rm -rf prunable && > + git worktree list >out && > + grep "/prunable *[0-9a-f].* prunable$" out && > + git worktree prune --verbose >out && > + test_i18ngrep "^Removing worktrees/prunable" out > +' To be trustworthy, doesn't this test also need to have an unprunable worktree, and test that `git worktree list` doesn't annotate it as "prunable" _and_ that `git worktree prune` didn't prune it? Otherwise, we really don't know that the two commands agree about what is and is not prunable -- we only know they agree that this particular worktree was prunable. > +test_expect_success '"list" all worktrees --porcelain with newline escaped locked reason' ' > + test_when_finished "rm -rf locked_lf locked_crlf reason_lf reason_crlf out actual expect reason && > + git worktree unlock locked_lf && > + git worktree unlock locked_crlf && > + git worktree prune" && Nit: It's not a big deal, but we don't normally bother cleaning up every junk file in tests, such as `out`, `actual`, `expect` if those files aren't going to be a problem for subsequent tests. We are explicitly cleaning up the worktrees in these tests because this script is all about testing worktree behavior, and some random leftover worktree could be a problem for other tests. I don't care strongly one way or the other, but I worry a tiny bit that the list of files being cleaned up could become outdated as changes are made to the tests later... > +test_expect_success '"list" all worktrees --porcelain with prunable' ' > + test_when_finished "rm -rf prunable list out && git worktree prune" && > + git worktree add --detach prunable && > + rm -rf prunable && > + git worktree list --porcelain >out && > + test_i18ngrep "^prunable gitdir file points to non-existent location$" out > +' ... for instance, the file `list` being cleaned up in this test is not even created by this test. > + > +test_expect_success '"list" all worktrees --verbose and --porcelain mutually exclusive' ' > + test_must_fail git worktree list --verbose --porcelain > +' Nit: This test title could probably be shortened to: '"list' --verbose and --porcelain mutually exclusive' ' Finally, I haven't tried it myself, but I was wondering if it is possible to make a test which shows both "locked" and "prunable" annotations for the same worktree. Would that be possible by specifying a particular value for `--expire`? If it's too much work, don't worry about it.
On Wed, Jan 6, 2021 at 4:39 AM Eric Sunshine <sunshine@sunshineco.com> wrote: > Finally, I haven't tried it myself, but I was wondering if it is > possible to make a test which shows both "locked" and "prunable" > annotations for the same worktree. Would that be possible by > specifying a particular value for `--expire`? If it's too much work, > don't worry about it. Ignore this stupid question/suggestion. A locked worktree will never be considered prunable. Don't know what I was thinking when I asked it.
Eric Sunshine writes: > On Mon, Jan 4, 2021 at 11:22 AM Rafael Silva > <rafaeloliveira.cs@gmail.com> wrote: >> Add tests for "git worktree list" verbose mode, prunable and locked >> annotations for both default and porcelain format and ensure the >> "prunable" annotation is consistent with what "git worktree prune" >> command will eventually remove. Additionally, add one test case to >> ensure any newline characters are escaped from locked reason for the >> porcelain format to prevent breaking the format. >> >> The c57b3367be (worktree: teach `list` to annotate locked worktree, >> 2020-10-11) introduced a new test to ensure locked worktrees are listed >> with "locked" annotation. However, the test does not remove the worktree >> as the "git worktree prune" is not going to remove any locked worktrees. >> Let's fix that by unlocking the worktree before the "prune" command. >> >> Signed-off-by: Rafael Silva <rafaeloliveira.cs@gmail.com> >> --- >> diff --git a/t/t2402-worktree-list.sh b/t/t2402-worktree-list.sh >> @@ -62,7 +62,9 @@ test_expect_success '"list" all worktrees --porcelain' ' >> test_expect_success '"list" all worktrees with locked annotation' ' >> - test_when_finished "rm -rf locked unlocked out && git worktree prune" && >> + test_when_finished "rm -rf locked unlocked out && >> + git worktree unlock locked && >> + git worktree prune" && >> git worktree add --detach locked master && >> git worktree add --detach unlocked master && >> git worktree lock locked && > > You might need to be a bit more careful here. If the test fails before > the worktree is locked, then the `git worktree unlock` in the cleanup > code will return an error, which will make the code executed by > test_when_finished() fail, as well, which makes it harder to debug > problems. Moving the `unlock` cleanup after you know the lock > succeeded will address this issue: > > test_when_finished "rm -rf locked unlocked out && git worktree prune" && > git worktree add --detach locked master && > git worktree add --detach unlocked master && > git worktree lock locked && > test_when_finished "git worktree unlock locked" && > ... > > Same comment applies to other new tests added by this patch which lock > worktrees. > This is good point. will change on the next revision. >> @@ -71,6 +73,96 @@ test_expect_success '"list" all worktrees with locked annotation' ' >> +test_expect_success '"list" all worktrees with prunable consistent with "prune"' ' >> + test_when_finished "rm -rf prunable out && git worktree prune" && >> + git worktree add --detach prunable && >> + rm -rf prunable && >> + git worktree list >out && >> + grep "/prunable *[0-9a-f].* prunable$" out && >> + git worktree prune --verbose >out && >> + test_i18ngrep "^Removing worktrees/prunable" out >> +' > > To be trustworthy, doesn't this test also need to have an unprunable > worktree, and test that `git worktree list` doesn't annotate it as > "prunable" _and_ that `git worktree prune` didn't prune it? Otherwise, > we really don't know that the two commands agree about what is and is > not prunable -- we only know they agree that this particular worktree > was prunable. > You're right this test is missing the case the "unprunable case". Will add into the next revision. >> +test_expect_success '"list" all worktrees --porcelain with newline escaped locked reason' ' >> + test_when_finished "rm -rf locked_lf locked_crlf reason_lf reason_crlf out actual expect reason && >> + git worktree unlock locked_lf && >> + git worktree unlock locked_crlf && >> + git worktree prune" && > > Nit: It's not a big deal, but we don't normally bother cleaning up > every junk file in tests, such as `out`, `actual`, `expect` if those > files aren't going to be a problem for subsequent tests. We are > explicitly cleaning up the worktrees in these tests because this > script is all about testing worktree behavior, and some random > leftover worktree could be a problem for other tests. I don't care > strongly one way or the other, but I worry a tiny bit that the list of > files being cleaned up could become outdated as changes are made to > the tests later... > Make sense, and ... >> +test_expect_success '"list" all worktrees --porcelain with prunable' ' >> + test_when_finished "rm -rf prunable list out && git worktree prune" && >> + git worktree add --detach prunable && >> + rm -rf prunable && >> + git worktree list --porcelain >out && >> + test_i18ngrep "^prunable gitdir file points to non-existent location$" out >> +' > > ... for instance, the file `list` being cleaned up in this test is not > even created by this test. > This is exactly the case of updating the test and forgetting to remove from the cleanup part because it was not used anymore. I'm also inclined to make this changes on the next revision.
diff --git a/t/t2402-worktree-list.sh b/t/t2402-worktree-list.sh index 795ddca2e4..6c4da438b3 100755 --- a/t/t2402-worktree-list.sh +++ b/t/t2402-worktree-list.sh @@ -62,7 +62,9 @@ test_expect_success '"list" all worktrees --porcelain' ' ' test_expect_success '"list" all worktrees with locked annotation' ' - test_when_finished "rm -rf locked unlocked out && git worktree prune" && + test_when_finished "rm -rf locked unlocked out && + git worktree unlock locked && + git worktree prune" && git worktree add --detach locked master && git worktree add --detach unlocked master && git worktree lock locked && @@ -71,6 +73,96 @@ test_expect_success '"list" all worktrees with locked annotation' ' ! grep "/unlocked *[0-9a-f].* locked$" out ' +test_expect_success '"list" all worktrees with prunable annotation' ' + test_when_finished "rm -rf prunable unprunable out && git worktree prune" && + git worktree add --detach prunable && + git worktree add --detach unprunable && + rm -rf prunable && + git worktree list >out && + grep "/prunable *[0-9a-f].* prunable$" out && + ! grep "/unprunable *[0-9a-f].* prunable$" +' + +test_expect_success '"list" all worktrees with prunable consistent with "prune"' ' + test_when_finished "rm -rf prunable out && git worktree prune" && + git worktree add --detach prunable && + rm -rf prunable && + git worktree list >out && + grep "/prunable *[0-9a-f].* prunable$" out && + git worktree prune --verbose >out && + test_i18ngrep "^Removing worktrees/prunable" out +' + +test_expect_success '"list" all worktrees --porcelain with locked' ' + test_when_finished "rm -rf locked1 locked2 out actual expect && + git worktree unlock locked1 && + git worktree unlock locked2 && + git worktree prune" && + echo "locked" >expect && + echo "locked with reason" >>expect && + git worktree add locked1 --detach && + git worktree add locked2 --detach && + git worktree lock locked1 && + git worktree lock locked2 --reason "with reason" && + git worktree list --porcelain >out && + grep "^locked" out >actual && + test_cmp expect actual +' + +test_expect_success '"list" all worktrees --porcelain with newline escaped locked reason' ' + test_when_finished "rm -rf locked_lf locked_crlf reason_lf reason_crlf out actual expect reason && + git worktree unlock locked_lf && + git worktree unlock locked_crlf && + git worktree prune" && + printf "locked locked\\\\r\\\\nreason\n" >expect && + printf "locked locked\\\\nreason\n" >>expect && + git worktree add locked_lf --detach && + git worktree add locked_crlf --detach && + printf "locked\nreason\n\n" >reason_lf && + printf "locked\r\nreason\n\n" >reason_crlf && + git worktree lock locked_lf --reason "$(cat reason_lf)" && + git worktree lock locked_crlf --reason "$(cat reason_crlf)" && + git worktree list --porcelain >out && + grep "^locked" out >actual && + test_cmp expect actual +' + +test_expect_success '"list" all worktrees --porcelain with prunable' ' + test_when_finished "rm -rf prunable list out && git worktree prune" && + git worktree add --detach prunable && + rm -rf prunable && + git worktree list --porcelain >out && + test_i18ngrep "^prunable gitdir file points to non-existent location$" out +' + +test_expect_success '"list" all worktrees --verbose and --porcelain mutually exclusive' ' + test_must_fail git worktree list --verbose --porcelain +' + +test_expect_success '"list" all worktrees --verbose with locked' ' + test_when_finished "rm -rf locked out actual expect && + git worktree unlock locked && + git worktree prune" && + git worktree add locked --detach && + git worktree lock locked --reason "with reason" && + echo "$(git -C locked rev-parse --show-toplevel) $(git rev-parse --short HEAD) (detached HEAD)" >expect && + printf "\tlocked: with reason\n" >>expect && + git worktree list --verbose >out && + sed -n "s/ */ /g;/\/locked *[0-9a-f].*$/,/locked: .*$/p" <out >actual && + test_cmp actual expect +' + +test_expect_success '"list" all worktrees --verbose with prunable' ' + test_when_finished "rm -rf prunable out actual expect && git worktree prune" && + git worktree add prunable --detach && + echo "$(git -C prunable rev-parse --show-toplevel) $(git rev-parse --short HEAD) (detached HEAD)" >expect && + printf "\tprunable: gitdir file points to non-existent location\n" >>expect && + rm -rf prunable && + git worktree list --verbose >out && + sed -n "s/ */ /g;/\/prunable *[0-9a-f].*$/,/prunable: .*$/p" <out >actual && + test_i18ncmp actual expect +' + test_expect_success 'bare repo setup' ' git init --bare bare1 && echo "data" >file1 &&
Add tests for "git worktree list" verbose mode, prunable and locked annotations for both default and porcelain format and ensure the "prunable" annotation is consistent with what "git worktree prune" command will eventually remove. Additionally, add one test case to ensure any newline characters are escaped from locked reason for the porcelain format to prevent breaking the format. The c57b3367be (worktree: teach `list` to annotate locked worktree, 2020-10-11) introduced a new test to ensure locked worktrees are listed with "locked" annotation. However, the test does not remove the worktree as the "git worktree prune" is not going to remove any locked worktrees. Let's fix that by unlocking the worktree before the "prune" command. Signed-off-by: Rafael Silva <rafaeloliveira.cs@gmail.com> --- t/t2402-worktree-list.sh | 94 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 93 insertions(+), 1 deletion(-)