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

[PATCH 6/9] t3903: adjust stash test to account for --[no-]index with breaking changes

From
D. Ben Knoble <ben.knoble+github@gmail.com>
Date
May 10, 2025, 18:33 UTC
Message-ID
<20250510183358.36806-7-ben.knoble+github@gmail.com>
In-Reply-To
<20250510183358.36806-1-ben.knoble+github@gmail.com>

A few tests check the results of the index after applying a stash; with breaking changes from previous commits that automatically restore the stashed index, the expected values are wrong.

A few of the relevant tests check the restoration of <pathspec>s; with the aforementioned breaking changes, things get more interesting. In particular, if we "git stash push -- foo" but have "bar" in the index, then when applying the stash we get a conflict: "bar" was not removed from the index by the stash, but it was included in the recorded index in the stash. In those cases, apply the stash with "--no-index" (which would be the required user behavior).

Signed-off-by: D. Ben Knoble <ben.knoble+github@gmail.com>
---
Notes:
    It looks like the pathspec filtering is not applied to the stashed
    index; should it be?
 t/t3903-stash.sh | 158 +++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 147 insertions(+), 11 deletions(-)
diff --git a/t/t3903-stash.sh b/t/t3903-stash.sh
index b8936a653b..36e1d3ec08 100755
--- a/t/t3903-stash.sh
+++ b/t/t3903-stash.sh
@@ -99,7 +99,7 @@ setup_stash()
 	test_cmp expect file
 '
 
-test_expect_success 'apply stashed changes' '
+test_expect_success !WITH_BREAKING_CHANGES 'apply stashed changes' '
 	git reset --hard &&
 	echo 5 >other-file &&
 	git add other-file &&
@@ -111,6 +111,18 @@ setup_stash()
 	test 1 = $(git show HEAD:file)
 '
 
+test_expect_success WITH_BREAKING_CHANGES 'apply stashed changes' '
+	git reset --hard &&
+	echo 5 >other-file &&
+	git add other-file &&
+	test_tick &&
+	git commit -m other-file &&
+	git stash apply &&
+	test 3 = $(cat file) &&
+	test 2 = $(git show :file) &&
+	test 1 = $(git show HEAD:file)
+'
+
 test_expect_success 'apply stashed changes (including index)' '
 	git reset --hard HEAD^ &&
 	echo 6 >other-file &&
@@ -136,7 +148,7 @@ setup_stash()
 	test_must_fail git stash drop --foo
 '
 
-test_expect_success 'drop top stash' '
+test_expect_success !WITH_BREAKING_CHANGES 'drop top stash' '
 	git reset --hard &&
 	git stash list >expected &&
 	echo 7 >file &&
@@ -150,7 +162,21 @@ setup_stash()
 	test 1 = $(git show HEAD:file)
 '
 
-test_expect_success 'drop middle stash' '
+test_expect_success WITH_BREAKING_CHANGES 'drop top stash' '
+	git reset --hard &&
+	git stash list >expected &&
+	echo 7 >file &&
+	git stash &&
+	git stash drop &&
+	git stash list >actual &&
+	test_cmp expected actual &&
+	git stash apply &&
+	test 3 = $(cat file) &&
+	test 2 = $(git show :file) &&
+	test 1 = $(git show HEAD:file)
+'
+
+test_expect_success !WITH_BREAKING_CHANGES 'drop middle stash' '
 	git reset --hard &&
 	echo 8 >file &&
 	git stash &&
@@ -170,7 +196,27 @@ setup_stash()
 	test 1 = $(git show HEAD:file)
 '
 
-test_expect_success 'drop middle stash by index' '
+test_expect_success WITH_BREAKING_CHANGES 'drop middle stash' '
+	git reset --hard &&
+	echo 8 >file &&
+	git stash &&
+	echo 9 >file &&
+	git stash &&
+	git stash drop stash@{1} &&
+	test 2 = $(git stash list | wc -l) &&
+	git stash apply &&
+	test 9 = $(cat file) &&
+	test 1 = $(git show :file) &&
+	test 1 = $(git show HEAD:file) &&
+	git reset --hard &&
+	git stash drop &&
+	git stash apply &&
+	test 3 = $(cat file) &&
+	test 2 = $(git show :file) &&
+	test 1 = $(git show HEAD:file)
+'
+
+test_expect_success !WITH_BREAKING_CHANGES 'drop middle stash by index' '
 	git reset --hard &&
 	echo 8 >file &&
 	git stash &&
@@ -227,7 +273,7 @@ setup_stash()
 	test_cmp expect actual
 '
 
-test_expect_success 'stash pop' '
+test_expect_success !WITH_BREAKING_CHANGES 'stash pop' '
 	git reset --hard &&
 	git stash pop &&
 	test 3 = $(cat file) &&
