Интеграция с Jira Data Center (Jira Server)

Jira Data Center (ранее известный как Jira Server) — это самохостируемая версия популярного трекера задач Jira. В этой статье описывается, как настроить интеграцию между инстансами Jira Data Center и ТестОпс.

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

Списки на стороне Jira встраиваются в страницу деталей задачи в виде HTML-iframe. Для этого ТестОпс не обязательно должен быть доступен с сервера Jira, но он должен быть доступен с устройства пользователя. Это также означает, что интеграция может быть затронута настройками веб-браузера пользователя, особенно если инстанс 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 нажмите на значок шестеренки в правом верхнем углу и выберите Manage apps.

   Если будет запрошено, введите пароль администратора Jira.

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

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

4. В появившемся диалоговом окне нажмите Accept & install.

   Подождите, пока плагин загрузится и установится.

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

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

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

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

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

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

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

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

4. В появившемся окне выберите Jira Server (DC).

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

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

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

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

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

Примечание

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

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

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

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

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

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

5. Нажмите Create.

   Новый токен станет временно видимым. Скопируйте его.

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

2.3. Добавьте учетные данные Jira в ТестОпс

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

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

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

4. В появившемся окне введите учетные данные для подключения к Jira. Вы можете использовать базовую аутентификацию или аутентификацию с помощью токена.

   Базовая аутентификация

   На вкладке basic введите имя пользователя и пароль учетной записи в Jira.

   Аутентификация с помощью токена

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

   Совет

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

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

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

2.4. Настройте отображение задач

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

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

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

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

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

   

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

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

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

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

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

Примечание

Этот раздел предполагает, что и ТестОпс, и Jira Data Center настроены на использование зашифрованного протокола HTTPS. В других случаях, пожалуйста, свяжитесь с нашей службой поддержки.

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

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

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 Data Center.

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

   

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

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

   Если потребуется, введите пароль администратора Jira.

2. В меню слева нажмите Manage apps.

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

   

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

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

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

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

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

   • Доступ

     • Selected groups, Groups — для каких групп Jira будет включен плагин. Чтобы включить его для пользователей из всех групп, оставьте Selected groups неотмеченными.
     • Selected projects, Projects — для каких проектов Jira будет включен плагин. Чтобы включить его для пользователей из всех проектов, оставьте Selected projects неотмеченными.
   Важно

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

5. Нажмите Save.

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

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

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

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

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

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

3. Найдите интеграцию Jira Data Center и нажмите на ее имя.

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 использует HTTPS, а ТестОпс использует HTTP. К сожалению, такая конфигурация не поддерживается. Мы рекомендуем переключиться на HTTPS для обоих продуктов. См. Включение HTTPS.

После включения HTTPS для ТестОпс обязательно замените “http” на “https” в настройках плагина.

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

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

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

Google Chrome

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

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

   

Mozilla Firefox

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

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

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

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

   

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 интеграции из ТестОпс и убедитесь, что он используется в настройках плагина.