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

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

Примечание

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

Настройка интеграции и подключений с Xray

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

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

Примечание

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

1. Создайте учетные данные в Jira и Xray

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

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

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

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

1.2. Создайте API-ключ в Xray

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

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

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

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

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

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

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

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

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

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

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

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

     Примечание

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

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

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

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

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

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

В разделе Администрирование → Интеграции появится интеграция с Xray с одним автоматически созданным подключением.

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

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

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

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

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

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

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

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

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

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

   Xray for Jira Data Center

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

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

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

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

1. Перейдите в ваш проект ТестОпс → раздел Настройки → Интеграции.

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

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

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

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

   • Project — нажмите на выпадающий список и выберите проект Jira, в который будут экспортироваться данные.
   • Test Case AQL — введите AQL-запрос, чтобы отфильтровать тест-кейсы, которые вы хотите экспортировать. Оставьте поле пустым, чтобы экспортировать все тест-кейсы.
   • Launches AQL — введите AQL-запрос, чтобы отфильтровать запуски, которые будут экспортированы для выбранных тест-кейсов. Оставьте поле пустым, чтобы экспортировать все запуски.
   • Disable Launches sync — поставьте галочку, если вы хотите отключить экспорт всех запусков.
   • Email for notifications — введите электронную почту для получения уведомлений от интеграции, если синхронизация с Xray автоматически отключится (подробнее см. Автоматическое отключение синхронизации).

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

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

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

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

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

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

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

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

Удаление подключений и интеграции с Xray

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

Удаление подключения на уровне проекта

Важно

Последствия удаления всех подключений из интеграции с Xray на уровне проекта:

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

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

1. Перейдите в ваш проект ТестОпс → раздел Настройки → Интеграции.
2. В списке настроенных интеграций найдите и откройте интеграцию с Xray.
3. Напротив нужного подключения к Xray нажмите ⋯ → Удалить → Да, удалить.

Подключение перестанет работать в вашем проекте.

Удаление подключения на уровне инстанса

Важно

Последствия удаления всех подключений из интеграции с Xray на уровне инстанса:

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

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

1. Перейдите в ваш инстанс ТестОпс → раздел Администрирование → Интеграции.
2. В списке настроенных интеграций найдите и откройте интеграцию с Xray.
3. В списке настроенных подключений откройте карточку нужного подключения и напротив названия каждого проекта нажмите ⋯ → Удалить из проекта → Да, удалить.
4. Нажмите Назад в интеграцию, чтобы вернуться к списку подключений.
5. Напротив нужного подключения к Xray нажмите ⋯ → Удалить → Да, удалить.

Подключение перестанет работать во всех проектах инстанса.