Интеграция с Zephyr
Интеграция с Zephyr позволяет автоматически экспортировать тест-кейсы и запуски из ТестОпс в Zephyr. Вы можете использовать Allure Query Language, чтобы выбрать нужный набор данных для экспорта.
Примечание
Чтобы настроить или удалить интеграцию в ТестОпс, вы должны иметь доступ к разделам:
- Администрирование — необходимы права администратора инстанса;
- Настройки в конкретном проекте — необходима роль владельца этого проекта.
Настройка интеграции
Чтобы настроить интеграцию с Zephyr:
Создайте API-токены в Jira и Zephyr.
На уровне инстанса ТестОпс добавьте интеграцию с Zephyr, указав:
- название интеграции;
- URL-адрес Jira.
На уровне инстанса или проекта ТестОпс включите добавленную интеграцию для проекта, указав созданные API-токены из Jira и Zephyr.
Создайте одну или несколько конфигураций экспорта в настройках интеграции.
1. Создайте API-токены в Jira и Zephyr
Чтобы ТестОпс мог создавать тест-кейсы в Zephyr, вам нужно создать два API-токена: один для Jira и один для Zephyr. Кроме этого, запомните имя пользователя Jira (адрес электронной почты), под которым вы вошли, оно будет использоваться позже.
1.1. Создайте API-токен в Jira
В Jira перейдите в раздел Account settings → Security → API tokens.
Нажмите Create API token.
Введите название, которое поможет вам распознать новый токен, и нажмите Create.
Нажмите Copy to clipboard, чтобы скопировать токен в буфер обмена.
Сохраните токен в безопасном месте, он понадобится для настройки интеграции в проекте ТестОпс.
1.2. Создайте токен доступа в Zephyr
Нажмите иконку профиля Jira и выберите Zephyr API Access Tokens.
Нажмите Create access token.
Нажмите Copy, чтобы скопировать токен в буфер обмена.
Сохраните токен в безопасном месте, он понадобится для настройки интеграции в проекте ТестОпс.
2. Добавьте интеграцию с Zephyr в ТестОпс
ТестОпс предоставляет два отдельных типа интеграций для Zephyr:
- Zephyr для Jira Data Center;
- Zephyr Cloud для Jira Software Cloud.
Перейдите в ваш инстанс ТестОпс.
Перейдите в раздел Администрирование → Интеграции.
Нажмите + Добавить интеграцию в правом верхнем углу.
В списке доступных интеграций выберите Zephyr.
Заполните поля:
- Название — название, которое поможет вам распознать интеграцию, например, Zephyr production.
- Endpoint — URL-адрес вашего инстанса Jira Data Center.
- Связанный таск-трекер — если вы хотите сохранить информацию о связанных с тест-кейсами задачах Jira при их экспорте в Zephyr, выберите вашу интеграцию c Jira.
Если ваш инстанс Jira Data Center использует самоподписанный SSL-сертификат, поставьте галочку напротив Отключить проверку сертификата.
Нажмите Добавить интеграцию.
3. Включите интеграцию для проекта ТестОпс
Чтобы включить интеграцию в нужном проекте ТестОпс, воспользуйтесь одним из способов:
Перейдите в раздел Администрирование → Интеграции.
В списке настроенных интеграций найдите и откройте вашу интеграцию с Zephyr.
Перейдите на вкладку Проекты.
Справа от поля поиска нажмите
+.В выпадающем списке Проект выберите нужный проект ТестОпс.
В появившемся окне заполните поля:
- Введите имя пользователя учетной записи, которая использовалась для создания API-токенов.
- Введите API-токен Jira и токен доступа Zephyr, которые вы создали на шаге 1.
Нажмите Добавить интеграцию.
Если вы хотите связать результаты тестов с тест-кейсами Zephyr, указав идентификаторы Zephyr в вашем коде, вам нужно добавить сопоставление ключей тестов в настройках вашего проекта:
- Перейдите в раздел Настройки → Сторонние TMS.
- Введите название метки, значение которой будет использоваться как идентификатор тест-кейса Zephyr.
- Выберите интеграцию с Zephyr как систему управления тестами.
- Нажмите Отправить.
4. Создайте конфигурацию экспорта в ТестОпс
Перейдите в ваш проект ТестОпс.
Перейдите в раздел Настройки → Интеграции.
В секции Добавленные интеграции найдите и откройте вашу интеграцию с Zephyr.
Перейдите на вкладку Синхронизация с TMS.
Нажмите + Создать.
В открывшемся окне заполните поля:
Project — укажите проект Zephyr, в который будут экспортироваться данные.
Test Case AQL — введите AQL-запрос, чтобы отфильтровать тест-кейсы, которые вы хотите экспортировать. Оставьте поле пустым, чтобы экспортировать все тест-кейсы.
Launches AQL — введите AQL-запрос, чтобы отфильтровать запуски, которые будут экспортированы для выбранных тест-кейсов. Оставьте поле пустым, чтобы экспортировать все запуски.
Disable Launches sync — поставьте галочку, если вы хотите отключить экспорт всех запусков.
Email for notifications — укажите электронную почту для получения уведомлений от интеграции, если синхронизация с Zephyr автоматически отключится (подробнее см. Автоматическое отключение синхронизации).
Все поля в секции Status Mapping — настройте маппинг, чтобы экспортировать статусы тест-кейсов.
Подробнее см. Маппинг статусов тест-кейсов. Оставьте поля пустыми, чтобы не экспортировать статусы тест-кейсов.
Нажмите Отправить.
После создания конфигурации и успешного экспорта тест-кейсов, вы можете отключить экспорт новых тест-кейсов, соответствующих этой конфигурации. Для этого:
- На вкладке Синхронизация с TMS откройте нужную конфигурацию экспорта.
- Поставьте галочку напротив Disable Test Case create — будут экспортироваться только изменения и запуски ранее экспортированных тест-кейсов.
Чтобы отключить конфигурацию экспорта, не удаляя ее:
- На вкладке Синхронизация с TMS откройте нужную конфигурацию экспорта.
- Поставьте галочку напротив Disable export.
Маппинг статусов тест-кейсов
Тест-кейсы в ТестОпс и Zephyr могут иметь разные статусы. Чтобы их сопоставить, создайте маппинг, который укажет, как статусы тест-кейсов из ТестОпс должны обрабатываться в Zephyr. Например, вы можете создать маппинг, который свяжет статус «Устаревший» в ТестОпс со статусом "Deprecated" в Zephyr.
Определение ID статусов
Перед тем как создать маппинг, определите ID статусов тест-кейсов в ТестОпс, которые должны обрабатываться при экспорте:
- Перейдите в раздел Администрирование → Статусы.
- Слева от названия статуса найдите его ID.
Cохраните полученные ID, они понадобятся во время создания маппинга статусов.
Создание маппинга статусов
Перейдите в ваш проект ТестОпс.
Перейдите в раздел Настройки → Интеграции.
В секции Добавленные интеграции найдите и откройте вашу интеграцию с Zephyr.
Перейдите на вкладку Синхронизация с TMS.
Откройте нужную конфигурацию экспорта.
В открывшемся окне заполните поля для статусов тест-кейсов:
Default value — укажите статус из Zephyr, который будет использоваться по умолчанию, если в настройках маппинга не указано иное значение.
Например, если вы укажете статус Deprecated как значение по умолчанию и оставите пустыми остальные настройки маппинга, все экспортированные тест-кейсы будут иметь статус Deprecated.
Mappings — нажмите + Добавить, чтобы создать маппинг:
- Source ID — укажите исходный статус (его ID) из ТестОпс.
- Target System Name — укажите желаемый статус из Zephyr. Если вы не укажете Target System Name и оставите поле Default value пустым, статусы тест-кейсов будут удалены при экспорте.
Автоматическое отключение синхронизации
Синхронизация ТестОпс с Zephyr автоматически отключится, если любой из токенов для доступа по API, указанный на шаге 3, недействителен, был отозван или имеет недостаточный уровень доступа.
Чтобы возобновить синхронизацию, введите актуальные токены с достаточным уровнем доступа.
Удаление интеграции
Вы можете удалить интеграцию с Zephyr двумя способами — на уровне всего инстанса ТестОпс (через раздел Администрирование) или на уровне отдельного проекта (через настройки проекта).
Важно
Последствия удаления интеграции:
Удаление на уровне инстанса — все связи с тест-кейсами Zephyr, которые относятся к интеграции, будут удалены из сущностей ТестОпс. Это действие необратимо — восстановить удаленные ссылки будет невозможно.
Удаление на уровне проекта — все связи с тест-кейсами Zephyr, которые относятся к интеграции, будут сохранены в сущностях ТестОпс, но вы не сможете создавать новые связи для этого проекта. Дополнительно в проекте будет отключена синхронизация с Zephyr.
Перейдите в раздел Администрирование → Интеграции.
В списке настроенных интеграций найдите и откройте вашу интеграцию с Zephyr.
Перейдите на вкладку Проекты и убедитесь, что интеграция не используется в проектах ТестОпс.
Если интеграция подключена к проектам, удалите ее из них. Для этого напротив названия каждого проекта нажмите иконку корзины → Удалять.
Перейдите на вкладку Конфигурация.
Нажмите Удалить интеграцию.
Нажмите Удалить.