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

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

Чтобы включить эту интеграцию, вам нужно:

1. Создать два API-токена в настройках Jira.
2. Включить интеграцию Xray в ТестОпс, используя созданные API-токены.
3. Создать одно или несколько правил экспорта в настройках интеграции.

Важно

Эта документация относится к плагину Xray Test Management для Jira Software Cloud. Плагин для установок Jira Data Center на собственных серверах в настоящее время не поддерживается.

1. Подготовьте необходимые API-токены

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

Jira Data Center

Примечание

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

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

2. В меню слева нажмите Personal Access Tokens.

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

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

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

5. Нажмите Create.

   Новый токен станет временно видимым. Сохраните его в файл или убедитесь, что вы сможете предоставить его позже на шаге 2.2.

Jira Software Cloud

1. В Jira нажмите на ваш аватар и перейдите в Manage account.

2. В верхнем меню перейдите в Security.

3. В разделе API tokens нажмите Create and manage API tokens.

4. Нажмите Create API token.

5. Введите название, которое поможет вам распознать токен, например, «Токен для ТестОпс».

6. Нажмите Create, затем нажмите Copy.

   Новый токен будет скопирован в буфер обмена. Сохраните его в файл или убедитесь, что вы сможете предоставить его позже на шаге 2.2.

1.2. Создайте API-токен в Xray

Jira Data Center

Примечание

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

Jira Software Cloud

1. Убедитесь, что плагин Xray Test Management установлен и настроен для вашего проекта Jira.

2. В Jira выберите Apps → Manage your apps в верхнем меню.

3. В меню слева нажмите Xray → API Keys.

4. Нажмите Create API Key.

5. В появившемся окне введите ваше имя или email в поле User и выберите вашу учетную запись из всплывающего списка.

6. Нажмите Generate.

7. Скопируйте Client ID и Client Secret.

   Сохраните эти учетные данные в файл или убедитесь, что вы сможете предоставить их позже на шаге 2.2.

2. Настройте интеграцию

2.1. Укажите URL-адрес Jira в ТестОпс

1. Войдите в ТестОпс, используя учетную запись администратора.

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

3. Нажмите + Добавить интеграцию в правом верхнем углу страницы.

4. В появившемся окне выберите:

   • Xray Test Management for Jira — если вы используете Jira Data Center,
   • Xray Test Management for Jira Cloud — если вы используете Jira Software Cloud.

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

   • Название — название, которое поможет вам распознать интеграцию, например, Xray production.
   • Endpoint — URL-адрес инстанса Jira, например, https://example.atlassian.net/.

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

2.2. Добавьте интеграцию Xray в проект ТестОпс

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

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

3. В разделе Доступные интеграции найдите интеграцию Xray и нажмите Добавить интеграцию рядом с ней.

4. В появившемся окне введите учетные данные для подключения к Jira.

   Jira Data Center (пароль)

   На вкладке Базовая введите имя пользователя и пароль пользователя Jira.

   Jira Data Center (токен)

   На вкладке Токен введите токен, который вы получили на шаге 1.1.

   Jira Software Cloud

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

   • Username — email, который вы используете для входа в Jira Software Cloud.
   • API token — API-токен Jira, который вы получили на шаге 1.1.
   • Xray Client ID и Xray Client secret — учетные данные Xray, которые вы получили на шаге 1.2.
   Совет

   Проверьте правильность учетных данных

   Нажмите Проверить соединение. Через несколько секунд должно появиться сообщение «Соединение установлено».

5. Нажмите Добавить интеграцию, чтобы сохранить настройки и закрыть окно.

3. Включите синхронизацию

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

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

3. Нажмите на интеграцию, которую вы добавили на шаге 2.2.

4. На вкладке Синхронизация с TMS нажмите Создать.

5. В выпадающем списке Project выберите проект Jira, в который ТестОпс должен отправлять данные о запуске тестов.

6. Укажите, какие данные ТестОпс должен экспортировать в Xray:

   • Фильтр по тест-кейсам — AQL-запрос для выбора тест-кейсов, которые будут синхронизированы, например, automation = false. Оставьте пустым, чтобы синхронизировать все тест-кейсы.
   • Фильтр по запускам — AQL-запрос для выбора запусков, которые будут синхронизированы, например, name ~= "Release". Оставьте пустым, чтобы синхронизировать все запуски.
   • Отключить экспорт — поставьте галочку, чтобы полностью отключить интеграцию Xray.
   • Отключить создание тест-кейсов — поставьте галочку, чтобы отключить экспорт информации о новых тест-кейсах.
   • Отключить синхронизацию запусков — поставьте галочку, чтобы отключить экспорт информации о запусках тестов.

7. Нажмите Отправить, чтобы применить изменения.

Важно

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