Skip to content
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

feat: added subprocess test client #3655

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

aranvir
Copy link
Contributor

@aranvir aranvir commented Aug 3, 2024

Description

This introduces new helper functions to create sync and async test clients that can be used to test SSE endpoints with infinite generators as outlined in #3654 and https://github.com/orgs/litestar-org/discussions/3547.

The litestar cli is run in a subprocess to start a web app instance with a random port. The helper function then sets up a basic sync or async client.

The test code and doc example show how this can be used to test an SSE endpoint with an infinite generator.

Overview:

  • Adds subprocess_async_client and subprocess_sync_client
  • Tests both clients
  • Adds general documentation. Adds docs example for subprocess_async_client

Closes

Closes #3654

@aranvir aranvir requested review from a team as code owners August 3, 2024 12:19
@github-actions github-actions bot added area/docs This PR involves changes to the documentation area/private-api This PR involves changes to the privatized API area/testing size: small type/feat pr/external Triage Required 🏥 This requires triage labels Aug 3, 2024
@aranvir
Copy link
Contributor Author

aranvir commented Aug 3, 2024

Tests are failing because the redis fixture does not seem to work correctly. Tbh, added that as a best guess, so would need some help with fixing this. Alternatively, I just replace the test with a regular "does it connect and return the right thing" kind of test and ditch the SSE testing.

No idea why doc generation is failing.

@JacobCoffee
Copy link
Member

JacobCoffee commented Aug 12, 2024

Tests are failing because the redis fixture does not seem to work correctly. Tbh, added that as a best guess, so would need some help with fixing this. Alternatively, I just replace the test with a regular "does it connect and return the right thing" kind of test and ditch the SSE testing.

cc: @litestar-org/maintainers thought?

docs/usage/testing.rst Outdated Show resolved Hide resolved
docs/usage/testing.rst Outdated Show resolved Hide resolved
docs/usage/testing.rst Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs This PR involves changes to the documentation area/private-api This PR involves changes to the privatized API area/testing pr/external pr/internal size: small Triage Required 🏥 This requires triage type/feat
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhancement: Provide test client that can handle infinite SSE generators
3 participants