Working implementation of git_submodule_status

This is a big redesign of the git_submodule_status API and the
implementation of the redesigned API.  It also fixes a number of
bugs that I found in other parts of the submodule API while
writing the tests for the status part.

This also fixes a couple of bugs in the iterators that had not
been noticed before - one with iterating when there is a gitlink
(i.e. separate-work-dir) and one where I was treating anything
even vaguely submodule-like as a submodule, more aggressively
than core git does.

1 files changed, 275 insertions, 11 deletions

diff --git a/tests-clar/submodule/status.c b/tests-clar/submodule/status.c
index e0c1e4c7a..d3a39235a 100644
--- a/tests-clar/submodule/status.c
+++ b/tests-clar/submodule/status.c
@@ -2,6 +2,7 @@
 #include "posix.h"
 #include "path.h"
 #include "submodule_helpers.h"
+#include "fileops.h"
 
 static git_repository *g_repo = NULL;
 
@@ -25,20 +26,283 @@ void test_submodule_status__cleanup(void)
 
 void test_submodule_status__unchanged(void)
 {
-	/* make sure it really looks unchanged */
+	unsigned int status, expected;
+	git_submodule *sm;
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_unchanged"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert(GIT_SUBMODULE_STATUS_IS_UNMODIFIED(status));
+
+	expected = GIT_SUBMODULE_STATUS_IN_HEAD |
+		GIT_SUBMODULE_STATUS_IN_INDEX |
+		GIT_SUBMODULE_STATUS_IN_CONFIG |
+		GIT_SUBMODULE_STATUS_IN_WD;
+
+	cl_assert(status == expected);
 }
 
-void test_submodule_status__changed(void)
+/* 4 values of GIT_SUBMODULE_IGNORE to check */
+
+void test_submodule_status__ignore_none(void)
 {
-	/* 4 values of GIT_SUBMODULE_IGNORE to check */
+	unsigned int status;
+	git_submodule *sm;
+	git_buf path = GIT_BUF_INIT;
+
+	cl_git_pass(git_buf_joinpath(&path, git_repository_workdir(g_repo), "sm_unchanged"));
+	cl_git_pass(git_futils_rmdir_r(git_buf_cstr(&path), GIT_DIRREMOVAL_FILES_AND_DIRS));
+
+	cl_git_fail(git_submodule_lookup(&sm, g_repo, "not_submodule"));
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_index"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_WD_INDEX_MODIFIED) != 0);
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_head"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_WD_MODIFIED) != 0);
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_file"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_WD_WD_MODIFIED) != 0);
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_untracked_file"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_WD_UNTRACKED) != 0);
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_missing_commits"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_WD_MODIFIED) != 0);
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_added_and_uncommited"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_INDEX_ADDED) != 0);
+
+	/* removed sm_unchanged for deleted workdir */
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_unchanged"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_WD_DELETED) != 0);
+
+	/* now mkdir sm_unchanged to test uninitialized */
+	cl_git_pass(git_futils_mkdir(git_buf_cstr(&path), NULL, 0755, 0));
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_unchanged"));
+	cl_git_pass(git_submodule_reload(sm));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_WD_UNINITIALIZED) != 0);
+
+	/* update sm_changed_head in index */
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_head"));
+	cl_git_pass(git_submodule_add_to_index(sm, true));
+	/* reload is not needed because add_to_index updates the submodule data */
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_INDEX_MODIFIED) != 0);
+
+	/* remove sm_changed_head from index */
+	{
+		git_index *index;
+		int pos;
+
+		cl_git_pass(git_repository_index(&index, g_repo));
+		pos = git_index_find(index, "sm_changed_head");
+		cl_assert(pos >= 0);
+		cl_git_pass(git_index_remove(index, pos));
+		cl_git_pass(git_index_write(index));
+
+		git_index_free(index);
+	}
 
-	/* 6 states of change:
-	 * - none, (handled in __unchanged above)
-	 * - dirty workdir file,
-	 * - dirty index,
-	 * - moved head,
-	 * - untracked file,
-	 * - missing commits (i.e. superproject commit is ahead of submodule)
-	 */
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_head"));
+	cl_git_pass(git_submodule_reload(sm));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_INDEX_DELETED) != 0);
+
+	git_buf_free(&path);
 }
 
