Интеграция с ТестОпс
Интеграция с ТестОпс позволяет автоматически экспортировать тест-кейсы и запуски из одного проекта ТестОпс в другой, включая экспорт в проекты, расположенные на другом инстансе ТестОпс. Вы можете использовать Allure Query Language, чтобы выбрать нужный набор данных для экспорта.
Примечание
Чтобы настроить или удалить интеграцию в ТестОпс, вы должны иметь доступ к разделам:
- Администрирование — необходимы права администратора инстанса;
- Настройки в конкретном проекте — необходима роль владельца этого проекта.
Настройка интеграции
Чтобы настроить интеграцию с ТестОпс:
Создайте API-токен в целевом инстансе ТестОпс (куда планируется экспортировать тест-кейсы и запуски).
На уровне текущего инстанса ТестОпс добавьте интеграцию с ТестОпс, указав:
- название интеграции;
- URL-адрес целевого инстанса.
На уровне текущего инстанса или проекта ТестОпс включите добавленную интеграцию для проекта, указав созданный API-токен.
Cоздайте одну или несколько конфигураций экспорта в настройках интеграции.
1. Создайте API-токен в целевом инстансе ТестОпс
Если вы хотите экспортировать данные на другой инстанс ТестОпс, вам нужно получить и сохранить API-токен от администратора этого инстанса.
Если вы являетесь администратором и хотите предоставить доступ для получения данных с другого инстанса (или если вы экспортируете данные на тот же инстанс), выполните следующие шаги для создания API-токена:
Перейдите в текущий инстанс ТестОпс.
Нажмите на ваш аватар и перейдите в раздел API-токены.
Нажмите + Токен.
Введите название токена, которое поможет вам распознать интеграцию, например, Токен для ТестОпс.
Нажмите Создать.
ТестОпс сгенерирует токен и отобразит его в модальном окне.
Нажмите иконку Копировать, чтобы скопировать токен в буфер обмена.
Cохраните токен в безопасном месте, он понадобится для настройки интеграции в проекте текущего инстанса ТестОпс.
2. Добавьте интеграцию с целевым инстансом ТестОпс
Перейдите в текущий инстанс ТестОпс.
Перейдите в раздел Администрирование → Интеграции.
Нажмите + Добавить интеграцию в правом верхнем углу.
В списке доступных интеграций выберите ТестОпс.
Заполните поля:
- Название — название, которое поможет вам распознать интеграцию, например, TestOps production.
- Endpoint — URL-адрес целевого инстанса ТестОпс, на который вы хотите экспортировать данные, например, https://testops.example.com.
Если целевой инстанс ТестОпс использует самоподписанный SSL-сертификат, поставьте галочку напротив Отключить проверку сертификата.
Нажмите Добавить интеграцию.
3. Включите интеграцию для проекта в текущем инстансе ТестОпс
Чтобы включить интеграцию в нужном проекте ТестОпс, воспользуйтесь одним из способов:
- Перейдите в раздел Администрирование → Интеграции.
- В списке настроенных интеграций найдите и откройте вашу интеграцию с ТестОпс.
- Перейдите на вкладку Проекты.
- Справа от поля поиска нажмите
+. - В выпадающем списке Проект выберите нужный проект ТестОпс.
- В поле API-токен введите API-токен, который вы сохранили на шаге 1.
- Нажмите Проверить соединение. Если API-токен указан верно, через несколько секунд появится сообщение «Соединение установлено».
- Нажмите Добавить интеграцию.
4. Создайте конфигурацию экспорта в текущем инстансе ТестОпс
Перейдите в ваш проект ТестОпс.
Перейдите в раздел Настройки → Интеграции.
В секции Добавленные интеграции найдите и откройте вашу интеграцию с ТестОпс.
Перейдите на вкладку Синхронизация с TMS.
Нажмите + Создать.
В открывшемся окне заполните поля:
Project — укажите проект целевого инстанса ТестОпс, в который будут экспортироваться данные.
Test Case AQL — введите AQL-запрос, чтобы отфильтровать тест-кейсы, которые вы хотите экспортировать. Оставьте поле пустым, чтобы экспортировать все тест-кейсы.
Launches AQL — введите AQL-запрос, чтобы отфильтровать запуски, которые будут экспортированы для выбранных тест-кейсов. Оставьте поле пустым, чтобы экспортировать все запуски.
Disable Launches sync — поставьте галочку, если вы хотите отключить экспорт всех запусков.
Email for notifications — укажите электронную почту для получения уведомлений от интеграции, если синхронизация с целевым инстансом ТестОпс автоматически отключится (подробнее см. Автоматическое отключение синхронизации).
Все поля в секции Settings — настройте маппинг, чтобы экспортировать атрибуты тест-кейсов:
- статусы (Status Mapping);
- воркфлоу (Workflow Mapping);
- тестовые слои (Test Layer Mapping);
- кастомные поля (Custom Field Mapping);
- роли участников (Role (Test Case Members) Mapping).
Подробнее см. Маппинг атрибутов тест-кейсов. Оставьте поля пустыми, чтобы не экспортировать атрибуты тест-кейсов.
Нажмите Отправить.
После создания конфигурации и успешного экспорта тест-кейсов, вы можете отключить экспорт новых тест-кейсов, соответствующих этой конфигурации. Для этого:
- На вкладке Синхронизация с TMS откройте нужную конфигурацию экспорта.
- Поставьте галочку напротив Disable Test Case create — будут экспортироваться только изменения и запуски ранее экспортированных тест-кейсов.
Чтобы отключить конфигурацию экспорта, не удаляя ее:
- На вкладке Синхронизация с TMS откройте нужную конфигурацию экспорта.
- Поставьте галочку напротив Disable export.
Маппинг атрибутов тест-кейсов
Тест-кейсы на разных инстансах ТестОпс могут иметь разные наборы атрибутов. Например, если вы создадите новый статус для тест-кейсов, он будет существовать только на текущем инстансе. Если вы попытаетесь экспортировать тест-кейс с этим статусом, другой инстанс не сможет его обработать.
По умолчанию интеграция с ТестОпс игнорирует все значения атрибутов тест-кейсов, включая встроенные, например, статусы «Черновик», «На ревью». Чтобы это изменить, создайте маппинг, который укажет, как атрибуты с текущего инстанса должны обрабатываться на другом инстансе.
Определение ID значений атрибутов
Перед тем как создать маппинг, определите ID всех значений атрибутов, которые ТестОпс должны обрабатываться при экспорте:
Чтобы узнать ID статусов тест-кейсов в текущем инстансе ТестОпс:
- Перейдите в раздел Администрирование → Статусы.
- Слева от названия статуса найдите его ID.
Аналогичным способом вы можете найти ID статусов в целевом инстансе ТестОпс.
Чтобы узнать ID воркфлоу, тестовых слоев, кастомных полей и ролей участников, воспользуйтесь API-запросами.
Cохраните полученные ID, они понадобятся во время создания маппинга атрибутов.
Создание маппинга атрибутов
Перейдите в ваш проект на текущем инстансе ТестОпс.
Перейдите в раздел Настройки → Интеграции.
В секции Добавленные интеграции найдите и откройте вашу интеграцию с ТестОпс.
Перейдите на вкладку Синхронизация с TMS.
Откройте нужную конфигурацию экспорта.
В открывшемся окне заполните поля для атрибутов тест-кейсов:
Map as identity. Useful for system entities or self-export — поставьте галочку, чтобы экспортировать встроенные значения атрибутов автоматически, без необходимости создавать маппинги.
Например, если вы поставите эту галочку для Status Mapping, статус тест-кейса «Черновик» будет экспортироваться как «Черновик», «Ревью» — как «Ревью».
Default value — укажите значение атрибута (его ID) из целевого инстанса ТестОпс, которое будет использоваться по умолчанию, если в настройках маппинга не указано иное значение.
Например, если для Status Mapping вы укажете статус «Ревью» как значение по умолчанию и оставите пустыми остальные настройки маппинга, все экспортированные тест-кейсы будут иметь статус «Ревью».
Mappings — нажмите + Добавить, чтобы создать маппинг:
Автоматическое отключение синхронизации
Синхронизация текущего инстанса с целевым инстансом ТестОпс автоматически отключится, если API-токен, указанный на шаге 3, недействителен, был отозван или имеет недостаточный уровень доступа.
Чтобы возобновить синхронизацию, введите актуальный API-токен с достаточным уровнем доступа.
Удаление интеграции
Вы можете удалить интеграцию с ТестОпс двумя способами — на уровне всего инстанса (через раздел Администрирование) или на уровне отдельного проекта (через настройки проекта).
Важно
Последствия удаления интеграции:
Удаление на уровне инстанса — все связи с тест-кейсами целевого инстанса ТестОпс, которые относятся к интеграции, будут удалены из сущностей текущего инстанса ТестОпс. Это действие необратимо — восстановить удаленные ссылки будет невозможно.
Удаление на уровне проекта — все связи с тест-кейсами целевого инстанса ТестОпс, которые относятся к интеграции, будут сохранены в сущностях текущего инстанса ТестОпс, но вы не сможете создавать новые связи для этого проекта. Дополнительно в проекте будет отключена синхронизация с целевым инстансом ТестОпс.
Перейдите в раздел Администрирование → Интеграции.
В списке настроенных интеграций найдите и откройте вашу интеграцию с ТестОпс.
Перейдите на вкладку Проекты и убедитесь, что интеграция не используется в проектах ТестОпс.
Если интеграция подключена к проектам, удалите ее из них. Для этого напротив названия каждого проекта нажмите иконку корзины → Удалять.
Перейдите на вкладку Конфигурация.
Нажмите Удалить интеграцию.
Нажмите Удалить.