[](https://pypi.org/project/drf-openapi-tester/)
[](https://codecov.io/gh/snok/drf-openapi-tester)
[](https://pypi.org/project/drf-openapi-tester/)
[](https://pypi.org/project/drf-openapi-tester/)
# DRF OpenAPI Tester
This is a test utility to validate DRF Test Responses against OpenAPI 2 and 3 schema. It has built-in support for:
- OpenAPI 2/3 yaml or json schema files.
- OpenAPI 2 schemas created with [drf-yasg](https://github.com/axnsan12/drf-yasg).
- OpenAPI 3 schemas created with [drf-spectacular](https://github.com/tfranzel/drf-spectacular).
## Installation
```shell script
pip install drf-openapi-tester
```
## Usage
Instantiate one or more instances of `SchemaTester`:
```python
from openapi_tester import SchemaTester
schema_tester = SchemaTester()
```
If you are using either [drf-yasg](https://github.com/axnsan12/drf-yasg)
or [drf-spectacular](https://github.com/tfranzel/drf-spectacular) this will be auto-detected, and the schema will be
loaded by the `SchemaTester` automatically.
If you are using schema files, you will need to pass the file path:
```python
from openapi_tester import SchemaTester
# path should be a string
schema_tester = SchemaTester(schema_file_path="./schemas/publishedSpecs.yaml")
```
Once you've instantiated a tester, you can use it to test responses:
```python
from openapi_tester.schema_tester import SchemaTester
schema_tester = SchemaTester()
def test_response_documentation(client):
response = client.get('api/v1/test/1')
assert response.status_code == 200
schema_tester.validate_response(response=response)
```
If you are using the Django testing framework, you can create a base `APITestCase` that incorporates schema validation:
```python
from rest_framework.response import Response
from rest_framework.test import APITestCase
from openapi_tester.schema_tester import SchemaTester
schema_tester = SchemaTester()
class BaseAPITestCase(APITestCase):
""" Base test class for api views including schema validation """
@staticmethod
def assertResponse(response: Response, **kwargs) -> None:
""" helper to run validate_response and pass kwargs to it """
schema_tester.validate_response(response=response, **kwargs)
```
Then use it in a test file:
```python
from shared.testing import BaseAPITestCase
class MyAPITests(BaseAPITestCase):
def test_some_view(self):
response = self.client.get("...")
self.assertResponse(response)
```
## Options
You can pass options either globally, when instantiating a `SchemaTester`, or locally, when
invoking `validate_response`:
```python
from openapi_tester import SchemaTester, is_camel_case
from tests.utils import my_uuid_4_validator
schema_test_with_case_validation = SchemaTester(
case_tester=is_camel_case,
ignore_case=["IP"],
validators=[my_uuid_4_validator]
)
```
Or
```python
from openapi_tester import SchemaTester, is_camel_case
from tests.utils import my_uuid_4_validator
schema_tester = SchemaTester()
def my_test(client):
response = client.get('api/v1/test/1')
assert response.status_code == 200
schema_tester.validate_response(
response=response,
case_tester=is_camel_case,
ignore_case=["IP"],
validators=[my_uuid_4_validator]
)
```
### case_tester
The case tester argument takes a callable that is used to validate the key case of both schemas and responses. If
nothing is passed, case validation is skipped.
The library currently has 4 built-in case testers:
- `is_pascal_case`
- `is_snake_case`
- `is_camel_case`
- `is_kebab_case`
You can use one of these, or your own.
### ignore_case
List of keys to ignore when testing key case. This setting only applies when case_tester is not `None`.
### validators
List of custom validators. A validator is a function that receives two parameters: schema_section and data, and returns
either an error message or `None`, e.g.:
```python
from typing import Any, Optional
from uuid import UUID
def my_uuid_4_validator(schema_section: dict, data: Any) -> Optional[str]:
schema_format = schema_section.get("format")
if schema_format == "uuid4":
try:
result = UUID(data, version=4)
if not str(result) == str(data):
return f"Expected uuid4, but received {data}"
except ValueError:
return f"Expected uuid4, but received {data}"
return None
```
### field_key_map
You can pass an optional dictionary that maps custom url parameter names into values, for situations where this cannot be
inferred by the DRF `EndpointEnumerator`. A concrete use case for this option is when
the [django i18n locale prefixes](https://docs.djangoproject.com/en/3.1/topics/i18n/translation/#language-prefix-in-url-patterns).
```python
from openapi_tester import SchemaTester
schema_tester = SchemaTester(field_key_map={
"language": "en",
})
```
## Schema Validation
When the SchemaTester loads a schema, it parses it using an
[OpenAPI spec validator](https://github.com/p1c2u/openapi-spec-validator). This validates the schema.
In case of issues with the schema itself, the validator will raise the appropriate error.
## Django testing client
The library includes an `OpenAPIClient`, which extends Django REST framework's
[`APIClient` class](https://www.django-rest-framework.org/api-guide/testing/#apiclient).
If you wish to validate each response against OpenAPI schema when writing
unit tests - `OpenAPIClient` is what you need!
To use `OpenAPIClient` simply pass `SchemaTester` instance that should be used
to validate responses and then use it like regular Django testing client:
```python
schema_tester = SchemaTester()
client = OpenAPIClient(schema_tester=schema_tester)
response = client.get('/api/v1/tests/123/')
```
To force all developers working on the project to use `OpenAPIClient` simply
override the `client` fixture (when using `pytest` with `pytest-django`):
```python
from pytest_django.lazy_django import skip_if_no_django
from openapi_tester.schema_tester import SchemaTester
@pytest.fixture
def schema_tester():
return SchemaTester()
@pytest.fixture
def client(schema_tester):
skip_if_no_django()
from openapi_tester.clients import OpenAPIClient
return OpenAPIClient(schema_tester=schema_tester)
```
If you are using plain Django test framework, we suggest to create custom
test case implementation and use it instead of original Django one:
```python
import functools
from django.test.testcases import SimpleTestCase
from openapi_tester.clients import OpenAPIClient
from openapi_tester.schema_tester import SchemaTester
schema_tester = SchemaTester()
class MySimpleTestCase(SimpleTestCase):
client_class = OpenAPIClient
# or use `functools.partial` when you want to provide custom
# ``SchemaTester`` instance:
# client_class = functools.partial(OpenAPIClient, schema_tester=schema_tester)
```
This will ensure you all newly implemented views will be validated against
the OpenAPI schema.
## Known Issues
* We are using [prance](https://github.com/jfinkhaeuser/prance) as a schema resolver, and it has some issues with the
resolution of (very) complex OpenAPI 2.0 schemas. If you encounter
issues, [please document them here](https://github.com/snok/drf-openapi-tester/issues/205).
## Contributing
Contributions are welcome. Please see the [contributing guide](https://github.com/snok/.github/blob/main/CONTRIBUTING.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/snok/drf-openapi-tester",
"name": "drf-openapi-tester",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "openapi,swagger,api,testing,schema,django,drf",
"author": "Sondre Lilleb\u00f8 Gundersen",
"author_email": "sondrelg@live.no",
"download_url": "https://files.pythonhosted.org/packages/64/ff/bea26307ae48d924f0aaad84fb17d7c3557e0a53208f8c808eb547f1804f/drf_openapi_tester-2.3.3.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/drf-openapi-tester/)\n[](https://codecov.io/gh/snok/drf-openapi-tester)\n[](https://pypi.org/project/drf-openapi-tester/)\n[](https://pypi.org/project/drf-openapi-tester/)\n\n\n# DRF OpenAPI Tester\n\nThis is a test utility to validate DRF Test Responses against OpenAPI 2 and 3 schema. It has built-in support for:\n\n- OpenAPI 2/3 yaml or json schema files.\n- OpenAPI 2 schemas created with [drf-yasg](https://github.com/axnsan12/drf-yasg).\n- OpenAPI 3 schemas created with [drf-spectacular](https://github.com/tfranzel/drf-spectacular).\n\n## Installation\n\n```shell script\npip install drf-openapi-tester\n```\n\n## Usage\n\nInstantiate one or more instances of `SchemaTester`:\n\n```python\nfrom openapi_tester import SchemaTester\n\nschema_tester = SchemaTester()\n```\n\nIf you are using either [drf-yasg](https://github.com/axnsan12/drf-yasg)\nor [drf-spectacular](https://github.com/tfranzel/drf-spectacular) this will be auto-detected, and the schema will be\nloaded by the `SchemaTester` automatically.\n\nIf you are using schema files, you will need to pass the file path:\n\n```python\nfrom openapi_tester import SchemaTester\n\n# path should be a string\nschema_tester = SchemaTester(schema_file_path=\"./schemas/publishedSpecs.yaml\")\n```\n\nOnce you've instantiated a tester, you can use it to test responses:\n\n```python\nfrom openapi_tester.schema_tester import SchemaTester\n\nschema_tester = SchemaTester()\n\n\ndef test_response_documentation(client):\n response = client.get('api/v1/test/1')\n assert response.status_code == 200\n schema_tester.validate_response(response=response)\n```\n\nIf you are using the Django testing framework, you can create a base `APITestCase` that incorporates schema validation:\n\n```python\nfrom rest_framework.response import Response\nfrom rest_framework.test import APITestCase\n\nfrom openapi_tester.schema_tester import SchemaTester\n\nschema_tester = SchemaTester()\n\n\nclass BaseAPITestCase(APITestCase):\n \"\"\" Base test class for api views including schema validation \"\"\"\n\n @staticmethod\n def assertResponse(response: Response, **kwargs) -> None:\n \"\"\" helper to run validate_response and pass kwargs to it \"\"\"\n schema_tester.validate_response(response=response, **kwargs)\n```\n\nThen use it in a test file:\n\n```python\nfrom shared.testing import BaseAPITestCase\n\n\nclass MyAPITests(BaseAPITestCase):\n def test_some_view(self):\n response = self.client.get(\"...\")\n self.assertResponse(response)\n```\n\n## Options\n\nYou can pass options either globally, when instantiating a `SchemaTester`, or locally, when\ninvoking `validate_response`:\n\n```python\nfrom openapi_tester import SchemaTester, is_camel_case\nfrom tests.utils import my_uuid_4_validator\n\nschema_test_with_case_validation = SchemaTester(\n case_tester=is_camel_case,\n ignore_case=[\"IP\"],\n validators=[my_uuid_4_validator]\n)\n\n```\n\nOr\n\n```python\nfrom openapi_tester import SchemaTester, is_camel_case\nfrom tests.utils import my_uuid_4_validator\n\nschema_tester = SchemaTester()\n\n\ndef my_test(client):\n response = client.get('api/v1/test/1')\n assert response.status_code == 200\n schema_tester.validate_response(\n response=response,\n case_tester=is_camel_case,\n ignore_case=[\"IP\"],\n validators=[my_uuid_4_validator]\n )\n```\n\n### case_tester\n\nThe case tester argument takes a callable that is used to validate the key case of both schemas and responses. If\nnothing is passed, case validation is skipped.\n\nThe library currently has 4 built-in case testers:\n\n- `is_pascal_case`\n- `is_snake_case`\n- `is_camel_case`\n- `is_kebab_case`\n\nYou can use one of these, or your own.\n\n### ignore_case\n\nList of keys to ignore when testing key case. This setting only applies when case_tester is not `None`.\n\n### validators\n\nList of custom validators. A validator is a function that receives two parameters: schema_section and data, and returns\neither an error message or `None`, e.g.:\n\n```python\nfrom typing import Any, Optional\nfrom uuid import UUID\n\n\ndef my_uuid_4_validator(schema_section: dict, data: Any) -> Optional[str]:\n schema_format = schema_section.get(\"format\")\n if schema_format == \"uuid4\":\n try:\n result = UUID(data, version=4)\n if not str(result) == str(data):\n return f\"Expected uuid4, but received {data}\"\n except ValueError:\n return f\"Expected uuid4, but received {data}\"\n return None\n```\n\n### field_key_map\n\nYou can pass an optional dictionary that maps custom url parameter names into values, for situations where this cannot be\ninferred by the DRF `EndpointEnumerator`. A concrete use case for this option is when\nthe [django i18n locale prefixes](https://docs.djangoproject.com/en/3.1/topics/i18n/translation/#language-prefix-in-url-patterns).\n\n```python\nfrom openapi_tester import SchemaTester\n\nschema_tester = SchemaTester(field_key_map={\n \"language\": \"en\",\n})\n```\n\n## Schema Validation\n\nWhen the SchemaTester loads a schema, it parses it using an\n[OpenAPI spec validator](https://github.com/p1c2u/openapi-spec-validator). This validates the schema.\nIn case of issues with the schema itself, the validator will raise the appropriate error.\n\n## Django testing client\n\nThe library includes an `OpenAPIClient`, which extends Django REST framework's\n[`APIClient` class](https://www.django-rest-framework.org/api-guide/testing/#apiclient).\nIf you wish to validate each response against OpenAPI schema when writing\nunit tests - `OpenAPIClient` is what you need!\n\nTo use `OpenAPIClient` simply pass `SchemaTester` instance that should be used\nto validate responses and then use it like regular Django testing client:\n\n```python\nschema_tester = SchemaTester()\nclient = OpenAPIClient(schema_tester=schema_tester)\nresponse = client.get('/api/v1/tests/123/')\n```\n\nTo force all developers working on the project to use `OpenAPIClient` simply\noverride the `client` fixture (when using `pytest` with `pytest-django`):\n\n```python\nfrom pytest_django.lazy_django import skip_if_no_django\n\nfrom openapi_tester.schema_tester import SchemaTester\n\n\n@pytest.fixture\ndef schema_tester():\n return SchemaTester()\n\n\n@pytest.fixture\ndef client(schema_tester):\n skip_if_no_django()\n\n from openapi_tester.clients import OpenAPIClient\n\n return OpenAPIClient(schema_tester=schema_tester)\n```\n\nIf you are using plain Django test framework, we suggest to create custom\ntest case implementation and use it instead of original Django one:\n\n```python\nimport functools\n\nfrom django.test.testcases import SimpleTestCase\nfrom openapi_tester.clients import OpenAPIClient\nfrom openapi_tester.schema_tester import SchemaTester\n\nschema_tester = SchemaTester()\n\n\nclass MySimpleTestCase(SimpleTestCase):\n client_class = OpenAPIClient\n # or use `functools.partial` when you want to provide custom\n # ``SchemaTester`` instance:\n # client_class = functools.partial(OpenAPIClient, schema_tester=schema_tester)\n```\n\nThis will ensure you all newly implemented views will be validated against\nthe OpenAPI schema.\n\n## Known Issues\n\n* We are using [prance](https://github.com/jfinkhaeuser/prance) as a schema resolver, and it has some issues with the\n resolution of (very) complex OpenAPI 2.0 schemas. If you encounter\n issues, [please document them here](https://github.com/snok/drf-openapi-tester/issues/205).\n\n## Contributing\n\nContributions are welcome. Please see the [contributing guide](https://github.com/snok/.github/blob/main/CONTRIBUTING.md)\n",
"bugtrack_url": null,
"license": "BSD-4-Clause",
"summary": "Test utility for validating OpenAPI response documentation",
"version": "2.3.3",
"project_urls": {
"Documentation": "https://github.com/snok/drf-openapi-tester",
"Homepage": "https://github.com/snok/drf-openapi-tester",
"Repository": "https://github.com/snok/drf-openapi-tester"
},
"split_keywords": [
"openapi",
"swagger",
"api",
"testing",
"schema",
"django",
"drf"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0fa76cadf3a5ba5ed6c8f824f61c3f22ce5599b6f191573d75eeea495d7c4a31",
"md5": "c6472deda87f5546a90057449598523b",
"sha256": "a65dafd0d81afd14faf844fad2349d4586a83e8d92d6162bf134a98391206957"
},
"downloads": -1,
"filename": "drf_openapi_tester-2.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c6472deda87f5546a90057449598523b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 19966,
"upload_time": "2023-07-04T09:15:18",
"upload_time_iso_8601": "2023-07-04T09:15:18.073367Z",
"url": "https://files.pythonhosted.org/packages/0f/a7/6cadf3a5ba5ed6c8f824f61c3f22ce5599b6f191573d75eeea495d7c4a31/drf_openapi_tester-2.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "64ffbea26307ae48d924f0aaad84fb17d7c3557e0a53208f8c808eb547f1804f",
"md5": "ce62ec2d6f670f595909bc276cca9094",
"sha256": "669d794d23b6e85318d04f2405aa36a5d2ee295f0472a1a5afff7757f40ab6f1"
},
"downloads": -1,
"filename": "drf_openapi_tester-2.3.3.tar.gz",
"has_sig": false,
"md5_digest": "ce62ec2d6f670f595909bc276cca9094",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 19173,
"upload_time": "2023-07-04T09:15:19",
"upload_time_iso_8601": "2023-07-04T09:15:19.413130Z",
"url": "https://files.pythonhosted.org/packages/64/ff/bea26307ae48d924f0aaad84fb17d7c3557e0a53208f8c808eb547f1804f/drf_openapi_tester-2.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-04 09:15:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "snok",
"github_project": "drf-openapi-tester",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "drf-openapi-tester"
}
JSON