+static int set_sm_ignore(git_submodule *sm, const char *name, void *payload)
+{
+	git_submodule_ignore_t ignore = *(git_submodule_ignore_t *)payload;
+	GIT_UNUSED(name);
+	git_submodule_set_ignore(sm, ignore);
+	return 0;
+}
+
+void test_submodule_status__ignore_untracked(void)
+{
+	unsigned int status;
+	git_submodule *sm;
+	git_buf path = GIT_BUF_INIT;
+	git_submodule_ignore_t ign = GIT_SUBMODULE_IGNORE_UNTRACKED;
+
+	cl_git_pass(git_buf_joinpath(&path, git_repository_workdir(g_repo), "sm_unchanged"));
+	cl_git_pass(git_futils_rmdir_r(git_buf_cstr(&path), GIT_DIRREMOVAL_FILES_AND_DIRS));
+
+	cl_git_pass(git_submodule_foreach(g_repo, set_sm_ignore, &ign));
+
+	cl_git_fail(git_submodule_lookup(&sm, g_repo, "not_submodule"));
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_index"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_WD_INDEX_MODIFIED) != 0);
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_head"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_WD_MODIFIED) != 0);
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_file"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_WD_WD_MODIFIED) != 0);
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_untracked_file"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert(GIT_SUBMODULE_STATUS_IS_UNMODIFIED(status));
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_missing_commits"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_WD_MODIFIED) != 0);
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_added_and_uncommited"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_INDEX_ADDED) != 0);
+
+	/* removed sm_unchanged for deleted workdir */
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_unchanged"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_WD_DELETED) != 0);
+
+	/* now mkdir sm_unchanged to test uninitialized */
+	cl_git_pass(git_futils_mkdir(git_buf_cstr(&path), NULL, 0755, 0));
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_unchanged"));
+	cl_git_pass(git_submodule_reload(sm));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_WD_UNINITIALIZED) != 0);
+
+	/* update sm_changed_head in index */
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_head"));
+	cl_git_pass(git_submodule_add_to_index(sm, true));
+	/* reload is not needed because add_to_index updates the submodule data */
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_INDEX_MODIFIED) != 0);
+
+	git_buf_free(&path);
+}
+
+void test_submodule_status__ignore_dirty(void)
+{
+	unsigned int status;
+	git_submodule *sm;
+	git_buf path = GIT_BUF_INIT;
+	git_submodule_ignore_t ign = GIT_SUBMODULE_IGNORE_DIRTY;
+
+	cl_git_pass(git_buf_joinpath(&path, git_repository_workdir(g_repo), "sm_unchanged"));
+	cl_git_pass(git_futils_rmdir_r(git_buf_cstr(&path), GIT_DIRREMOVAL_FILES_AND_DIRS));
+
+	cl_git_pass(git_submodule_foreach(g_repo, set_sm_ignore, &ign));
+
+	cl_git_fail(git_submodule_lookup(&sm, g_repo, "not_submodule"));
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_index"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert(GIT_SUBMODULE_STATUS_IS_UNMODIFIED(status));
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_head"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_WD_MODIFIED) != 0);
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_file"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert(GIT_SUBMODULE_STATUS_IS_UNMODIFIED(status));
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_untracked_file"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert(GIT_SUBMODULE_STATUS_IS_UNMODIFIED(status));
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_missing_commits"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_WD_MODIFIED) != 0);
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_added_and_uncommited"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_INDEX_ADDED) != 0);
+
+	/* removed sm_unchanged for deleted workdir */
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_unchanged"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_WD_DELETED) != 0);
+
+	/* now mkdir sm_unchanged to test uninitialized */
+	cl_git_pass(git_futils_mkdir(git_buf_cstr(&path), NULL, 0755, 0));
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_unchanged"));
+	cl_git_pass(git_submodule_reload(sm));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_WD_UNINITIALIZED) != 0);
+
+	/* update sm_changed_head in index */
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_head"));
+	cl_git_pass(git_submodule_add_to_index(sm, true));
+	/* reload is not needed because add_to_index updates the submodule data */
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert((status & GIT_SUBMODULE_STATUS_INDEX_MODIFIED) != 0);
+
+	git_buf_free(&path);
+}
+
+void test_submodule_status__ignore_all(void)
+{
+	unsigned int status;
+	git_submodule *sm;
+	git_buf path = GIT_BUF_INIT;
+	git_submodule_ignore_t ign = GIT_SUBMODULE_IGNORE_ALL;
+
+	cl_git_pass(git_buf_joinpath(&path, git_repository_workdir(g_repo), "sm_unchanged"));
+	cl_git_pass(git_futils_rmdir_r(git_buf_cstr(&path), GIT_DIRREMOVAL_FILES_AND_DIRS));
+
+	cl_git_pass(git_submodule_foreach(g_repo, set_sm_ignore, &ign));
+
+	cl_git_fail(git_submodule_lookup(&sm, g_repo, "not_submodule"));
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_index"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert(GIT_SUBMODULE_STATUS_IS_UNMODIFIED(status));
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_head"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert(GIT_SUBMODULE_STATUS_IS_UNMODIFIED(status));
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_file"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert(GIT_SUBMODULE_STATUS_IS_UNMODIFIED(status));
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_untracked_file"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert(GIT_SUBMODULE_STATUS_IS_UNMODIFIED(status));
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_missing_commits"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert(GIT_SUBMODULE_STATUS_IS_UNMODIFIED(status));
+
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_added_and_uncommited"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert(GIT_SUBMODULE_STATUS_IS_UNMODIFIED(status));
+
+	/* removed sm_unchanged for deleted workdir */
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_unchanged"));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert(GIT_SUBMODULE_STATUS_IS_UNMODIFIED(status));
+
+	/* now mkdir sm_unchanged to test uninitialized */
+	cl_git_pass(git_futils_mkdir(git_buf_cstr(&path), NULL, 0755, 0));
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_unchanged"));
+	cl_git_pass(git_submodule_reload(sm));
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert(GIT_SUBMODULE_STATUS_IS_UNMODIFIED(status));
+
+	/* update sm_changed_head in index */
+	cl_git_pass(git_submodule_lookup(&sm, g_repo, "sm_changed_head"));
+	cl_git_pass(git_submodule_add_to_index(sm, true));
+	/* reload is not needed because add_to_index updates the submodule data */
+	cl_git_pass(git_submodule_status(&status, sm));
+	cl_assert(GIT_SUBMODULE_STATUS_IS_UNMODIFIED(status));
+
+	git_buf_free(&path);
+}