Files

135 lines
7.3 KiB
Markdown
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.
# Запуск и проверка лабораторной 2
Команды рассчитаны на локальный тестовый стенд: Docker с Compose v2, `make` и Python 3.9+. В этой лабораторной проверяются уровни 3, 4 и 5.
## Запуск стенда
Из каталога `mtusi2026lab2`:
```sh
cp .env.example .env
```
Задайте в `.env` собственный локальный `POSTGRES_PASSWORD` (hex-строка), затем запустите API и зависимости:
```sh
docker compose --env-file .env up -d --build
```
## Быстрая проверка через curl
```sh
BASE_URL=http://127.0.0.1:8080
# Процесс API работает: ожидается HTTP 200 и {"status":"ok"}
curl --fail --show-error "$BASE_URL/health/live"
# API и PostgreSQL готовы принимать запросы: ожидается HTTP 200
curl --fail --show-error "$BASE_URL/health/ready"
# Без Bearer-токена доступ запрещён: ожидается HTTP 401
curl -sS -o /dev/null -w 'HTTP %{http_code}\n' "$BASE_URL/api/v1/users/me"
```
Следующий пример регистрирует двух тестовых пользователей, получает Bearer-токен Алисы через Basic-аутентификацию, создаёт чат и отправляет в него сообщение. Нужен `jq` для чтения JSON-ответов; используйте только тестовые пароли:
```sh
ALICE_USERNAME="codes_alice_$(date +%s)"
ALICE_PASSWORD='Example-password-alice-42'
BOB_USERNAME="codes_bob_$(date +%s)"
BOB_PASSWORD='Example-password-bob-42'
# Создать пользователей и сохранить их ID
ALICE=$(curl --fail --show-error "$BASE_URL/api/v1/users" \
-H 'Content-Type: application/json' \
-d "$(jq -n --arg username "$ALICE_USERNAME" --arg password "$ALICE_PASSWORD" \
'{username:$username, display_name:"Алиса (тест)", password:$password}')")
ALICE_ID=$(printf '%s' "$ALICE" | jq -r '.id')
BOB=$(curl --fail --show-error "$BASE_URL/api/v1/users" \
-H 'Content-Type: application/json' \
-d "$(jq -n --arg username "$BOB_USERNAME" --arg password "$BOB_PASSWORD" \
'{username:$username, display_name:"Боб (тест)", password:$password}')")
BOB_ID=$(printf '%s' "$BOB" | jq -r '.id')
# Войти как Алиса с Basic-аутентификацией и получить Bearer-токен
SESSION=$(curl --fail --show-error "$BASE_URL/api/v1/auth/sessions" \
-u "$ALICE_USERNAME:$ALICE_PASSWORD" \
-X POST)
TOKEN=$(printf '%s' "$SESSION" | jq -r '.token')
# Проверить авторизованный запрос
curl --fail --show-error "$BASE_URL/api/v1/users/me" \
-H "Authorization: Bearer $TOKEN"
# Создать чат от имени Алисы и включить обоих пользователей
CHAT=$(curl --fail --show-error "$BASE_URL/api/v1/chats" \
-H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' \
-d "$(jq -n --arg alice "$ALICE_ID" --arg bob "$BOB_ID" \
'{title:"Тестовый чат", member_ids:[$alice, $bob]}')")
CHAT_ID=$(printf '%s' "$CHAT" | jq -r '.id')
printf 'Создан чат: %s\n' "$CHAT_ID"
# Отправить сообщение; ожидается HTTP 201 и JSON нового сообщения
curl --fail --show-error "$BASE_URL/api/v1/chats/$CHAT_ID/messages" \
-H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' \
-d '{"text":"Проверка отправки сообщения через curl"}'
```
Для полной проверки API используйте smoke-тест ниже: он сам регистрирует синтетических пользователей, создаёт чат и сообщения. Эти данные остаются в тестовой базе.
## Проверки по уровням
Сначала выполните общую проверку контракта и OpenAPI:
```sh
make check
# Один раз, если ещё не установлен валидатор OpenAPI:
python3 -m venv .venv
. .venv/bin/activate
pip install -r requirements-dev.txt
make validate
```
Далее команды проверки уровней:
```sh
# Уровень 3: публичный API и сохранность данных/сессии после перезапуска
make test
make test-persistence ACTION_SCRIPT=scripts/restart.sh
# Уровень 4: проверки Redis TTL/fallback, конкурентной регистрации,
# rollback транзакции и истечения срока сессии
make grade4
# Уровень 5, трек 2: сравнение планов/индексов и backup/restore
make track5
```
Уровень 4 предполагает прохождение проверок уровня 3; уровень 5 — уровней 3 и 4, поэтому запускайте команды по порядку. `make track5` создаёт и удаляет собственные временные базы для эксперимента. Используйте только локальный учебный стенд, не production.
## Остановка
Останавливает контейнеры, сохраняя PostgreSQL volume и данные:
```sh
docker compose --env-file .env down
```
docker compose --env-file .env up -d
curl --fail http://127.0.0.1:8080/health/ready
Затем публичные тесты из tests/ можно запустить напрямую:
python3 tests/smoke.py
Он проверяет основной сценарий API: регистрацию и вход, чаты, отправку и чтение сообщений, доступы и пагинацию. В конце должен вывести PASS. Тест создаёт записи в базе, они автоматически не удаляются.
python3 tests/resilience.py --mode persistence --action-script scripts/restart.sh
Он проверяет, что данные и существующая сессия доступны после перезапуска. Скрипт перезапуска должен быть исполняемым; если нужно:
python3 tests/resilience.py --mode persistence --action-script scripts/restart.sh
Он проверяет, что данные и существующая сессия доступны после перезапуска. Скрипт перезапуска должен быть исполняемым; если нужно:
chmod +x scripts/restart.sh
python3 tests/load.py --duration 30 --concurrency 4
Это тест нагрузки: отправляет сообщения несколько секунд и показывает успешные запросы в секунду, ошибки и задержки. Он тоже создаёт тестовые сообщения.
tests/client.py — вспомогательный модуль для этих проверок, отдельно его запускать не нужно. То же самое можно запускать короче командами Make: make test, make test-persistence ACTION_SCRIPT=scripts/restart.sh. С описанием публичных проверок можно свериться в tests/README.md.