fix: resolve gitdir for LFS tmp path in submodule contexts#62
Open
thevinchi wants to merge 1 commit into
Open
Conversation
The LFS custom transfer agent hardcoded ".git/lfs/tmp" as a literal
path, which fails in submodule worktrees where .git is a gitlink file
rather than a directory ("OSError [Errno 20] Not a directory"). Replace
with `git rev-parse --absolute-git-dir` so the real gitdir under the
parent's .git/modules/<path>/ is resolved.
Defer module-level logging.basicConfig into _configure_logging() called
from main() so the same resolution applies to the agent log file path.
Add unit + integration tests covering the gitdir resolution and the
download() temp-dir construction.
Fixes awslabs#61
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue #, if available: #61
Description of changes:
The LFS custom transfer agent hardcoded
.git/lfs/tmpas a literal path, which fails in submodule worktrees where.gitis a gitlink file rather than a directory:In a submodule,
<sub>/.gitis a regular file containinggitdir: ../../.git/modules/<path>rather than a directory, so paths constructed by string concatenation through.git/...are invalid. This PR resolves the gitdir at runtime viagit rev-parse --absolute-git-dir, which follows the gitlink and returns the real path under the parent's.git/modules/<path>/.Changes:
git_remote_s3/lfs.py_resolve_git_dir()helper.os.path.abspath(".git/lfs/tmp")inLFSProcess.download()with the resolved gitdir, plusos.makedirs(..., exist_ok=True)so a fresh submodule gitdir works.logging.basicConfiginto_configure_logging()called frommain(), so the agent log path is also resolved correctly (with a graceful fallback if the gitdir can't be located).test/lfs_test.py(new) — 4 tests:_resolve_git_dir()in a normal repo returns an absolute path matching<tmp>/.git._resolve_git_dir()in a real submodule (created withgit init+git submodule addin a tempdir) returns the path under<parent>/.git/modules/sub, proving the gitlink is followed._resolve_git_dir()invokesgit rev-parse --absolute-git-dir(mock-based contract test).download()constructstemp_dirfrom the resolved gitdir and creates it (mock-based).Verification:
pytest test/— 52 passed; the single failure (test_simultaneous_pushes_single_bundle_remains) is pre-existing onmainand unrelated.black --check,flake8,mypy— all clean on the modified files (mypy reports the same 4 pre-existing errors asmain).Fixes #61
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.