feat: package and verify lab1 container lifecycle

This commit is contained in:
Самохвалов Андрей Ремович
2026-10-01 21:59:13 +03:00
parent 55ec45cc3d
commit c5e93067ec
8 changed files with 215 additions and 37 deletions
+11 -15
View File
@@ -1,20 +1,16 @@
.git
.github
.env
.env.*
!.env.example
secrets
certs
volumes
data
backups
*.key
*.pem
*.p12
*.pfx
*.jks
.venv
__pycache__
node_modules
*.pyc
.env
.env.*
secrets
docs
evidence
.DS_Store
student-tests
tests
contracts
scripts
*.md
Dockerfile.example
+1 -3
View File
@@ -1,5 +1,3 @@
# Copy to .env for your LOCAL synthetic test environment; never commit .env.
# These are logical interface suggestions; map actual framework names in REPORT.md.
# Copy to .env for a LOCAL synthetic test environment; never commit .env.
APP_HOST=0.0.0.0
APP_PORT=8080
APP_ENV=lab
+28
View File
@@ -0,0 +1,28 @@
name: Application
on: [push, pull_request]
permissions:
contents: read
jobs:
application:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.12'
- run: docker build -t mtusi-messenger:lab1 .
- name: Start and wait for readiness
run: |
docker run -d --name mtusi-messenger-ci -p 127.0.0.1:8080:8080 mtusi-messenger:lab1
for attempt in $(seq 1 60); do
if curl --fail --silent http://127.0.0.1:8080/health/ready; then exit 0; fi
sleep 1
done
docker logs mtusi-messenger-ci
exit 1
- run: make test BASE_URL=http://127.0.0.1:8080
- name: Container logs and cleanup
if: always()
run: |
docker logs mtusi-messenger-ci || true
docker rm -f mtusi-messenger-ci || true
+18
View File
@@ -0,0 +1,18 @@
FROM python:3.12.12-slim-bookworm@sha256:593bd06efe90efa80dc4eee3948be7c0fde4134606dd40d8dd8dbcade98e669c
ENV PYTHONDONTWRITEBYTECODE=1 \
PYTHONUNBUFFERED=1 \
APP_HOST=0.0.0.0 \
APP_PORT=8080
WORKDIR /app
COPY requirements.lock .
RUN pip install --no-cache-dir -r requirements.lock \
&& groupadd --system app \
&& useradd --system --gid app --home-dir /app app
COPY src/ src/
USER app
EXPOSE 8080
HEALTHCHECK --interval=5s --timeout=3s --start-period=10s --retries=3 \
CMD python -c "import os, urllib.request; urllib.request.urlopen('http://127.0.0.1:' + os.environ['APP_PORT'] + '/health/ready', timeout=2)" || exit 1
CMD ["python", "-m", "src.server"]
+38 -19
View File
@@ -1,37 +1,56 @@
# Отчёт — лабораторная 1
- Автор, группа: TODO
- Целевая оценка; выбранный трек 5, если нужен: TODO
- Commit/PR: TODO после публикации
- Использованные источники, библиотеки и помощь ИИ: TODO
- Автор: Самохвалов Андрей Ремович (локальный Git); группа БПИ2302 (имя ветки/remote). Подтвердить данные перед PR.
- Цель: оценка 5, трек 1. Результаты исследования будут добавлены в U5. Ниже — проверенные критерии уровней 3 и 4.
- Ветка: `solution/bpi2302-samohvalov`. Commit/PR: заполнить после публикации.
- Источники: `README.md`, `COURSE.md`, `contracts/openapi.json`, `contracts/README.md`, `Dockerfile.example`, `tests/README.md`. FastAPI, Pydantic и Uvicorn закреплены в `requirements.lock`. Codex помог написать код, тесты и отчёт; результаты команд получены локально.
## Запуск из чистого clone
TODO: версии runtime/образов, prerequisites, команды создания локальных secrets/.env, build, миграций, запуска, ожидания готовности, тестов и остановки. Указать необходимые действия оператора. Не вставлять секреты. Отдельно указать безопасную остановку и команду намеренного удаления учебных данных.
Нужны Docker Engine, Python 3.9+ и `make`. В корне репозитория:
## Архитектура и решения
```sh
cp .env.example .env
docker build -t mtusi-messenger:lab1 .
docker run -d --name mtusi-messenger-lab1 -p 127.0.0.1:8080:8080 --env-file .env mtusi-messenger:lab1
curl --fail http://127.0.0.1:8080/health/ready
make check
make test BASE_URL=http://127.0.0.1:8080
python3 student-tests/test_lifecycle.py -v
docker stop --time 10 mtusi-messenger-lab1
docker rm mtusi-messenger-lab1
```
TODO: схема процессов/хранилищ, источник истины, транзакционные границы, ограничения. Что перенесено из lab1, что изменено в этой работе. Соответствие переменных из .env.example реальной конфигурации.
`APP_HOST=0.0.0.0` и `APP_PORT=8080` из `.env.example` читает `src/server.py`; при смене порта измените и публикацию Docker. Миграций и volumes нет. Сервер — PID 1, `docker stop` посылает SIGTERM. Удаление контейнера намеренно удаляет учебные данные. Локальный `.env` исключён из Git и Docker build context.
## Архитектура
Один Uvicorn worker обслуживает FastAPI и один `Store` в памяти. Словари пользователей, чатов и сообщений защищены общим `threading.Lock`. Членство проверяется перед чтением чата и истории. Страницы отсортированы по `(created_at, id)`, cursor привязан к пользователю или чату. Данные не переживают рестарт и не синхронизируются между процессами. Базовый Python 3.12.12 slim-bookworm закреплён по digest; прямые и транзитивные зависимости закреплены версиями в `requirements.lock`. Контейнер работает от UID 999.
## Доказательства критериев
| Критерий README | Команда/сценарий | Наблюдаемый результат | Файл доказательства |
| Критерий README | Команда/сценарий | Наблюдение 01.10.2026 | Файл доказательства |
| --- | --- | --- | --- |
| Публичный smoke | make test | TODO | TODO |
| Остальные пункты уровня 3 | TODO | TODO | TODO |
| Все пункты уровня 4, если заявлен | TODO | TODO | TODO |
| Выбранный трек 5, если заявлен | TODO | TODO | TODO |
TODO: добавить отдельную строку для каждого заявленного критерия. PASS без команды и наблюдения не является доказательством. Проверка инфраструктурного hook требует подтверждения, какие реальные процессы/хранилища перезапущены.
| Целостность skeleton | `make check` | `PASS: offline skeleton structure, local refs and Python syntax` | `scripts/check_contract.py` |
| Все endpoint, доступ, Unicode, ошибки, страницы | `make test BASE_URL=http://127.0.0.1:8080` через временный SSH-туннель к Colima; также публичный smoke внутри VM | `PASS: lab1 public API scenario` | `tests/smoke.py` |
| Сборка и запуск на 8080 | `docker build -t mtusi-messenger:lab1 .`; `docker run -d -p 127.0.0.1:8080:8080 ...` | Сборка успешна; в VM `/health/ready` вернул `{"status":"ok"}`, Uvicorn слушал `0.0.0.0:8080` | `Dockerfile`, `src/server.py` |
| Только память и сброс после рестарта | `colima ssh -- python3 /Users/wingto/study/mtusi2026lab1/student-tests/test_lifecycle.py -v` | Сообщение читалось до рестарта; старый `X-User-Id` после `docker restart` получил 401 | `student-tests/test_lifecycle.py` |
| Негативные и cursor-тесты | `/private/tmp/mtusi-lab1-venv/bin/python -m unittest discover -s student-tests -v` | `Ran 8 tests in 0.517s`, `OK (skipped=1)`; отдельный Docker lifecycle запускается явно | `student-tests/test_api.py`, `student-tests/test_lifecycle.py` |
| Параллельная запись | Та же команда `unittest discover` | `Concurrency evidence: 10 clients, 100 writes, 100 unique messages read` | `student-tests/test_concurrency.py` |
| Non-root, pinned образ/зависимости, healthcheck, .dockerignore | Lifecycle-тест в Colima VM | `healthy`, UID 999; образ собран по digest и `requirements.lock` | `Dockerfile`, `.dockerignore`, `requirements.lock`, `student-tests/test_lifecycle.py` |
| SIGTERM, закрытый порт, логи без текстов | Lifecycle-тест в Colima VM | `SIGTERM=0.25s`, exit code 0, новое TCP-подключение отклонено, текст тестового сообщения отсутствует в `docker logs` | `student-tests/test_lifecycle.py` |
| CI приложения | `.github/workflows/application.yml` | Job build/readiness/public smoke добавлен; внешнее выполнение ещё не подтверждено | `.github/workflows/application.yml` |
| Трек 5 | Эксперимент U5 | Пока не выполнен | `student-tests/benchmark_memory.py`, `evidence/load-lab1.csv` будут добавлены в U5 |
## Эксперименты и отказы
TODO: гипотеза, hardware/лимиты, версии, объём данных, профиль нагрузки, concurrency/arrival rate, длительность/прогрев, повторы, успешные RPS, ошибки, p50/p95/p99, CPU/RAM. Сохранить raw summary без tokens и объяснить ограничения измерения.
| Воздействие | Что ожидаем | Что наблюдали | Время восстановления / потеря данных |
| Воздействие | Ожидание | Наблюдение | Восстановление / потеря данных |
| --- | --- | --- | --- |
| TODO | TODO | TODO | TODO |
| `docker restart` | Память сброшена | Прежний пользователь получил 401 после готовности | Все данные потеряны по дизайну lab1 |
| `docker stop --time 10` | Завершение за ≤10 с, новые запросы отклонены | 0.25 с, exit code 0, порт закрыт | После остановки сервис недоступен |
Для трека 1 в U5 нужны гипотеза, одинаковые CPU/RAM-лимиты, матрица ≥3 размеров истории × ≥3 конкуренции, прогрев, длительность, повторения, successful RPS, доля ошибок, p50/p95/p99, CPU/RSS и сравнение до/после одного изменения. `tests/load.py` использует closed-loop нагрузку; его latencies относятся только к успешным ответам и подвержены coordinated omission.
## Ограничения и следующие шаги
TODO: какие отказы выдерживаются и какие нет; что не реализовано; где учебное упрощение; какое улучшение подтверждено, а какое пока гипотеза.
В текущей Colima VM опубликованный порт отвечал, но macOS host без отдельного SSH-туннеля получал `Connection refused` даже для `-p 18080:8080`. Контейнер и API проверены из VM, штатный `make test` — через туннель; прямой host localhost на этой машине пока не подтверждён. CI job рассчитан на обычный Docker runner, внешний результат пока не получен. Второй worker имел бы независимую память. Cursor не даёт snapshot между запросами. Стоимость общего lock и сортировки истории будет измерена в U5.
+13
View File
@@ -0,0 +1,13 @@
# Frozen from the Python 3.12.12 container on 2026-10-01.
annotated-types==0.8.0
anyio==4.15.1
click==8.5.0
fastapi==0.118.3
h11==0.16.0
idna==3.20
pydantic==2.12.4
pydantic_core==2.41.5
starlette==0.48.0
typing-inspection==0.4.4
typing_extensions==4.16.0
uvicorn==0.38.0
+14
View File
@@ -0,0 +1,14 @@
"""Run the single in-memory ASGI worker as the container's main process."""
import os
import uvicorn
if __name__ == "__main__":
uvicorn.run(
"src.main:app",
host=os.environ.get("APP_HOST", "0.0.0.0"),
port=int(os.environ.get("APP_PORT", "8080")),
workers=1,
)
+92
View File
@@ -0,0 +1,92 @@
"""Container lifecycle check; run explicitly after building the image."""
import json
import os
import subprocess
import time
import unittest
import urllib.error
import urllib.request
@unittest.skipUnless(
__name__ == "__main__" or os.environ.get("LAB1_DOCKER_LIFECYCLE") == "1",
"requires Docker; run this file directly",
)
class ContainerLifecycle(unittest.TestCase):
def test_memory_health_user_and_sigterm(self):
name = f"mtusi-lab1-lifecycle-{os.getpid()}"
image = os.environ.get("LAB1_IMAGE", "mtusi-messenger:lab1")
def docker(*args):
return subprocess.run(["docker", *args], check=True, capture_output=True, text=True).stdout.strip()
def request(base, method, path, body=None, user=None):
data = json.dumps(body).encode("utf-8") if body is not None else None
headers = {"Content-Type": "application/json"} if body is not None else {}
if user:
headers["X-User-Id"] = user
req = urllib.request.Request(base + path, data=data, headers=headers, method=method)
try:
with urllib.request.urlopen(req, timeout=2) as response:
return response.status, json.load(response)
except urllib.error.HTTPError as error:
return error.code, json.load(error)
def ready(base):
deadline = time.monotonic() + 40
while time.monotonic() < deadline:
try:
if request(base, "GET", "/health/ready")[0] == 200:
return
except (OSError, TimeoutError):
pass
time.sleep(0.25)
self.fail("container did not become ready within 40 seconds")
docker("run", "-d", "--name", name, "-p", "127.0.0.1::8080", image)
try:
port = docker("port", name, "8080/tcp").rsplit(":", 1)[1]
base = f"http://127.0.0.1:{port}"
ready(base)
deadline = time.monotonic() + 20
while docker("inspect", "-f", "{{.State.Health.Status}}", name) != "healthy":
self.assertLess(time.monotonic(), deadline, "Docker healthcheck never became healthy")
time.sleep(0.5)
uid = docker("exec", name, "id", "-u")
self.assertNotEqual(uid, "0")
username = f"lifecycle_{os.getpid()}"
status, user = request(base, "POST", "/api/v1/users", {"username": username, "display_name": "Проверка"})
self.assertEqual(status, 201)
user_id = user["id"]
status, chat = request(base, "POST", "/api/v1/chats", {"title": "Жизненный цикл", "member_ids": [user_id]}, user_id)
self.assertEqual(status, 201)
marker = f"private-message-{os.getpid()}"
path = f"/api/v1/chats/{chat['id']}/messages"
self.assertEqual(request(base, "POST", path, {"text": marker}, user_id)[0], 201)
status, history = request(base, "GET", path, user=user_id)
self.assertEqual(status, 200)
self.assertEqual([item["text"] for item in history["items"]], [marker])
docker("restart", "--time", "10", name)
port = docker("port", name, "8080/tcp").rsplit(":", 1)[1]
base = f"http://127.0.0.1:{port}"
ready(base)
self.assertEqual(request(base, "GET", "/api/v1/users/me", user=user_id)[0], 401)
started = time.monotonic()
docker("stop", "--time", "10", name)
elapsed = time.monotonic() - started
self.assertLessEqual(elapsed, 10, f"SIGTERM shutdown took {elapsed:.2f}s")
self.assertEqual(docker("inspect", "-f", "{{.State.ExitCode}}", name), "0")
with self.assertRaises(urllib.error.URLError):
request(base, "GET", "/health/ready")
self.assertNotIn(marker, docker("logs", name))
print(f"lifecycle: healthy, uid={uid}, memory reset=401, SIGTERM={elapsed:.2f}s, closed port, no message text in stdout")
finally:
docker("rm", "-f", name)
if __name__ == "__main__":
unittest.main()