2021-02-20 23:20:20 +01:00
|
|
|
import json
|
2022-05-27 13:28:26 +02:00
|
|
|
from random import randint
|
2022-03-13 08:36:49 +01:00
|
|
|
from typing import Any, Dict, Optional, Tuple
|
2021-02-20 23:20:20 +01:00
|
|
|
|
|
|
|
from flask import Flask
|
|
|
|
from flask.testing import FlaskClient
|
2022-03-13 08:36:49 +01:00
|
|
|
from werkzeug.test import TestResponse
|
|
|
|
|
2022-05-27 14:08:07 +02:00
|
|
|
from .custom_asserts import (
|
|
|
|
assert_errored_response,
|
|
|
|
assert_oauth_errored_response,
|
|
|
|
)
|
2022-03-19 20:34:36 +01:00
|
|
|
from .utils import random_email, random_string
|
2021-02-20 23:20:20 +01:00
|
|
|
|
|
|
|
|
2022-03-19 20:34:36 +01:00
|
|
|
class RandomMixin:
|
|
|
|
@staticmethod
|
|
|
|
def random_string(
|
|
|
|
length: Optional[int] = None,
|
|
|
|
prefix: Optional[str] = None,
|
|
|
|
suffix: Optional[str] = None,
|
|
|
|
) -> str:
|
|
|
|
return random_string(length, prefix, suffix)
|
|
|
|
|
2022-05-27 13:28:26 +02:00
|
|
|
@staticmethod
|
|
|
|
def random_domain() -> str:
|
|
|
|
return random_string(prefix='https://', suffix='com')
|
|
|
|
|
2022-03-19 20:34:36 +01:00
|
|
|
@staticmethod
|
|
|
|
def random_email() -> str:
|
|
|
|
return random_email()
|
|
|
|
|
2022-05-27 13:28:26 +02:00
|
|
|
@staticmethod
|
|
|
|
def random_int(min_val: int = 0, max_val: int = 999999) -> int:
|
|
|
|
return randint(min_val, max_val)
|
|
|
|
|
2022-03-19 20:34:36 +01:00
|
|
|
|
|
|
|
class ApiTestCaseMixin(RandomMixin):
|
2021-02-20 23:20:20 +01:00
|
|
|
@staticmethod
|
|
|
|
def get_test_client_and_auth_token(
|
2022-03-12 17:56:06 +01:00
|
|
|
app: Flask, user_email: str
|
2021-02-20 23:20:20 +01:00
|
|
|
) -> Tuple[FlaskClient, str]:
|
|
|
|
client = app.test_client()
|
|
|
|
resp_login = client.post(
|
|
|
|
'/api/auth/login',
|
|
|
|
data=json.dumps(
|
|
|
|
dict(
|
2022-03-12 17:56:06 +01:00
|
|
|
email=user_email,
|
2022-03-19 20:34:36 +01:00
|
|
|
password='12345678',
|
2021-02-20 23:20:20 +01:00
|
|
|
)
|
|
|
|
),
|
|
|
|
content_type='application/json',
|
|
|
|
)
|
|
|
|
auth_token = json.loads(resp_login.data.decode())['auth_token']
|
|
|
|
return client, auth_token
|
2021-07-14 20:20:48 +02:00
|
|
|
|
2022-03-13 08:36:49 +01:00
|
|
|
@staticmethod
|
|
|
|
def assert_400(
|
|
|
|
response: TestResponse,
|
|
|
|
error_message: Optional[str] = 'invalid payload',
|
|
|
|
status: Optional[str] = 'error',
|
|
|
|
) -> Dict:
|
|
|
|
return assert_errored_response(
|
|
|
|
response, 400, error_message=error_message, status=status
|
|
|
|
)
|
|
|
|
|
|
|
|
@staticmethod
|
2022-03-19 22:02:06 +01:00
|
|
|
def assert_401(
|
|
|
|
response: TestResponse,
|
|
|
|
error_message: Optional[str] = 'provide a valid auth token',
|
|
|
|
) -> Dict:
|
2022-03-13 08:36:49 +01:00
|
|
|
return assert_errored_response(
|
|
|
|
response, 401, error_message=error_message
|
|
|
|
)
|
|
|
|
|
|
|
|
@staticmethod
|
|
|
|
def assert_403(
|
|
|
|
response: TestResponse,
|
|
|
|
error_message: Optional[str] = 'you do not have permissions',
|
|
|
|
) -> Dict:
|
|
|
|
return assert_errored_response(response, 403, error_message)
|
|
|
|
|
|
|
|
@staticmethod
|
|
|
|
def assert_404(response: TestResponse) -> Dict:
|
|
|
|
return assert_errored_response(response, 404, status='not found')
|
|
|
|
|
|
|
|
@staticmethod
|
|
|
|
def assert_404_with_entity(response: TestResponse, entity: str) -> Dict:
|
|
|
|
error_message = f'{entity} does not exist'
|
|
|
|
return assert_errored_response(
|
|
|
|
response, 404, error_message=error_message, status='not found'
|
|
|
|
)
|
|
|
|
|
|
|
|
@staticmethod
|
|
|
|
def assert_404_with_message(
|
|
|
|
response: TestResponse, error_message: str
|
|
|
|
) -> Dict:
|
|
|
|
return assert_errored_response(
|
|
|
|
response, 404, error_message=error_message, status='not found'
|
|
|
|
)
|
|
|
|
|
|
|
|
@staticmethod
|
|
|
|
def assert_413(
|
|
|
|
response: TestResponse,
|
|
|
|
error_message: Optional[str] = None,
|
|
|
|
match: Optional[str] = None,
|
|
|
|
) -> Dict:
|
|
|
|
return assert_errored_response(
|
|
|
|
response,
|
|
|
|
413,
|
|
|
|
error_message=error_message,
|
|
|
|
status='fail',
|
|
|
|
match=match,
|
|
|
|
)
|
|
|
|
|
|
|
|
@staticmethod
|
|
|
|
def assert_500(
|
|
|
|
response: TestResponse,
|
|
|
|
error_message: Optional[str] = (
|
|
|
|
'error, please try again or contact the administrator'
|
|
|
|
),
|
|
|
|
status: Optional[str] = 'error',
|
|
|
|
) -> Dict:
|
|
|
|
return assert_errored_response(
|
|
|
|
response, 500, error_message=error_message, status=status
|
|
|
|
)
|
|
|
|
|
2022-05-27 14:08:07 +02:00
|
|
|
@staticmethod
|
|
|
|
def assert_unsupported_grant_type(response: TestResponse) -> Dict:
|
|
|
|
return assert_oauth_errored_response(
|
|
|
|
response, 400, error='unsupported_grant_type'
|
|
|
|
)
|
|
|
|
|
|
|
|
@staticmethod
|
|
|
|
def assert_invalid_client(response: TestResponse) -> Dict:
|
|
|
|
return assert_oauth_errored_response(
|
|
|
|
response,
|
|
|
|
400,
|
|
|
|
error='invalid_client',
|
|
|
|
)
|
|
|
|
|
|
|
|
@staticmethod
|
|
|
|
def assert_invalid_request(response: TestResponse) -> Dict:
|
|
|
|
return assert_oauth_errored_response(
|
|
|
|
response,
|
|
|
|
400,
|
|
|
|
error='invalid_request',
|
|
|
|
)
|
|
|
|
|
2022-05-27 15:51:40 +02:00
|
|
|
@staticmethod
|
|
|
|
def assert_invalid_token(response: TestResponse) -> Dict:
|
|
|
|
return assert_oauth_errored_response(
|
|
|
|
response,
|
|
|
|
401,
|
|
|
|
error='invalid_token',
|
|
|
|
error_description=(
|
|
|
|
'The access token provided is expired, revoked, malformed, '
|
|
|
|
'or invalid for other reasons.'
|
|
|
|
),
|
|
|
|
)
|
|
|
|
|
2021-07-14 20:20:48 +02:00
|
|
|
|
|
|
|
class CallArgsMixin:
|
|
|
|
@staticmethod
|
|
|
|
def get_args(call_args: Any) -> Any:
|
|
|
|
if len(call_args) == 2:
|
|
|
|
args, _ = call_args
|
|
|
|
else:
|
|
|
|
_, args, _ = call_args
|
|
|
|
return args
|