Files
mtusi2026lab3/DEMO.md
2026-10-21 18:25:07 +03:00

106 lines
6.9 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.
# Шпаргалка для защиты — лабораторная 3
Команды по порядку сценария защиты из README. Подробности решения — в [REPORT.md](REPORT.md).
Shell: **Git Bash** в Windows или обычный терминал в Linux/macOS (в Linux вместо `python -X utf8` — `python3`).
`-X utf8` в Windows обязателен для публичных тестов: они читают контракт в кодировке системы (cp1251), а в контракте lab3 есть символы, которых в ней нет.
Адрес — `127.0.0.1`, а не `localhost`: в Windows `localhost` сначала пробует IPv6, и каждый запрос идёт около двух секунд.
## 0. Подготовка (один раз)
```sh
python scripts/init_secrets.py # случайные пароли в secrets/, в Git не попадают
cp .env.example .env
URL=http://127.0.0.1:8080
# post <путь> [токен] [Idempotency-Key] — JSON со стандартного ввода; печатает код и реплику
post() { curl -s -X POST "$URL$1" -H 'Content-Type: application/json' ${2:+-H "Authorization: Bearer $2"} ${3:+-H "Idempotency-Key: $3"} --data-binary @- -w '\nHTTP %{http_code} via %header{x-instance-id}\n'; }
# get <путь> [токен]
get() { curl -s "$URL$1" ${2:+-H "Authorization: Bearer $2"} -w '\nHTTP %{http_code} via %header{x-instance-id}\n'; }
# new <ПЕРЕМЕННАЯ> <путь> [токен] — как post, но ещё сохраняет id созданного объекта
new() { local r; r=$(post "$2" "$3"); echo "$r"; printf -v "$1" %s "$(echo "$r" | sed -nE 's/.*"id":"([^"]+)".*/\1/p' | head -1)"; }
# signin <ПЕРЕМЕННАЯ> <username> <password> — вход по Basic, токен сохраняется в переменную
signin() { local r; r=$(curl -s -X POST "$URL/api/v1/auth/sessions" -u "$2:$3" -w '\nHTTP %{http_code}\n'); echo "$r" | tail -1; printf -v "$1" %s "$(echo "$r" | sed -nE 's/.*"token":"([^"]+)".*/\1/p')"; }
```
## 1. Запуск и две реплики через балансировщик с одной сессией
```sh
docker compose up -d --build --wait # postgres, valkey, migrate (один раз), api x2, lb
docker compose ps # api-1, api-2 без портов; порты только у lb, на 127.0.0.1
new ALICE /api/v1/users <<< '{"username":"alice","display_name":"Алиса","password":"Alice-password-123"}'
new BOB /api/v1/users <<< '{"username":"bob","display_name":"Боб","password":"Bob-password-12345"}'
signin TA alice Alice-password-123
signin TB bob Bob-password-12345
for i in 1 2 3 4; do get /api/v1/users/me "$TA" | tail -1; done # via чередуется: две реплики, один токен
docker ps --filter label=com.docker.compose.service=api --format '{{.ID}} {{.Names}}' # X-Instance-Id = ID контейнера
python -X utf8 tests/smoke.py --base-url $URL # make test
```
Идемпотентность: тот же ключ — то же сообщение, другое тело — 409, без ключа — 400:
```sh
new CHAT /api/v1/chats "$TA" <<< "{\"title\":\"Проект по ВНП\",\"member_ids\":[\"$ALICE\",\"$BOB\"]}"
post /api/v1/chats/$CHAT/messages "$TA" key-001 <<< '{"text":"Привет, Боб!"}'
post /api/v1/chats/$CHAT/messages "$TA" key-001 <<< '{"text":"Привет, Боб!"}' # тот же id, возможно другая реплика
post /api/v1/chats/$CHAT/messages "$TA" key-001 <<< '{"text":"Другой текст"}' # 409
post /api/v1/chats/$CHAT/messages "$TA" <<< '{"text":"Без ключа"}' # 400
get /api/v1/chats/$CHAT/messages "$TB" # одно сообщение
```
## 2–3. Отказ одной реплики
Страница состояния балансировщика: <http://127.0.0.1:8404> — видно, какая реплика UP, а какая DOWN.
```sh
python -X utf8 tests/resilience.py --mode failover --action-script scripts/stop-one.cmd --base-url $URL # Windows
make test-failover ACTION_SCRIPT=scripts/stop-one.sh BASE_URL=$URL # Linux/macOS
docker compose ps -a # какой контейнер действительно остановлен: Exited (0)
docker compose logs lb | grep -E "is (DOWN|UP)" # HAProxy исключил его: Layer7 wrong status 503
docker compose up -d --wait # вернуть реплику
# повторить тест: если остановлена та же реплика, запустить ещё раз, пока не будет вторая
```
## 4. Перезапуск всего стенда с тем же токеном
```sh
python -X utf8 tests/resilience.py --mode persistence --action-script scripts/restart.cmd --base-url $URL # Windows
make test-persistence ACTION_SCRIPT=scripts/restart.sh BASE_URL=$URL # Linux/macOS
get /api/v1/chats/$CHAT/messages "$TA" # после перезапуска: те же данные, тот же токен
```
## Уровень «4»
Каждый пункт можно показать отдельно (скрипт сам печатает команды и вывод):
```sh
python -X utf8 scripts/lab3_checks.py --only stack # лимиты CPU/RAM, порты только у lb, секреты, нет container_name
python -X utf8 scripts/lab3_checks.py --only idempotency # 20 одновременных запросов с одним ключом
python -X utf8 scripts/lab3_checks.py --only experiment # stop и kill каждой реплики под нагрузкой: RPS, ошибки, время
python -X utf8 scripts/lab3_checks.py --only rolling # поочерёдная замена реплик новым образом под нагрузкой
python -X utf8 scripts/lab3_checks.py --only valkey-down postgres-down
```
Плавная остановка одной реплики: в логе реплики `shutdown_started`, затем через 3 с закрытие приёма и `clean=True`:
```sh
docker stop <ID реплики>; docker logs --tail 3 <ID реплики>; docker compose up -d --wait
```
Собственные тесты:
```sh
BASE_URL=$URL python -X utf8 -m unittest discover -s student-tests -v # make student-test
BASE_URL=$URL python student-tests/race.py # make race
```
## Остановка и уборка
```sh
docker compose stop # безопасная остановка, данные остаются в volumes
docker compose down # удалить контейнеры, volumes остаются
docker compose down -v # удалить ещё и все данные
```