Интеграция с Jira Software Cloud

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

Примечание

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

• Администрирование — необходимы права администратора инстанса;
• Настройки в конкретном проекте — необходима роль владельца этого проекта.

Интеграция с Jira Software Cloud позволяет:

• связывать сущности ТестОпс (тест-кейсы, запуски, результаты тестов, дефекты, карантин) с задачами Jira Software Cloud;
• создавать задачи Jira Software Cloud через интерфейс открытого дефекта в ТестОпс (подробнее см. Связывание дефектов с задачами);
• просматривать и управлять связанными тест-кейсами из ТестОпс в задачах Jira Software Cloud;
• просматривать связанные запуски и результаты тестов из ТестОпс в задачах Jira Software Cloud.

Списки тест-кейсов, результатов тестов и запусков из ТестОпс добавляются в задачи в Jira с помощью компонента iFrame. Для этого ТестОпс не обязательно должен быть доступен из Jira Software Cloud, но он должен быть доступен с устройства пользователя. Это также означает, что работа интеграции может зависеть от настроек браузера пользователя, особенно если ваш инстанс ТестОпс использует HTTP, а не HTTPS. Если у ваших пользователей возникли проблемы при работе с интеграцией, пожалуйста, перейдите в раздел Устранение неполадок или свяжитесь с нашей службой поддержки.

Для добавления ссылки на задачу в тест-кейс вручную Jira должна быть доступна с сервера ТестОпс.

Совет

Для использования автоматической привязки между тест-кейсами и задачами Jira автор теста должен определить связь, используя адаптер Allure Report для своего тестового фреймворка. Пример такого определения:

import { test } from "@playwright/test";
import { allure } from "allure-playwright";

test("Some test", async ({ page }) => {
  allure.label("jira", "BUG-123");
  // ...
});

Этот код свяжет тест с задачей "BUG-123" в таск-трекере "jira". Чтобы добавить ссылку на эту задачу в интерфейс, ТестОпс использует маппинг для значения "jira", как будет показано на шаге 1.4.

Обратите внимание, что хотя приведенный выше пример работает, в реальном проекте мы рекомендуем использовать оберточную функцию вместо указания ключа с помощью allure.label() каждый раз. Более подробную информацию можно найти в документации Allure Report для вашего тестового фреймворка.

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

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

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

2. На уровне инстанса ТестОпс добавьте интеграцию с Jira, указав:

   • название интеграции;
   • URL-адрес Jira.

3. На уровне инстанса или проекта ТестОпс включите добавленную интеграцию для проекта, указав учетные данные из Jira.

4. Настройте маппинг задач в ТестОпс.

5. Настройте встраивание данных из ТестОпс в Jira, установив плагин ТестОпс.

6. Включите синхронизацию жизненных циклов задач, настроив вебхуки между Jira и ТестОпс.

1. Включите ссылки Jira в ТестОпс

Выполнив этот шаг, вы сможете добавлять ссылки на задачи Jira в сущностях ТестОпс.

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

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

2. Нажмите Manage your account.

3. В верхнем меню перейдите на вкладку Security.

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

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

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

7. Нажмите Create, затем нажмите Copy, чтобы скопировать токен в буфер обмена.

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

1.2. Добавьте интеграцию с Jira в ТестОпс

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

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

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

4. В списке доступных интеграций выберите Jira Software Cloud.

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

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

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

1.3. Включите интеграцию для проекта ТестОпс

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

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

2. В списке настроенных интеграций найдите и откройте вашу интеграцию с Jira Software Cloud.

3. Перейдите на вкладку Проекты.

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

5. В выпадающем списке Проект выберите нужный проект.

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

   • Имя пользователя — электронная почта, которую вы используете для входа в Jira Software Cloud.
   • API-токен — API-токен, который вы сохранили на шаге 1.1.

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

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

1.4. Настройте маппинг задач

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

2. Перейдите в раздел Настройки → Задачи из баг-трекера.

3. Нажмите + Создать.

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

   • Ключ — короткий идентификатор интеграции, который вы собираетесь использовать при написании тестов, например, jira.
   • Баг-трекер — название интеграции, которую вы добавили на шаге 1.2.

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

2. Настройте встраивание данных из ТестОпс в Jira

Выполнив этот шаг, вы сможете просматривать список связанных сущностей ТестОпс в задачах Jira.

2.1. Включите защищенные cookies в ТестОпс

По соображениям безопасности веб-браузер пользователя может блокировать обмен cookies между двумя разными веб-сайтами, такими как ТестОпс и Jira. Это может помешать добавлению информации из ТестОпс на страницу Jira.

Чтобы это исправить, убедитесь, что защищенные cookies включены для вашего инстанса ТестОпс.

В файле values.yaml установите для параметра network.tls.secureCookie значение true.

2.2. Найдите ID интеграции в ТестОпс

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

2. В списке настроенных интеграций найдите вашу интеграцию с Jira Software Cloud.

3. Скопируйте ID, который отображается слева от названия интеграции.

   Этот ID понадобится вам для настройки плагина ТестОпс в Jira.

2.3. Подключите плагин ТестОпс для Jira

1. В Jira в правом верхнем углу нажмите иконку Settings и выберите Apps.

2. В сайдбаре слева нажмите Explore apps.

3. С помощью поля поиска найдите и откройте плагин Allure TestOps for Jira.

