Интеграция с Zephyr

Zephyr — это плагин для управления тестированием в Jira. Интеграция с Zephyr позволяет автоматически экспортировать тест-кейсы и запуски из ТестОпс в Zephyr, чтобы создавать и обновлять задачи Jira для каждого из тест-кейсов. Вы можете использовать Allure Query Language, чтобы выбрать нужный набор данных для экспорта.

Примечание

Чтобы настроить или удалить любую интеграцию ТестОпс с внешней системой, необходима глобальная роль «Администратор» в инстансе ТестОпс и, как правило, права администратора инстанса внешней системы.

Настройка интеграции

Чтобы настроить интеграцию с Zephyr:

1. Создайте токены в Jira и Zephyr.
2. Подключите интеграцию с Zephyr на уровне инстанса ТестОпс.
3. Добавьте настроенное подключение к Zephyr в проект ТестОпс.
4. Создайте одно или несколько правила экспорта в настройках подключения к Zephyr.

Примечание

ТестОпс предоставляет два отдельных типа интеграций с Zephyr: Zephyr for Jira Data Center и Zephyr for Jira Software Cloud.

1. Создайте токены в Jira и Zephyr

1.1. Создайте токен в Jira

Чтобы создать токен в Jira, воспользуйтесь одним из способов в зависимости от вашего типа интеграции с Zephyr:

Пропустите этот шаг, если вы планируете использовать свое имя пользователя и пароль в качестве учетных данных для Jira Data Center.

1. В Jira Data Center нажмите на ваш аватар и перейдите в раздел Profile.

2. В сайдбаре слева перейдите в раздел Personal Access Tokens.

3. Нажмите Create token.

4. Заполните поля:

   • Token Name — введите название токена, которое поможет вам распознать интеграцию (например, Токен для ТестОпс).
   • Expiry date — введите срок действия токена. После указанной даты интеграция перестанет работать. Чтобы возобновить ее работу, вам нужно будет создать новый токен. Чтобы создать бессрочный токен, уберите галочку напротив Automatic expiry.

5. Нажмите Create.

   Новый токен станет временно видимым. Скопируйте и сохраните токен в безопасном месте, он понадобится для подключения интеграции с Zephyr в ТестОпс.

1.2. Создайте токен в Zephyr

Чтобы создать токен в Zephyr, воспользуйтесь одним из способов в зависимости от вашего типа интеграции с Zephyr:

Если вы используете Zephyr для Jira Data Center, вам не нужно создавать дополнительный токен на этом шаге.

2. Подключите интеграцию с Zephyr на уровне инстанса ТестОпс

Чтобы подключить интеграцию с Zephyr, воспользуйтесь одним из способов в зависимости от вашего типа интеграции с Zephyr:

1. Перейдите в ваш инстанс ТестОпс.

2. Перейдите в раздел Администрирование → Интеграции.

3. Нажмите Добавить интеграцию.

4. В списке доступных интеграций выберите Zephyr for Jira Data Center.

