Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 84 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ OneUnit поддерживает следующие аннотации для н
| `&ИнформацияОТесте` | Передает [сведения о текущем тесте или наборе](#1141-информация-о-тесте) в параметр или поле |
| `&ИнформацияОПовторении` | Передает [номер и количество повторений](#1142-информация-о-повторении) в параметр или поле |
| `&ИнформацияОПараметризованномВызове` | Передает [номер вызова и аргументы источника](#1143-информация-о-параметризованном-вызове) в параметр или поле |
| `&ВременныйКаталог` | Передает [путь к временному каталогу](#115-временные-файлы-и-каталоги) в параметр или поле |
| `&ВременныйФайл` | Передает [путь к временному файлу](#115-временные-файлы-и-каталоги) в параметр или поле |

### 1.2 Тестовые методы и наборы

Expand Down Expand Up @@ -741,6 +743,88 @@ OneUnit предоставляет возможность повторять т
не используется. Аннотация поля подходит для наборов, в которых все тесты параметризованные
и нет методов уровня набора.

### 1.15 Временные файлы и каталоги

Аннотации [`&ВременныйКаталог`](./docs/api/Аннотации/ВременныйКаталог.md) и
[`&ВременныйФайл`](./docs/api/Аннотации/ВременныйФайл.md) создают пустой каталог или файл
и передают его полный путь строкой. Их можно ставить на поля набора, параметры конструктора,
теста и методов жизненного цикла. Файлы и каталоги создаются при выполнении тестов.

Все параметры аннотаций необязательны. Ниже указаны значения по умолчанию:

```bsl
&ВременныйКаталог(Область = "Тест", Очистка = "Всегда")
&ВременныйФайл(Расширение = "tmp", Область = "Тест", Очистка = "Всегда")
```

Параметр `Расширение` у `&ВременныйФайл` задаётся без начальной точки, по умолчанию `"tmp"`.

`Область` определяет, когда создаются и удаляются временные файлы и каталоги:

| Значение | Поведение |
|---|---|
| `"Тест"` (по умолчанию) | Параметр метода или конструктора получает путь к новому файлу или каталогу при каждом вызове. Поле получает новый путь перед каждым тестом. Очистка выполняется при завершении теста, после всех методов `ПослеКаждого`. |
| `"Набор"` | Один и тот же файл или каталог для данного поля или параметра используется всеми тестами и экземплярами набора. Очистка выполняется после `ПослеВсех`. |

Например, если у параметра `ПередКаждым` указать `&ВременныйКаталог(Область = "Набор")`,
он получит один и тот же путь перед первым, вторым и остальными тестами набора.
Параметр другого метода получит путь к отдельному каталогу.

Поля одиночки с областью `"Тест"` получают новые пути перед каждым тестом.
В конструкторе одиночки, `ПередВсеми` и `ПослеВсех` файлы и каталоги обеих областей очищаются после завершения набора.
При изоляции файл или каталог создаётся в среде выполнения изолированного теста или набора.

Параметр `Очистка` позволяет оставить данные для разбора:

| Значение | Поведение |
|---|---|
| `"Всегда"` (по умолчанию) | Удалить файл или каталог независимо от результата. |
| `"ПриУспехе"` | Сохранить файл или каталог при ошибке в тесте или наборе. |
| `"Никогда"` | Сохранить файл или каталог независимо от результата. |

Пустые файлы и каталоги удаляются при любом режиме очистки.

Если каталог нужен и в `ПередКаждым`, и в тесте, объявите поле с `&ВременныйКаталог`.
OneUnit создаст каталог до вызова `ПередКаждым`. Один и тот же путь будет доступен через это поле
в `ПередКаждым`, тесте и `ПослеКаждого`:

```bsl
&ВременныйКаталог
Перем РабочийКаталог;

&ПередКаждым
Процедура Подготовить() Экспорт
Сообщить(РабочийКаталог);
КонецПроцедуры

&Тест
Процедура СохранениеДанных(&ВременныйФайл(Расширение = "json") ПутьФайла) Экспорт
Сообщить(РабочийКаталог);
Запись = Новый ЗаписьТекста(ПутьФайла, КодировкаТекста.UTF8NoBOM);
Запись.Записать("{}");
Запись.Закрыть();
КонецПроцедуры
```

В этом примере оба метода выводят один и тот же путь `РабочийКаталог`.
Для следующего теста поле получит путь к новому каталогу.

Если же поставить `&ВременныйКаталог` на параметр `ПередКаждым` и отдельно на параметр теста,
каждый из этих параметров получит свой каталог. Одинаковые имена параметров не делают путь общим.

```bsl
&ВременныйКаталог(Область = "Набор", Очистка = "ПриУспехе")
Перем ДанныеНабора;
```

Путь сохранённого файла или каталога записывается в лог на уровне `Информация` сообщением
`Сохранён временный каталог: ...` или `Сохранён временный файл: ...`.
При включённом уровне `Информация` сообщение сохраняется в выводе теста или набора и попадает в отчёты вместе с ним.

После таймаута тестовый метод может продолжать работу в фоне.
OneUnit повторяет удаление временных файлов и каталогов теста в конце набора.
Если фоновый метод работает и после завершения набора, автоматическая очистка не гарантируется.

## 2. Запуск тестов

### 2.1 Запуск тестов из командной строки
Expand Down
27 changes: 27 additions & 0 deletions docs/api/Аннотации/ВременныйКаталог.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# АннотацияВременныйКаталог

## ПриСозданииОбъекта

```bsl
// Передает путь к временному каталогу в параметр или поле набора.
// При первом обращении создаёт пустой каталог.
// Каталог удаляется при закрытии области с учётом режима очистки.
//
// Параметры:
// Область - Строка - "Тест": параметр получает путь к новому каталогу при каждом вызове
// метода или конструктора. Поле получает новый путь перед каждым тестом.
// Каталог удаляется после теста. В конструкторе одиночки, ПередВсеми и ПослеВсех - после набора.
// "Набор" использует один каталог для данного параметра или поля во всех экземплярах набора.
// Очистка - Строка - "Всегда", "ПриУспехе" или "Никогда".
// ПриУспехе сохраняет каталог при ошибке в области. Пустой каталог удаляется всегда.
// Путь оставленного каталога записывается в лог на уровне Информация.
// При включённом уровне сообщение попадает в вывод теста или набора и отчёты.
//
// Пример:
// &Тест
// Процедура Проверка(&ВременныйКаталог Каталог) Экспорт
// Сообщить(Каталог);
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Область = "Тест", Очистка = "Всегда")
```
28 changes: 28 additions & 0 deletions docs/api/Аннотации/ВременныйФайл.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# АннотацияВременныйФайл

## ПриСозданииОбъекта

```bsl
// Передает путь к временному файлу в параметр или поле набора.
// При первом обращении создаёт пустой файл.
// Файл удаляется при закрытии области с учётом режима очистки.
//
// Параметры:
// Расширение - Строка - Расширение файла без начальной точки, по умолчанию "tmp".
// Область - Строка - "Тест": параметр получает путь к новому файлу при каждом вызове
// метода или конструктора. Поле получает новый путь перед каждым тестом.
// Файл удаляется после теста. В конструкторе одиночки, ПередВсеми и ПослеВсех - после набора.
// "Набор" использует один файл для данного параметра или поля во всех экземплярах набора.
// Очистка - Строка - "Всегда", "ПриУспехе" или "Никогда".
// ПриУспехе сохраняет файл при ошибке в области. Пустой файл удаляется всегда.
// Путь оставленного файла записывается в лог на уровне Информация.
// При включённом уровне сообщение попадает в вывод теста или набора и отчёты.
//
// Пример:
// &Тест
// Процедура Проверка(&ВременныйФайл(Расширение = "json") Файл) Экспорт
// Сообщить(Файл);
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Расширение = "tmp", Область = "Тест", Очистка = "Всегда")
```
2 changes: 2 additions & 0 deletions lib.config
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
<class name="АннотацияВыключен" file="src/core/Классы/АннотацияВыключен.os"/>
<class name="АннотацияВыключенДляOneScript" file="src/core/Классы/АннотацияВыключенДляOneScript.os"/>
<class name="АннотацияВыключенЕсли" file="src/core/Классы/АннотацияВыключенЕсли.os"/>
<class name="АннотацияВременныйКаталог" file="src/core/Классы/АннотацияВременныйКаталог.os"/>
<class name="АннотацияВременныйФайл" file="src/core/Классы/АннотацияВременныйФайл.os"/>
<class name="АннотацияВыключенНаОС" file="src/core/Классы/АннотацияВыключенНаОС.os"/>
<class name="АннотацияИсточникВыражение" file="src/core/Классы/АннотацияИсточникВыражение.os"/>
<class name="АннотацияИсточникЗначение" file="src/core/Классы/АннотацияИсточникЗначение.os"/>
Expand Down
2 changes: 1 addition & 1 deletion packagedef
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
.ЗависитОт("logos", "1.7.1")
.ЗависитОт("optional", "2.2.1")
.ЗависитОт("semver", "1.1.1")
.ЗависитОт("tempfiles", "1.1.1")
.ЗависитОт("tempfiles", "1.2.0")

.ИсполняемыйФайл("src/cli/main.os")
;
Loading
Loading