Files
mtusi2026lab4/student-tests/api.py

145 lines
6.4 KiB
Python
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
"""Небольшой HTTP-клиент для собственных тестов. Только стандартная библиотека, Python 3.9+.
Стенд должен быть уже запущен. Адрес берётся из переменной окружения BASE_URL.
По умолчанию 127.0.0.1, а не localhost: в Windows localhost сначала пробует IPv6
и каждый запрос к IPv4-порту занимает около двух секунд.
"""
import base64
import json
import os
import urllib.error
import urllib.request
import uuid
from datetime import datetime
from urllib.parse import quote
BASE_URL = os.environ.get('BASE_URL', 'http://127.0.0.1:8080').rstrip('/')
TIMEOUT = 10
USER_FIELDS = ('id', 'username', 'display_name', 'created_at')
# Значение по умолчанию для key: новый случайный Idempotency-Key у каждого POST сообщения.
AUTO = object()
class Response:
def __init__(self, status, headers, body):
self.status = status
self.headers = headers
self.body = body
self.json = json.loads(body) if body else None
def request(method, path, user=None, body=None, raw=None, headers=None, base_url=None, key=AUTO):
"""Один запрос. user — словарь с token (Bearer); body — объект для JSON; raw — готовые байты.
key — Idempotency-Key для POST сообщения: по умолчанию новый случайный, None — без заголовка.
"""
all_headers = {'Accept': 'application/json'}
if user is not None:
all_headers['Authorization'] = 'Bearer ' + user['token']
if key is AUTO:
key = uuid.uuid4().hex if method == 'POST' and path.endswith('/messages') else None
if key is not None:
all_headers['Idempotency-Key'] = key
if body is not None:
raw = json.dumps(body, ensure_ascii=False).encode('utf-8')
if raw is not None:
all_headers['Content-Type'] = 'application/json'
all_headers.update(headers or {})
req = urllib.request.Request((base_url or BASE_URL) + path, data=raw, headers=all_headers, method=method)
try:
response = urllib.request.urlopen(req, timeout=TIMEOUT)
except urllib.error.HTTPError as error:
response = error
with response:
result = Response(response.code, response.headers, response.read())
# Общие требования контракта ко всем ответам.
assert result.headers.get('X-Request-Id'), 'no X-Request-Id in response'
assert result.headers.get('X-Instance-Id'), 'no X-Instance-Id in response'
if result.status == 204:
assert not result.body, '204 must not have a body'
return result
assert result.headers.get_content_type() == 'application/json', 'response is not JSON'
if result.status >= 400:
error = result.json['error']
assert set(error) == {'code', 'message', 'request_id'}, 'unexpected error fields'
assert error['message'], 'empty error message'
assert error['request_id'] == result.headers['X-Request-Id'], 'request_id differs from header'
return result
def basic(username, password):
"""Значение заголовка Authorization: Basic base64(username:password) в UTF-8."""
return 'Basic ' + base64.b64encode((username + ':' + password).encode('utf-8')).decode('ascii')
def unique_username(prefix='t'):
return prefix + '_' + uuid.uuid4().hex[:16]
def new_password():
# Кириллица и двоеточие: проверяем UTF-8 и деление Basic по первому двоеточию.
return 'Пароль:' + uuid.uuid4().hex
def register(username=None, password=None, display_name='Тестовый пользователь'):
body = {'username': username or unique_username(), 'display_name': display_name, 'password': password or new_password()}
return request('POST', '/api/v1/users', body=body), body
def login(username, password, base_url=None):
return request('POST', '/api/v1/auth/sessions', headers={'Authorization': basic(username, password)},
base_url=base_url)
def new_user(display_name='Тестовый пользователь', base_url=None):
"""Зарегистрированный пользователь с действующим токеном: поля User + token + password."""
response, body = register(display_name=display_name)
assert response.status == 201, 'user was not created: %d' % response.status
session = login(body['username'], body['password'], base_url=base_url)
assert session.status == 201, 'login failed: %d' % session.status
return dict(response.json, token=session.json['token'], password=body['password'])
def public(user):
"""Только поля схемы User: так пользователь выглядит в ответах API."""
return {field: user[field] for field in USER_FIELDS}
def new_chat(owner, members, title='Тестовый чат'):
body = {'title': title, 'member_ids': [member['id'] for member in members]}
response = request('POST', '/api/v1/chats', user=owner, body=body)
assert response.status == 201, 'chat was not created: %d' % response.status
return response.json
def send(user, chat, text, key=AUTO):
return request('POST', '/api/v1/chats/%s/messages' % chat['id'], user=user, body={'text': text}, key=key)
def instance(response):
"""Какая реплика API ответила."""
return response.headers['X-Instance-Id']
def pages(path, user, limit):
"""Обходит все страницы списка и возвращает их как список списков."""
result = []
cursor = None
while True:
url = '%s?limit=%d' % (path, limit)
if cursor:
url += '&cursor=' + quote(cursor, safe='')
response = request('GET', url, user=user)
assert response.status == 200, 'page was not read: %d' % response.status
result.append(response.json['items'])
cursor = response.json['next_cursor']
if cursor is None:
return result
assert len(result) < 1000, 'pagination does not finish'
def order_key(item):
"""Порядок из контракта: (created_at, id) по возрастанию."""
created_at = datetime.fromisoformat(item['created_at'][:-1] + '+00:00')
return created_at, uuid.UUID(item['id']).int