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

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

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

Примечание

Чтобы настроить или удалить любую интеграцию ТестОпс с внешней системой, необходима глобальная роль «Администратор» в инстансе ТестОпс и, как правило, права администратора инстанса внешней системы.

В задачах Kaiten для просмотра и управления сущностями ТестОпс используется плагин на базе компонента iFrame 2.0.

Возможности iFrame 2.0 в плагине ТестОпс

Тест-кейсы:

• отображение всех тест-кейсов, связанных с задачей;
• поддержка мультипроектности — работа с тест-кейсами из разных проектов ТестОпс;
• добавление новых тест-кейсов к задаче без перехода в ТестОпс;
• отвязка тест-кейсов от задачи без перехода в ТестОпс;
• быстрый переход из задачи к конкретному тест-кейсу в ТестОпс;
• переход в ТестОпс к списку тест-кейсов, отфильтрованных по связи с задачей.

Запуски:

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

Аналитика и статистика:

• отображение статистики по статусам тест-кейсов и количеству ручных тестов;
• визуализация статусов результатов тестов;
• отображение суммарного времени выполнения всех тестов.

Навигация и фильтрация:

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

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

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

1. Создайте API-ключ в Kaiten.
2. Подключите интеграцию с Kaiten на уровне инстанса ТестОпс.
3. Добавьте настроенное подключение к Kaiten в проект ТестОпс.
4. Настройте плагин ТестОпс в Kaiten, указав ID настроенного подключения к Kaiten.
5. Настройте вебхуки между Kaiten и ТестОпс.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

   • Название подключения — введите название, которое поможет вам распознать интеграцию (например, Kaiten production).

   • Endpoint — введите URL-адрес вашего инстанса Kaiten (например, https://example.kaiten.ru/).

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

     • Все (глобальные и проектные) — интеграция может работать как с глобальными, так и с проектными учетными данными;
     • Только глобальные — интеграция может работать только с глобальными учетными данными;
     • Только проектные — интеграция может работать только с проектными учетными данными.

     Примечание

     Подробнее о поддерживаемых типах учетных данных см. Интеграции с внешними системами → Глобальные и проектные учетные данные

6. Если ваш инстанс Kaiten использует самоподписанный SSL-сертификат, уберите галочку напротив Проверка SSL-сертификата.

7. Если интеграция может работать с глобальными учетными данными Kaiten, в секции Глобальные учетные данные введите API-ключ, который вы сохранили на шаге 1.1.

8. Нажмите Добавить подключение.

1.3. Добавьте настроенное подключение к Kaiten в проект ТестОпс

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

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

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

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

4. Нажмите Добавить в проект.

5. В списке доступных проектов выберите нужный проект ТестОпс.

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

   • Проектные — использовать проектные учетные данные для подключения к Kaiten;
   • Глобальные — использовать глобальные учетные данные для подключения к Kaiten.

7. Если интеграция будет работать с проектными учетными данными Kaiten, в секции Проектные учетные данные введите API-ключ, который вы сохранили на шаге 1.1.

8. Нажмите Добавить в проект.

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

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

Важно

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

2.1. Найдите ID подключения к Kaiten в ТестОпс

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

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

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

4. В URL-адресе открытого подключения найдите и скопируйте ID этого подключения.

   Пример ID в URL-адресе подключения

   Предположим, URL-адрес настроенного подключения к Kaiten выглядит как https://testops.example.com/admin/integration/kaiten/connections/6/projects. Число 6 в данном случае — 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. В списке настроенных подключений найдите и откройте ваше подключение к Kaiten.

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

6. Нажмите + Вебхук.

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

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

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

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

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

Вы можете удалить интеграцию с Kaiten двумя способами — на уровне всего инстанса ТестОпс (через раздел Администрирование) или на уровне отдельного проекта (через настройки проекта).

Важно

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

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

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

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

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

3. В списке настроенных подключений найдите ваше подключение к Kaiten и убедитесь, что оно не используется в проектах ТестОпс.

   Если интеграция подключена к проектам, удалите ее из них. Для этого откройте карточку подключения к Kaiten и напротив названия каждого проекта нажмите ⋯ → Удалить из проекта → Да, удалить.

4. Напротив нужного подключения к Kaiten нажмите ⋯ → Удалить → Да, удалить.

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

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

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

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

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

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

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

1. Найдите нужный ID подключения к Kaiten в ТестОпс.
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 (Windows) / Command+Shift+C (macOS).

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

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

   

   Важно

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

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