107 lines
7.1 KiB
Markdown
107 lines
7.1 KiB
Markdown
# Spec Delta
|
||
|
||
## MODIFIED Requirements
|
||
|
||
### Requirement: Покрытие сценариев основных спеков
|
||
|
||
Для каждого сценария основных спеков `api-conventions`,
|
||
`identification`, `sessions`, `users`, `chats`, `messages`,
|
||
`pagination`, `data-storage`, `chat-cache`, `health`, `idempotency` и с
|
||
лабы 4 `attachments` и `storage-consistency`, который воспроизводится
|
||
по HTTP против работающего сервера, в том числе на стенде отказов,
|
||
SHALL быть тест. Из имени или описания теста SHALL быть понятно, какой
|
||
capability и сценарий он проверяет. Сценарий, который проверяет тест
|
||
отказа, SHALL считаться покрытым, хотя `make student_test` этот тест
|
||
не выполняет; итог сверки SHALL называть, сколько сценариев покрыто
|
||
проверками отказов. Сценарии, которые по HTTP не воспроизвести, SHALL
|
||
быть перечислены с причиной и способом проверки.
|
||
|
||
#### Scenario: Сверка покрытия
|
||
|
||
- **WHEN** проверяющий берёт любой сценарий перечисленных спеков
|
||
- **THEN** находится проверяющий его тест либо запись в списке
|
||
исключений с причиной
|
||
|
||
#### Scenario: Сценарий отказа в сверке
|
||
|
||
- **WHEN** выполняется `make student_test`
|
||
- **THEN** сверка считает сценарии проверок отказов покрытыми, не
|
||
требует для них исключений и печатает их число
|
||
|
||
### Requirement: Проверки отказов на отдельном стенде
|
||
|
||
Сценарии отказов SHALL проверяться автоматически одной командой
|
||
`make failure_checks`:
|
||
- `sessions`: «Истёкший токен», «Срок не продлевается», «БД остановлена при
|
||
запросе с токеном»;
|
||
- `data-storage`: «Сбой при добавлении участников», «БД остановлена»,
|
||
«БД вернулась», «Соединения исчерпаны»;
|
||
- `health`: «Хранилище не готово», «Кэш недоступен», «Хранилище
|
||
объектов недоступно»;
|
||
- `chat-cache`: «Valkey остановлен», «Valkey завис», «Valkey вернулся»,
|
||
«Очистка кэша»;
|
||
- `idempotency`: «Сбой при записи сообщения», «Отказ БД при отправке»,
|
||
«Ключ после срока»;
|
||
- `attachments`: «Запись в S3 не удалась», «Отклонённая загрузка ничего
|
||
не оставляет», «S3 остановлен», «S3 завис», «Незавершённая загрузка не
|
||
видна», «Сбой записи метаданных», «Фиксация ready не удалась», «Обрыв
|
||
передачи тела»;
|
||
- `storage-consistency`: все сценарии.
|
||
|
||
Команда SHALL:
|
||
- собрать образ из рабочего дерева;
|
||
- поднять отдельный стенд со своими PostgreSQL, Valkey и S3, применить
|
||
миграции и bootstrap S3;
|
||
- запустить два API: с настройками по умолчанию и «тесный» — с
|
||
коротким сроком сессии и ключа идемпотентности и пулом из одного
|
||
соединения;
|
||
- запустить уборщика с коротким grace и интервалом, сравнимыми со
|
||
временем теста, и передать их значения проверкам. Grace при этом
|
||
SHALL проходить проверку границы живой загрузки (`service-
|
||
configuration`, «Параметры уборщика»);
|
||
- выполнить проверки отказов;
|
||
- удалить стенд вместе с его данными при любом исходе.
|
||
|
||
Hook стенда отказов SHALL уметь:
|
||
- сообщить вложения стенда в PostgreSQL с их статусами и `id`
|
||
последнего вложения в статусе «загружается»;
|
||
- сообщить, у каких вложений есть объект в bucket стенда, — по самим
|
||
объектам, а не по каталогам хранилища;
|
||
- внедрить отказ PostgreSQL при записи метаданных и при фиксации
|
||
`ready` загрузки с заданным `filename` и задержать такую фиксацию;
|
||
- убить и снова запустить обычный API стенда.
|
||
|
||
Других сведений о хранилищах проверки вложений не получают. Объекты без
|
||
метаданных проверка находит сравнением этих двух списков.
|
||
|
||
Порты PostgreSQL, Valkey и S3 этого стенда MUST NOT публиковаться на
|
||
хосте, API — только на `127.0.0.1`. Рабочий стенд, его база, кэш,
|
||
хранилище объектов и контейнеры MUST NOT затрагиваться. Код выхода
|
||
SHALL быть ненулевым, если не прошла хотя бы одна проверка или уборка.
|
||
Параллельный запуск двух прогонов не поддерживается: уборка хвоста в
|
||
начале второго удаляет стенд первого.
|
||
|
||
#### Scenario: Успешный прогон
|
||
|
||
- **WHEN** рабочий стенд запущен, и выполнен `make failure_checks`
|
||
- **THEN** все проверки отказов прошли, код выхода 0, контейнеров и
|
||
volumes стенда отказов после команды нет, а у контейнеров рабочего
|
||
стенда прежнее время старта, и рабочий API отвечает
|
||
|
||
#### Scenario: Упавшая проверка
|
||
|
||
- **WHEN** во время `make failure_checks` падает хотя бы одна проверка
|
||
- **THEN** код выхода ненулевой, журналы API и уборщика стенда отказов
|
||
выведены, стенд отказов удалён
|
||
|
||
#### Scenario: Прерывание
|
||
|
||
- **WHEN** `make failure_checks` прерван Ctrl+C
|
||
- **THEN** стенд отказов остановлен и удалён вместе с volumes
|
||
|
||
#### Scenario: Хвост прошлого прогона
|
||
|
||
- **WHEN** контейнеры или volumes стенда отказов остались от прогона,
|
||
убитого без уборки
|
||
- **THEN** следующий `make failure_checks` удаляет их и начинает заново
|