2023-11-11 18:48:54 +03:00
|
|
|
import urllib.request
|
|
|
|
|
|
|
|
from openapi_tester.schema_tester import SchemaTester
|
|
|
|
from rest_framework.response import Response
|
|
|
|
from rest_framework.test import APITestCase
|
|
|
|
|
|
|
|
# Update api specs to the newest from a running django server (if any)
|
|
|
|
try:
|
|
|
|
urllib.request.urlretrieve(
|
2023-11-14 16:38:06 +03:00
|
|
|
"http://127.0.0.1:8000/api/schema", "docs/assets/schemas/api-latest.yaml"
|
2023-11-11 18:48:54 +03:00
|
|
|
)
|
|
|
|
except Exception as e:
|
2023-11-14 16:38:06 +03:00
|
|
|
print(f"Could not fetch latests API specs: {e}")
|
|
|
|
print("Using previously existing api-latest.yaml definitions from docs")
|
2023-11-11 18:48:54 +03:00
|
|
|
|
2023-11-14 16:38:06 +03:00
|
|
|
schema_tester = SchemaTester(schema_file_path="docs/assets/schemas/api-latest.yaml")
|
2023-11-11 18:48:54 +03:00
|
|
|
|
|
|
|
|
|
|
|
class BaseAPITestCase(APITestCase):
|
|
|
|
@staticmethod
|
|
|
|
def assertResponse(response: Response, **kwargs) -> None:
|
|
|
|
"""helper to run validate_response and pass kwargs to it"""
|
|
|
|
|
|
|
|
# List of endpoints with no available OpenAPI schema
|
|
|
|
skip_paths = ["/coordinator/login/"]
|
|
|
|
|
|
|
|
if response.request["PATH_INFO"] not in skip_paths:
|
|
|
|
schema_tester.validate_response(response=response, **kwargs)
|
2023-11-17 18:16:03 +03:00
|
|
|
|
|
|
|
def assertIsHash(self, s):
|
|
|
|
hex_chars = set("0123456789abcdefABCDEF")
|
|
|
|
self.assertTrue(
|
|
|
|
len(s) == 64 and all(c in hex_chars for c in s),
|
|
|
|
"The hash is not 64 hex characters",
|
|
|
|
)
|