Интеграция с Allure TestOps
Интеграция с Allure TestOps позволяет автоматически экспортировать тест-кейсы и запуски из ТестОпс в Allure TestOps. Вы можете использовать Allure Query Language, чтобы выбрать нужный набор данных для экспорта.
Примечание
Чтобы настроить или удалить интеграцию в ТестОпс, вы должны иметь доступ к разделам:
- Администрирование — необходимы права администратора инстанса;
- Настройки в конкретном проекте — необходима роль владельца этого проекта.
Настройка интеграции
Чтобы настроить интеграцию с Allure TestOps:
Создайте API-токен в Allure TestOps.
На уровне инстанса ТестОпс добавьте интеграцию с Allure TestOps, указав:
- название интеграции;
- URL-адрес Allure TestOps.
На уровне инстанса или проекта ТестОпс включите добавленную интеграцию для проекта, указав созданный API-токен из Allure TestOps.
Cоздайте одну или несколько конфигураций экспорта в настройках интеграции.
1. Создайте API-токен в Allure TestOps
Перейдите в ваш инстанс Allure TestOps.
Нажмите на ваш аватар и перейдите в раздел API tokens.
Нажмите + Token.
Введите название токена, которое поможет вам распознать интеграцию, например, Token for TestOps.
Нажмите Create.
Allure TestOps сгенерирует токен и отобразит его в модальном окне.
Нажмите иконку Copy, чтобы скопировать токен в буфер обмена.
Cохраните токен в безопасном месте, он понадобится для настройки интеграции в проекте ТестОпс.
2. Добавьте интеграцию с Allure TestOps в ТестОпс
Перейдите в ваш инстанс ТестОпс.
Перейдите в раздел Администрирование → Интеграции.
Нажмите + Добавить интеграцию в правом верхнем углу.
В списке доступных интеграций выберите Allure TestOps.
Заполните поля:
- Название — название, которое поможет вам распознать интеграцию, например, Allure TestOps production.
- Endpoint — URL-адрес вашего инстанса Allure TestOps, например, https://allure-testops.example.com.
Если ваш инстанс Allure TestOps использует самоподписанный SSL-сертификат, поставьте галочку напротив Отключить проверку сертификата.
Нажмите Добавить интеграцию.
3. Включите интеграцию для проекта ТестОпс
Чтобы включить интеграцию в нужном проекте ТестОпс, воспользуйтесь одним из способов:
- Перейдите в раздел Администрирование → Интеграции.
- В списке настроенных интеграций найдите и откройте вашу интеграцию с Allure TestOps.
- Перейдите на вкладку Проекты.
- Справа от поля поиска нажмите
+. - В выпадающем списке Проект выберите нужный проект ТестОпс.
- В поле API-токен введите API-токен, который вы сохранили на шаге 1.
- Нажмите Проверить соединение. Если API-токен указан верно, через несколько секунд появится сообщение «Соединение установлено».
- Нажмите Добавить интеграцию.
4. Создайте конфигурацию экспорта в ТестОпс
Перейдите в ваш проект ТестОпс.
Перейдите в раздел Настройки → Интеграции.
В секции Добавленные интеграции найдите и откройте вашу интеграцию с Allure TestOps.
Перейдите на вкладку Синхронизация с TMS.
Нажмите + Создать.
В открывшемся окне заполните поля:
Project — укажите проект Allure TestOps, в который будут экспортироваться данные.
Test Case AQL — введите AQL-запрос, чтобы отфильтровать тест-кейсы, которые вы хотите экспортировать. Оставьте поле пустым, чтобы экспортировать все тест-кейсы.
Launches AQL — введите AQL-запрос, чтобы отфильтровать запуски, которые будут экспортированы для выбранных тест-кейсов. Оставьте поле пустым, чтобы экспортировать все запуски.
Disable Launches sync — поставьте галочку, если вы хотите отключить экспорт всех запусков.
Email for notifications — укажите электронную почту для получения уведомлений от интеграции, если синхронизация с Allure TestOps автоматически отключится (подробнее см. Автоматическое отключение синхронизации).
Все поля в секции Settings — настройте маппинг, чтобы экспортировать атрибуты тест-кейсов:
- статусы (Status Mapping);
- воркфлоу (Workflow Mapping);
- тестовые слои (Test Layer Mapping);
- кастомные поля (Custom Field Mapping);
- роли участников (Role (Test Case Members) Mapping).
Подробнее см. Маппинг атрибутов тест-кейсов. Оставьте поля пустыми, чтобы не экспортировать атрибуты тест-кейсов.
Нажмите Отправить.
После создания конфигурации и успешного экспорта тест-кейсов, вы можете отключить экспорт новых тест-кейсов, соответствующих этой конфигурации. Для этого:
- На вкладке Синхронизация с TMS откройте нужную конфигурацию экспорта.
- Поставьте галочку напротив Disable Test Case create — будут экспортироваться только изменения и запуски ранее экспортированных тест-кейсов.
Чтобы отключить конфигурацию экспорта, не удаляя ее:
- На вкладке Синхронизация с TMS откройте нужную конфигурацию экспорта.
- Поставьте галочку напротив Disable export.
Маппинг атрибутов тест-кейсов
Тест-кейсы в ТестОпс и Allure TestOps могут иметь разные наборы атрибутов. Например, если вы создадите новый статус для тест-кейсов в ТестОпс и попытаетесь экспортировать тест-кейс с этим статусом, Allure TestOps не сможет его обработать.
По умолчанию интеграция с Allure TestOps игнорирует все значения атрибутов тест-кейсов, включая встроенные, например, статусы «Черновик», «Ревью». Чтобы это изменить, создайте маппинг, который укажет, как атрибуты из ТестОпс должны обрабатываться в Allure TestOps.
Определение ID значений атрибутов
Перед тем как создать маппинг, определите ID всех значений атрибутов, которые должны обрабатываться при экспорте:
Чтобы узнать ID статусов тест-кейсов в ТестОпс:
- Перейдите в раздел Администрирование → Статусы.
- Слева от названия статуса найдите его ID.
Аналогичным способом вы можете найти ID статусов в Allure TestOps.
Чтобы узнать ID воркфлоу, тестовых слоев, кастомных полей и ролей участников, воспользуйтесь API-запросами в ТестОпс и Allure TestOps.
Cохраните полученные ID, они понадобятся во время создания маппинга атрибутов.
Создание маппинга атрибутов
Перейдите в ваш проект ТестОпс.
Перейдите в раздел Настройки → Интеграции.
В секции Добавленные интеграции найдите и откройте вашу интеграцию с Allure TestOps.
Перейдите на вкладку Синхронизация с TMS.
Откройте нужную конфигурацию экспорта.
В открывшемся окне заполните поля для атрибутов тест-кейсов:
Map as identity. Useful for system entities or self-export — поставьте галочку, чтобы экспортировать встроенные значения атрибутов автоматически, без необходимости создавать маппинги.
Например, если вы поставите эту галочку для атрибута Status Mapping, статус тест-кейса «Черновик» будет экспортироваться как "Draft", «Ревью» — как "Review".
Default value — укажите значение атрибута (его ID) из Allure TestOps, которое будет использоваться по умолчанию, если в настройках маппинга не указано иное значение.
Например, если для Status Mapping вы укажете статус "Review" как значение по умолчанию и оставите пустыми остальные настройки маппинга, все экспортированные тест-кейсы будут иметь статус "Review".
Mappings — нажмите + Добавить, чтобы создать маппинг:
Автоматическое отключение синхронизации
Синхронизация ТестОпс с Allure TestOps автоматически отключится, если API-токен, указанный на шаге 3, недействителен, был отозван или имеет недостаточный уровень доступа.
Чтобы возобновить синхронизацию, введите актуальный API-токен с достаточным уровнем доступа.
Удаление интеграции
Вы можете удалить интеграцию с Allure TestOps двумя способами — на уровне всего инстанса ТестОпс (через раздел Администрирование) или на уровне отдельного проекта (через настройки проекта).
Важно
Последствия удаления интеграции:
Удаление на уровне инстанса — все связи с тест-кейсами Allure TestOps, которые относятся к интеграции, будут удалены из сущностей ТестОпс. Это действие необратимо — восстановить удаленные ссылки будет невозможно.
Удаление на уровне проекта — все связи с тест-кейсами Allure TestOps, которые относятся к интеграции, будут сохранены в сущностях ТестОпс, но вы не сможете создавать новые связи для этого проекта. Дополнительно в проекте будет отключена синхронизация с Allure TestOps.
Перейдите в раздел Администрирование → Интеграции.
В списке настроенных интеграций найдите и откройте вашу интеграцию с Allure TestOps.
Перейдите на вкладку Проекты и убедитесь, что интеграция не используется в проектах ТестОпс.
Если интеграция подключена к проектам, удалите ее из них. Для этого напротив названия каждого проекта нажмите иконку корзины → Удалять.
Перейдите на вкладку Конфигурация.
Нажмите Удалить интеграцию.
Нажмите Удалить.