Skip to content

test: add tests in test_requests#2677

Merged
Kludex merged 9 commits intoKludex:masterfrom
Orenoid:test/requests
Sep 23, 2024
Merged

test: add tests in test_requests#2677
Kludex merged 9 commits intoKludex:masterfrom
Orenoid:test/requests

Conversation

@Orenoid
Copy link
Contributor

@Orenoid Orenoid commented Aug 31, 2024

Summary

Add tests for some of the uncovered branches in starlette.requests, related to this issue

Checklist

  • I understand that this PR may be closed in case there was no previous discussion. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly. (It seems no documentation needs update)

Comment on lines -428 to +456
# (" = b ; ; = ; c = ; ", {"": "b", "c": ""}),
(" = b ; ; = ; c = ; ", {"": "b", "c": ""}),
Copy link
Contributor Author

@Orenoid Orenoid Aug 31, 2024

Choose a reason for hiding this comment

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

Testing this, when the key and value both are empty, this pair should be ignored.

I don't know why this parameter was commented out before. However, to meet the condition where both the key and value are empty, this parameter with an empty chunk ("; ;") is what we need.

Copy link
Owner

Choose a reason for hiding this comment

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

This may have been on purpose? When was introduced?

Copy link
Contributor Author

@Orenoid Orenoid Sep 2, 2024

Choose a reason for hiding this comment

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

The test and cookie_parser were introduced in this PR.
It looks like these tests were inspired by tornado test suite ( relevant commit ).
And I didn't see any discussion related to this specific parameter. It was just commented out at the beginning.

My thought is that enabling the parameter shouldn't be a problem. cookie_parser does support this case.

Copy link
Contributor Author

@Orenoid Orenoid Sep 2, 2024

Choose a reason for hiding this comment

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

Just did more searching in Tornado's code and found this. They did have tested the case.

@Orenoid Orenoid changed the title test: add tests in test_requests test: add tests in test_requests Aug 31, 2024
Comment on lines +31 to +56
def test_request_lazy_load_property(test_client_factory: TestClientFactory) -> None:
async def app(scope: Scope, receive: Receive, send: Send) -> None:
request = Request(scope, receive)
assert not hasattr(request, "_url")
assert not hasattr(request, "_query_params")
assert not hasattr(request, "_json")
# trigger lazy loading
_, _, _ = request.url, request.query_params, await request.json()
assert hasattr(request, "_url")
assert hasattr(request, "_query_params")
assert hasattr(request, "_json")
data = {
"url": str(request.url),
"query_params": dict(request.query_params),
"json": await request.json(),
}
response = JSONResponse(data)
await response(scope, receive, send)

client = test_client_factory(app)
response = client.post("/42?foo=bar", json={"baz": "qux"})
assert response.json() == {
"url": "http://testserver/42?foo=bar",
"query_params": {"foo": "bar"},
"json": {"baz": "qux"},
}
Copy link
Owner

Choose a reason for hiding this comment

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

Which lines are this trying to cover?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Or should we add pragma: no branch to these lines too?

Copy link
Owner

Choose a reason for hiding this comment

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

The thing is that this test is doing too much, maybe we can divide it a bit? Or maybe just the no branch... I don't want us to try to satisfy the coverage just because we want to satisfy it, but actually create meaningful tests (naming wise as well).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Or maybe just the no branch

No problem, let's go with this.

@Kludex Kludex enabled auto-merge (squash) September 23, 2024 18:36
@Kludex
Copy link
Owner

Kludex commented Sep 23, 2024

Thanks @Orenoid ! 🙏

@Kludex Kludex merged commit 4fbf766 into Kludex:master Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants