2018-08-28 13:58:03 +00:00
The test client allows you to make requests against your ASGI application,
2022-09-06 05:43:32 +00:00
using the `httpx` library.
2018-08-28 13:58:03 +00:00
```python
2018-09-05 09:29:04 +00:00
from starlette.responses import HTMLResponse
2018-08-28 14:18:17 +00:00
from starlette.testclient import TestClient
2018-08-28 13:58:03 +00:00
2019-06-14 10:53:17 +00:00
async def app(scope, receive, send):
assert scope['type'] == 'http'
response = HTMLResponse('< html > < body > Hello, world!< / body > < / html > ')
await response(scope, receive, send)
2018-08-28 13:58:03 +00:00
def test_app():
2019-06-14 10:53:17 +00:00
client = TestClient(app)
2018-08-28 13:58:03 +00:00
response = client.get('/')
assert response.status_code == 200
```
2022-09-06 05:43:32 +00:00
The test client exposes the same interface as any other `httpx` session.
2018-08-28 13:58:03 +00:00
In particular, note that the calls to make a request are just standard
function calls, not awaitables.
2022-09-06 05:43:32 +00:00
You can use any of `httpx` standard API, such as authentication, session
2018-09-04 10:52:29 +00:00
cookies handling, or file uploads.
2018-08-28 13:58:03 +00:00
2022-06-15 13:47:55 +00:00
For example, to set headers on the TestClient you can do:
```python
client = TestClient(app)
# Set headers on the client for future requests
client.headers = {"Authorization": "..."}
response = client.get("/")
# Set headers for each request separately
response = client.get("/", headers={"Authorization": "..."})
```
And for example to send files with the TestClient:
```python
client = TestClient(app)
# Send a single file
with open("example.txt", "rb") as f:
response = client.post("/form", files={"file": f})
# Send multiple files
with open("example.txt", "rb") as f1:
with open("example.png", "rb") as f2:
files = {"file1": f1, "file2": ("filename", f2, "image/png")}
response = client.post("/form", files=files)
```
2022-11-05 16:17:32 +00:00
For more information you can check the `httpx` [documentation ](https://www.python-httpx.org/advanced/ ).
2022-06-15 13:47:55 +00:00
2018-09-04 10:52:29 +00:00
By default the `TestClient` will raise any exceptions that occur in the
application. Occasionally you might want to test the content of 500 error
responses, rather than allowing client to raise the server exception. In this
case you should use `client = TestClient(app, raise_server_exceptions=False)` .
2022-07-10 12:23:40 +00:00
!!! note
2023-03-09 22:30:28 +00:00
If you want the `TestClient` to run the `lifespan` handler,
you will need to use the `TestClient` as a context manager. It will
not be triggered when the `TestClient` is instantiated. You can learn more about it
[here ](/lifespan/#running-lifespan-in-tests ).
2022-07-10 12:23:40 +00:00
2021-06-18 14:48:43 +00:00
### Selecting the Async backend
2021-06-28 20:36:13 +00:00
`TestClient` takes arguments `backend` (a string) and `backend_options` (a dictionary).
These options are passed to `anyio.start_blocking_portal()` . See the [anyio documentation ](https://anyio.readthedocs.io/en/stable/basics.html#backend-options )
for more information about the accepted backend options.
By default, `asyncio` is used with default options.
2021-06-18 14:48:43 +00:00
2021-06-28 20:36:13 +00:00
To run `Trio` , pass `backend="trio"` . For example:
2021-06-18 14:48:43 +00:00
```python
def test_app()
2021-06-28 20:36:13 +00:00
with TestClient(app, backend="trio") as client:
...
```
To run `asyncio` with `uvloop` , pass `backend_options={"use_uvloop": True}` . For example:
```python
def test_app()
with TestClient(app, backend_options={"use_uvloop": True}) as client:
...
2021-06-18 14:48:43 +00:00
```
2018-09-04 10:52:29 +00:00
### Testing WebSocket sessions
You can also test websocket sessions with the test client.
2018-08-28 13:58:03 +00:00
2022-09-06 05:43:32 +00:00
The `httpx` library will be used to build the initial handshake, meaning you
2018-08-28 13:58:03 +00:00
can use the same authentication options and other headers between both http and
websocket testing.
```python
from starlette.testclient import TestClient
2018-09-05 09:29:04 +00:00
from starlette.websockets import WebSocket
2018-08-28 13:58:03 +00:00
2019-06-14 10:53:17 +00:00
async def app(scope, receive, send):
assert scope['type'] == 'websocket'
websocket = WebSocket(scope, receive=receive, send=send)
await websocket.accept()
await websocket.send_text('Hello, world!')
await websocket.close()
2018-08-28 13:58:03 +00:00
def test_app():
2019-06-14 10:53:17 +00:00
client = TestClient(app)
2018-09-05 09:29:04 +00:00
with client.websocket_connect('/') as websocket:
data = websocket.receive_text()
2018-08-28 13:58:03 +00:00
assert data == 'Hello, world!'
```
The operations on session are standard function calls, not awaitables.
It's important to use the session within a context-managed `with` block. This
ensure that the background thread on which the ASGI application is properly
terminated, and that any exceptions that occur within the application are
always raised by the test client.
#### Establishing a test session
2022-09-06 05:43:32 +00:00
* `.websocket_connect(url, subprotocols=None, **options)` - Takes the same set of arguments as `httpx.get()` .
2018-08-28 13:58:03 +00:00
2020-07-15 17:29:20 +00:00
May raise `starlette.websockets.WebSocketDisconnect` if the application does not accept the websocket connection.
2018-08-28 13:58:03 +00:00
2021-06-18 14:48:43 +00:00
`websocket_connect()` must be used as a context manager (in a `with` block).
2022-05-09 18:44:42 +00:00
!!! note
The `params` argument is not supported by `websocket_connect` . If you need to pass query arguments, hard code it
directly in the URL.
```python
with client.websocket_connect('/path?foo=bar') as websocket:
...
```
2018-08-28 14:18:17 +00:00
#### Sending data
* `.send_text(data)` - Send the given text to the application.
* `.send_bytes(data)` - Send the given bytes to the application.
2019-01-25 15:27:39 +00:00
* `.send_json(data, mode="text")` - Send the given data to the application. Use `mode="binary"` to send JSON over binary data frames.
2018-08-28 14:18:17 +00:00
2018-08-28 13:58:03 +00:00
#### Receiving data
* `.receive_text()` - Wait for incoming text sent by the application and return it.
* `.receive_bytes()` - Wait for incoming bytestring sent by the application and return it.
2022-01-26 10:34:25 +00:00
* `.receive_json(mode="text")` - Wait for incoming json data sent by the application and return it. Use `mode="binary"` to receive JSON over binary data frames.
2018-08-28 13:58:03 +00:00
2020-07-15 17:29:20 +00:00
May raise `starlette.websockets.WebSocketDisconnect` .
2018-08-28 13:58:03 +00:00
#### Closing the connection
* `.close(code=1000)` - Perform a client-side close of the websocket connection.
2022-07-06 16:43:04 +00:00
### Asynchronous tests
Sometimes you will want to do async things outside of your application.
For example, you might want to check the state of your database after calling your app using your existing async database client / infrastructure.
For these situations, using `TestClient` is difficult because it creates it's own event loop and async resources (like a database connection) often cannot be shared across event loops.
The simplest way to work around this is to just make your entire test async and use an async client, like [httpx.AsyncClient].
Here is an example of such a test:
```python
from httpx import AsyncClient
from starlette.applications import Starlette
from starlette.routing import Route
from starlette.requests import Request
from starlette.responses import PlainTextResponse
def hello(request: Request) -> PlainTextResponse:
return PlainTextResponse("Hello World!")
app = Starlette(routes=[Route("/", hello)])
# if you're using pytest, you'll need to to add an async marker like:
# @pytest.mark.anyio # using https://github.com/agronholm/anyio
# or install and configure pytest-asyncio (https://github.com/pytest-dev/pytest-asyncio)
async def test_app() -> None:
# note: you _must_ set `base_url` for relative urls like "/" to work
async with AsyncClient(app=app, base_url="http://testserver") as client:
r = await client.get("/")
assert r.status_code == 200
assert r.text == "Hello World!"
```
[httpx.AsyncClient]: https://www.python-httpx.org/advanced/#calling-into-python-web-apps
