# Sanic Core Test
This package is meant to be the core testing utility and clients for testing Sanic applications. It is mainly derived from `sanic.testing` which has (or will be) removed from the main Sanic repository in the future.
[Documentation](https://sanicframework.org/en/plugins/sanic-testing/getting-started.html)
## Getting Started
pip install sanic-testing
The package is meant to create an almost seemless transition. Therefore, after loading the package, it will attach itself to your Sanic instance and insert test clients.
```python
from sanic import Sanic
from sanic_testing import TestManager
sanic_app = Sanic(__name__)
TestManager(sanic_app)
```
This will provide access to both the sync (`sanic.test_client`) and async (`sanic.asgi_client`) clients. Both of these clients are also available directly on the `TestManager` instance.
## Writing a sync test
Testing should be pretty much the same as when the test client was inside Sanic core. The difference is just that you need to run `TestManager`.
```python
import pytest
@pytest.fixture
def app():
sanic_app = Sanic(__name__)
TestManager(sanic_app)
@sanic_app.get("/")
def basic(request):
return response.text("foo")
return sanic_app
def test_basic_test_client(app):
request, response = app.test_client.get("/")
assert response.body == b"foo"
assert response.status == 200
```
## Writing an async test
Testing of an async method is best done with `pytest-asyncio` installed. Again, the following test should look familiar to anyone that has used `asgi_client` in the Sanic core package before.
The main benefit of using the `asgi_client` is that it is able to reach inside your application, and execute your handlers without ever having to stand up a server or make a network call.
```python
import pytest
@pytest.fixture
def app():
sanic_app = Sanic(__name__)
TestManager(sanic_app)
@sanic_app.get("/")
def basic(request):
return response.text("foo")
return sanic_app
@pytest.mark.asyncio
async def test_basic_asgi_client(app):
request, response = await app.asgi_client.get("/")
assert response.body == b"foo"
assert response.status == 200
```
Raw data
{
"_id": null,
"home_page": "https://github.com/sanic-org/sanic-testing/",
"name": "sanic-testing",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Adam Hopkins",
"author_email": "admhpkns@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b2/56/8d31d8a7e0b61633d6358694edfae976e69739b5bd640ceac7989b62e749/sanic_testing-24.6.0.tar.gz",
"platform": "any",
"description": "# Sanic Core Test\n\nThis package is meant to be the core testing utility and clients for testing Sanic applications. It is mainly derived from `sanic.testing` which has (or will be) removed from the main Sanic repository in the future.\n\n[Documentation](https://sanicframework.org/en/plugins/sanic-testing/getting-started.html)\n\n## Getting Started\n\n pip install sanic-testing\n\nThe package is meant to create an almost seemless transition. Therefore, after loading the package, it will attach itself to your Sanic instance and insert test clients.\n\n```python\nfrom sanic import Sanic\nfrom sanic_testing import TestManager\n\nsanic_app = Sanic(__name__)\nTestManager(sanic_app)\n```\n\nThis will provide access to both the sync (`sanic.test_client`) and async (`sanic.asgi_client`) clients. Both of these clients are also available directly on the `TestManager` instance.\n\n## Writing a sync test\n\nTesting should be pretty much the same as when the test client was inside Sanic core. The difference is just that you need to run `TestManager`.\n\n```python\nimport pytest\n\n@pytest.fixture\ndef app():\n sanic_app = Sanic(__name__)\n TestManager(sanic_app)\n\n @sanic_app.get(\"/\")\n def basic(request):\n return response.text(\"foo\")\n\n return sanic_app\n\ndef test_basic_test_client(app):\n request, response = app.test_client.get(\"/\")\n\n assert response.body == b\"foo\"\n assert response.status == 200\n```\n\n## Writing an async test\n\nTesting of an async method is best done with `pytest-asyncio` installed. Again, the following test should look familiar to anyone that has used `asgi_client` in the Sanic core package before.\n\nThe main benefit of using the `asgi_client` is that it is able to reach inside your application, and execute your handlers without ever having to stand up a server or make a network call.\n\n```python\nimport pytest\n\n@pytest.fixture\ndef app():\n sanic_app = Sanic(__name__)\n TestManager(sanic_app)\n\n @sanic_app.get(\"/\")\n def basic(request):\n return response.text(\"foo\")\n\n return sanic_app\n\n@pytest.mark.asyncio\nasync def test_basic_asgi_client(app):\n request, response = await app.asgi_client.get(\"/\")\n\n assert response.body == b\"foo\"\n assert response.status == 200\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Core testing clients for Sanic",
"version": "24.6.0",
"project_urls": {
"Homepage": "https://github.com/sanic-org/sanic-testing/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0c931d588f1cb9b710b9f22fa78b53d699a8062edc94204d50dd0d78c5f5b495",
"md5": "a01f59dcf79e371649f4ae40dc780be4",
"sha256": "b1027184735e88230891aa0461fff84093abfa3bff0f4d29c0f78f42e59efada"
},
"downloads": -1,
"filename": "sanic_testing-24.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a01f59dcf79e371649f4ae40dc780be4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10326,
"upload_time": "2024-06-30T12:13:30",
"upload_time_iso_8601": "2024-06-30T12:13:30.014683Z",
"url": "https://files.pythonhosted.org/packages/0c/93/1d588f1cb9b710b9f22fa78b53d699a8062edc94204d50dd0d78c5f5b495/sanic_testing-24.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b2568d31d8a7e0b61633d6358694edfae976e69739b5bd640ceac7989b62e749",
"md5": "7b5a1bb75abba42d5ba9c36a06a5d582",
"sha256": "7591ce537e2a651efb6dc01b458e7e4ea5347f6d91438676774c6f505a124731"
},
"downloads": -1,
"filename": "sanic_testing-24.6.0.tar.gz",
"has_sig": false,
"md5_digest": "7b5a1bb75abba42d5ba9c36a06a5d582",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10871,
"upload_time": "2024-06-30T12:13:31",
"upload_time_iso_8601": "2024-06-30T12:13:31.346973Z",
"url": "https://files.pythonhosted.org/packages/b2/56/8d31d8a7e0b61633d6358694edfae976e69739b5bd640ceac7989b62e749/sanic_testing-24.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-30 12:13:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sanic-org",
"github_project": "sanic-testing",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "sanic-testing"
}
JSON
