Skip to content

Commit

Permalink
Make git_repository() ignore GIT_ env vars
Browse files Browse the repository at this point in the history
This ensures that this repository rule cannot be influenced by these environment variables, particularly `GIT_DIR`, keeping the operation limited to the directory specified by the `repository_ctx`.

In particular, this ensures that calling Bazel (e.g. `bazel test`) from within a Git hook will work reliably. Git hooks set `GIT_DIR` (among others), which can cause the repository rule's invocations of `git` to misbehave. https://git-scm.com/docs/githooks

When using Git worktrees and calling Bazel from a Git hook, it has been observed that `git_repository()` will not only fail, but will also set `core.bare = true`, breaking the user's clone.

Fixes bazelbuild#24199.

Closes bazelbuild#24204.

PiperOrigin-RevId: 695642299
Change-Id: Id81e32194117cd8996408b236a6a88a20b14910b
  • Loading branch information
rpwoodbu authored and copybara-github committed Nov 12, 2024
1 parent 66ea9a0 commit 89115d9
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions tools/build_defs/repo/git_worker.bzl
Original file line number Diff line number Diff line change
@@ -126,7 +126,7 @@ def _update(ctx, git_repo):

def init(ctx, git_repo):
cl = ["git", "init", str(git_repo.directory)]
st = ctx.execute(cl, environment = ctx.os.environ)
st = ctx.execute(cl, environment = ctx.os.environ | _GIT_LOCAL_ENV_VARS)
if st.return_code != 0:
_error(ctx.name, cl, st.stderr)

@@ -195,13 +195,35 @@ def _git_maybe_shallow(ctx, git_repo, command, *args):
return st
return _execute(ctx, git_repo, start + args_list)

# List of variables to unset when calling `git` to ensure no interference of
# operation. This is in the form of a dict that can be passed to `execute()`.
# This list is taken from the output of `git rev-parse --local-env-vars`
_GIT_LOCAL_ENV_VARS = {
"GIT_ALTERNATE_OBJECT_DIRECTORIES": None,
"GIT_CONFIG": None,
"GIT_CONFIG_PARAMETERS": None,
"GIT_CONFIG_COUNT": None,
"GIT_OBJECT_DIRECTORY": None,
"GIT_DIR": None,
"GIT_WORK_TREE": None,
"GIT_IMPLICIT_WORK_TREE": None,
"GIT_GRAFT_FILE": None,
"GIT_INDEX_FILE": None,
"GIT_NO_REPLACE_OBJECTS": None,
"GIT_REPLACE_REF_BASE": None,
"GIT_PREFIX": None,
"GIT_INTERNAL_SUPER_PREFIX": None,
"GIT_SHALLOW_FILE": None,
"GIT_COMMON_DIR": None,
}

def _execute(ctx, git_repo, args):
# "core.fsmonitor=false" disables git from spawning a file system monitor which can cause hangs when cloning a lot.
# See https://github.com/bazelbuild/bazel/issues/21438
start = ["git", "-c", "core.fsmonitor=false"]
return ctx.execute(
start + args,
environment = ctx.os.environ,
environment = ctx.os.environ | _GIT_LOCAL_ENV_VARS,
working_directory = str(git_repo.directory),
)

0 comments on commit 89115d9

Please sign in to comment.