Make checkout match diff for untracked/ignored dir

When diff finds an untracked directory, it emulates Git behavior
by looking inside the directory to see if there are any untracked
items inside it. If there are only ignored items inside the dir,
then diff considers it ignored, even if there is no direct ignore
rule for it.

Checkout was not copying this behavior - when it found an untracked
directory, it just treated it as untracked.  Unfortunately, when
combined with GIT_CHECKOUT_REMOVE_UNTRACKED, this made is seem that
checkout (and stash, which uses checkout) was removing ignored
items when you had only asked it to remove untracked ones.

This commit moves the logic for advancing past an untracked dir
while scanning for non-ignored items into an iterator helper fn,
and uses that for both diff and checkout.

1 files changed, 57 insertions, 28 deletions

diff --git a/src/checkout.c b/src/checkout.c
index 04b2a66b2..a412c4c4e 100644
--- a/src/checkout.c
+++ b/src/checkout.c
@@ -56,6 +56,7 @@ typedef struct {
 	git_vector conflicts;
 	git_buf path;
 	size_t workdir_len;
+	git_buf tmp;
 	unsigned int strategy;
 	int can_symlink;
 	bool reload_submodules;
@@ -270,21 +271,30 @@ static bool wd_item_is_removable(git_iterator *iter, const git_index_entry *wd)
 	return !full || !git_path_contains(full, DOT_GIT);
 }
 
+static int checkout_queue_remove(checkout_data *data, const char *path)
+{
+	char *copy = git_pool_strdup(&data->pool, path);
+	GITERR_CHECK_ALLOC(copy);
+	return git_vector_insert(&data->removes, copy);
+}
+
+/* note that this advances the iterator over the wd item */
 static int checkout_action_wd_only(
 	checkout_data *data,
 	git_iterator *workdir,
-	const git_index_entry *wd,
+	const git_index_entry **wditem,
 	git_vector *pathspec)
 {
 	int error = 0;
 	bool remove = false;
 	git_checkout_notify_t notify = GIT_CHECKOUT_NOTIFY_NONE;
+	const git_index_entry *wd = *wditem;
 
 	if (!git_pathspec__match(
 			pathspec, wd->path,
 			(data->strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH) != 0,
 			git_iterator_ignore_case(workdir), NULL, NULL))
-		return 0;
+		return git_iterator_advance(wditem, workdir);
 
 	/* check if item is tracked in the index but not in the checkout diff */
 	if (data->index != NULL) {
@@ -314,26 +324,49 @@ static int checkout_action_wd_only(
 		}
 	}
 
-	if (notify != GIT_CHECKOUT_NOTIFY_NONE)
-		/* found in index */;
-	else if (git_iterator_current_is_ignored(workdir)) {
-		notify = GIT_CHECKOUT_NOTIFY_IGNORED;
-		remove = ((data->strategy & GIT_CHECKOUT_REMOVE_IGNORED) != 0) &&
-			wd_item_is_removable(workdir, wd);
-	}
-	else {
-		notify = GIT_CHECKOUT_NOTIFY_UNTRACKED;
-		remove = ((data->strategy & GIT_CHECKOUT_REMOVE_UNTRACKED) != 0) &&
-			wd_item_is_removable(workdir, wd);
-	}
+	if (notify != GIT_CHECKOUT_NOTIFY_NONE) {
+		/* if we found something in the index, notify and advance */
+		if ((error = checkout_notify(data, notify, NULL, wd)) != 0)
+			return error;
+
+		if (remove && wd_item_is_removable(workdir, wd))
+			error = checkout_queue_remove(data, wd->path);
 
-	error = checkout_notify(data, notify, NULL, wd);
+		if (!error)
+			error = git_iterator_advance(wditem, workdir);
+	} else {
+		/* untracked or ignored - can't know which until we advance through */
+		bool ignored, over = false;
+		bool removable = wd_item_is_removable(workdir, wd);
 
-	if (!error && remove) {
-		char *path = git_pool_strdup(&data->pool, wd->path);
-		GITERR_CHECK_ALLOC(path);
+		/* copy the entry for issuing notification callback later */
+		git_index_entry saved_wd = *wd;
+		git_buf_sets(&data->tmp, wd->path);
+		saved_wd.path = data->tmp.ptr;
 
-		error = git_vector_insert(&data->removes, path);
+		error = git_iterator_advance_over_and_check_ignored(
+			wditem, &ignored, workdir);
+		if (error == GIT_ITEROVER)
+			over = true;
+		else if (error < 0)
+			return error;
+
+		if (ignored) {
+			notify = GIT_CHECKOUT_NOTIFY_IGNORED;
+			remove = ((data->strategy & GIT_CHECKOUT_REMOVE_IGNORED) != 0);
+		} else {
+			notify = GIT_CHECKOUT_NOTIFY_UNTRACKED;
+			remove = ((data->strategy & GIT_CHECKOUT_REMOVE_UNTRACKED) != 0);
+		}
+
+		if ((error = checkout_notify(data, notify, NULL, &saved_wd)) != 0)
+			return error;
+
+		if (remove && removable)
+			error = checkout_queue_remove(data, saved_wd.path);
+
+		if (!error && over) /* restore ITEROVER if needed */
+			error = GIT_ITEROVER;
 	}
 
 	return error;
@@ -567,11 +600,8 @@ static int checkout_action(
 			}
 
 			/* case 1 - handle wd item (if it matches pathspec) */
-			error = checkout_action_wd_only(data, workdir, wd, pathspec);
-			if (error)
-				goto done;
-			if ((error = git_iterator_advance(wditem, workdir)) < 0 &&
-				error != GIT_ITEROVER)
+			error = checkout_action_wd_only(data, workdir, wditem, pathspec);
+			if (error && error != GIT_ITEROVER)
 				goto done;
 			continue;
 		}
@@ -632,10 +662,8 @@ static int checkout_remaining_wd_items(
 {
 	int error = 0;
 
-	while (wd && !error) {
-		if (!(error = checkout_action_wd_only(data, workdir, wd, spec)))
-			error = git_iterator_advance(&wd, workdir);
-	}
+	while (wd && !error)
+		error = checkout_action_wd_only(data, workdir, &wd, spec);
 
 	if (error == GIT_ITEROVER)
 		error = 0;
@@ -1866,6 +1894,7 @@ static void checkout_data_clear(checkout_data *data)
 	data->pfx = NULL;
 
 	git_buf_free(&data->path);
+	git_buf_free(&data->tmp);
 
 	git_index_free(data->index);
 	data->index = NULL;