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

[PATCH 08/11] t9902-completion: ignore COMPREPLY element order in some tests

From
SZEDER Gábor <szeder.dev@gmail.com>
Date
Apr 16, 2018, 22:41 UTC
Message-ID
<20180416224113.16993-9-szeder.dev@gmail.com>
In-Reply-To
<20180416224113.16993-1-szeder.dev@gmail.com>

The order or possible completion words in the COMPREPLY array doesn't actually matter, as long as all the right words are in there, because Bash will sort them anyway. Yet, our tests looking at the elements of COMPREPLY always expect them to be in a specific order.

Now, this hasn't been an issue before, but the next patch is about to optimize a bit more our git-aware path completion, and as a harmless side effect the order of elements in COMPREPLY will change. Worse, the order will be downright undefined, because after the next patch path components will come directly from iterating through an associative array in 'awk', and the order of iteration over the elements in those arrays is undefined, and indeed different 'awk' implementations produce different order. Consequently, we can't get away with simply adjusting the expected results in the affected tests.

Modify the 'test_completion' helper function to sort both the expected and the actual results, i.e. the elements in COMPREPLY, before comparing them, so the tests using this helper function will work regardless of the order of elements.

Note that this change still leaves a bunch of tests depending on the order of elements in COMPREPLY, tests that focus on a specific helper function and therefore don't use the 'test_completion' helper. I would rather deal with those later, when (if ever) the need actually arises, than create unnecessary code churn now.

Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
---
 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 f7a9dd446d..a747998d6c 100755
--- a/t/t9902-completion.sh
+++ b/t/t9902-completion.sh
@@ -84,10 +84,11 @@ test_completion ()
 	then
 		printf '%s\n' "$2" >expected
 	else
-		sed -e 's/Z$//' >expected
+		sed -e 's/Z$//' |sort >expected
 	fi &&
 	run_completion "$1" &&
-	test_cmp expected out
+	sort out >out_sorted &&
+	test_cmp expected out_sorted
 }
 
 # Test __gitcomp.
@@ -1405,6 +1406,7 @@ test_expect_success 'complete files' '
 
 	echo "expected" > .gitignore &&
 	echo "out" >> .gitignore &&
+	echo "out_sorted" >> .gitignore &&
 
 	git add .gitignore &&
 	test_completion "git commit " ".gitignore" &&
-- 
2.17.0.366.gbe216a3084
Previous: SZEDER GáborNext: SZEDER Gábor
Message 27 of 36 in “completion: improve ls-files filter performance”
  1. 1/2 completion: improve ls-files filter performanceClemens Buchacher, Mar 17, 2018
  2. 2/2 completion: simplify ls-files filterClemens Buchacher, Mar 17, 2018
  3. Junio C HamanoMar 18, 2018
  4. SZEDER GáborMar 18, 2018
  5. Junio C HamanoMar 18, 2018
  6. completion: improve ls-files filter performanceClemens Buchacher, Apr 4, 2018
  7. Johannes SchindelinApr 4, 2018
  8. 00/11 completion: path completion improvements: speedup and quoted pathsSZEDER Gábor, Apr 16, 2018
  9. 01/11 t9902-completion: add tests demonstrating issues with quoted pathnamesSZEDER Gábor, Apr 16, 2018
  10. Junio C HamanoApr 17, 2018
  11. SZEDER GáborApr 17, 2018
  12. SZEDER GáborApr 17, 2018
  13. Junio C HamanoApr 18, 2018
  14. SZEDER GáborApr 26, 2018
  15. Junio C HamanoApr 26, 2018
  16. 0/2 Test improvements for 'sg/complete-paths'SZEDER Gábor, May 18, 2018
  17. 1/2 completion: don't return with error from __gitcomp_file_direct()SZEDER Gábor, May 18, 2018
  18. 2/2 t9902-completion: exercise __git_complete_index_file() directlySZEDER Gábor, May 18, 2018
  19. Eric SunshineMay 18, 2018
  20. Johannes SchindelinMay 21, 2018
  21. Johannes SchindelinMay 21, 2018
  22. Johannes SchindelinMay 21, 2018
  23. Johannes SchindelinApr 18, 2018
  24. SZEDER GáborApr 19, 2018
  25. 02/11 completion: move __git_complete_index_file() next to its helpersSZEDER Gábor, Apr 16, 2018
  26. 04/11 completion: support completing non-ASCII pathnamesSZEDER Gábor, Apr 16, 2018
  27. 08/11 t9902-completion: ignore COMPREPLY element order in some testsSZEDER Gábor, Apr 16, 2018
  28. 09/11 completion: remove repeated dirnames with 'awk' during path completionSZEDER Gábor, Apr 16, 2018
  29. 06/11 completion: let 'ls-files' and 'diff-index' filter matching pathsSZEDER Gábor, Apr 16, 2018
  30. 07/11 completion: use 'awk' to strip trailing path componentsSZEDER Gábor, Apr 16, 2018
  31. 05/11 completion: improve handling quoted paths on the command lineSZEDER Gábor, Apr 16, 2018
  32. 03/11 completion: simplify prefix path component handling during path completionSZEDER Gábor, Apr 16, 2018
  33. 10/11 completion: improve handling quoted paths in 'git ls-files's outputSZEDER Gábor, Apr 16, 2018
  34. 11/11 completion: fill COMPREPLY directly when completing pathsSZEDER Gábor, Apr 16, 2018
  35. Junio C HamanoMar 18, 2018
  36. Johannes SchindelinMar 19, 2018

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.