Repository navigation
fix: align recipe git clone error handling with git_utils #6544
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.
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
Open
aviruthen
wants to merge
3
commits into
aws:master
Choose a base branch
from
aviruthen:fix-recipe-clone-error-handling
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"). You | ||
| # may not use this file except in compliance with the License. A copy of | ||
| # the License is located at | ||
| # | ||
| # http://aws.amazon.com/apache2.0/ | ||
| # | ||
| # or in the "license" file accompanying this file. This file is | ||
| # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF | ||
| # ANY KIND, either express or implied. See the License for the specific | ||
| # language governing permissions and limitations under the License. | ||
| """Unit tests for _run_clone_command_silent in sagemaker.core.modules.utils.""" | ||
|
|
||
| import logging | ||
| import subprocess | ||
| from unittest.mock import patch | ||
|
|
||
| import pytest | ||
|
|
||
| from sagemaker.core.modules.utils import _run_clone_command_silent | ||
|
|
||
| MODULE = "sagemaker.core.modules.utils" | ||
| DEST = "/tmp/dest" | ||
|
|
||
|
|
||
| @pytest.mark.parametrize( | ||
| "repo_url,userinfo", | ||
| [ | ||
| ("https://oauth2:abc123@example.com/org/repo.git", "oauth2:abc123"), | ||
| ("https://user:p%40ss@example.com/org/repo.git", "user:p%40ss"), | ||
| ("https://user:p@ss@example.com/org/repo.git", "user:p@ss"), | ||
| ], | ||
| ) | ||
| def test_clone_failure_uses_sanitized_url(repo_url, userinfo, caplog): | ||
| with patch( | ||
| f"{MODULE}.subprocess.check_call", | ||
| side_effect=subprocess.CalledProcessError(128, ["git", "clone", repo_url, DEST]), | ||
| ): | ||
| with caplog.at_level(logging.ERROR): | ||
| with pytest.raises(subprocess.CalledProcessError) as exc_info: | ||
| _run_clone_command_silent(repo_url, DEST) | ||
|
|
||
| error = exc_info.value | ||
| expected_url = "https://<credentials-redacted>@example.com/org/repo.git" | ||
| assert error.returncode == 128 | ||
| assert error.cmd == ["git", "clone", expected_url, DEST] | ||
| assert error.__suppress_context__ | ||
| assert userinfo not in str(error) | ||
| assert userinfo not in caplog.text | ||
| assert expected_url in caplog.text | ||
|
|
||
|
|
||
| def test_clone_failure_without_userinfo_keeps_url(caplog): | ||
| repo_url = "https://example.com/org/repo.git" | ||
| with patch( | ||
| f"{MODULE}.subprocess.check_call", | ||
| side_effect=subprocess.CalledProcessError(128, ["git", "clone", repo_url, DEST]), | ||
| ): | ||
| with caplog.at_level(logging.ERROR): | ||
| with pytest.raises(subprocess.CalledProcessError) as exc_info: | ||
| _run_clone_command_silent(repo_url, DEST) | ||
|
|
||
| assert exc_info.value.cmd == ["git", "clone", repo_url, DEST] | ||
| assert repo_url in caplog.text | ||
|
|
||
|
|
||
| def test_clone_success_uses_original_url(): | ||
| repo_url = "https://oauth2:abc123@example.com/org/repo.git" | ||
| with patch(f"{MODULE}.subprocess.check_call") as mock_check_call: | ||
| _run_clone_command_silent(repo_url, DEST) | ||
|
|
||
| args, kwargs = mock_check_call.call_args | ||
| assert args[0] == ["git", "clone", repo_url, DEST] | ||
| assert kwargs["env"]["GIT_TERMINAL_PROMPT"] == "0" |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"). You | ||
| # may not use this file except in compliance with the License. A copy of | ||
| # the License is located at | ||
| # | ||
| # http://aws.amazon.com/apache2.0/ | ||
| # | ||
| # or in the "license" file accompanying this file. This file is | ||
| # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF | ||
| # ANY KIND, either express or implied. See the License for the specific | ||
| # language governing permissions and limitations under the License. | ||
| """Unit tests for _run_clone_command_silent in sagemaker.train.utils.""" | ||
|
|
||
| import logging | ||
| import subprocess | ||
| from unittest.mock import patch | ||
|
|
||
| import pytest | ||
|
|
||
| from sagemaker.train.utils import _run_clone_command_silent | ||
|
|
||
| MODULE = "sagemaker.train.utils" | ||
| DEST = "/tmp/dest" | ||
|
|
||
|
|
||
| @pytest.mark.parametrize( | ||
| "repo_url,userinfo", | ||
| [ | ||
| ("https://oauth2:abc123@example.com/org/repo.git", "oauth2:abc123"), | ||
| ("https://user:p%40ss@example.com/org/repo.git", "user:p%40ss"), | ||
| ("https://user:p@ss@example.com/org/repo.git", "user:p@ss"), | ||
| ], | ||
| ) | ||
| def test_clone_failure_uses_sanitized_url(repo_url, userinfo, caplog): | ||
| with patch( | ||
| f"{MODULE}.subprocess.check_call", | ||
| side_effect=subprocess.CalledProcessError(128, ["git", "clone", repo_url, DEST]), | ||
| ): | ||
| with caplog.at_level(logging.ERROR): | ||
| with pytest.raises(subprocess.CalledProcessError) as exc_info: | ||
| _run_clone_command_silent(repo_url, DEST) | ||
|
|
||
| error = exc_info.value | ||
| expected_url = "https://<credentials-redacted>@example.com/org/repo.git" | ||
| assert error.returncode == 128 | ||
| assert error.cmd == ["git", "clone", expected_url, DEST] | ||
| assert error.__suppress_context__ | ||
| assert userinfo not in str(error) | ||
| assert userinfo not in caplog.text | ||
| assert expected_url in caplog.text | ||
|
|
||
|
|
||
| def test_clone_failure_without_userinfo_keeps_url(caplog): | ||
| repo_url = "https://example.com/org/repo.git" | ||
| with patch( | ||
| f"{MODULE}.subprocess.check_call", | ||
| side_effect=subprocess.CalledProcessError(128, ["git", "clone", repo_url, DEST]), | ||
| ): | ||
| with caplog.at_level(logging.ERROR): | ||
| with pytest.raises(subprocess.CalledProcessError) as exc_info: | ||
| _run_clone_command_silent(repo_url, DEST) | ||
|
|
||
| assert exc_info.value.cmd == ["git", "clone", repo_url, DEST] | ||
| assert repo_url in caplog.text | ||
|
|
||
|
|
||
| def test_clone_success_uses_original_url(): | ||
| repo_url = "https://oauth2:abc123@example.com/org/repo.git" | ||
| with patch(f"{MODULE}.subprocess.check_call") as mock_check_call: | ||
| _run_clone_command_silent(repo_url, DEST) | ||
|
|
||
| args, kwargs = mock_check_call.call_args | ||
| assert args[0] == ["git", "clone", repo_url, DEST] | ||
| assert kwargs["env"]["GIT_TERMINAL_PROMPT"] == "0" |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 Low: This regex change to
_redact_credentials_from_urlis a behavior change to the shared helper and therefore also affects the existing_run_clone_commandHTTPS path, not just the two new_run_clone_command_silentcopies described in the PR summary. The new pattern is an improvement (the old greedy[^@]+@would wrongly redact a URL likehttps://github.com/user/repo@v1.gitup to the@in the path), and it's covered by the new tests. Consider calling out thisgit_utils.pychange explicitly in the PR description so reviewers don't miss that the canonical redaction behavior changed.