5.9 KiB
GUIDE — запуск и тесты
Нужно: Docker с Compose v2 и Git. Для публичных проверок (tests/, scripts/*.py) — python3 3.9+ на хосте: они используют только стандартную библиотеку. Виртуальное окружение не нужно: API и собственные pytest-тесты собираются и работают в контейнерах. Команды выполняются из корня проекта. Для Windows (cmd) замените cp на copy, а scripts/restart.sh на scripts\restart.bat.
1. Поднять стенд
cp env.lab2.template .env # затем смените POSTGRES_PASSWORD (латиница и цифры)
docker compose --env-file .env up -d --build
docker compose --env-file .env ps # db, redis, api — healthy
curl http://localhost:8080/health/ready # {"status":"ok"}
- Миграции применяются сами при старте API.
- API:
http://localhost:8080. PostgreSQL для отладки:127.0.0.1:5433. Redis наружу не опубликован:docker compose --env-file .env exec redis redis-cli. - Если
apiперезапускается, смотритеdocker compose --env-file .env logs api.
Остановить с сохранением данных: docker compose --env-file .env stop. Удалить вместе с данными: docker compose --env-file .env down -v.
2. Проверки
| Команда | Что проверяет |
|---|---|
make check |
Структура репозитория и контракта (офлайн) |
make test |
Публичный сквозной smoke по живому API |
make test-persistence ACTION_SCRIPT=scripts/restart.sh |
Рестарт API, Redis и PostgreSQL: данные и прежний токен живы |
make test-student |
Все собственные тесты (153) в контейнере tests |
make explain |
EXPLAIN (ANALYZE, BUFFERS) истории на 60 000 синтетических сообщений |
python3 scripts/dependency_demo.py |
Роль Redis; остановка Redis и PostgreSQL (листинг в evidence/14_dependencies.txt) |
python3 scripts/storage_demo.py |
down → up -d, те же данные старыми токенами |
docker compose --env-file .env --profile expiry up -d api-ttl и python3 scripts/check_expiry.py |
Expiry на живом экземпляре с SESSION_TTL_SECONDS=3 (порт 8081) |
scripts/collect_evidence.sh |
Всё сразу, с сохранением в evidence/ (см. EVIDENCE.md) |
Собственные тесты работают с отдельной БД messenger_test на том же PostgreSQL и с Redis DB 15, поэтому рабочие данные messenger не затрагиваются. Один файл или один тест:
docker compose --env-file .env --profile test run --rm tests python -m pytest -v student-tests/test_cache.py
docker compose --env-file .env --profile test run --rm tests python -m pytest -v -k redis_down
После изменения тестов или кода пересоберите образ: make test-student делает --build сам.
Что проверяет каждый файл student-tests/
| Файл | За что отвечает |
|---|---|
test_auth.py |
Регистрация с паролем; Basic только на входе; Bearer на остальном; одинаковый 401 + WWW-Authenticate для неверного пароля и несуществующего логина; logout и повтор = 401; X-User-Id не даёт доступ |
test_session_expiry.py |
TTL 1 с и TTL 2 с из SESSION_TTL_SECONDS → 401; очистка истёкших сессий при входе |
test_cache.py |
Redis: попадания и TTL ключа, в кэше нет токенов и паролей, logout → revoked, SET NX против гонки, FLUSHDB без потерь, кэш не продлевает сессию, граница устаревания, Redis недоступен → обход и 401 для анонимов, FLUSHDB «грязного» кэша после восстановления |
test_db_failure.py |
БД недоступна → 503, live 200, ready 503, аноним не пропускается (с кэшем и без) |
test_transactions.py |
Сбой посреди создания чата → ROLLBACK; пул ограничен настройками; занятый пул → быстрый 503 |
test_explain.py |
План запроса истории на 10 000 сообщениях: Index Scan, нет Seq Scan и Sort |
test_database.py |
Что реально лежит в БД: scrypt$…, хеш токена, PK/FK/UNIQUE/CHECK, повторные миграции, атомарность чата |
test_duplicate_username.py |
409 и гонка 10 одновременных регистраций → ровно один 201 |
test_invalid_json.py, test_empty_message.py, test_foreign_chat.py, test_pagination.py, test_concurrency.py, test_contract_basics.py |
Валидация, ACL (404 для чужого), keyset-курсор, параллельная запись, общий формат ошибок, отсутствие секретов в логах |
3. Запуск без Docker (только для отладки)
Нужны свои PostgreSQL и Redis (необязательно) и установленные requirements.txt.
DATABASE_URL=postgresql+asyncpg://messenger:ПАРОЛЬ@127.0.0.1:5433/messenger CACHE_URL= python -m app
Адрес БД обязан начинаться с postgresql+asyncpg://. Пустой CACHE_URL выключает кэш.