@@ -236,6 +282,15 @@ setup_stash()
 	test 0 = $(git stash list | wc -l)
 '
 
+test_expect_success WITH_BREAKING_CHANGES 'stash pop' '
+	git reset --hard &&
+	git stash pop &&
+	test 3 = $(cat file) &&
+	test 2 = $(git show :file) &&
+	test 1 = $(git show HEAD:file) &&
+	test 0 = $(git stash list | wc -l)
+'
+
 cat >expect <<EOF
 diff --git a/file2 b/file2
 new file mode 100644
@@ -320,7 +375,7 @@ setup_stash()
 	test_must_be_empty output.out
 '
 
-test_expect_success 'pop -q works and is quiet' '
+test_expect_success !WITH_BREAKING_CHANGES 'pop -q works and is quiet' '
 	git stash pop -q >output.out 2>&1 &&
 	echo bar >expect &&
 	git show :file >actual &&
@@ -328,6 +383,14 @@ setup_stash()
 	test_must_be_empty output.out
 '
 
+test_expect_success WITH_BREAKING_CHANGES 'pop -q works and is quiet' '
+	git stash pop -q >output.out 2>&1 &&
+	echo test >expect &&
+	git show :file >actual &&
+	test_cmp expect actual &&
+	test_must_be_empty output.out
+'
+
 test_expect_success 'pop -q --index works and is quiet' '
 	echo foo >file &&
 	git add file &&
@@ -1166,7 +1229,7 @@ setup_stash()
 	test_cmp expect actual
 '
 
-test_expect_success 'stash -- <pathspec> stashes and restores the file' '
+test_expect_success !WITH_BREAKING_CHANGES 'stash -- <pathspec> stashes and restores the file' '
 	>foo &&
 	>bar &&
 	git add foo bar &&
@@ -1178,7 +1241,19 @@ setup_stash()
 	test_path_is_file bar
 '
 
-test_expect_success 'stash -- <pathspec> stashes in subdirectory' '
+test_expect_success WITH_BREAKING_CHANGES 'stash -- <pathspec> stashes and restores the file' '
+	>foo &&
+	>bar &&
+	git add foo bar &&
+	git stash push -- foo &&
+	test_path_is_file bar &&
+	test_path_is_missing foo &&
+	git stash pop --no-index &&
+	test_path_is_file foo &&
+	test_path_is_file bar
+'
+
+test_expect_success !WITH_BREAKING_CHANGES 'stash -- <pathspec> stashes in subdirectory' '
 	mkdir sub &&
 	>foo &&
 	>bar &&
@@ -1194,7 +1269,23 @@ setup_stash()
 	test_path_is_file bar
 '
 
-test_expect_success 'stash with multiple pathspec arguments' '
+test_expect_success WITH_BREAKING_CHANGES 'stash -- <pathspec> stashes in subdirectory' '
+	mkdir sub &&
+	>foo &&
+	>bar &&
+	git add foo bar &&
+	(
+		cd sub &&
+		git stash push -- ../foo
+	) &&
+	test_path_is_file bar &&
+	test_path_is_missing foo &&
+	git stash pop --no-index &&
+	test_path_is_file foo &&
+	test_path_is_file bar
+'
+
+test_expect_success !WITH_BREAKING_CHANGES 'stash with multiple pathspec arguments' '
 	>foo &&
 	>bar &&
 	>extra &&
@@ -1209,7 +1300,22 @@ setup_stash()
 	test_path_is_file extra
 '
 
-test_expect_success 'stash with file including $IFS character' '
+test_expect_success WITH_BREAKING_CHANGES 'stash with multiple pathspec arguments' '
+	>foo &&
+	>bar &&
+	>extra &&
+	git add foo bar extra &&
+	git stash push -- foo bar &&
+	test_path_is_missing bar &&
+	test_path_is_missing foo &&
+	test_path_is_file extra &&
+	git stash pop --no-index &&
+	test_path_is_file foo &&
+	test_path_is_file bar &&
+	test_path_is_file extra
+'
+
+test_expect_success !WITH_BREAKING_CHANGES 'stash with file including $IFS character' '
 	>"foo bar" &&
 	>foo &&
 	>bar &&
@@ -1224,6 +1330,21 @@ setup_stash()
 	test_path_is_file bar
 '
 
+test_expect_success WITH_BREAKING_CHANGES 'stash with file including $IFS character' '
+	>"foo bar" &&
+	>foo &&
+	>bar &&
+	git add foo* &&
+	git stash push -- "foo b*" &&
+	test_path_is_missing "foo bar" &&
+	test_path_is_file foo &&
+	test_path_is_file bar &&
+	git stash pop --no-index &&
+	test_path_is_file "foo bar" &&
+	test_path_is_file foo &&
+	test_path_is_file bar
+'
+
 test_expect_success 'stash with pathspec matching multiple paths' '
 	echo original >file &&
 	echo original >other-file &&