5. Заполните поля:

   • Название подключения — введите название, которое поможет вам распознать интеграцию (например, Zephyr production).

   • Endpoint — введите URL-адрес вашего инстанса Jira Data Center (например, https://jira.example.com/).

   • Тип учетных данных — нажмите на выпадающий список и выберите тип учетных данных Zephyr, который будет поддерживать интеграция:

     • Все (глобальные и проектные) — интеграция может работать как с глобальными, так и с проектными учетными данными;
     • Только глобальные — интеграция может работать только с глобальными учетными данными;
     • Только проектные — интеграция может работать только с проектными учетными данными.

     Примечание

     Подробнее о поддерживаемых типах учетных данных см. Интеграции с внешними системами → Глобальные и проектные учетные данные

6. Если вы хотите сохранить информацию о задачах Jira Data Center, связанных с тест-кейсами ТестОпс, при их экспорте в Zephyr, в поле Связанный баг-трекер нажмите на выпадающий список и выберите нужное подключение к Jira Data Center.

7. Если ваш инстанс Jira Data Center использует самоподписанный SSL-сертификат, уберите галочку напротив Проверка SSL-сертификата.

8. Если интеграция может работать с глобальными учетными данными Jira Data Center, в секции Глобальные учетные данные:

   1. Перейдите на вкладку, соответствующую учетным данным Jira Data Center, которые вы планируете использовать, — Пароль или Персональный токен доступа.
   2. Введите имя пользователя и пароль нужной учетной записи в Jira Data Center или токен Jira Data Center, который вы получили на шаге 1.1.

9. Нажмите Добавить подключение.

3. Добавьте настроенное подключение к Zephyr в проект ТестОпс

Чтобы добавить настроенное подключение к Zephyr в нужный проект ТестОпс, воспользуйтесь одним из способов:

1. В ТестОпс перейдите в раздел Администрирование → Интеграции.

2. В списке настроенных интеграций найдите и откройте интеграцию с Zephyr.

3. В списке настроенных подключений найдите и откройте ваше подключение к Zephyr.

4. Нажмите Добавить в проект.

5. В списке доступных проектов выберите нужный проект ТестОпс.

6. Если интеграция может работать и с глобальными, и с проектными учетными данными Jira, в поле Тип учетных данных нажмите на выпадающий список и выберите вариант, который будет использоваться в проекте:

   • Проектные — использовать проектные учетные данные для подключения к Jira;
   • Глобальные — использовать глобальные учетные данные для подключения к Jira.

7. Если интеграция будет работать с проектными учетными данными Jira, в секции Проектные учетные данные введите учетные данные в зависимости от вашего типа интеграции с Zephyr.

   Zephyr for Jira Data Center

   1. Перейдите на вкладку, соответствующую учетным данным Jira Data Center, которые вы планируете использовать, — Пароль или Персональный токен доступа.
   2. Введите имя пользователя и пароль нужной учетной записи в Jira Data Center или токен Jira Data Center, который вы получили на шаге 1.1.
   Zephyr for Jira Software Cloud

   1. Введите электронную почту нужной учетной записи в Jira Software Cloud.
   2. Введите токен Jira Software Cloud, который вы сохранили на шаге 1.1.
   3. Введите токен Zephyr, который вы сохранили на шаге 1.2.

8. Нажмите Добавить в проект.

4. Создайте правило экспорта в ТестОпс

1. Перейдите в ваш проект ТестОпс.

2. Перейдите в раздел Настройки → Интеграции.

3. В списке настроенных интеграций найдите и откройте интеграцию с Zephyr.

4. В списке настроенных подключений найдите и откройте ваше подключение к Zephyr.

5. Нажмите + Правило экспорта.

6. В открывшемся окне заполните поля:

   • Project — нажмите на выпадающий список и выберите проект Jira, в который будут экспортироваться данные.

   • Test Case AQL — введите AQL-запрос, чтобы отфильтровать тест-кейсы, которые вы хотите экспортировать. Оставьте поле пустым, чтобы экспортировать все тест-кейсы.

   • Launches AQL — введите AQL-запрос, чтобы отфильтровать запуски, которые будут экспортированы для выбранных тест-кейсов. Оставьте поле пустым, чтобы экспортировать все запуски.

   • Disable Launches sync — поставьте галочку, если вы хотите отключить экспорт всех запусков.

   • Email for notifications — введите электронную почту для получения уведомлений от интеграции, если синхронизация с Zephyr автоматически отключится (подробнее см. Автоматическое отключение синхронизации).

   • Все поля в секции Status Mapping — настройте маппинг, чтобы экспортировать статусы тест-кейсов.

     Подробнее см. Маппинг статусов тест-кейсов. Оставьте поля пустыми, чтобы не экспортировать статусы тест-кейсов.

7. Нажмите Отправить.

После создания правила экспорта и успешного экспорта тест-кейсов, вы можете отключить экспорт новых тест-кейсов, соответствующих этому правилу. Для этого:

1. Напротив нужного правила экспорта нажмите Изменить.
2. Поставьте галочку напротив Disable Test Case create — будут экспортироваться только изменения и запуски ранее экспортированных тест-кейсов.

Чтобы отключить правило экспорта, не удаляя его:

1. Напротив нужного правила экспорта нажмите Изменить.
2. Поставьте галочку напротив Disable export.

Маппинг статусов тест-кейсов

Тест-кейсы в ТестОпс и Zephyr могут иметь разные статусы. Чтобы их сопоставить, создайте маппинг, который укажет, как статусы тест-кейсов из ТестОпс должны обрабатываться в Zephyr. Например, вы можете создать маппинг, который свяжет статус «Устаревший» в ТестОпс со статусом «Deprecated» в Zephyr.

Определение ID статусов

Перед тем как создать маппинг, определите ID статусов тест-кейсов в ТестОпс, которые должны обрабатываться при экспорте:

1. В ТестОпс перейдите в раздел Администрирование → Статусы.
2. Слева от названия статуса найдите его ID.

Cохраните полученные ID, они понадобятся во время создания маппинга статусов.

Создание маппинга статусов

1. Перейдите в ваш проект ТестОпс.

2. Перейдите в раздел Настройки → Интеграции.

3. В списке настроенных интеграций найдите и откройте интеграцию с Zephyr.

4. В списке настроенных подключений найдите и откройте ваше подключение к Zephyr.

5. Напротив нужного правила экспорта нажмите Изменить.

6. Заполните поля для статусов тест-кейсов:

   • Default value — введите статус из Zephyr, который будет использоваться по умолчанию, если в настройках маппинга не указано иное значение.

     Например, если вы укажете статус «Deprecated» как значение по умолчанию и оставите пустыми остальные настройки маппинга, все экспортированные тест-кейсы будут иметь статус «Deprecated».

   • Mappings — нажмите + Добавить, чтобы создать маппинг:

     • Source ID — введите исходный статус (его ID) из ТестОпс.
     • Target System Name — введите желаемый статус из Zephyr. Если вы не укажете Target System Name и оставите поле Default value пустым, статусы тест-кейсов будут удалены при экспорте.

Автоматическое отключение синхронизации

Синхронизация ТестОпс с Zephyr автоматически отключится, если любой из токенов, указанных на шаге 2 или шаге 3, недействителен, был отозван или имеет недостаточный уровень доступа.

Чтобы возобновить синхронизацию, введите актуальные токены с достаточным уровнем доступа.

Удаление интеграции

Вы можете удалить интеграцию с Zephyr двумя способами — на уровне всего инстанса ТестОпс (через раздел Администрирование) или на уровне отдельного проекта (через настройки проекта).

Важно

Последствия удаления интеграции:

• Удаление на уровне инстанса — все связи с тест-кейсами Zephyr, которые относятся к интеграции, будут удалены из сущностей ТестОпс. Это действие необратимо — восстановить удаленные ссылки будет невозможно.

• Удаление на уровне проекта — все связи с тест-кейсами Zephyr, которые относятся к интеграции, будут сохранены в сущностях ТестОпс, но вы не сможете создавать новые связи для этого проекта. Дополнительно в проекте будет отключена синхронизация с Zephyr.

1. В ТестОпс перейдите в раздел Администрирование → Интеграции.

2. В списке настроенных интеграций найдите и откройте интеграцию с Zephyr.

3. В списке настроенных подключений найдите ваше подключение к Zephyr и убедитесь, что оно не используется в проектах ТестОпс.

   Если интеграция подключена к проектам, удалите ее из них. Для этого откройте карточку подключения к Zephyr и напротив названия каждого проекта нажмите ⋯ → Удалить из проекта → Да, удалить.

4. Напротив нужного подключения к Zephyr нажмите ⋯ → Удалить → Да, удалить.