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.
- OpenAPI 3 schemas created with drf-spectacular.
Installation
pip install drf-openapi-tester
Usage
First instantiate one or more instances of SchemaTester:
from openapi_tester import SchemaTester
schema_tester = SchemaTester()
If you are using either drf-yasg or drf-spectacular this will be auto-detected, and the schema will be loaded by the SchemaTester automatically. If you are using schema files though, you will need to pass the file path to the tester:
from openapi_tester import SchemaTester
# path should be a string
schema_tester = SchemaTester(schema_file_path="./schemas/publishedSpecs.yaml")
Once you instantiate a tester, you can use it to test responses:
from openapi_tester.schema_tester import SchemaTester
# you need to create at least one instance of SchemaTester.
# you can pass kwargs to it
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:
from openapi_tester.schema_tester import SchemaTester
from rest_framework.test import APITestCase
from rest_framework.response import Response
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:
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:
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
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 casings of both schemas and responses. If nothing is passed, case validation is skipped.
The library currently has 4 built-in case testers:
is_pascal_caseis_snake_caseis_camel_caseis_kebab_case
You can of course pass your own custom case tester.
ignore_case
List of keys to ignore when testing key casing. 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.:
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 cases where this cannot be inferred by the DRF EndpointEnumerator. A concrete use case for this option is when the django i18n locale prefixes.
from openapi_tester import SchemaTester
schema_tester = SchemaTester(field_key_map={
"language": "en",
})
Schema Validation
When the SchemaTester loads a schema, it runs it through OpenAPI Spec validator which validates that the schema passes without specification compliance issues. In case of issues with the schema itself, the validator will raise the appropriate error.
Known Issues
- We are using 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.
Contributing
Contributions are welcome. Please see the contributing guide
7 Sep 19, 2022
21.3k Dec 28, 2022
670 Dec 19, 2022
6 Jan 25, 2022
470 Dec 28, 2022
946 Dec 30, 2022
2 Jun 01, 2022
10 Oct 06, 2022
1 Jan 13, 2022
217 Dec 06, 2022
3.1k Jan 05, 2023
0 Oct 29, 2022
1.4k Jan 08, 2023
25 Jan 05, 2023
0 Jan 05, 2022
195 Jan 04, 2023
266 Jan 02, 2023
1 Dec 19, 2021
144 Jan 06, 2023
8 Jan 08, 2023