diff --git a/content/documentation/admin/actions/types.ru.md b/content/documentation/admin/actions/types.ru.md index d18ad2b..8493ea1 100644 --- a/content/documentation/admin/actions/types.ru.md +++ b/content/documentation/admin/actions/types.ru.md @@ -1387,3 +1387,64 @@ name: my-repo-to-delete ### Документация API - [Nexus 3 REST API: Repository Management](https://help.sonatype.com/en/repositories-api.html) + +## CreateTestOpsLaunch + +CreateTestOpsLaunch — создает новый launch (запуск тестов) в системе TestOps (Allure TestOps). Действие использует TestOps API для создания launch с указанными параметрами. + +### Пример запроса + +```yaml +projectId: 1 +name: Example Launch +testPlanId: 5 +testCaseIds: + - 10 + - 11 + - 12 +``` + +### Спецификация запроса + +| Название | Обязательность | Описание | +|-----------------|-----------------|------------------------------------------------------------------------------| +| projectId | **обязательно** | Идентификатор проекта в TestOps, для которого создается launch | +| name | **обязательно** | Название launch | +| testPlanId | опционально | Идентификатор тест-плана, который будет использован при создании launch | +| testCaseIds | опционально | Список идентификаторов тест-кейсов, которые будут включены в launch | + +### Учетные данные + +* **token** — API токен пользователя TestOps, от имени которого будет запускаться выполнение действия. + +### Примечание + +Для выполнения действия необходимо наличие корректных реквизитов с TestOps API token. Этот токен передается через механизм учетных данных и используется для аутентификации при вызове TestOps API (HTTP-заголовок `Authorization: Bearer `). + +Действие осуществляет POST-запрос по URL: `/api/rs/launch`. В случае успешного создания launch TestOps возвращает информацию о созданном launch, включая его идентификатор. + +## CloseTestOpsLaunch + +CloseTestOpsLaunch — закрывает существующий launch в системе TestOps (Allure TestOps). Действие использует TestOps API для закрытия launch по его идентификатору. + +### Пример запроса + +```yaml +launchId: 123 +``` + +### Спецификация запроса + +| Название | Обязательность | Описание | +|-----------------|-----------------|------------------------------------------------------------------------------| +| launchId | **обязательно** | Идентификатор launch, который необходимо закрыть | + +### Учетные данные + +* **token** — API токен пользователя TestOps, от имени которого будет запускаться выполнение действия. + +### Примечание + +Для выполнения действия необходимо наличие корректных реквизитов с TestOps API token. Этот токен передается через механизм учетных данных и используется для аутентификации при вызове TestOps API (HTTP-заголовок `Authorization: Bearer `). + +Действие осуществляет POST-запрос по URL: `/api/rs/launch/{launchId}/close`. В случае успешного закрытия launch действие возвращает подтверждение закрытия. diff --git a/content/documentation/admin/healthchecks/types.ru.md b/content/documentation/admin/healthchecks/types.ru.md index 19d62e3..ec01271 100644 --- a/content/documentation/admin/healthchecks/types.ru.md +++ b/content/documentation/admin/healthchecks/types.ru.md @@ -261,3 +261,59 @@ name: "{{ .entity.name }}" ```go https://api.example.com/{{ .entity.slug }}/health ``` + +## TestOps + +Правило типа **TestOps** проверяет статистику выполнения тестов в системе TestOps (Allure TestOps) на основе заданных условий. Проверка выполняется для указанного проекта и запуска (launch), либо для последнего запуска проекта. + +Во всех текстовых полях поддерживается шаблонизация, например, можно подставить ID проекта из параметров сущности: + +```go +{{ .entity.properties.testops_project_id }} +``` + +### Параметры конфигурации + +| Название | Опциональность | Описание | Возможные значения | +|---------------------|-----------------|-----------------------------------------------------------------------------|---------------------| +| ID проекта | **обязательно** | Идентификатор проекта в TestOps | | +| ID запуска | опционально | ID конкретного запуска для проверки. Если не указан, проверяется последний запуск | | +| Условия | **обязательно** | Условия для сравнения статистики выполнения тестов | | + +#### Условия + +Каждое условие представляет объект следующей формы: + +```yaml +conditions: + - status: passed + operator: ">=" + value: "90" + - status: failed + operator: "<" + value: "5" + - status: passRate + operator: ">=" + value: "95" +``` + +| Поле | Описание | Возможные значения | +|-----------|----------------------------------------------------------------|-----------------------------------------------------------------------------------| +| Статус | Тип статистики для проверки | passed, failed, broken, skipped, total, passRate | +| Оператор | Оператор сравнения | ==, !=, <, <=, >, >= | +| Значение | Целевое значение для сравнения | | + +**Возможные значения статуса:** + +- **passed** — количество успешно пройденных тестов +- **failed** — количество проваленных тестов +- **broken** — количество сломанных тестов +- **skipped** — количество пропущенных тестов +- **total** — общее количество тестов в запуске +- **passRate** — процент успешно пройденных тестов (вычисляется как `passed / total * 100`) + +### Авторизация + +Конфигурация авторизации описана в разделе [внешний сервис TestOps](../external-services/#testops). + +> Для проверки каждой сущности выполняется отдельный запрос к TestOps. Рекомендуется учитывать это при планировании нагрузки на систему. diff --git a/content/documentation/admin/widgets/types.ru.md b/content/documentation/admin/widgets/types.ru.md index 9e46e6f..931fb47 100644 --- a/content/documentation/admin/widgets/types.ru.md +++ b/content/documentation/admin/widgets/types.ru.md @@ -1180,3 +1180,135 @@ sum(ingress_nginx_detail_requests_total) ### Конфигурация Виджет не требует дополнительной конфигурации и работает сразу после добавления на дашборд. + +## TestOps. Статистика тест-кейсов + +Виджет позволяет отображать статистику тест-кейсов проекта в системе TestOps (Allure TestOps) с разбивкой по статусам. + +### Авторизация + +Конфигурация авторизации описана в разделе [внешний сервис TestOps](../external-services/#testops). + +### Конфигурация + +| Название | Опциональность | Описание | Значение по умолчанию | +|-----------------|-----------------|-----------------------------------------------------------------------------|-----------------------| +| URL | **обязательно** | URL TestOps API. Используется для получения данных из TestOps | - | +| ID проекта | **обязательно** | ID проекта в TestOps, из которого будут загружаться данные в виджет | - | +| Тег | опционально | Фильтр по тегу для фильтрации тест-кейсов | - | + +### Параметры запроса + +| Название | Опциональность | Описание | Значение по умолчанию | +|-----------------|-----------------|-----------------------------------------------------------------------------|-----------------------| +| Страница | опционально | Номер страницы для пагинации | 0 | +| Элементов на странице | опционально | Количество элементов на странице | 100 | + +### Отображаемые данные + +Виджет отображает следующую статистику: + +- **Общее количество** — общее количество тест-кейсов в проекте +- **Пройдено** — количество тест-кейсов со статусом "Passed" +- **Провалено** — количество тест-кейсов со статусом "Failed" +- **Сломано** — количество тест-кейсов со статусом "Broken" +- **Пропущено** — количество тест-кейсов со статусом "Skipped" +- **Черновик** — количество тест-кейсов со статусом "Draft" +- **По статусам** — распределение тест-кейсов по всем статусам + +## TestOps. Статистика запусков + +Виджет позволяет отображать статистику запусков тестов (launches) в системе TestOps (Allure TestOps) с информацией о результатах выполнения тестов. + +### Авторизация + +Конфигурация авторизации описана в разделе [внешний сервис TestOps](../external-services/#testops). + +### Конфигурация + +| Название | Опциональность | Описание | Значение по умолчанию | +|-----------------|-----------------|-----------------------------------------------------------------------------|-----------------------| +| URL | **обязательно** | URL TestOps API. Используется для получения данных из TestOps | - | +| ID проекта | **обязательно** | ID проекта в TestOps, из которого будут загружаться данные в виджет | - | + +### Параметры запроса + +| Название | Опциональность | Описание | Значение по умолчанию | +|-----------------|-----------------|-----------------------------------------------------------------------------|-----------------------| +| ID запуска | опционально | ID конкретного запуска для отображения статистики. Если не указан, отображается последний запуск | - | + +### Отображаемые данные + +Виджет отображает следующую статистику для выбранного запуска: + +- **Пройдено** — количество успешно пройденных тестов +- **Провалено** — количество проваленных тестов +- **Сломано** — количество сломанных тестов +- **Пропущено** — количество пропущенных тестов +- **Всего** — общее количество тестов в запуске +- **Процент успеха** — процент успешно пройденных тестов от общего количества + +## TestOps. Результаты тестов + +Виджет позволяет отображать детальную информацию о результатах выполнения тестов в системе TestOps (Allure TestOps). + +### Авторизация + +Конфигурация авторизации описана в разделе [внешний сервис TestOps](../external-services/#testops). + +### Конфигурация + +| Название | Опциональность | Описание | Значение по умолчанию | +|-----------------|-----------------|-----------------------------------------------------------------------------|-----------------------| +| URL | **обязательно** | URL TestOps API. Используется для получения данных из TestOps | - | +| ID проекта | **обязательно** | ID проекта в TestOps, из которого будут загружаться данные в виджет | - | + +### Параметры запроса + +| Название | Опциональность | Описание | Значение по умолчанию | +|-----------------|-----------------|-----------------------------------------------------------------------------|-----------------------| +| ID запуска | опционально | ID запуска, для которого отображаются результаты. Если не указан, отображаются результаты последнего запуска | - | +| Страница | опционально | Номер страницы для пагинации | 0 | +| Элементов на странице | опционально | Количество элементов на странице | 100 | + +### Отображаемые данные + +Для каждого результата теста отображается: + +- **ID результата** — уникальный идентификатор результата +- **ID тест-кейса** — идентификатор связанного тест-кейса +- **ID запуска** — идентификатор запуска, к которому относится результат +- **Статус** — статус выполнения теста (Passed, Failed, Broken, Skipped) +- **Длительность** — время выполнения теста +- **Сообщение** — дополнительное сообщение о результате выполнения + +## TestOps. Тренды тестов + +Виджет позволяет отображать тренды выполнения тестов в системе TestOps (Allure TestOps) за выбранный период времени. + +### Авторизация + +Конфигурация авторизации описана в разделе [внешний сервис TestOps](../external-services/#testops). + +### Конфигурация + +| Название | Опциональность | Описание | Значение по умолчанию | +|-----------------|-----------------|-----------------------------------------------------------------------------|-----------------------| +| URL | **обязательно** | URL TestOps API. Используется для получения данных из TestOps | - | +| ID проекта | **обязательно** | ID проекта в TestOps, из которого будут загружаться данные в виджет | - | + +### Параметры запроса + +| Название | Опциональность | Описание | Значение по умолчанию | +|-----------------|-----------------|-----------------------------------------------------------------------------|-----------------------| +| Дата от | опционально | Начальная дата для анализа трендов | 30 дней назад | +| Дата до | опционально | Конечная дата для анализа трендов | текущая дата | + +### Отображаемые данные + +Виджет отображает графики и статистику, показывающие: + +- **Динамику выполнения тестов** — изменение количества пройденных, проваленных, сломанных и пропущенных тестов во времени +- **Процент успеха** — изменение процента успешно пройденных тестов +- **Тренды по статусам** — визуализация изменений в распределении тестов по статусам +- **Сравнение запусков** — сравнение результатов различных запусков тестов