Skip to main content

Async client for testing ASGI web applications

Project description

async-asgi-testclient

Build Status PyPI version Codcov

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, Startlette, ...).

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.

Quickstart

Requirements: Python 3.6+

Installation:

pip install async-asgi-testclient

Usage

my_api.py:

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:

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

  • cookies
  • follow redirects
  • response streams
  • request streams
  • websocket support

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

async-asgi-testclient-1.2.2.tar.gz (10.7 kB view details)

Uploaded Source

File details

Details for the file async-asgi-testclient-1.2.2.tar.gz.

File metadata

  • Download URL: async-asgi-testclient-1.2.2.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.1

File hashes

Hashes for async-asgi-testclient-1.2.2.tar.gz
Algorithm Hash digest
SHA256 f9d53d481a4890ef96b73b3f76b17a5fa0634077842cba7ea9e83a5b4e45e8c5
MD5 7c6acb8599d842db0cfaa413a18ad598
BLAKE2b-256 066efb005268167a0140c5b3f14b49573ba1e75521e61032ab6f98744f91759c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page