https://github.com/vinissimus/async-asgi-testclient
A framework-agnostic library for testing ASGI web applications
https://github.com/vinissimus/async-asgi-testclient
asgi guillotina quart starlette testing
Last synced: about 2 months ago
JSON representation
A framework-agnostic library for testing ASGI web applications
- Host: GitHub
- URL: https://github.com/vinissimus/async-asgi-testclient
- Owner: vinissimus
- License: mit
- Created: 2019-04-15T12:26:06.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-06-29T14:52:47.000Z (almost 2 years ago)
- Last Synced: 2025-03-28T18:13:01.343Z (about 2 months ago)
- Topics: asgi, guillotina, quart, starlette, testing
- Language: Python
- Homepage:
- Size: 77.1 KB
- Stars: 160
- Watchers: 5
- Forks: 20
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-python-testing - async-asgi-testclient - A framework-agnostic library for testing ASGI web applications. (Testing Frameworks)
README
# async-asgi-testclient
[](https://travis-ci.com/vinissimus/async-asgi-testclient) [](https://badge.fury.io/py/async-asgi-testclient)  [](https://codecov.io/gh/vinissimus/async-asgi-testclient/branch/master) 
Async ASGI TestClient is a library for testing web applications that implements ASGI specification (version 2 and 3).
The motivation behind this project is building a common testing library that doesn't depend on the web framework ([Quart](https://gitlab.com/pgjones/quart), [Startlette](https://github.com/encode/starlette), ...).
It works by calling the ASGI app directly. This avoids the need to run the app with a http server in a different process/thread/asyncio-loop. Since the app and test run in the same asyncio loop, it's easier to write tests and debug code.
This library is based on the testing module provided in [Quart](https://gitlab.com/pgjones/quart).
## Quickstart
Requirements: Python 3.6+
Installation:
```bash
pip install async-asgi-testclient
```
## Usage
`my_api.py`:
```python
from quart import Quart, jsonify
app = Quart(__name__)
@app.route("/")
async def root():
return "plain response"
@app.route("/json")
async def json():
return jsonify({"hello": "world"})
if __name__ == '__main__':
app.run()
```
`test_app.py`:
```python
from async_asgi_testclient import TestClient
import pytest
@pytest.mark.asyncio
async def test_quart_app():
from .my_api import app
async with TestClient(app) as client:
resp = await client.get("/")
assert resp.status_code == 200
assert resp.text == "plain response"
resp = await client.get("/json")
assert resp.status_code == 200
assert resp.json() == {"hello": "world"}
```
## Supports
- [X] cookies
- [X] multipart/form-data
- [X] follow redirects
- [X] response streams
- [X] request streams
- [X] websocket support