refs: provide a more general error message for dwim

carlosmn · Edward Thomson · commit 3e2e8240c02b · 2016-04-11T15:58:57.000-04:00
If we cannot dwim the input, set the error message to be explicit about
that. Otherwise we leave the error for the last failed lookup, which
can be rather unexpected as it mentions a remote when the user thought
they were trying to look up a branch.
diff --git a/src/refs.c b/src/refs.c
@@ -289,6 +289,9 @@ int git_reference_dwim(git_reference **out, git_repository *repo, const char *re
 			"Could not use '%s' as valid reference name", git_buf_cstr(&name));
 	}
 
+	if (error == GIT_ENOTFOUND)
+		giterr_set(GITERR_REFERENCE, "no reference found for shorthand '%s'", refname);
+
 	git_buf_free(&name);
 	git_buf_free(&refnamebuf);
 	return error;
diff --git a/tests/refs/lookup.c b/tests/refs/lookup.c
@@ -58,3 +58,11 @@ void test_refs_lookup__namespace(void)
 	error = git_reference_lookup(&ref, g_repo, "refs/heads/");
 	cl_assert_equal_i(error, GIT_EINVALIDSPEC);
 }
+
+void test_refs_lookup__dwim_notfound(void)
+{
+	git_reference *ref;
+
+	cl_git_fail_with(GIT_ENOTFOUND, git_reference_dwim(&ref, g_repo, "idontexist"));
+	cl_assert_equal_s("no reference found for shorthand 'idontexist'", giterr_last()->message);
+}

Original file line number	Diff line number	Diff line change
`@@ -289,6 +289,9 @@ int git_reference_dwim(git_reference *out, git_repository repo, const char *re`
`289`	`289`	`"Could not use '%s' as valid reference name", git_buf_cstr(&name));`
`290`	`290`	`}`
`291`	`291`
	`292`	`+ if (error == GIT_ENOTFOUND)`
	`293`	`+ giterr_set(GITERR_REFERENCE, "no reference found for shorthand '%s'", refname);`
	`294`	`+`
`292`	`295`	`git_buf_free(&name);`
`293`	`296`	`git_buf_free(&refnamebuf);`
`294`	`297`	`return error;`