Fix autocorrect in work tree for bare repository

Currently, auto correction doesn't work reliably for commands which must run in a work tree (e.g. git status) in Git work trees which are created from a bare repository.

This patch series adds a test case illustrating the issue and proposes a fix which adjusts the usage of read_early_config() in help_unknown_cmd() to match other usages of read_early_config(). In particular the patch removes the call to git_default_config() in the read config callback.

Simon Gerber (2):
tests: add test case for autocorrect in work tree for bare clone help.c: don't call git_default_config in git_unknown_cmd_config

 help.c                               |  2 +-
 t/t9005-help-autocorrect-worktree.sh | 29 ++++++++++++++++++++++++++++
 2 files changed, 30 insertions(+), 1 deletion(-)
 create mode 100755 t/t9005-help-autocorrect-worktree.sh

base-commit: e7e5c6f715b2de7bea0d39c7d2ba887335b40aa0
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1373%2Fsimu%2Ffix%2Fautocorrect-bare-worktree-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1373/simu/fix/autocorrect-bare-worktree-v1
Pull-Request: https://github.com/git/git/pull/1373

gitgitgadget

From: Simon Gerber <[email protected]>

Currently, auto correction doesn't work reliably for commands which must run in a work tree (e.g. git status) in Git work trees which are created from a bare repository.

This commit adds a test which shows the broken autocompletion by calling git stauts which gets autocorrected to git status. This works fine in a work tree created with git worktree add from a regular clone, but doesn't work in a work tree created with git worktree add from a bare clone.

---
 t/t9005-help-autocorrect-worktree.sh | 29 ++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100755 t/t9005-help-autocorrect-worktree.sh

new file mode 100755
index 00000000000..4fecc8a8e01
@@ -0,0 +1,29 @@
+#!/bin/sh
+
+test_description='test autocorrect in work tree based on bare repository'
+. ./test-lib.sh
+
+test_expect_success 'setup non-bare' '
+	echo one >file &&
+	git add file &&
+	git commit -m one &&
+	echo two >file &&
+	git commit -a -m two
+'
+
+test_expect_success 'setup bare' '
+	git clone --bare . bare.git &&
+	cd bare.git
+'
+
+test_expect_success 'setup worktree from bare' '
+	git worktree add ../bare-wt &&
+	cd ../bare-wt
+'
+
+test_expect_success 'autocorrect works in work tree created from bare repo' '
+	git config help.autocorrect immediate &&
+	git stauts
+'
+
+test_done

gitgitgadget

Don't we have existing test script for auto-correction? Is it sensible to waste a new fail for this single test? I doubt it.

Perhaps appending after 9003 a new test instead?

	(
		git clone --bare . bare.git &&
		cd bare.git &&
		git worktree add ../worktree &&
		cd ../worktree &&
		git -c help.autocorrect=immediate staut
	)

	git clone --bare . bare.git &&
	git -C bare.git worktree add ../worktree &&
	git -C worktree -c help.autocorrect=immediate staut

	$ git show -- ':!t/' | git apply -R

I'll move the test to 9003. I was considering doing so in the beginning, but was hesitant to add an only vaguely related test in 9003 which has the description "help.autocorrect finding a match".

Thanks for taking the time to point out how I'm supposed to use the test framework, I was pretty lost trying to write my test and ended up copying some bits from 7103.

That makes sense. I'll resubmit this as a single patch.

From: Simon Gerber <[email protected]>

Currently, auto correction doesn't work reliably for commands which must run in a work tree (e.g. git status) in Git work trees which are created from a bare repository.

As far as I'm able to determine, this has been broken since commit 659fef199f (help: use early config when autocorrecting aliases, 2017-06-14), where the call to git_config() in help_unknown_cmd() was replaced with a call to read_early_config(). From what I can tell, the actual cause for the unexpected error is that we call git_default_config() in the git_unknown_cmd_config callback instead of simply returning 0 for config entries which we aren't interested in.

Calling git_default_config() in this callback to read_early_config() seems like a bad idea since those calls will initialize a bunch of state in environment.c (among other things is_bare_repository_cfg) before we've properly detected that we're running in a work tree.

All other callbacks provided to read_early_config() appear to only extract their configurations while simply returning 0 for all other config keys.

This commit changes the git_unknown_cmd_config callback to not call git_default_config(). Instead we also simply return 0 for config keys which we're not interested in.

---
 help.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

index d04542d8261..ae534ff0bae 100644
@@ -563,7 +563,7 @@ static int git_unknown_cmd_config(const char *var, const char *value, void *cb)
 	if (skip_prefix(var, "alias.", &p))
 		add_cmdname(&aliases, p, strlen(p));
 
-	return git_default_config(var, value, cb);
+	return 0;
 }
 
 static int levenshtein_compare(const void *p1, const void *p2)

gitgitgadget

From: Simon Gerber <[email protected]>

