docs: документация по архитектуре, данным и деплою

Конвенции слоёв api и web, работа с БД и миграциями, тесты, деплой
миграций, а также оглавление документации и README шаблона.
This commit is contained in:
arswarog committed 2026-10-27 10:43:49 +03:00
1 parent 9d5478ddeb
commit dbd5762ecf
10 files changed
+1308 -87

No files matched your search

+31
View File
@@ -0,0 +1,31 @@
# Тесты
## Расположение и имя
Юнит-тест лежит **рядом с тестируемым файлом**, отдельной папки под тесты нет:
```
apps/api/src/contests/
├── contests.service.ts
└── contests.service.test.ts
```
Расширение — `.test.ts` (`.test.tsx` для React-компонентов).
В репозитории встречается и `.spec.ts` — vitest подхватывает оба паттерна.
## DAL тестами не покрывается
Юнит-тест DAL с замоканным репозиторием проверял бы сам себя: что `findOne` вызван с теми
аргументами, с которыми его вызвали. Такие тесты не пишутся.
Логика, ради которой стоит писать тест, живёт в сервисе — там она и тестируется, с замоканным DAL.
Исключение — [БД-логика внутри DAL](30-data-access.md#бизнес-логики-в-dal-нет): её корректность
проверяется на реальной базе, а не моками.
## Запуск
```bash
yarn nx run api:test
yarn nx run web:test
```