-
Notifications
You must be signed in to change notification settings - Fork 55
fix: prevent credential_process hang on Windows in stdio transport mode #293
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
b2fcd15
fix: prevent credential_process hang on Windows in stdio transport mode
rshevchuk-git 96ab17e
refactor: patch _popen instead of copying _retrieve_credentials_using
rshevchuk-git 872d670
chore: trigger PR sync
rshevchuk-git cab24ed
fix: suppress pyright type error for mock popen argument
rshevchuk-git 4330d49
test: simplify credential_process stdin tests to focus on the patch
rshevchuk-git 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| # 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. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License 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. | ||
|
|
||
| """Tests for the credential_process stdin isolation patch in sigv4_helper. | ||
|
|
||
| When mcp-proxy-for-aws runs in stdio transport mode, its stdin is the MCP | ||
| JSON-RPC pipe. Without the patch, botocore's ProcessProvider would spawn | ||
| credential_process subprocesses that inherit the pipe, causing hangs on Windows. | ||
| """ | ||
|
|
||
| import mcp_proxy_for_aws.sigv4_helper # noqa: F401 - ensure patch is applied | ||
| import subprocess | ||
| from botocore.credentials import ProcessProvider | ||
| from unittest.mock import MagicMock | ||
|
|
||
|
|
||
| class TestCredentialProcessStdinPatch: | ||
| """Verify the sigv4_helper patch injects stdin=DEVNULL into ProcessProvider.""" | ||
|
|
||
| def test_popen_receives_stdin_devnull(self): | ||
| """ProcessProvider._popen passes stdin=subprocess.DEVNULL after the patch.""" | ||
| popen_kwargs = {} | ||
|
|
||
| def mock_popen(*args, **kwargs): | ||
| popen_kwargs.update(kwargs) | ||
| mock = MagicMock() | ||
| mock.returncode = 0 | ||
| mock.communicate.return_value = ( | ||
| b'{"Version":1,"AccessKeyId":"A","SecretAccessKey":"B"}', | ||
| b'', | ||
| ) | ||
| return mock | ||
|
|
||
| provider = ProcessProvider( | ||
| profile_name='test', | ||
| load_config=lambda: {'profiles': {'test': {'credential_process': 'echo hi'}}}, | ||
| popen=mock_popen, # type: ignore[arg-type] | ||
| ) | ||
| provider.load() | ||
| assert popen_kwargs.get('stdin') == subprocess.DEVNULL | ||
|
|
||
| def test_explicit_stdin_is_not_overridden(self): | ||
| """If caller explicitly sets stdin, the patch does not override it.""" | ||
| popen_kwargs = {} | ||
|
|
||
| def mock_popen(*args, **kwargs): | ||
| popen_kwargs.update(kwargs) | ||
| mock = MagicMock() | ||
| mock.returncode = 0 | ||
| mock.communicate.return_value = ( | ||
| b'{"Version":1,"AccessKeyId":"A","SecretAccessKey":"B"}', | ||
| b'', | ||
| ) | ||
| return mock | ||
|
|
||
| provider = ProcessProvider( | ||
| profile_name='test', | ||
| load_config=lambda: {'profiles': {'test': {'credential_process': 'echo hi'}}}, | ||
| popen=mock_popen, # type: ignore[arg-type] | ||
| ) | ||
|
|
||
| # Call _popen directly with an explicit stdin to verify setdefault behavior | ||
| provider._popen('echo', stdin=subprocess.PIPE) | ||
| assert popen_kwargs.get('stdin') == subprocess.PIPE | ||
|
|
||
| def test_credential_process_error_propagates(self): | ||
| """The patch does not swallow errors from credential_process.""" | ||
| from botocore.exceptions import CredentialRetrievalError | ||
|
|
||
| def mock_popen(*args, **kwargs): | ||
| mock = MagicMock() | ||
| mock.returncode = 1 | ||
| mock.communicate.return_value = (b'', b'access denied') | ||
| return mock | ||
|
|
||
| provider = ProcessProvider( | ||
| profile_name='test', | ||
| load_config=lambda: {'profiles': {'test': {'credential_process': 'fail'}}}, | ||
| popen=mock_popen, # type: ignore[arg-type] | ||
| ) | ||
|
|
||
| import pytest | ||
|
|
||
| with pytest.raises(CredentialRetrievalError): | ||
| provider.load() |
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.
Uh oh!
There was an error while loading. Please reload this page.