Интеграция с Kaiten

Важно

Интеграция доступна начиная с ТестОпс версии 5.16.0.

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

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

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

Примечание

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

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

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

1. Создайте API-ключ в Kaiten.

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

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

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

4. В Kaiten настройте плагин ТестОпс, указав ID добавленной интеграции.

5. Настройте вебхуки между Kaiten и ТестОпс.

1. Настройте связь от ТестОпс к Kaiten

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

1.1. Создайте API-ключ в Kaiten

1. Перейдите в ваше пространство в Kaiten.

2. Нажмите на аватар вашего профиля и выберите НАСТРОЙКИ ПРОФИЛЯ.

3. Перейдите в раздел Ключ доступа API.

4. Нажмите + СОЗДАТЬ КЛЮЧ.

5. Нажмите значок Копировать, чтобы скопировать API-ключ в буфер обмена.

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

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

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

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

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

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

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

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

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

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

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

1. Перейдите в раздел Администрирование → Интеграции.
2. В списке настроенных интеграций найдите и откройте вашу интеграцию с Kaiten.
3. Перейдите на вкладку Проекты.
4. Нажмите + справа от поля поиска.
5. В выпадающем списке Проект выберите нужный проект.
6. В поле API-ключ введите API-ключ, который вы сохранили на шаге 1.1.
7. Нажмите Проверить соединение. Если API-ключ указан верно, через несколько секунд появится сообщение «Соединение установлено».
8. Нажмите Добавить интеграцию, чтобы сохранить настройки.

2. Настройте связь от Kaiten к ТестОпс

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

Важно

Настройка связи от Kaiten к ТестОпс доступна только в облачной версии Kaiten.

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

Чтобы определить ID добавленной интеграции, воспользуйтесь одним из двух способов ниже:

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

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

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

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

2.2. Подключите плагин ТестОпс в Kaiten

1. Перейдите в ваше пространство в Kaiten.

2. В сайдбаре справа перейдите в раздел Дополнения.

3. В блоке с описанием плагина ТестОпс нажмите ВКЛЮЧИТЬ.

4. В открывшемся окне подтверждения повторно нажмите ВКЛЮЧИТЬ.

5. В блоке с описанием плагина ТестОпс нажмите НАСТРОЙКИ → Настройки.

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

   • Endpoint — URL-адрес вашего инстанса ТестОпс, например, https://testops.example.com.
   • Integration ID — ID интеграции Kaiten, который вы скопировали на шаге 2.1.

7. Нажмите SUBMIT SETTINGS.

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

3. Настройте вебхуки

Чтобы синхронизировать статусы задач Kaiten со статусами дефектов ТестОпс, настройте вебхуки.

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

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

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

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

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

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

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

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

3.2. Настройте вебхук в Kaiten

1. Перейдите в ваше пространство в Kaiten.
2. В сайдбаре наведите курсор на название пространства и справа от него нажмите Настройки пространства.
3. Перейдите в раздел External webhooks.
4. В поле External webhook вставьте URL-адрес вебхука из ТестОпс, который вы скопировали на шаге 3.1.
5. Включите переключатель Включено и нажмите СОХРАНИТЬ.

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

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

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

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

Примечание

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

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

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

   

iFrame не отображается в задаче Kaiten

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

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

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

В iFrame отображается сообщение «Невозможно установить соединение с ТестОпс»

Сообщение «Невозможно установить соединение с ТестОпс» означает, что в настройках плагина ТестОпс указан неверный ID интеграции.

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

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

В iFrame отображается сообщение «Загрузка пространства»

Сообщение «Загрузка пространства» означает, что в настройках плагина ТестОпс указан неверный URL-адрес инстанса ТестОпс.

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

1. Откройте настройки плагина.

2. Убедитесь, что в поле Endpoint указан:

   • правильный протокол передачи данных (https:// или http://);
   • правильный формат URL-адреса.

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

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

1. Проверьте корректность указанного URL-адреса инстанса ТестОпс:

   1. Откройте настройки плагина.

   2. Убедитесь, что в поле Endpoint указан:

      • правильный протокол передачи данных (https:// или http://);
      • правильный формат URL-адреса.

2. Перейдите в ваш инстанс ТестОпс и убедитесь, что он доступен.

3. Если инстанс ТестОпс развернут в закрытом контуре, обратитесь к вашему системному администратору с просьбой проверить сетевые настройки инстанса (например, доступ ТестОпс к внешним сервисам).

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

Важно

Перед обращением в службу поддержки Kaiten убедитесь, что вы выполнили все предложенные выше действия и они не помогли исправить ошибку.

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

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

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

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

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

   

   Важно

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

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