Интеграция с 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

Примечание

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

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

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

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

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

   • Token Name — имя, которое поможет вам распознать токен, например, “Token for ТестОпс”.
   • 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. Введите имя, которое поможет вам распознать токен, например, “Token for ТестОпс”.

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. Нажмите на ваш аватар и перейдите в Administration → Integrations.

3. Нажмите Add integration в правом верхнем углу страницы.

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

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

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

   • Name — имя, которое поможет вам распознать интеграцию, например, “Xray production”.
   • Endpoint — URL экземпляра Jira, например, “https://example.atlassian.net/”.

6. Нажмите Add integration.

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

1. В ТестОпс перейдите на страницу проекта.

2. В меню слева нажмите Settings → Integrations.

3. В разделе Available integrations найдите интеграцию Xray и нажмите Add integration рядом с ней.

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

   Jira Data Center, используя пароль

   На вкладке Basic в диалоговом окне введите Username и Password пользователя Jira.

   Jira Data Center, используя токен

   На вкладке Token в диалоговом окне введите Token, который вы получили на шаге 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.
   Совет

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

   Нажмите Test connection. Через несколько мгновений должно появиться сообщение “Connection established”.

5. Нажмите Add integration чтобы закрыть диалоговое окно и сохранить настройки.

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

1. В ТестОпс перейдите на страницу проекта.

2. В меню слева нажмите Settings → Integrations.

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

4. На вкладке TMS Sync нажмите Create.

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

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

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

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