Merge branch 'develop'

readme.md

@@ -1,12 +1,18 @@
-[![Статус Порога Качества](https://sonar.openbsl.ru/api/project_badges/measure?project=1testrunner&metric=alert_status)](https://sonar.openbsl.ru/dashboard?id=1testrunner) [![Покрытие](https://sonar.openbsl.ru/api/project_badges/measure?project=1testrunner&metric=coverage)](https://sonar.openbsl.ru/dashboard?id=1testrunner) [![Строки кода](https://sonar.openbsl.ru/api/project_badges/measure?project=1testrunner&metric=ncloc)](https://sonar.openbsl.ru/dashboard?id=1testrunner) [![GitHub release](https://img.shields.io/github/release/artbear/1testrunner.svg)](https://github.com/artbear/1testrunner/releases) [![Build Status](http://build.oscript.io/buildStatus/icon?job=oscript-library/1testrunner/develop)](http://build.oscript.io/job/oscript-library/job/1testrunner/job/develop/) [![Build status](https://ci.appveyor.com/api/projects/status/7sgdu30u1yqbot4m?svg=true)](https://ci.appveyor.com/project/artbear/1testrunner) [![Build Status](https://travis-ci.org/artbear/1testrunner.svg)](https://travis-ci.org/artbear/1testrunner)
+[![Статус Порога Качества](https://sonar.openbsl.ru/api/project_badges/measure?project=1testrunner&metric=alert_status)](https://sonar.openbsl.ru/dashboard?id=1testrunner)
+[![Покрытие](https://sonar.openbsl.ru/api/project_badges/measure?project=1testrunner&metric=coverage)](https://sonar.openbsl.ru/dashboard?id=1testrunner)
+[![Строки кода](https://sonar.openbsl.ru/api/project_badges/measure?project=1testrunner&metric=ncloc)](https://sonar.openbsl.ru/dashboard?id=1testrunner)
+[![GitHub release](https://img.shields.io/github/release/artbear/1testrunner.svg)](https://github.com/artbear/1testrunner/releases)
+[![Build Status](http://build.oscript.io/buildStatus/icon?job=oscript-library/1testrunner/develop)](http://build.oscript.io/job/oscript-library/job/1testrunner/job/develop/)
+[![Build status](https://ci.appveyor.com/api/projects/status/7sgdu30u1yqbot4m?svg=true)](https://ci.appveyor.com/project/artbear/1testrunner)
+[![Build Status](https://travis-ci.org/artbear/1testrunner.svg)](https://travis-ci.org/artbear/1testrunner)
 
 Организовано приемочное тестирование, аналогичное тестированию 1C в проекте [xUnitFor1C](https://github.com/xDrivenDevelopment/xUnitFor1C/wiki)
 
 Основные принципы работы с тестами для скриптов OneScript описаны в [официальной документации OneScript](http://oscript.io/docs/page/testing)
 
 # Использование тестирования (выдержка из документации OneScript)
 
-## Пример запуска всех приемочных тестов ###
+## Пример запуска всех приемочных тестов
 
 Проверить все файлы текущего каталога из командной строки (с паузой, если есть упавшие тесты):
 
@@ -20,9 +26,9 @@
 
     cmd /c C:\Projects\1script\tests\start-all.cmd . notpause
 
-## Запуск тестов ###
+## Запуск тестов
 
-### Формат командной строки:
+### Формат командной строки
 
     1testrunner [-command] testfile|testdir [test-id|test-number] [-option [optionData]]
 
@@ -41,7 +47,7 @@
 * `xddReportPath` - формировать отчет тестирования в формате junit-xml
 * * [optionData] - полный или относительный путь к каталогу, где формировать файл *.xml
 
-### Примеры:
+### Примеры
 
 * `1testrunner -show testfile` - вывод списка тестов
 * `1testrunner testfile` или `1testrunner -run testfile` - запуск всех тестов из файла
@@ -51,7 +57,7 @@
 * `1testrunner -runall tests` - запуск всех тестов из каталога tests
 * `1testrunner -runall tests xddReportPath .` - запуск всех тестов из каталога tests и формирование отчета тестирования в формате  junit-xml
 
-### Формат скриптов-тестов
+### Формат скриптов-тестов (предопределенные методы)
 
 Тесты находятся в каталоге `tests`
 
@@ -65,21 +71,125 @@
 // основной метод для тестирования
 Функция ПолучитьСписокТестов(ЮнитТестирование) Экспорт
 
-	юТест = ЮнитТестирование;
+    юТест = ЮнитТестирование;
 
-	ВсеТесты = Новый Массив;
+    ВсеТесты = Новый Массив;
+    ВсеТесты.Добавить("ТестДолжен_ПроверитьВерсию");
 
-	ВсеТесты.Добавить("ТестДолжен_ПроверитьВерсию");
+    Возврат ВсеТесты;
+КонецФункции
+
+// вызывается 1 раз перед выполнением всех тестов в файле
+// для инициализации окружения, общего для всех тестов
+//
+Процедура ПередЗапускомТестов() Экспорт
+
+КонецПроцедуры
+
+// вызывается перед выполнением каждого тестового метода
+// для выполнения общих действий перед каждым тестом
+//
+Процедура ПередЗапускомТеста() Экспорт
+
+КонецПроцедуры
+
+// вызывается после выполнения каждого тестового метода
+// для выполнения общих действий после каждого теста
+//
+Процедура ПослеЗапускаТеста() Экспорт
+
+КонецПроцедуры
+
+// вызывается 1 раз после выполнения всех тестов в файле
+// для выполнения общих действий после всех тестов, например, освобождения ресурсов
+//
+Процедура ПослеЗапускаТестов() Экспорт
 
-	Возврат ВсеТесты;
+КонецПроцедуры
+
+Процедура ТестДолжен_ПроверитьВерсию() Экспорт
+    Утверждения.ПроверитьРавенство("0.1", Версия());
+КонецПроцедуры
+
+Функция Версия() Экспорт
+    Возврат "0.1";
 КонецФункции
+```
+
+### Формат скриптов-тестов (аннотированные методы)
+
+Для удобства написания тестов возможно использование анотаций методов в файле тестов:
+
+* &Инициализация
+* &Завершение
+* &Перед
+* &После
+* &Тест
+* &Параметры
 
+См. пример.
+
+```bsl
+#Использовать asserts
+
+Перем юТест;
+
+// вызывается 1 раз перед выполнением всех тестов в файле
+// для инициализации окружения, общего для всех тестов
+// возможно последовательное выполнение нескольких методов с аннотацией &Инициализация
+//
+&Инициализация
+Процедура ПередЗапускомТестов() Экспорт
+
+    юТест = ЮнитТестирование;
+
+КонецПроцедуры
+
+// вызывается перед выполнением каждого тестового метода
+// для выполнения общих действий перед каждым тестом
+// возможно последовательное выполнение нескольких методов с аннотацией &Перед
+//
+&Перед
+Процедура ПередЗапускомТеста() Экспорт
+
+КонецПроцедуры
+
+// вызывается после выполнения каждого тестового метода
+// для выполнения общих действий после каждого теста
+// возможно последовательное выполнение нескольких методов с аннотацией &После
+//
+&После
+Процедура ПослеЗапускаТеста() Экспорт
+
+КонецПроцедуры
+
+// вызывается 1 раз после выполнения всех тестов в файле
+// для выполнения общих действий после всех тестов, например, освобождения ресурсов
+// возможно последовательное выполнение нескольких методов с аннотацией &Завершение
+//
+&Завершение
+Процедура ПослеЗапускаТестов() Экспорт
+
+КонецПроцедуры
+
+&Тест
 Процедура ТестДолжен_ПроверитьВерсию() Экспорт
-	Утверждения.ПроверитьРавенство("0.1", Версия());
+    Утверждения.ПроверитьРавенство("0.1", Версия());
+КонецПроцедуры
+
+// возможна передача параметров теста через аннотацию &Параметры
+// тест будет вызван для каждого набора параметров
+//
+&Тест
+&Параметры(1, 2, Ложь)
+&Параметры(1, 1, Истина)
+Процедура ТестДолжен_ВыполнитьсяСПараметрами(ПервоеЗначение, ВтороеЗначение, Ожидание) Экспорт
+    Результат = (ПервоеЗначение = ВтороеЗначение);
+    Утверждения.ПроверитьРавенство(Ожидание, Результат);
 КонецПроцедуры
 
 Функция Версия() Экспорт
-	Возврат "0.1";
+    Возврат "0.1";
 КонецФункции
 ```
 
@@ -111,6 +221,6 @@
 
 В случае ошибок в тестах/файле будет выдано окно консоли с описанием ошибки.
 
-### Пример запуска всех приемочных тестов ###
+### Для запуска всех приемочных тестов в текущем каталоге
 
     1testrunner -runall "$(CURRENT_DIRECTORY)"