@@ -1297,7 +1418,7 @@ setup_stash()
 	test_path_is_file untracked
 '
 
-test_expect_success 'stash without verb with pathspec' '
+test_expect_success !WITH_BREAKING_CHANGES 'stash without verb with pathspec' '
 	>"foo bar" &&
 	>foo &&
 	>bar &&
@@ -1312,6 +1433,21 @@ setup_stash()
 	test_path_is_file bar
 '
 
+test_expect_success WITH_BREAKING_CHANGES 'stash without verb with pathspec' '
+	>"foo bar" &&
+	>foo &&
+	>bar &&
+	git add foo* &&
+	git stash -- "foo b*" &&
+	test_path_is_missing "foo bar" &&
+	test_path_is_file foo &&
+	test_path_is_file bar &&
+	git stash pop --no-index &&
+	test_path_is_file "foo bar" &&
+	test_path_is_file foo &&
+	test_path_is_file bar
+'
+
 test_expect_success 'stash -k -- <pathspec> leaves unstaged files intact' '
 	git reset &&
 	>foo &&

-- 
2.48.1
Previous: D. Ben KnobleNext: D. Ben Knoble
Message 7 of 38 in “make stash apply with --index by default”
  1. 0/9 make stash apply with --index by defaultD. Ben Knoble, May 10, 2025
  2. 1/9 t3903: reduce dependencies on previous testsD. Ben Knoble, May 10, 2025
  3. 2/9 t3905: remove unneeded blank lineD. Ben Knoble, May 10, 2025
  4. 3/9 BreakingChanges: announce stash {apply,pop} will imply --indexD. Ben Knoble, May 10, 2025
  5. 4/9 stash: restore the index by default when breaking changes are enabledD. Ben Knoble, May 10, 2025
  6. 5/9 t0450: mark stash documentation as a known discrepancyD. Ben Knoble, May 10, 2025
  7. 6/9 t3903: adjust stash test to account for --[no-]index with breaking changesD. Ben Knoble, May 10, 2025
  8. 7/9 t3904: adjust stash -p test to account for index states with breaking changesD. Ben Knoble, May 10, 2025
  9. 8/9 t3905: adjust stash -u tests for breaking changesD. Ben Knoble, May 10, 2025
  10. 9/9 t3906: adjust stash submodule tests to account for breaking changesD. Ben Knoble, May 10, 2025
  11. Junio C HamanoMay 12, 2025
  12. D. Ben KnobleMay 20, 2025
  13. D. Ben KnobleMay 20, 2025
  14. 0/4 Teach git-stash to use --index from configD. Ben Knoble, Sep 16, 2025
  15. 1/4 t3903: reduce dependencies on previous testsD. Ben Knoble, Sep 16, 2025
  16. 2/4 t3905: remove unneeded blank lineD. Ben Knoble, Sep 16, 2025
  17. 3/4 stash: refactor private config globalsD. Ben Knoble, Sep 16, 2025
  18. 4/4 stash: honor stash.index in apply, pop modesD. Ben Knoble, Sep 16, 2025
  19. Phillip WoodSep 16, 2025
  20. D. Ben KnobleSep 16, 2025
  21. Phillip WoodSep 16, 2025
  22. D. Ben KnobleSep 16, 2025
  23. Junio C HamanoSep 16, 2025
  24. 0/4 Teach git-stash to use --index from configD. Ben Knoble, Sep 22, 2025
  25. 1/4 t3903: reduce dependencies on previous testsD. Ben Knoble, Sep 22, 2025
  26. 2/4 t3905: remove unneeded blank lineD. Ben Knoble, Sep 22, 2025
  27. 3/4 stash: refactor private config globalsD. Ben Knoble, Sep 22, 2025
  28. 4/4 stash: honor stash.index in apply, pop modesD. Ben Knoble, Sep 22, 2025
  29. Phillip WoodSep 22, 2025
  30. D. Ben KnobleSep 24, 2025
  31. Phillip WoodSep 29, 2025
  32. doc: explain the impact of stash.index on --autostash optionsD. Ben Knoble, Oct 6, 2025
  33. Kristoffer HaugsbakkOct 9, 2025
  34. D. Ben KnobleOct 11, 2025
  35. Junio C HamanoOct 11, 2025
  36. Ben KnobleOct 12, 2025
  37. Kristoffer HaugsbakkOct 13, 2025
  38. D. Ben KnobleOct 14, 2025

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.