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

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

• В запуске ТестОпс, результате теста или дефекте будут кликабельные ссылки на связанные задачи Jira.
• В задаче Jira будут списки связанных запусков или результатов тестов ТестОпс.
• Закрытие задачи Jira приведет к закрытию соответствующего дефекта в ТестОпс.

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

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

Примечание

Для использования автоматической привязки между тест-кейсами и задачами автор теста должен определить связь с помощью адаптера Allure Report для своей тестовой среды. Вот пример такого определения:

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

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

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

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

1. Установите плагин для Jira

1. В Jira выберите Apps → Explore more apps в верхнем навигационном меню.

2. Используя строку поиска, найдите плагин “Allure TestOps for Jira”.

3. Нажмите Get app рядом с плагином.

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

   Подождите, пока не появится сообщение “Allure TestOps for Jira installed successfully”.

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

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

Сначала администратор укажет URL-адрес инстанса Jira.

Затем владелец любого проекта создаст токен аутентификации в Jira, добавит его в ТестОпс и настроит сопоставление задач.

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

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

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

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

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

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

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

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

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

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

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

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

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

5. Введите имя, которое поможет вам распознать токен, например, “Token for TestOps”.

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

   Новый токен будет скопирован в ваш буфер обмена.

   Вам понадобится этот токен на следующем шаге.

2.3. Добавьте токен в ТестОпс

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

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

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

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

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

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

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

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

2.4. Настройте сопоставление задач

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

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

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

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

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

   

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

3. Настройте встраивание данных в Jira

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

Сначала убедитесь, что включены безопасные cookies для ТестОпс. Затем узнайте идентификатор интеграции и используйте его при настройке плагина в Jira.

3.1. Включите безопасные cookies в ТестОпс

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

Чтобы исправить это, убедитесь, что настройка “secure cookie” включена для вашей установки ТестОпс.

Kubernetes

Установите для параметра network.tls.secureCookie значение true.

Docker Compose

В файле .env установите TESTOPS_SECURE_COOKIE в true.

Сохраните изменения и перезапустите ТестОпс.

DEB

В файле /opt/testops/conf/testops.conf установите ALLURE_SECURE в true.

Сохраните изменения и перезапустите ТестОпс.

RPM

В файле /opt/testops/conf/testops.conf установите ALLURE_SECURE в true.

Сохраните изменения и перезапустите ТестОпс.

3.2. Узнайте ID интеграции в ТестОпс

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

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

3. Найдите интеграцию Jira Software Cloud.

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

   

3.3. Настройка плагина в Jira

1. В Jira выберите Apps → Manage your apps в верхнем навигационном меню.

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

   

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

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

     • Enabled — должно быть отмечено.
     • Endpoint — URL-адрес вашего инстанса ТестОпс, например, “https://demo.testops.cloud”.
     • Version — “Версия 4.x.x”.
     • Integration ID — идентификатор, который вы получили в ТестОпс на шаге 3.2.

   • Расположение панелей

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

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

4. Нажмите Save.

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

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

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

4.1. Создание вебхука в ТестОпс

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

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

3. Найдите интеграцию Jira Software Cloud и нажмите на ее название.

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

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

6. В появившемся диалоговом окне нажмите значок Копировать, чтобы скопировать токен в буфер обмена.

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

4.2. Добавление вебхука в Jira

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

2. В меню слева нажмите Advanced → WebHooks.

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

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

   • Name — имя, которое поможет вам распознать вебхук.
   • Status — “Включено”.
   • URL — URL-адрес вебхука, который вы получили на шаге 4.1.
   • Issue related events — выберите "Issue → updated".

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

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

Разделы ТестОпс отображают значок ошибки подключения или сообщение об ошибке

Когда Jira отображает индикатор ошибки подключения (значок или “502 Bad Gateway”, в зависимости от браузера) вместо списков ТестОпс, сначала убедитесь, что сам ТестОпс доступен в отдельной вкладке. Если это так, но проблема остается, это означает, что политика Jira Software Cloud не позволяет веб-странице взаимодействовать с iframes с вашего домена ТестОпс.

Чтобы решить эту проблему, вам придется связаться с поддержкой Atlassian. Прежде чем это сделать, мы рекомендуем вам найти пример URL-адреса iframe, который не отображается.

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

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

   Google Chrome

   Перейдите в Menu → More tools → Developer tools и нажмите значок Inspect element или просто нажмите Ctrl+Shift+C.

   Mozilla Firefox

   Перейдите в Menu → More tools → Web Developer Tools и нажмите значок Inspect element или просто нажмите Ctrl+Shift+C.

   Apple Safari

   Убедитесь, что функции для веб-разработчиков включены в браузере. Затем перейдите в Menu → Develop → Show Web Inspector и нажмите значок Start element selection или просто нажмите Command+Shift+C.

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

   Скопируйте URL-адрес атрибута src iframe.

   

   Важно

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

4. Напишите в поддержку Atlassian, предоставив им URL-адрес iframe.

Разделы ТестОпс отображают кнопки входа

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

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

Google Chrome

1. Перейдите в chrome://settings/cookies.

2. В разделе Default behavior выберите “Allow third-party cookies”.

   

Mozilla Firefox

1. Перейдите в about:preferences#privacy.

2. В разделе Enhanced Tracking Protection выберите Custom.

3. Убедитесь, что галочка Cookies отмечена.

4. В выпадающем списке рядом с галочкой Cookies выберите “Cross-site tracking cookies”.

   

Apple Safari

1. Перейдите в Safari → Settings.

2. Откройте вкладку Privacy.

3. Снимите флажок Prevent cross-site tracking.

   

Разделы ТестОпс отображают сообщение “Couldn't connect to Allure TestOps”

Если разделы ТестОпс говорят “Couldn't connect to Allure TestOps”, это указывает на то, что ТестОпс не распознает ID интеграции, который он получает от Jira.

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