Currently, auto correction doesn't work reliably for commands which must run in a work tree (e.g. git status) in Git work trees which are created from a bare repository.

As far as I'm able to determine, this has been broken since commit 659fef199f (help: use early config when autocorrecting aliases, 2017-06-14), where the call to git_config() in help_unknown_cmd() was replaced with a call to read_early_config(). From what I can tell, the actual cause for the unexpected error is that we call git_default_config() in the git_unknown_cmd_config callback instead of simply returning 0 for config entries which we aren't interested in.

Calling git_default_config() in this callback to read_early_config() seems like a bad idea since those calls will initialize a bunch of state in environment.c (among other things is_bare_repository_cfg) before we've properly detected that we're running in a work tree.

All other callbacks provided to read_early_config() appear to only extract their configurations while simply returning 0 for all other config keys.

This commit changes the git_unknown_cmd_config callback to not call git_default_config(). Instead we also simply return 0 for config keys which we're not interested in.

Additionally the commit adds a new test case covering help.autocorrect in a work tree created from a bare clone.

---
Fix autocorrect in work tree for bare repository

Currently, auto correction doesn't work reliably for commands which must run in a work tree (e.g. git status) in Git work trees which are created from a bare repository.

This patch adds a test case illustrating the issue and proposes a fix which adjusts the usage of read_early_config() in help_unknown_cmd() to match other usages of read_early_config(). In particular the patch removes the call to git_default_config() in the read config callback.

Changes since v1 (both suggested by Junio):

* Moved test to 9003
* Squashed change and test into a single commit

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1373%2Fsimu%2Ffix%2Fautocorrect-bare-worktree-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1373/simu/fix/autocorrect-bare-worktree-v2
Pull-Request: https://github.com/git/git/pull/1373

Range-diff vs v1:

 1:  d0a6eea93b5 < -:  ----------- tests: add test case for autocorrect in work tree for bare clone
 2:  7a2bef32439 ! 1:  4c598dbe778 help.c: don't call git_default_config in git_unknown_cmd_config

@@ Metadata
Author: Simon Gerber <[email protected]>

## Commit message ##
- help.c: don't call git_default_config in git_unknown_cmd_config
+ help.c: fix autocorrect in work tree for bare repository

Currently, auto correction doesn't work reliably for commands which must run in a work tree (e.g. git status) in Git work trees which are
@@ Commit message
git_default_config(). Instead we also simply return 0 for config keys which we're not interested in.

+ Additionally the commit adds a new test case covering help.autocorrect
+ in a work tree created from a bare clone.
+

## help.c ##
@@ help.c: static int git_unknown_cmd_config(const char *var, const char *value, vo
}

static int levenshtein_compare(const void *p1, const void *p2)
+
+ ## t/t9003-help-autocorrect.sh ##
+@@ t/t9003-help-autocorrect.sh: test_expect_success 'autocorrect can be declined altogether' '
+ test_line_count = 1 actual
+ '
+
++test_expect_success 'autocorrect works in work tree created from bare repo' '
++ git clone --bare . bare.git &&
++ git -C bare.git worktree add ../worktree &&
++ git -C worktree -c help.autocorrect=immediate stauts
++'
++
+ test_done

 help.c                      | 2 +-
 t/t9003-help-autocorrect.sh | 6 ++++++
 2 files changed, 7 insertions(+), 1 deletion(-)

index d04542d8261..ae534ff0bae 100644
@@ -563,7 +563,7 @@ static int git_unknown_cmd_config(const char *var, const char *value, void *cb)
 	if (skip_prefix(var, "alias.", &p))
 		add_cmdname(&aliases, p, strlen(p));
 
-	return git_default_config(var, value, cb);
+	return 0;
 }
 
 static int levenshtein_compare(const void *p1, const void *p2)

index f00deaf3815..f5b6b4f746b 100755
@@ -60,4 +60,10 @@ test_expect_success 'autocorrect can be declined altogether' '
 	test_line_count = 1 actual
 '
 
+test_expect_success 'autocorrect works in work tree created from bare repo' '
+	git clone --bare . bare.git &&
+	git -C bare.git worktree add ../worktree &&
+	git -C worktree -c help.autocorrect=immediate stauts
+'
+
 test_done

base-commit: e7e5c6f715b2de7bea0d39c7d2ba887335b40aa0

gitgitgadget

Hi all,

Just wanted to check what the state on this patch is (side-note: I just noticed that I didn't cc Junio in the v2 submission, my apologies). As described in the quote (and the parent email), the patch fixes how auto correct initializes the config. Version 2 addresses the points raised on v1, in particular, I've moved the test to 9003, and have squashed the change into a single commit. Please let me know if further changes are necessary.

-- Simon

Very good observation and justification for this change.

Thanks for pointing out that autocorrect could work differently for a tester depending on what's in their path. I didn't consider that case at all.

I think that's fine in this case.

Awesome, thanks