Интеграция с 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. Используя поле поиска, найдите плагин “ТестОпс для Jira”.

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

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

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

---

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

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

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

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

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

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

2. Нажмите на свой аватар и перейдите в Administration → Integrations.

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

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

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

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

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

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

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. В меню слева нажмите Settings → Integrations.

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

4. В появившемся диалоговом окне введите учетные данные для подключения к Jira. Вы можете сделать это через Basic authentication или Token authentication.

   import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

   Basic authentication

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

   Token authentication

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

   Совет

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

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

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

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

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

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

3. Нажмите Create.

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

   • Key — короткий идентификатор интеграции, который вы собираетесь использовать при написании тестов.
   • Issue tracker — имя интеграции, которую вы добавили на шаге 2.1.

   

5. Нажмите Submit.

---

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 нажмите на значок шестеренки в правом верхнем углу и выберите Управление приложениями.

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

2. В меню слева нажмите Управление приложениями.

3. Разверните раздел ТестОпс для JIRA и нажмите Настроить.

   

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

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

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

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

     • Тест-кейсы — расположение списка результатов тестов.
     • Запуски — расположение списка запусков.

   • Доступ

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

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

5. Нажмите Сохранить.

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

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

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

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

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

2. Нажмите на свой аватар и перейдите в Администрирование → Интеграции.

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

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

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

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

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

4.2. Добавьте вебхук в Jira

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

2. В меню слева нажмите Дополнительно → Вебхуки.

3. Нажмите Создать вебхук.

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

   • Имя — имя, которое поможет вам распознать вебхук.
   • Статус — “Включен”.
   • URL — URL вебхука, который вы получили на шаге 4.1.
   • События, связанные с задачами — выберите “Задача → обновлена”.

5. Нажмите Создать внизу страницы.

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

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

Пустые разделы ТестОпс обычно указывают на то, что ваш экземпляр Jira использует HTTPS, а ТестОпс использует HTTP. К сожалению, такая конфигурация не поддерживается. Мы рекомендуем переключиться на HTTPS для обоих продуктов. См. Включение HTTPS.

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

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

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

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

Google Chrome

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

2. Выберите “Разрешить сторонние cookies”.

   

Mozilla Firefox

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

2. В разделе Усиленная защита от отслеживания выберите Настраиваемая.

3. Убедитесь, что флажок Cookies установлен.

4. В выпадающем списке рядом с флажком Cookies выберите “Cookies для межсайтового отслеживания”.

   

Safari

1. Перейдите в Safari → Настройки.

2. Откройте вкладку Конфиденциальность.

3. Снимите флажок Предотвращать межсайтовое отслеживание.

   

Разделы ТестОпс отображают сообщение “Не удалось подключиться к ТестОпс”

Если разделы ТестОпс говорят “Не удалось подключиться к ТестОпс”, это указывает на то, что ТестОпс не распознает ID интеграции, который он получает от Jira.

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