Обновил документацию по параметрам запуска

2024-11-24 08:22:22 +02:00 · 2023-01-31 19:09:06 +03:00 · 2023-01-31 19:09:06 +03:00 · c96c791119
commit c96c791119
parent d195475435
2 changed files with 94 additions and 65 deletions
--- a/README.md
+++ b/README.md
@ -4,9 +4,8 @@
  - [Возможности](#возможности)
 - [Пример тестового модуля](#пример-тестового-модуля)
 - [Запуск](#запуск)
-  - [Конфигурация запуска](#конфигурация-запуска)
-  - [Строка запуска предприятия](#строка-запуска-предприятия)
  - [Запуск из EDT](#запуск-из-edt)
+  - [Запуск вне EDT](#запуск-вне-edt)
 - [Благодарности](#благодарности)
 - [Лицензия](#лицензия)

@ -146,79 +145,24 @@

 ```

-После запуска тестов модуля в EDT получаем такой отчет:
+После запуска тестов модуля в EDT (используя [плагин](https://github.com/bia-technologies/edt-test-runner)) получаем такой отчет:

 ![Отчет](docs/images/report.PNG)

 ## Запуск

-Для запуска тестов необходимо запустить 1С:Предприятие с параметром `RunUnitTests`, при необходимости можно указать путь к файлу конфигурации запуска.
-
-### Конфигурация запуска
-
-Конфигурация настраивается в файле json и может иметь следующие параметры:
-
-| Имя параметра     | Тип       | Значение по умолчанию | Описание                                                                                                     |
-|-------------------|-----------|-----------------------|--------------------------------------------------------------------------------------------------------------|
-| `filter`          | `Object`  | Object, смотрите ниже | Параметры фильтрации, поиска тестов                                                                          |
-| `reportFormat`    | `String`  | `"jUnit"`             | Формат отчета о тестировании, возможные значения: `"jUnit"`, `"JSON"`                                        |
-| `reportPath`      | `String`  | `""`                  | Путь к формируемому отчету, можно указать или каталог (в которому будет создан файл отчета) или путь к файлу |
-| `closeAfterTests` | `Boolean` | `True`                | Признак закрытия 1С:Предприятие по завершению тестирования                                                   |
-| `showReport`      | `Boolean` | `True`                | Открыть форму отчета завершению тестирования                                                                 |
-
-Параметры фильтрации:
-
-| Имя параметра | Тип     | Значение по умолчанию | Описание                                                                                                                    |
-|---------------|---------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------|
-| `extensions`  | `Array` | `["tests"]`           | Список имен расширений, из которых грузятся тесты                                                                           |
-| `modules`     | `Array` | `Null`                | Список имен модулей, из которых грузятся тесты                                                                              |
-| `suites`      | `Array` | `Null`                | **Не реализованно.** Список имен тестовых наборов, которые будут запускаться                                                |
-| `tags`        | `Array` | `Null`                | **Не реализованно.** Список тегов, которые будут запускаться                                                                |
-| `contexts`    | `Array` | `Null`                | **Не реализованно.**  Список имен контекстов исполнения, в которых будут запускаться тесты                                  |
-| `paths`       | `Array` | `Null`                | **Не реализованно.** Список полных путей к исполняемым тестам (`[имя модуля.имя теста|имя модуля.имя теста.имя контекста]`) |
-
-Примеры:
-
-1. Запустить тесты из расширения `tests`, расположенные в модулях `МодульТестов1`, `МодульТестов2`, закрыть предприятие по завершении и сохранить отчет в формате `junit`
-
-    ```JSON
-    {
-        "filter": {
-            "modules": ["МодульТестов1", "МодульТестов2"]
-        },
-        "reportPath": "C:\\temp\\jUnit\\report.xml",
-        "reportFormat": "jUnit",
-        "closeAfterTests": true
-    }
-    ```
-
-2. Запустить все тесты из расширения `YAXUNIT` и сохранить отчет файл `C:\temp\jUnit\report.xml`, остальные параметры будут установлены по умолчанию
-
-    ```JSON
-    {
-        "filter": {
-            "extensions": ["YAXUNIT"]
-        },
-        "reportPath": "C:\\temp\\jUnit\\report.xml"
-    }
-    ```
-
-### Строка запуска предприятия
-
-`[путь к клиенту 1С] ENTERPRISE [Параметры подключения к ИБ] [Параметры авторизации] /C RunUnitTests=/путь/к/конфигурационному/файлу`
-
-*После загрузки расширения в информационную базу необходимо отключить у него `безопасный режим` и `защиту от опасных действий`*
-
-Пример:
-
-`"C:\Program Files\1cv8\8.3.18.1698\bin\1cv8c.exe" ENTERPRISE /IBName MyInfoBase /N Admin /C RunUnitTests=C:\tmp\test-config.json`
-  Запуск тестов в режиме тонкого клиента на информационной базе `MyInfoBase` под пользователем `Admin` по конфигурации указанной в файле `C:\tmp\test-config.json`
-
 ### Запуск из EDT

 При разработке в EDT процесс запуска тестов можно упростить, установив [плагин](https://github.com/bia-technologies/edt-test-runner)
 и настроив конфигурацию запуска, как указано в описании плагина.

+### Запуск вне EDT
+
+Для запуска тестов без использования EDT необходимо:
+
+1. Сформировать файл конфигурации запуска [вручную](docs/run.md), либо воспользоваться [формой настройки](docs/yaxunit-ui.md)
+2. [Запустить 1С:Предприятие](docs/run.md) с параметром `RunUnitTests=ПутьКФайлуКонфигурации.json`.
+
 ## Благодарности

 Приносим благодарность всему [open-source сообществу 1с](https://github.com/topics/1c-enterprise) за идеи и мотивацию.
--- a/docs/run.md
+++ b/docs/run.md
@ -0,0 +1,85 @@
+# Запуск
+
+Для запуска тестов необходимо запустить 1С:Предприятие с параметром `RunUnitTests`, при необходимости можно указать путь к файлу конфигурации запуска.
+
+## Конфигурация запуска
+
+Конфигурация настраивается в файле json и может иметь следующие параметры:
+
+| Имя параметра     | Тип       | Значение по умолчанию | Описание                                                                                                     |
+|-------------------|-----------|-----------------------|--------------------------------------------------------------------------------------------------------------|
+| `filter`          | `Object`  | Object, смотрите ниже | Параметры фильтрации, поиска тестов                                                                          |
+| `reportFormat`    | `String`  | `"jUnit"`             | Формат отчета о тестировании, возможные значения: `"jUnit"`, `"JSON"`                                        |
+| `reportPath`      | `String`  | `""`                  | Путь к формируемому отчету, можно указать или каталог (в которому будет создан файл отчета) или путь к файлу |
+| `closeAfterTests` | `Boolean` | `True`                | Признак закрытия 1С:Предприятие по завершению тестирования                                                   |
+| `showReport`      | `Boolean` | `True`                | Открыть форму отчета завершению тестирования                                                                 |
+| `logging`         | `Object`  | Смотрите ниже         | Параметры логирования, подробнее ниже                                                                        |
+
+Параметры фильтрации:
+
+| Имя параметра | Тип     | Значение по умолчанию | Описание                                                                                                                    |
+|---------------|---------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------|
+| `extensions`  | `Array` | `["tests"]`           | Список имен расширений, из которых грузятся тесты                                                                           |
+| `modules`     | `Array` | `Null`                | Список имен модулей, из которых грузятся тесты                                                                              |
+| `tests`       | `Array` | `Null`                | Список полных путей к исполняемым тестам (`[имя модуля.имя теста]`) |
+| `suites`      | `Array` | `Null`                | **Не реализованно.** Список имен тестовых наборов, которые будут запускаться                                                |
+| `tags`        | `Array` | `Null`                | **Не реализованно.** Список тегов, которые будут запускаться                                                                |
+| `contexts`    | `Array` | `Null`                | Список имен контекстов исполнения, в которых будут запускаться тесты                                  |
+| `paths`       | `Array` | `Null`                | **Не реализованно.** Список полных путей к исполняемым тестам (`[имя модуля.имя теста|имя модуля.имя теста.имя контекста]`) |
+
+Параметры логирования:
+
+| Имя параметра | Тип       | Значение по умолчанию | Описание                                                            |
+|---------------|-----------|-----------------------|---------------------------------------------------------------------|
+| `file`        | `String`  | `""`                  | Путь к файлу лога                   |
+| `enable`      | `Boolean` | `Null`                | Признак использования логирования. Если не указан, зависит от файла, если он указан - вкл, если не указан - выкл                     |
+| `level`       | `String`  | `"debug"`             | Уровень детализации лога. Возможные значения: `"debug"`, `"info"`, `"error"` |
+
+Примеры:
+
+1. Запустить тесты из расширения `tests`, расположенные в модулях `МодульТестов1`, `МодульТестов2`, закрыть предприятие по завершении и сохранить отчет в формате `junit`
+
+    ```JSON
+    {
+        "filter": {
+            "modules": ["МодульТестов1", "МодульТестов2"]
+        },
+        "reportPath": "C:\\temp\\jUnit\\report.xml",
+        "reportFormat": "jUnit",
+        "closeAfterTests": true
+    }
+    ```
+
+2. Запустить все тесты из расширения `YAXUNIT` и сохранить отчет файл `C:\temp\jUnit\report.xml`, остальные параметры будут установлены по умолчанию
+
+    ```JSON
+    {
+        "filter": {
+            "extensions": ["YAXUNIT"]
+        },
+        "reportPath": "C:\\temp\\jUnit\\report.xml"
+    }
+    ```
+
+3. Запустить все тесты с выводом подробного лога в файл, сохранить отчет файл `C:\temp\jUnit\report.xml`
+
+    ```JSON
+    {
+        "reportPath": "C:\\temp\\jUnit\\report.xml",
+        "logging": {
+            "file": "C:\\temp\\jUnit\\tests.log",
+            "level": "debug"
+        }
+    }
+    ```
+
+## Строка запуска предприятия
+
+`[путь к клиенту 1С] ENTERPRISE [Параметры подключения к ИБ] [Параметры авторизации] /C RunUnitTests=/путь/к/конфигурационному/файлу`
+
+*После загрузки расширения в информационную базу необходимо отключить у него `безопасный режим` и `защиту от опасных действий`*
+
+Пример:
+
+`"C:\Program Files\1cv8\8.3.18.1698\bin\1cv8c.exe" ENTERPRISE /IBName MyInfoBase /N Admin /C RunUnitTests=C:\tmp\test-config.json`
+  Запуск тестов в режиме тонкого клиента на информационной базе `MyInfoBase` под пользователем `Admin` по конфигурации указанной в файле `C:\tmp\test-config.json`