Интеграция с ТестОпс
Интеграция с ТестОпс позволяет автоматически экспортировать тест-кейсы и запуски из одного проекта ТестОпс в другой, включая экспорт в проекты, расположенные на другом инстансе ТестОпс. Вы можете использовать Allure Query Language, чтобы выбрать нужный набор данных для экспорта.
Примечание
Чтобы настроить или удалить любую интеграцию ТестОпс с внешней системой, необходима глобальная роль «Администратор» в инстансе ТестОпс и, как правило, права администратора инстанса внешней системы.
Настройка интеграции
Чтобы настроить интеграцию с ТестОпс:
- Создайте API-токен в целевом инстансе ТестОпс (куда планируется экспортировать тест-кейсы и запуски).
- Подключите интеграцию с целевым инстансом ТестОпс на уровне текущего инстанса ТестОпс.
- Добавьте настроенное подключение к целевому инстансу ТестОпс в проект текущего инстанса ТестОпс.
- Cоздайте одно или несколько правил экспорта в настройках подключения к целевому инстансу ТестОпс.
Совет
В инструкции описан сценарий экспорта данных из текущего инстанса ТестОпс в целевой инстанс.
Если вам нужно экспортировать данные в пределах текущего инстанса (например, из одного проекта в другой), выполните все действия в настройках этого инстанса ТестОпс.
1. Создайте API-токен в целевом инстансе ТестОпс
Перейдите в целевой инстанс ТестОпс.
Нажмите на ваш аватар и перейдите в раздел API-токены.
Нажмите + Токен.
Введите название токена, которое поможет вам распознать интеграцию (например, Токен для ТестОпс).
Нажмите Создать.
ТестОпс сгенерирует токен и отобразит его в модальном окне.
Нажмите иконку Копировать, чтобы скопировать токен в буфер обмена.
Cохраните токен в безопасном месте, он понадобится для подключения интеграции с целевым инстансом ТестОпс в текущем инстансе.
Нажмите Готово.
2. Подключите интеграцию с целевым инстансом ТестОпс на уровне текущего инстанса ТестОпс
Перейдите в текущий инстанс ТестОпс.
Перейдите в раздел Администрирование → Интеграции.
Нажмите Добавить интеграцию.
В списке доступных интеграций выберите ТестОпс.
Заполните поля:
Название подключения — введите название, которое поможет вам распознать интеграцию (например, TestOps production).
Endpoint — введите URL-адрес целевого инстанса ТестОпс, на который вы хотите экспортировать данные (например, https://testops.example.com).
Тип учетных данных — нажмите на выпадающий список и выберите тип учетных данных целевого инстанса ТестОпс, который будет поддерживать интеграция:
- Все (глобальные и проектные) — интеграция может работать как с глобальными, так и с проектными учетными данными;
- Только глобальные — интеграция может работать только с глобальными учетными данными;
- Только проектные — интеграция может работать только с проектными учетными данными.
Примечание
Подробнее о поддерживаемых типах учетных данных см. Интеграции с внешними системами → Глобальные и проектные учетные данные
Если целевой инстанс ТестОпс использует самоподписанный SSL-сертификат, уберите галочку напротив Проверка SSL-сертификата.
Если интеграция может работать с глобальными учетными данными целевого инстанса ТестОпс, в секции Глобальные учетные данные введите API-токен, который вы сохранили на шаге 1.
Нажмите Добавить подключение.
3. Добавьте настроенное подключение к целевому инстансу ТестОпс в проект текущего инстанса ТестОпс
Чтобы добавить настроенное подключение к целевому инстансу ТестОпс в нужный проект текущего инстанса, воспользуйтесь одним из способов:
В текущем инстансе ТестОпс перейдите в раздел Администрирование → Интеграции.
В списке настроенных интеграций найдите и откройте интеграцию с ТестОпс.
В списке настроенных подключений найдите и откройте ваше подключение к целевому инстансу ТестОпс.
Нажмите Добавить в проект.
В списке доступных проектов выберите нужный проект текущего инстанса ТестОпс.
Если интеграция может работать и с глобальными, и с проектными учетными данными целевого инстанса ТестОпс, в поле Тип учетных данных нажмите на выпадающий список и выберите вариант, который будет использоваться в проекте:
- Проектные — использовать проектные учетные данные для подключения к целевому инстансу ТестОпс;
- Глобальные — использовать глобальные учетные данные для подключения к целевому инстансу ТестОпс.
Если интеграция будет работать с проектными учетными данными целевого инстанса ТестОпс, в секции Проектные учетные данные введите API-токен, который вы сохранили на шаге 1.
Нажмите Добавить в проект.
4. Создайте правило экспорта в текущем инстансе ТестОпс
Перейдите в ваш проект на текущем инстансе ТестОпс.
Перейдите в раздел Настройки → Интеграции.
В списке настроенных интеграций найдите и откройте интеграцию с ТестОпс.
В списке настроенных подключений найдите и откройте ваше подключение к целевому инстансу ТестОпс.
Нажмите + Правило экспорта.
В открывшемся окне заполните поля:
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).
Подробнее см. Маппинг метаданных тест-кейсов. Оставьте поля пустыми, чтобы не экспортировать метаданные тест-кейсов.
Нажмите Отправить.
После создания правила экспорта и успешного экспорта тест-кейсов, вы можете отключить экспорт новых тест-кейсов, соответствующих этому правилу. Для этого:
- Напротив нужного правила экспорта нажмите Изменить.
- Поставьте галочку напротив Disable Test Case create — будут экспортироваться только изменения и запуски ранее экспортированных тест-кейсов.
Чтобы отключить правило экспорта, не удаляя его:
- Напротив нужного правила экспорта нажмите Изменить.
- Поставьте галочку напротив Disable export.
Маппинг метаданных тест-кейсов
Тест-кейсы на разных инстансах ТестОпс могут иметь разные наборы метаданных. Например, если вы создадите новый статус для тест-кейсов, он будет существовать только на текущем инстансе. Если вы попытаетесь экспортировать тест-кейс с этим статусом, другой инстанс не сможет его обработать.
По умолчанию интеграция с ТестОпс игнорирует все значения метаданных тест-кейсов, включая встроенные, например, статусы «Черновик», «На ревью». Чтобы это изменить, создайте маппинг, который укажет, как метаданные с текущего инстанса должны обрабатываться на другом инстансе.
Определение ID значений метаданных
Перед тем как создать маппинг, определите ID всех значений метаданных, которые ТестОпс должны обрабатываться при экспорте:
Чтобы узнать ID статусов тест-кейсов в текущем инстансе ТестОпс:
- Перейдите в раздел Администрирование → Статусы.
- Слева от названия статуса найдите его ID.
Аналогичным способом вы можете найти ID статусов в целевом инстансе ТестОпс.
Чтобы узнать ID воркфлоу, тестовых слоев, кастомных полей и ролей участников, воспользуйтесь API-запросами.
Cохраните полученные ID, они понадобятся во время создания маппинга метаданных.
Создание маппинга метаданных
Перейдите в ваш проект на текущем инстансе ТестОпс.
Перейдите в раздел Настройки → Интеграции.
В списке настроенных интеграций найдите и откройте интеграцию с ТестОпс.
В списке настроенных подключений найдите и откройте ваше подключение к целевому инстансу ТестОпс.
Напротив нужного правила экспорта нажмите Изменить.
Заполните поля для метаданных тест-кейсов:
Map as identity. Useful for system entities or self-export — поставьте галочку, чтобы экспортировать встроенные значения метаданных автоматически, без необходимости создавать маппинги.
Например, если вы поставите эту галочку для Status Mapping, статус тест-кейса «Черновик» будет экспортироваться как «Черновик», «Ревью» — как «Ревью».
Default value — введите значение типа метаданных (его ID) из целевого инстанса ТестОпс, которое будет использоваться по умолчанию, если в настройках маппинга не указано иное значение.
Например, если для Status Mapping вы укажете статус «Ревью» как значение по умолчанию и оставите пустыми остальные настройки маппинга, все экспортированные тест-кейсы будут иметь статус «Ревью».
Mappings — нажмите + Добавить, чтобы создать маппинг:
- Source ID — введите исходное значение типа метаданных (его ID) из текущего инстанса ТестОпс.
- Target ID — введите желаемое значение типа метаданных (его ID) из целевого инстанса ТестОпс. Если вы не укажете Target ID и оставите поле Default value пустым, значение соответствующего типа метаданных будет удалено при экспорте.
Автоматическое отключение синхронизации
Синхронизация текущего инстанса с целевым инстансом ТестОпс автоматически отключится, если API-токен, указанный на шаге 2 или на шаге 3, недействителен, был отозван или имеет недостаточный уровень доступа.
Чтобы возобновить синхронизацию, введите актуальный API-токен с достаточным уровнем доступа.
Удаление интеграции
Вы можете удалить интеграцию с ТестОпс двумя способами — на уровне всего инстанса (через раздел Администрирование) или на уровне отдельного проекта (через настройки проекта).
Важно
Последствия удаления интеграции:
Удаление на уровне инстанса — все связи с тест-кейсами целевого инстанса ТестОпс, которые относятся к интеграции, будут удалены из сущностей текущего инстанса ТестОпс. Это действие необратимо — восстановить удаленные ссылки будет невозможно.
Удаление на уровне проекта — все связи с тест-кейсами целевого инстанса ТестОпс, которые относятся к интеграции, будут сохранены в сущностях текущего инстанса ТестОпс, но вы не сможете создавать новые связи для этого проекта. Дополнительно в проекте будет отключена синхронизация с целевым инстансом ТестОпс.
В текущем инстансе ТестОпс перейдите в раздел Администрирование → Интеграции.
В списке настроенных интеграций найдите и откройте интеграцию с ТестОпс.
В списке настроенных подключений найдите ваше подключение к целевому инстансу ТестОпс и убедитесь, что оно не используется в проектах текущего инстанса.
Если интеграция подключена к проектам, удалите ее из них. Для этого откройте карточку подключения к целевому инстансу ТестОпс и напротив названия каждого проекта нажмите
⋯→ Удалить из проекта → Да, удалить.Напротив нужного подключения к целевому инстансу ТестОпс нажмите
⋯→ Удалить → Да, удалить.