test-writing

$npx mdskill add SteelMorgan/1c-agent-based-dev-framework/test-writing

Creates YaxUnit test modules in BSL for registering tests, assertions, mocking, and test data.

  • Helps automate writing unit tests for 1C:Enterprise applications using the YaxUnit framework.
  • Integrates with YaxUnit's test structure and depends on BSL language and project configuration files.
  • Follows strict project layout rules, such as placing tests only in designated extensions and avoiding manual changes to runner infrastructure.
  • Outputs test modules with proper naming conventions and registration in configuration metadata for execution.
SKILL.md
.github/skills/test-writingView on GitHub ↗
---
name: test-writing
description: Написание тестов YaxUnit (BSL). Навык учит агента создавать тестовые модули для фреймворка YaxUnit — регистрация тестов, утверждения, мокирование, тестовые данные.
---

# Написание тестов YaxUnit (BSL)

Запуск написанных тестов — отдельный навык [`test-execution`](../../tool-usage/test-execution/SKILL.md).

**Полная документация YaxUnit:** см. [`references/yaxunit-cheatsheet.md`](references/yaxunit-cheatsheet.md)

---

## Расположение тестов в проекте

Тесты хранятся в **отдельном расширении конфигурации**: `<корень проекта>/exts/TESTS/`

### Варианты структуры: EDT и DESIGNER

| Формат | Код модуля | Файл метаданных |
|--------|------------|-----------------|
| EDT | `exts/TESTS/src/CommonModules/<ИмяМодуля>/Module.bsl` | `.../<ИмяМодуля>.mdo` |
| DESIGNER | `exts/TESTS/src/CommonModules/<ИмяМодуля>/Ext/Module.bsl` | `.../<ИмяМодуля>.xml` |

Если формат неочевиден — проверь `application-*.yml` / `yaxunit-*.yml` в корне проекта.

Не смешивай структуры: для DESIGNER обязателен `Ext/`, для EDT он не используется.

Новый модуль должен быть зарегистрирован в `Configuration.[mdo|xml]`, иначе тест не подхватится раннером.

**Категорические запреты:**
- Тестовые исходники размещаются только в `exts/TESTS/**`, никогда в основной конфигурации
- `exts/YAXUNIT/**` никогда не изменяется вручную — это инфраструктура раннера

---

## Именование тестовых модулей

Шаблон: `<Префикс>_<ИмяОбъекта>[_<Суффикс>]`

### Префиксы по типу объекта

| Тип объекта | Префикс | Пример |
|-------------|---------|--------|
| Общий модуль | `ОМ_` | `ОМ_ОбщегоНазначения` |
| Документ | `Док_` | `Док_ПоступлениеТоваров` |
| Справочник | `Спр_` | `Спр_Контрагенты` |
| Регистр накопления | `РН_` | `РН_ОстаткиТоваров` |
| Регистр сведений | `РС_` | `РС_КурсыВалют` |
| Обработка | `Обр_` | `Обр_ЗакрытиеМесяца` |

### Суффиксы по типу модуля

| Тип модуля | Суффикс | Пример |
|-----------|---------|--------|
| Модуль объекта | `_МО` | `Спр_Контрагенты_МО` |
| Модуль менеджера | `_ММ` | `РН_ОстаткиТоваров_ММ` |
| Модуль набора записей | `_НЗ` | `РБ_Хозрасчетный_НЗ` |

---

## Структура тестового модуля

Обязательно: экспортная процедура `ИсполняемыеСценарии`. Только регистрация тестов — никаких данных, никакой логики.

```bsl
Процедура ИсполняемыеСценарии() Экспорт

    ЮТТесты
        .ДобавитьТестовыйНабор("Остатки")
            .ДобавитьСерверныйТест("ТестПолучитьОстатки")
            .ДобавитьСерверныйТест("ТестОстатокПустойСклад")
        .ДобавитьТестовыйНабор("Перемещение")
            .ДобавитьСерверныйТест("ТестПеремещениеМеждуСкладами");

КонецПроцедуры
```

| Метод | Где выполняется |
|-------|----------------|
| `ДобавитьТест` | контекст по умолчанию |
| `ДобавитьСерверныйТест` | &НаСервереБезКонтекста |
| `ДобавитьКлиентскийТест` | &НаКлиенте |

---

## Реализация теста

Один тест проверяет одно утверждение. Паттерн Arrange-Act-Assert:

```bsl
Процедура ТестПолучитьОстатки() Экспорт

    // Arrange
    Склад = ЮТест.Данные().СоздатьЭлемент("Справочник.Склады");
    НоменклатураСсылка = ЮТест.Данные().СоздатьЭлемент("Справочник.Номенклатура");

    // Act
    Остаток = УправлениеСкладом.ПолучитьОстаток(НоменклатураСсылка, Склад);

    // Assert
    ЮТест.ОжидаетЧто(Остаток).Равно(0);

КонецПроцедуры
```

---

## Утверждения (ЮТест.ОжидаетЧто)

