libgit2/tests/submodule/open.c
Patrick Steinhardt 2696c5c3ec repository: make check if repo is a worktree more strict
To determine if a repository is a worktree or not, we currently check
for the existence of a "gitdir" file inside of the repository's gitdir.
While this is sufficient for non-broken repositories, we have at least
one case of a subtly broken repository where there exists a gitdir file
inside of a gitmodule. This will cause us to misidentify the submodule
as a worktree.

While this is not really a fault of ours, we can do better here by
observing that a repository can only ever be a worktree iff its common
directory and dotgit directory are different. This allows us to make our
check whether a repo is a worktree or not more strict by doing a simple
string comparison of these two directories. This will also allow us to
do the right thing in the above case of a broken repository, as for
submodules these directories will be the same. At the same time, this
allows us to skip the `stat` check for the "gitdir" file for most
repositories.
2017-05-19 09:44:44 +02:00

91 lines
2.9 KiB
C

#include "clar_libgit2.h"
#include "submodule_helpers.h"
#include "path.h"
static git_repository *g_parent;
static git_repository *g_child;
static git_submodule *g_module;
void test_submodule_open__initialize(void)
{
g_parent = setup_fixture_submod2();
}
void test_submodule_open__cleanup(void)
{
git_submodule_free(g_module);
git_repository_free(g_child);
cl_git_sandbox_cleanup();
g_parent = NULL;
g_child = NULL;
g_module = NULL;
}
static void assert_sm_valid(git_repository *parent, git_repository *child, const char *sm_name)
{
git_buf expected = GIT_BUF_INIT, actual = GIT_BUF_INIT;
/* assert working directory */
cl_git_pass(git_buf_joinpath(&expected, git_repository_workdir(parent), sm_name));
cl_git_pass(git_path_prettify_dir(&expected, expected.ptr, NULL));
cl_git_pass(git_buf_sets(&actual, git_repository_workdir(child)));
cl_git_pass(git_path_prettify_dir(&actual, actual.ptr, NULL));
cl_assert_equal_s(expected.ptr, actual.ptr);
git_buf_clear(&expected);
git_buf_clear(&actual);
/* assert common directory */
cl_git_pass(git_buf_joinpath(&expected, git_repository_commondir(parent), "modules"));
cl_git_pass(git_buf_joinpath(&expected, expected.ptr, sm_name));
cl_git_pass(git_path_prettify_dir(&expected, expected.ptr, NULL));
cl_git_pass(git_buf_sets(&actual, git_repository_commondir(child)));
cl_git_pass(git_path_prettify_dir(&actual, actual.ptr, NULL));
cl_assert_equal_s(expected.ptr, actual.ptr);
/* assert git directory */
cl_git_pass(git_buf_sets(&actual, git_repository_path(child)));
cl_git_pass(git_path_prettify_dir(&actual, actual.ptr, NULL));
cl_assert_equal_s(expected.ptr, actual.ptr);
git_buf_free(&expected);
git_buf_free(&actual);
}
void test_submodule_open__opening_via_lookup_succeeds(void)
{
cl_git_pass(git_submodule_lookup(&g_module, g_parent, "sm_unchanged"));
cl_git_pass(git_submodule_open(&g_child, g_module));
assert_sm_valid(g_parent, g_child, "sm_unchanged");
}
void test_submodule_open__direct_open_succeeds(void)
{
git_buf path = GIT_BUF_INIT;
cl_git_pass(git_buf_joinpath(&path, git_repository_workdir(g_parent), "sm_unchanged"));
cl_git_pass(git_repository_open(&g_child, path.ptr));
assert_sm_valid(g_parent, g_child, "sm_unchanged");
git_buf_free(&path);
}
void test_submodule_open__direct_open_succeeds_for_broken_sm_with_gitdir(void)
{
git_buf path = GIT_BUF_INIT;
/*
* This is actually not a valid submodule, but we
* encountered at least one occasion where the gitdir
* file existed inside of a submodule's gitdir. As we are
* now able to open these submodules correctly, we still
* add a test for this.
*/
cl_git_mkfile("submod2/.git/modules/sm_unchanged/gitdir", ".git");
cl_git_pass(git_buf_joinpath(&path, git_repository_workdir(g_parent), "sm_unchanged"));
cl_git_pass(git_repository_open(&g_child, path.ptr));
assert_sm_valid(g_parent, g_child, "sm_unchanged");
git_buf_free(&path);
}