Интеграция с Яндекс Трекером

Интеграция с Яндекс Трекером позволяет:

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

Примечание

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

Настройка интеграции и подключений с Яндекс Трекером

Чтобы настроить интеграцию с Яндекс Трекером:

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

1. Создайте учетные данные в Яндекс

Интеграция с Яндекс Трекером поддерживает два типа аутентификации — с использованием OAuth2-токена или IAM-токена. OAuth2-токен доступен для организаций Яндекс 360 и Yandex Cloud, IAM-токен — только для организаций Yandex Cloud с использованием сервисных аккаунтов.

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

1. Создайте OAuth2-токен в Яндекс, добавив разрешения:

   • Чтение из трекера;
   • Запись в трекер;
   • Аутентификация в облаке.

2. Сохраните токен в безопасном месте, он понадобится для подключения интеграции с Яндекс Трекером в ТестОпс.

2. Получите идентификатор организации в Яндекс

Воспользуйтесь одним из способов в зависимости от организации в Яндекс, в которой используется Яндекс Трекер:

1. Перейдите в кабинет организации Яндекс 360.
2. Перейдите в раздел Общие настройки → Профиль организации.
3. Под названием организации скопируйте ее идентификатор.

Сохраните идентификатор организации в безопасном месте, он понадобится для подключения интеграции с Яндекс Трекером в ТестОпс.

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

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

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

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

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

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

   • Endpoint — введите URL-адрес вашего инстанса Яндекс Трекера (например, https://tracker.yandex.ru).

   • Endpoint для вызовов API — введите URL-адрес API Яндекс Трекера:

     • для облачной версии Яндекс Трекера укажите https://api.tracker.yandex.net;
     • для серверной версии Яндекс Трекера укажите собственный эндпоинт.

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

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

     Примечание

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

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

6. Если интеграция может работать с глобальными учетными данными Яндекс Трекера, в секции Глобальные учетные данные:

   1. Перейдите на вкладку, соответствующую учетным данным Яндекс, которые вы планируете использовать, — OAuth2-токен или IAM-токен.
   2. Введите идентификатор организации, который вы сохранили на шаге 2, а также учетные данные, которые вы сохранили на шаге 1.

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

В разделе Администрирование → Интеграции появится интеграция с Яндекс Трекером с одним автоматически созданным подключением.

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

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

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

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

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

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

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

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

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

7. Если интеграция будет работать с проектными учетными данными Яндекс Трекера, в секции Проектные учетные данные:

   1. Перейдите на вкладку, соответствующую учетным данным Яндекс, которые вы планируете использовать, — OAuth2-токен или IAM-токен.
   2. Введите идентификатор организации, который вы сохранили на шаге 2, а также учетные данные, которые вы сохранили на шаге 1.

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

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

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

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

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

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

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

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

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

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

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

5.2. Добавьте вебхук из ТестОпс в Яндекс Трекер

В нужной очереди Яндекс Трекера создайте триггер, заполнив секции:

• При условии — выберите Статус с условием Значение поля изменилось.

• Выполнить действия — выберите HTTP-запрос и заполните поля:

  • Метод — нажмите на выпадающий список и выберите POST.

  • Адрес — введите URL-адрес вебхука, который вы скопировали на шаге 5.1.

  • Способ авторизации — нажмите на выпадающий список и выберите NoAuth.

  • Тело запроса — на вкладке application/json введите:

    {
      "key": "{{issue.key}}",
      "summary": "{{issue.summary}}",
      "status": "{{issue.status.key}}"
    }

Важно

Дефект в ТестОпс закроется автоматически, если ключ статуса связанной задачи в Яндекс Трекере станет равен closed.

Удаление подключений и интеграции с Яндекс Трекером

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

Удаление подключения на уровне проекта

Важно

Последствия удаления всех подключений из интеграции с Яндекс Трекером на уровне проекта:

• Подключения к интеграции с Яндекс Трекером перестанут отображаться в списке подключений проекта, но продолжат работать в других проектах инстанса, в которых они были добавлены, и сохранятся в разделе Администрирование → Интеграции.
• Интеграция с Яндекс Трекером перестанет отображаться в списке интеграций проекта, но сохранится в разделе Администрирование → Интеграции.
• Все связи с задачами Яндекс Трекера, которые относятся к интеграции, будут сохранены в сущностях ТестОпс, но вы не сможете создавать новые связи для этого проекта.

Чтобы удалить подключение на уровне проекта:

1. Перейдите в ваш проект ТестОпс → раздел Настройки → Интеграции.
2. В списке настроенных интеграций найдите и откройте интеграцию с Яндекс Трекером.
3. Напротив нужного подключения к Яндекс Трекеру нажмите ⋯ → Удалить → Да, удалить.

Подключение перестанет работать в вашем проекте.

Удаление подключения на уровне инстанса

Важно

Последствия удаления всех подключений из интеграции с Яндекс Трекером на уровне инстанса:

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

Чтобы удалить подключение на уровне инстанса:

1. Перейдите в ваш инстанс ТестОпс → раздел Администрирование → Интеграции.
2. В списке настроенных интеграций найдите и откройте интеграцию с Яндекс Трекером.
3. В списке настроенных подключений откройте карточку нужного подключения и напротив названия каждого проекта нажмите ⋯ → Удалить из проекта → Да, удалить.
4. Нажмите Назад в интеграцию, чтобы вернуться к списку подключений.
5. Напротив нужного подключения к Яндекс Трекеру нажмите ⋯ → Удалить → Да, удалить.

Подключение перестанет работать во всех проектах инстанса.

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

Не устанавливается соединение с Яндекс Трекером («Insufficient scope for this Yandex.passport account»)

Если при попытке установить соединение в интеграции с Яндекс Трекером возникает ошибка «Insufficient scope for this Yandex.passport account. Yandex.passport account lacks»:

1. Откройте приложение в Яндекс OAuth, которое было создано для OAuth2-токена на шаге 1.
2. Убедитесь, что в разрешениях выбрано Аутентификация в облаке.
3. Пересоздайте OAuth2-токен и обновите его в настройках подключения в ТестОпс.