```bsl
// Базовые сравнения
ЮТест.ОжидаетЧто(Результат).Равно(42);
ЮТест.ОжидаетЧто(Результат).НеРавно(0);
ЮТест.ОжидаетЧто(Результат).Больше(10);
ЮТест.ОжидаетЧто(Флаг).ЭтоИстина();
ЮТест.ОжидаетЧто(Значение).ВСписке(МассивДопустимых);

// Тип и заполненность
ЮТест.ОжидаетЧто(Ссылка).ИмеетТип("СправочникСсылка.Номенклатура");
ЮТест.ОжидаетЧто(Значение).НеЯвляетсяНеопределено();

// Исключения
ЮТест.ОжидаетЧто(ЭтотОбъект).МетодВыбрасываетИсключение("МетодСОшибкой", Параметры);

// Данные ИБ
ЮТест.ОжидаетЧтоТаблицаБазы("Справочник.Склады")
    .СодержитЗаписи()
    .ГдеРеквизит("Наименование").Равно("Основной склад");
```

---

## Тестовые данные (ЮТест.Данные)

```bsl
// Пустышка
Склад = ЮТест.Данные().СоздатьЭлемент("Справочник.Склады");

// Конструктор с реквизитами
Номенклатура = ЮТест.Данные()
    .КонструкторОбъекта("Справочник.Номенклатура")
    .Установить("Наименование", "Тестовый товар")
    .Установить("ЕдиницаИзмерения", ПредопределённыйЭлемент("Классификатор.ЕдиницыИзмерения.Штука"))
    .Записать()
    .Ссылка();

// Документ
Документ = ЮТест.Данные().СоздатьДокумент("Документ.ПоступлениеТоваров");
```

Данные через `ЮТест.Данные()` **автоматически удаляются** после теста. Не создавай данные в `ИсполняемыеСценарии`.

---

## Мокирование (Мокито)

Паттерн: Обучение -> Прогон -> Проверка.

```bsl
Процедура ТестРасчётСкидки() Экспорт

    Мокито.Обучение(МодульСкидок)
        .Когда().ПолучитьПроцентСкидки(Клиент)
        .Вернуть(15);

    Результат = УправлениеПродажами.РассчитатьСумму(100, Клиент);

    ЮТест.ОжидаетЧто(Результат).Равно(85);
    Мокито.Проверить(МодульСкидок).ПолучитьПроцентСкидки(Клиент);

КонецПроцедуры
```

### Сценарии мокирования

```bsl
Мокито.Обучение(Модуль).Когда().МетодА(Параметр).Вернуть(42);
Мокито.Обучение(Модуль).Когда().МетодБ(Параметр).ВыброситьИсключение("Текст ошибки");
Мокито.Обучение(Модуль).Когда().МетодВ().Пропустить();
Мокито.Обучение(Модуль).Когда().МетодГ().Наблюдать();
```

---

## Жизненный цикл и обработчики событий

```bsl
Процедура ИсполняемыеСценарии() Экспорт

    ЮТТесты
        .ДобавитьТестовыйНабор("Расчёты")
            .Перед("ПередНаборомРасчёты")
            .После("ПослеКаждогоТестаОчистка")
            .ДобавитьСерверныйТест("ТестРасчётА")
            .ДобавитьСерверныйТест("ТестРасчётБ");

КонецПроцедуры

Процедура ПередНаборомРасчёты() Экспорт
    ЮТест.Контекст().УстановитьЗначение("Ставка", 18);
КонецПроцедуры
```

### Контекст — передача данных между методами

```bsl
ЮТест.Контекст().УстановитьЗначение("МоёЗначение", Данные);
Данные = ЮТест.Контекст().Значение("МоёЗначение");
```

---

## Параметризованные тесты

```bsl
Процедура ИсполняемыеСценарии() Экспорт

    Варианты = ЮТест.Варианты()
        .Добавить(0,   "Нулевое количество",  0)
        .Добавить(10,  "Положительное",       100)
        .Добавить(-5,  "Отрицательное",       0);

    ЮТТесты
        .ДобавитьТестовыйНабор("Расчёт суммы")
            .ДобавитьСерверныйТест("ТестРасчётСуммы")
                .СПараметрами(Варианты);

КонецПроцедуры

Процедура ТестРасчётСуммы(Количество, Описание, ОжидаемаяСумма) Экспорт
    Результат = МойМодуль.РассчитатьСумму(Количество);
    ЮТест.ОжидаетЧто(Результат)
        .НазваниеПроверки(Описание)
        .Равно(ОжидаемаяСумма);
КонецПроцедуры
```

---

## Антипаттерны

| Антипаттерн | Правильно |
|-------------|-----------|
| Данные в `ИсполняемыеСценарии` | Данные в теле теста или `Перед`-обработчике |
| Один тест проверяет 10 условий | Один тест — одно утверждение |
| Тест зависит от порядка выполнения | Каждый тест изолирован |
| Хардкод ссылок на объекты ИБ | Создавать через `ЮТест.Данные()` |
| Тестировать приватную логику | Тестировать через публичный интерфейс |
| Мокировать тестируемый модуль | Мокировать только *зависимости* |

---
depends_on: []
---
More from SteelMorgan/1c-agent-based-dev-framework