Skip to content

Commit

Permalink
worktree: detect from secondary worktree if main worktree is bare
Browse files Browse the repository at this point in the history
Setup:
1. Have a bare repo with core.bare = true in config.worktree
2. Create a new worktree

Behavior:
From the secondary worktree the main worktree appears as non-bare.

Expected:
From the secondary worktree the main worktree should appear as bare.

Why current behavior is not good?
If the main worktree is detected as not bare it doesn't allow
checking out the branch of the main worktree. There are possibly
other problems associated with that behavior.

Why is it happening?
While we're inside the secondary worktree we don't initialize the main
worktree's repository with its configuration.

How is it fixed?
Load actual configs of the main worktree. Also, skip the config loading
step if we're already inside the current worktree because in that case we
rely on is_bare_repository() to return the correct result.

Other solutions considered:
Alternatively, instead of incorrectly always using
`the_repository` as the main worktree's repository, we can detect
and load the actual repository of the main worktree and then use
that repository's `is_bare` value extracted from correct configs.
However, this approach is a bit riskier and could also affect
performance. Since we had the assignment `worktree->repo =
the_repository` for a long time already, I decided it's safe to
keep it as it is for now; it can be still fixed separately from
this change.

Real life use case:
1. Have a bare repo
2. Create a worktree from the bare repo
3. In the secondary worktree enable sparse-checkout - this enables
extensions.worktreeConfig and keeps core.bare=true setting in
config.worktree of the bare worktree
4. The secondary worktree or any other non-bare worktree created
won't be able to use branch main (not even once), but it should be
able to.

Signed-off-by: Olga Pilipenco <olga.pilipenco@shopify.com>
  • Loading branch information
olga-mcbfe committed Nov 14, 2024
1 parent 25b0f41 commit b92d0d1
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 9 deletions.
14 changes: 14 additions & 0 deletions t/t3200-branch.sh
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,20 @@ test_expect_success 'bare main worktree has HEAD at branch deleted by secondary
git -C secondary branch -D main
'

test_expect_success 'secondary worktree can switch to main if common dir is bare worktree' '
test_when_finished "rm -rf bare_repo non_bare_repo secondary_worktree" &&
git init -b main non_bare_repo &&
test_commit -C non_bare_repo x &&
git clone --bare non_bare_repo bare_repo &&
git -C bare_repo config extensions.worktreeConfig true &&
git -C bare_repo config unset core.bare &&
git -C bare_repo config --worktree core.bare true &&
git -C bare_repo worktree add ../secondary_worktree &&
git -C secondary_worktree checkout main
'

test_expect_success 'git branch --list -v with --abbrev' '
test_when_finished "git branch -D t" &&
git branch t &&
Expand Down
39 changes: 30 additions & 9 deletions worktree.c
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,29 @@ static int is_current_worktree(struct worktree *wt)
return is_current;
}

static int is_bare_git_dir(const char *git_dir)
{
int bare = 0;
struct config_set cs = { { 0 } };
char *config_file;
char *worktree_config_file;

config_file = xstrfmt("%s/config", git_dir);
worktree_config_file = xstrfmt("%s/config.worktree", git_dir);

git_configset_init(&cs);
git_configset_add_file(&cs, config_file);
git_configset_add_file(&cs, worktree_config_file);

git_configset_get_bool(&cs, "core.bare", &bare);

cleanup:

Check failure on line 83 in worktree.c

View workflow job for this annotation

GitHub Actions / fuzz smoke test

worktree.c:83:1: unused label 'cleanup' [-Werror,-Wunused-label]

Check failure on line 83 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-musl (alpine)

worktree.c:83:1: label 'cleanup' defined but not used [-Werror=unused-label]

Check failure on line 83 in worktree.c

View workflow job for this annotation

GitHub Actions / pedantic (fedora)

worktree.c:83:1: label 'cleanup' defined but not used [-Werror=unused-label]

Check failure on line 83 in worktree.c

View workflow job for this annotation

GitHub Actions / linux32 (i386/ubuntu:focal)

worktree.c:83:1: label 'cleanup' defined but not used [-Werror=unused-label]

Check failure on line 83 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-asan-ubsan (ubuntu-latest)

worktree.c:83:1: unused label 'cleanup' [-Werror,-Wunused-label]

Check failure on line 83 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-gcc (ubuntu-20.04)

worktree.c:83:1: label ‘cleanup’ defined but not used [-Werror=unused-label]

Check failure on line 83 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-gcc-default (ubuntu-latest)

worktree.c:83:1: label ‘cleanup’ defined but not used [-Werror=unused-label]

Check failure on line 83 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-leaks (ubuntu-latest)

worktree.c:83:1: label ‘cleanup’ defined but not used [-Werror=unused-label]

Check failure on line 83 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-reftable (ubuntu-latest)

worktree.c:83:1: unused label 'cleanup' [-Werror,-Wunused-label]

Check failure on line 83 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-reftable-leaks (ubuntu-latest)

worktree.c:83:1: label ‘cleanup’ defined but not used [-Werror=unused-label]

Check failure on line 83 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-sha256 (ubuntu-latest)

worktree.c:83:1: unused label 'cleanup' [-Werror,-Wunused-label]

Check failure on line 83 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-TEST-vars (ubuntu-20.04)

worktree.c:83:1: label ‘cleanup’ defined but not used [-Werror=unused-label]

Check failure on line 83 in worktree.c

View workflow job for this annotation

GitHub Actions / win build

worktree.c:83:1: label 'cleanup' defined but not used [-Werror=unused-label]
git_configset_clear(&cs);
free(config_file);
free(worktree_config_file);
return bare;
}

