Add testing utilities to smithy-http #588
Conversation
alexgromero
changed the base branch from
develop
to
functional-testing-framework
arandito
left a comment
arandito
left a comment
There was a problem hiding this comment.
Thanks Alessandra! This looks great. Just left some minor comments about simplification and other nits.
| client_config: HTTPClientConfiguration | None = None, | ||
| ) -> None: | ||
| """ | ||
| :param client_config: Configuration that applies to all requests made with this |
There was a problem hiding this comment.
FYI, I think we'll be using Google style docstrings moving forward (see #564). I think for now that would cause the CI to fail so this is more of a heads up.
| def add_response( | ||
| self, | ||
| status: int = 200, | ||
| headers: list[tuple[str, str]] | None = None, |
There was a problem hiding this comment.
In line 49 we set fields to headers if it exists or to an empty list if it doesn't exist. Can we simplify this by defaulting headers to an empty list instead of making it an optional parameter with a default of None?
There was a problem hiding this comment.
Thanks for the suggestion! I would prefer to keep the current pattern to stay consistent with the existing ResponseTestHTTPClient implementation in the generated protocol tests (see example here). This also avoids the mutable default argument issue in Python.
packages/smithy-http/.changes/next-release/smithy-http-feature-20251024135122.json
Outdated
Show resolved
Hide resolved
| self._response_queue: deque[HTTPResponse] = deque() | ||
| self._captured_requests: list[HTTPRequest] = [] | ||
|
|
||
| def add_response( |
There was a problem hiding this comment.
Potential idea for a helper function: it's pretty common in tests that we add multiple responses and test subsequent calls. It may be nice to have a helper function that sets a default response.
There was a problem hiding this comment.
Chatted offline and will look into this, but we'll consider adding these convenience methods as we see need for this use case.
alexgromero
force-pushed
the
add-testing-utilities-to-smithy-http
branch
from
0557a66 to
8467d11
Compare
Co-authored-by: Nate Prewitt <[email protected]>
nateprewitt
left a comment
nateprewitt
left a comment
There was a problem hiding this comment.
Thanks @alexgromero!
alexgromero
changed the base branch from
functional-testing-framework
to
develop
alexgromero
dismissed
nateprewitt’s stale review
The base branch was changed.
4 participants
Issue #, if available:
Description of changes:
MockHTTPClientto test generated clients without hitting live endpoints.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.