4. В появившемся окне нажмите Get it now.

   Дождитесь установки плагина.

5. В правом верхнем углу нажмите иконку Settings и выберите Apps.

6. Разверните раздел Allure TestOps for Jira и нажмите Configure.

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

   Общие настройки:

   • Enabled — должно быть отмечено.
   • Endpoint — URL-адрес вашего инстанса ТестОпс, например, https://testops.example.com. Убедитесь, что в URL-адресе нет слэша в конце, так как это может привести к некорректному поведению плагина.
   • Version — Version 4.x.x.
   • Integration ID — ID интеграции Jira Software Cloud, который вы скопировали на шаге 2.2.

   Месторасположение панелей:

   • Test Cases — расположение списка результатов тестов.
   • Launches — расположение списка запусков.

   Важно

   Хотя с помощью настроек для месторасположения панелей вы можете переместить списки на правую сторону страницы Jira, делать это не рекомендуется. В отличие от основной области, правая сторона интерфейса Jira очень ограничена по ширине, что может сделать список ТестОпс неудобным на большинстве дисплеев.

8. Нажмите Save.

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

ТестОпс поддерживает вебхуки Jira. Jira использует вебхуки для того, чтобы уведомить внешнюю систему об изменении статуса задачи. При получении такого уведомления ТестОпс найдет все дефекты, связанные с задачей, и обновит их статус.

3.1. Создайте вебхук в ТестОпс

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

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

3. В списке настроенных интеграций найдите и откройте вашу интеграцию с Jira Software Cloud.

4. Перейдите на вкладку Вебхуки.

5. Нажмите + Создать вебхук, затем нажмите Подтвердить создание.

6. Нажмите иконку Копировать, чтобы скопировать URL-адрес вебхука в буфер обмена.

   Этот URL-адрес понадобится вам на следующем шаге.

3.2. Добавьте вебхук из ТестОпс в Jira

1. В Jira в правом верхнем углу нажмите иконку Settings и выберите System.

2. В сайдбаре слева в разделе Advanced нажмите WebHooks.

3. Нажмите Create a WebHook.

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

   • Name — название, которое поможет вам распознать вебхук.
   • Status — Enabled.
   • URL — URL-адрес вебхука, который вы скопировали на шаге 3.1.
   • Issue related events — выберите Issue → updated.

5. Нажмите Create внизу страницы.

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

Вы можете удалить интеграцию с Jira двумя способами — на уровне всего инстанса ТестОпс или на уровне отдельного проекта.

Важно

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

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

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

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

1. Перейдите в раздел Администрирование → Интеграции.
2. В списке настроенных интеграций найдите и откройте вашу интеграцию с Jira Software Cloud.
3. На вкладке Конфигурация нажмите Удалить интеграцию.
4. Нажмите Удалить.

Устранение неполадок

В задачах Jira просмотр и управление сущностями ТестОпс осуществляется через компонент iFrame. Ниже приведены примеры возможных ошибок, которые могут отображаться в iFrame, и рекомендации по их устранению.

В iFrame отображается кнопка входа

Если вы вошли в ТестОпс, но все еще видите кнопку Login в задаче Jira, скорее всего, это вызвано настройками безопасности вашего браузера. Следуйте инструкции для вашего браузера ниже, чтобы убедиться, что связь между Jira и iFrame ТестОпс разрешена.

Примечание

Эти действия нужно совершить каждому пользователю, который столкнулся с проблемой.

1. Перейдите в настройки браузера в раздел Privacy and security → Third-party cookies (chrome://settings/cookies).

2. Выберите Allow third-party cookies.

   

В iFrame отображается сообщение "Couldn't connect to ТестОпс"

Сообщение "Couldn't connect to ТестОпс" означает, что в настройках плагина в Jira указан неверный ID интеграции.

Чтобы исправить ошибку:

1. Найдите нужный ID интеграции в ТестОпс.
2. Проверьте, что этот ID указан в настройках плагина.

В iFrame отображается иконка ошибки подключения или сообщение об ошибке

Если в iFrame отображается ошибка подключения (иконка или текст “502 Bad Gateway”) вместо данных из ТестОпс, перейдите в ваш инстанс ТестОпс и убедитесь, что он доступен.

Если ТестОпс открывается, но проблема остается, это означает, что настройки Jira Software Cloud не позволяют странице встраивать элементы iFrame для вашего домена ТестОпс. Чтобы решить эту проблему, вам придется связаться со службой поддержки Atlassian. Перед этим мы рекомендуем определить URL-адрес раздела iFrame, который не отображается.

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

2. Откройте инструменты разработчика в вашем браузере:

   1. В верхнем меню перейдите в раздел View → Developer → Developer Tools.
   2. Нажмите значок Select an element in the page to inspect it или нажмите Ctrl+Shift+C (Windows) / Command+Shift+C (macOS).

3. Наведите курсор на область, в которой должны отображаться данные из ТестОпс. В дереве исходного кода HTML найдите элемент <iframe>, который соответствует этой области.

4. Скопируйте URL-адрес из атрибута src в элементе <iframe>.

   

   Важно

   Веб-страница может содержать несколько элементов <iframe>, в том числе вложенных друг в друга. Убедитесь, что URL-адрес, который вы скопировали, указывает на домен ТестОпс.

5. Напишите в службу поддержки Atlassian, предоставив URL-адрес из элемента <iframe>.