/**
* get the main worktree
*/
Expand All @@ -76,18 +99,16 @@ static struct worktree *get_main_worktree(int skip_reading_head)
strbuf_strip_suffix(&worktree_path, "/.git");

CALLOC_ARRAY(worktree, 1);
/*
* NEEDSWORK: the_repository is not always main worktree's repository
*/
worktree->repo = the_repository;
worktree->path = strbuf_detach(&worktree_path, NULL);
/*
* NEEDSWORK: If this function is called from a secondary worktree and
* config.worktree is present, is_bare_repository_cfg will reflect the
* contents of config.worktree, not the contents of the main worktree.
* This means that worktree->is_bare may be set to 0 even if the main
* worktree is configured to be bare.
*/
worktree->is_bare = (is_bare_repository_cfg == 1) ||
is_bare_repository();
worktree->is_current = is_current_worktree(worktree);
worktree->is_bare = (is_bare_repository_cfg == 1) ||
is_bare_repository() ||
!worktree->is_current && is_bare_git_dir(repo_get_common_dir(the_repository));

Check failure on line 110 in worktree.c

View workflow job for this annotation

GitHub Actions / fuzz smoke test

worktree.c:110:25: '&&' within '||' [-Werror,-Wlogical-op-parentheses]

Check failure on line 110 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-musl (alpine)

worktree.c:110:39: suggest parentheses around '&&' within '||' [-Werror=parentheses]

Check failure on line 110 in worktree.c

View workflow job for this annotation

GitHub Actions / pedantic (fedora)

worktree.c:110:39: suggest parentheses around '&&' within '||' [-Werror=parentheses]

Check failure on line 110 in worktree.c

View workflow job for this annotation

GitHub Actions / linux32 (i386/ubuntu:focal)

worktree.c:110:25: suggest parentheses around '&&' within '||' [-Werror=parentheses]

Check failure on line 110 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-asan-ubsan (ubuntu-latest)

worktree.c:110:25: '&&' within '||' [-Werror,-Wlogical-op-parentheses]

Check failure on line 110 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-gcc (ubuntu-20.04)

worktree.c:110:25: suggest parentheses around ‘&&’ within ‘||’ [-Werror=parentheses]

Check failure on line 110 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-gcc-default (ubuntu-latest)

worktree.c:110:39: suggest parentheses around ‘&&’ within ‘||’ [-Werror=parentheses]

Check failure on line 110 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-leaks (ubuntu-latest)

worktree.c:110:39: suggest parentheses around ‘&&’ within ‘||’ [-Werror=parentheses]

Check failure on line 110 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-reftable (ubuntu-latest)

worktree.c:110:25: '&&' within '||' [-Werror,-Wlogical-op-parentheses]

Check failure on line 110 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-reftable-leaks (ubuntu-latest)

worktree.c:110:39: suggest parentheses around ‘&&’ within ‘||’ [-Werror=parentheses]

Check failure on line 110 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-sha256 (ubuntu-latest)

worktree.c:110:25: '&&' within '||' [-Werror,-Wlogical-op-parentheses]

Check failure on line 110 in worktree.c

View workflow job for this annotation

GitHub Actions / linux-TEST-vars (ubuntu-20.04)

worktree.c:110:25: suggest parentheses around ‘&&’ within ‘||’ [-Werror=parentheses]

Check failure on line 110 in worktree.c

View workflow job for this annotation

GitHub Actions / win build

worktree.c:110:39: suggest parentheses around '&&' within '||' [-Werror=parentheses]

if (!skip_reading_head)
add_head_info(worktree);
return worktree;
Expand Down

0 comments on commit b92d0d1

Please sign in to comment.