Skip to content

Expose git errors instead of printing a generic error message #9845

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
alexprabhat99 wants to merge 6 commits into from
Closed

Expose git errors instead of printing a generic error message #9845

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7c38bf3
expose git errors when run as a subprocess
alexprabhat99 Nov 14, 2024
3460e8a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 14, 2024
b68e177
capture_output for git subprocess
alexprabhat99 Nov 14, 2024
3c76d5c
added missing comma
alexprabhat99 Nov 14, 2024
627cab0
updated test for #9819 fix
alexprabhat99 Nov 14, 2024
098b40c
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions src/poetry/vcs/git/backend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,11 +231,8 @@ def _clone_legacy(url: str, refspec: GitRefSpec, target: Path) -> Repo:

try:
SystemGit.clone(url, target)
except CalledProcessError:
raise PoetryConsoleError(
f"Failed to clone {url}, check your git configuration and permissions"
" for this repository."
)
except CalledProcessError as e:
raise PoetryConsoleError(f"Failed to clone {url}\n {e.stderr}")
Copy link
Member

@abn abn Nov 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest the git error be surfaced via logger.debug instead. The proposed change is too noisy.

Suggested change
raise PoetryConsoleError(f"Failed to clone {url}\n {e.stderr}")
logger.debug("Git command returned the following error:\n%s", e.stderr)
raise PoetryConsoleError(
f"Failed to clone {url}, check your git configuration and permissions"
" for this repository."
)


if revision:
revision.replace("refs/head/", "")
Expand Down
6 changes: 3 additions & 3 deletions src/poetry/vcs/git/system.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ def run(*args: Any, **kwargs: Any) -> None:
git_command = find_git_command()
env = os.environ.copy()
env["GIT_TERMINAL_PROMPT"] = "0"
subprocess.check_call( # type: ignore[call-arg]
subprocess.run(
git_command + list(args),
stderr=subprocess.DEVNULL,
stdout=subprocess.DEVNULL,
check=True,
capture_output=True,
env=env,
text=True,
encoding="utf-8",
Expand Down
10 changes: 10 additions & 0 deletions tests/integration/test_utils_vcs_git.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,3 +435,13 @@ def test_relative_submodules_with_ssh(
"ssh://github.com/python-poetry/test-fixture-vcs-repository.git",
"ssh://github.com/python-poetry/test-fixture-vcs-repository.git",
]


def test_git_error_is_exposed_for_non_existent_repo() -> None:
source_url = "https://github.com/python-poetry/test-fixture-vcs-repo.git"
branch = uuid.uuid4().hex

with pytest.raises(PoetryConsoleError) as e:
Git.clone(url=source_url, branch=branch)

assert "remote: Repository not found." in str(e.value)