+ Описала шаблон отчета REPORT.md. Перенесла базовую информацию из отчета лаб 1

This commit is contained in:
vasyukova
2026-09-30 19:55:36 +03:00
parent 0f3be6ab7c
commit 78887d14eb
+94 -9
View File
@@ -1,23 +1,108 @@
# Отчёт — лабораторная 2
- Автор, группа: TODO
- Целевая оценка; выбранный трек 5, если нужен: TODO
- Commit/PR: TODO после публикации
- Использованные источники, библиотеки и помощь ИИ: TODO
- Автор, группа: Васюкова Наталья, БВТ2303
- Целевая оценка: 5
- Commit/PR: solution/BVT2303-Vasyukova
- Использованные источники, библиотеки и помощь ИИ:
- Контракт: contracts/openapi.json, contracts/README.md
- Инструкции: README.md, COURSE.md, CONTRIBUTING.md
- Библиотеки: fastapi==0.115.0, uvicorn[standard]==0.32.0, pydantic (из fastapi)
- ИИ: DeepSeek — помощь в структурировании кода и отчёта. Весь код проверен, отредактирован и запущен разработчиком.
## Запуск из чистого clone
TODO: версии runtime/образов, prerequisites, команды создания локальных secrets/.env, build, миграций, запуска, ожидания готовности, тестов и остановки. Указать необходимые действия оператора. Не вставлять секреты. Отдельно указать безопасную остановку и команду намеренного удаления учебных данных.
Версии runtime/образов и Prerequisites (предварительные требования):
- Python: 3.12 (базовый образ python:3.12-slim)
- FastAPI 0.115.0, uvicorn[standard] 0.32.0
- Docker Desktop (Windows), образ mtusi-messenger:lab1
- Git
Шаги:
1. git clone https://gitflic.ru/project/vasyukova-nat/mtusi2026lab1.git && cd mtusi2026lab1
2. git checkout solution/BVT2303-Vasyukova
3. Создать локального secrets из шаблона:
copy .env.example .env
(значения по умолчанию: APP_HOST=0.0.0.0, APP_PORT=8080, APP_ENV=lab)
4. Сборка образа:
docker build -t mtusi-messenger:lab1 .
5. Запуск:
docker run --rm --name mtusi-messenger-lab1 -p 127.0.0.1:8080:8080 --env-file .env mtusi-messenger:lab1
6. Проверка готовности:
curl.exe -s http://localhost:8080/health/ready
Ожидается: {"status":"ok"}
7. Публичный smoke (в другом терминале):
python tests/smoke.py --base-url http://localhost:8080
8. Собственные тесты уровня 4 (в другом терминале):
python student-tests/run_all.py --base-url http://localhost:8080
9. Остановка и удаление учебных данных:
Ctrl+C в терминале контейнера
Или:
docker stop mtusi-messenger-lab1
Данные исчезают при остановке контейнера (флаг --rm - удалить сам контейнер).
Альтернативный локальный запуск без Docker:
python -m uvicorn src.app.main:app --host 0.0.0.0 --port 8080 --reload
## Архитектура и решения
TODO: схема процессов/хранилищ, источник истины, транзакционные границы, ограничения. Что перенесено из lab1, что изменено в этой работе. Соответствие переменных из .env.example реальной конфигурации.
Актуальная архитектура на момент лаб 1:
Схема процессов/хранилищ:
HTTP-клиент → FastAPI (uvicorn, 0.0.0.0:8080) → in-memory storage (dict + RLock)
Источник истины:
Память процесса.
Persistence - сохранение данных при перезапуске процесса - отсутствует.
Транзакционные границы: операции над storage выполняются под RLock
атомарно.
Ограничения:
Одно-процессное хранение, нет репликации, нет HA.
Дерево папок:
```
mtusi2026lab1/
├── src/app/ # исходники приложения
│ ├── main.py # точка входа uvicorn, создание FastAPI, подключение роутеров, middleware для X-Request-Id, структурное логирование, обработчик SIGTERM, обработчики ошибок
│ ├── api/ # HTTP-роутеры (по ресурсам)
│ │ ├── health.py
│ │ ├── users.py
│ │ ├── chats.py
│ │ └── messages.py
│ ├── models/
│ │ └── schemas.py # Pydantic-схемы
│ └── storage/
│ └── memory.py # in-memory хранилище (RLock)
├── contracts/ # OpenAPI + семантика (без изменений)
├── tests/ # публичные проверки (без изменений)
├── scripts/ # check_contract.py, validate_openapi.py (без изменений)
├── student-tests/ # собственные тесты уровня 4
│ ├── run_all.py # единая команда запуска
│ ├── test_negative.py # негативные сценарии
│ └── test_concurrency.py # защита от гонок (100 сообщений / 10 клиентов)
├── Dockerfile # сборка образа
├── Makefile # + test-student
├── README.md, ... # скелет (без изменений)
└── REPORT.md # отчет
```
Примечание:
Соответствие .env.example реальной конфигурации:
- APP_HOST, APP_PORT — используется uvicorn/CMD в Dockerfile.
- APP_ENV — используется в стартовом логе (event=startup app_env=...), в остальном в lab1 не влияет на логику.
TODO дял лаб 2: схема процессов/хранилищ, источник истины, транзакционные границы, ограничения.
Что перенесено из lab1, что изменено в этой работе.
Соответствие переменных из .env.example реальной конфигурации.
## Доказательства критериев
| Критерий README | Команда/сценарий | Наблюдаемый результат | Файл доказательства |
| --- | --- | --- | --- |
| Публичный smoke | make test | TODO | TODO |
| Критерий README | Команда/сценарий | Наблюдаемый результат | Файл доказательства | Уровень |
| --- | --- | --- | --- | --- |
| OpenAPI 3.1 и JSON Schema | python scripts/validate_openapi.py | PASS: full OpenAPI 3.1 and JSON Schema validation | evidence/lab1_checks.txt | **3** |
| Публичный smoke (endpoint lab1, форматы ошибок, членство, пагинация) | python tests/smoke.py --base-url http://localhost:8080 | PASS: lab1 public API scenario | evidence/lab1_checks.txt | **3** |
| Dockerfile собирает приложение, слушает 0.0.0.0:8080 | docker build -t mtusi-messenger:lab1 . ; docker run ... | образ собран, /health/ready = {"status":"ok"} | evidence/lab1_checks.txt | **3** |
| Остальные пункты уровня 3 | TODO | TODO | TODO |
| Все пункты уровня 4, если заявлен | TODO | TODO | TODO |
| Выбранный трек 5, если заявлен | TODO | TODO | TODO |