-
Notifications
You must be signed in to change notification settings - Fork 887
test(python-sdk): add regression tests for template upload Content-Length #1292
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
Closed
+138
−0
Closed
Changes from all commits
Commits
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
71 changes: 71 additions & 0 deletions
71
packages/python-sdk/tests/async/template_async/test_upload_file.py
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,71 @@ | ||
| import threading | ||
| from http.server import BaseHTTPRequestHandler, HTTPServer | ||
|
|
||
| from e2b.api.client.client import AuthenticatedClient | ||
| from e2b.template_async.build_api import upload_file | ||
|
|
||
|
|
||
| # Regression test for e2b-dev/e2b#1243 — upload_file must set Content-Length | ||
| # and must not fall back to Transfer-Encoding: chunked. S3 presigned PUT URLs | ||
| # reject chunked encoding with 501 NotImplemented. httpx sets Content-Length | ||
| # automatically when we pass bytes (tar_buffer.getvalue()); this test guards | ||
| # against someone swapping the bytes for a generator/stream later. | ||
| # | ||
| # The mock server runs in a daemon thread and doesn't need to be async — the | ||
| # httpx.AsyncClient connects to it via asyncio sockets without blocking the | ||
| # event loop. | ||
|
|
||
|
|
||
| def _make_server(): | ||
| state = {"headers": None, "body_length": 0} | ||
|
|
||
| class Handler(BaseHTTPRequestHandler): | ||
| def do_PUT(self): | ||
| state["headers"] = dict(self.headers) | ||
| length = int(self.headers.get("Content-Length", 0)) | ||
| body = self.rfile.read(length) if length else b"" | ||
| state["body_length"] = len(body) | ||
| self.send_response(200) | ||
| self.end_headers() | ||
|
|
||
| def log_message(self, *args, **kwargs): | ||
| return | ||
|
|
||
| server = HTTPServer(("127.0.0.1", 0), Handler) | ||
| thread = threading.Thread(target=server.serve_forever, daemon=True) | ||
| thread.start() | ||
| return server, thread, state | ||
|
|
||
|
|
||
| async def test_upload_file_sets_content_length_and_no_chunked_encoding(tmp_path): | ||
| (tmp_path / "hello.txt").write_text("hello world") | ||
|
|
||
| server, thread, state = _make_server() | ||
| host, port = server.server_address | ||
| url = f"http://{host}:{port}/upload" | ||
|
|
||
| try: | ||
| client = AuthenticatedClient(base_url="http://test", token="test") | ||
| await upload_file( | ||
| api_client=client, | ||
| file_name="*.txt", | ||
| context_path=str(tmp_path), | ||
| url=url, | ||
| ignore_patterns=[], | ||
| resolve_symlinks=False, | ||
| stack_trace=None, | ||
| ) | ||
| finally: | ||
| server.shutdown() | ||
| server.server_close() | ||
| thread.join(timeout=5) | ||
|
|
||
| assert state["headers"] is not None | ||
| content_length = state["headers"].get("Content-Length") | ||
| assert content_length is not None | ||
| assert int(content_length) > 0 | ||
| assert int(content_length) == state["body_length"] | ||
|
|
||
| transfer_encoding = state["headers"].get("Transfer-Encoding") | ||
| if transfer_encoding is not None: | ||
| assert "chunked" not in transfer_encoding.lower() |
67 changes: 67 additions & 0 deletions
67
packages/python-sdk/tests/sync/template_sync/test_upload_file.py
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,67 @@ | ||
| import threading | ||
| from http.server import BaseHTTPRequestHandler, HTTPServer | ||
|
|
||
| from e2b.api.client.client import AuthenticatedClient | ||
| from e2b.template_sync.build_api import upload_file | ||
|
|
||
|
|
||
| # Regression test for e2b-dev/e2b#1243 — upload_file must set Content-Length | ||
| # and must not fall back to Transfer-Encoding: chunked. S3 presigned PUT URLs | ||
| # reject chunked encoding with 501 NotImplemented. httpx sets Content-Length | ||
| # automatically when we pass bytes (tar_buffer.getvalue()); this test guards | ||
| # against someone swapping the bytes for a generator/stream later. | ||
|
|
||
|
|
||
| def _make_server(): | ||
| state = {"headers": None, "body_length": 0} | ||
|
|
||
| class Handler(BaseHTTPRequestHandler): | ||
| def do_PUT(self): | ||
| state["headers"] = dict(self.headers) | ||
| length = int(self.headers.get("Content-Length", 0)) | ||
| body = self.rfile.read(length) if length else b"" | ||
| state["body_length"] = len(body) | ||
| self.send_response(200) | ||
| self.end_headers() | ||
|
|
||
| def log_message(self, *args, **kwargs): | ||
| return | ||
|
|
||
| server = HTTPServer(("127.0.0.1", 0), Handler) | ||
| thread = threading.Thread(target=server.serve_forever, daemon=True) | ||
| thread.start() | ||
| return server, thread, state | ||
|
|
||
|
|
||
| def test_upload_file_sets_content_length_and_no_chunked_encoding(tmp_path): | ||
| (tmp_path / "hello.txt").write_text("hello world") | ||
|
|
||
| server, thread, state = _make_server() | ||
| host, port = server.server_address | ||
| url = f"http://{host}:{port}/upload" | ||
|
|
||
| try: | ||
| client = AuthenticatedClient(base_url="http://test", token="test") | ||
| upload_file( | ||
| api_client=client, | ||
| file_name="*.txt", | ||
| context_path=str(tmp_path), | ||
| url=url, | ||
| ignore_patterns=[], | ||
| resolve_symlinks=False, | ||
| stack_trace=None, | ||
| ) | ||
| finally: | ||
| server.shutdown() | ||
| server.server_close() | ||
| thread.join(timeout=5) | ||
|
|
||
| assert state["headers"] is not None | ||
| content_length = state["headers"].get("Content-Length") | ||
| assert content_length is not None | ||
| assert int(content_length) > 0 | ||
| assert int(content_length) == state["body_length"] | ||
|
|
||
| transfer_encoding = state["headers"].get("Transfer-Encoding") | ||
| if transfer_encoding is not None: | ||
| assert "chunked" not in transfer_encoding.lower() | ||
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.
Converting
self.headersto a plaindicthere drops the case-insensitive behavior ofHTTPMessage, so later checks like.get("Content-Length")/.get("Transfer-Encoding")can fail if the client sends lowercase header names (which is valid HTTP). In that case this regression test would report a false failure even thoughContent-Lengthis present and correct, making CI flaky across client/library versions.Useful? React with 👍 / 👎.