Интеграция с Allure TestOps

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

• экспортировать тест-кейсы и запуски из ТестОпс в Allure TestOps;
• связывать тест-кейсы ТестОпс с тест-кейсами Allure TestOps (см. Ссылки на сторонние тест-кейсы);
• синхронизировать создание и изменение тест-кейсов и закрытие запусков в ТестОпс с Allure TestOps;
• автоматически отключать синхронизацию между ТестОпс и Allure TestOps при проблемах с учетными данными и получать уведомления об этом.

Важно

Чтобы экспортировать запуск из ТестОпс, он должен быть закрыт после настройки интеграции с Allure TestOps. Для запусков, закрытых до настройки интеграции, экспорт не выполняется.

Примечание

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

Настройка интеграции и подключений с Allure TestOps

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

1. Создайте API-токен в Allure TestOps.
2. Подключите интеграцию с Allure TestOps на уровне инстанса ТестОпс.
3. Добавьте настроенное подключение к Allure TestOps в проект ТестОпс.
4. Cоздайте одно или несколько правил экспорта в настройках подключения к Allure TestOps.

1. Создайте API-токен в Allure TestOps

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

2. Нажмите на ваш аватар и перейдите в раздел API tokens.

3. Нажмите + Token.

4. Введите название токена, которое поможет вам распознать интеграцию (например, Токен для ТестОпс).

5. Нажмите Create.

   Allure TestOps сгенерирует токен и отобразит его в модальном окне.

6. Нажмите иконку Copy, чтобы скопировать токен в буфер обмена.

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

7. Нажмите Done.

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

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

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

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

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

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

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

   • Endpoint — введите URL-адрес вашего инстанса Allure TestOps (например, https://allure-testops.example.com).

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

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

     Примечание

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

4. Создайте правило экспорта в ТестОпс

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

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

3. В списке настроенных интеграций найдите и откройте интеграцию с Allure TestOps.

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

5. Нажмите + Правило экспорта.

6. В открывшемся окне заполните поля:

   • Project — нажмите на выпадающий список и выберите проект Allure TestOps, в который будут экспортироваться данные.

   • Test Case AQL — введите AQL-запрос, чтобы отфильтровать тест-кейсы, которые вы хотите экспортировать. Оставьте поле пустым, чтобы экспортировать все тест-кейсы.

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

   • Disable Launches sync — поставьте галочку, если вы хотите отключить экспорт всех запусков.

   • Email for notifications — введите электронную почту для получения уведомлений от интеграции, если синхронизация с Allure TestOps автоматически отключится (подробнее см. Автоматическое отключение синхронизации).

   • Все поля в секции Settings — настройте маппинг, чтобы экспортировать метаданные тест-кейсов:

     • статусы (Status Mapping);
     • воркфлоу (Workflow Mapping);
     • тестовые слои (Test Layer Mapping);
     • кастомные поля (Custom Field Mapping);
     • роли участников (Role (Test Case Members) Mapping).

     Подробнее см. Маппинг метаданных тест-кейсов. Оставьте поля пустыми, чтобы не экспортировать метаданные тест-кейсов.

7. Нажмите Отправить.

После создания правила экспорта и успешного экспорта тест-кейсов, вы можете отключить экспорт новых тест-кейсов, соответствующих этому правилу. Для этого:

1. Напротив нужного правила экспорта нажмите Изменить.
2. Поставьте галочку напротив Disable Test Case create — будут экспортироваться только изменения и запуски ранее экспортированных тест-кейсов.

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

1. Напротив нужного правила экспорта нажмите Изменить.
2. Поставьте галочку напротив Disable export.

Маппинг метаданных тест-кейсов

Тест-кейсы в ТестОпс и Allure TestOps могут иметь разные наборы метаданных. Например, если вы создадите новый статус для тест-кейсов в ТестОпс и попытаетесь экспортировать тест-кейс с этим статусом, Allure TestOps не сможет его обработать.

По умолчанию интеграция с Allure TestOps игнорирует все значения метаданных тест-кейсов, включая встроенные, например, статусы «Черновик», «Ревью». Чтобы это изменить, создайте маппинг, который укажет, как метаданные из ТестОпс должны обрабатываться в Allure TestOps.

Определение ID значений метаданных

Перед тем как создать маппинг, определите ID всех значений метаданных, которые должны обрабатываться при экспорте:

• Чтобы узнать ID статусов тест-кейсов в ТестОпс:

  1. Перейдите в раздел Администрирование → Статусы.
  2. Слева от названия статуса найдите его ID.

  Аналогичным способом вы можете найти ID статусов в Allure TestOps.

• Чтобы узнать ID воркфлоу, тестовых слоев, кастомных полей и ролей участников, воспользуйтесь API-запросами в ТестОпс и Allure TestOps.

Cохраните полученные ID, они понадобятся во время создания маппинга метаданных.

Создание маппинга метаданных

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

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

3. В списке настроенных интеграций найдите и откройте интеграцию с Allure TestOps.

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

5. Напротив нужного правила экспорта нажмите Изменить.

6. Заполните поля для метаданных тест-кейсов:

   • Map as identity. Useful for system entities or self-export — поставьте галочку, чтобы экспортировать встроенные значения метаданных автоматически, без необходимости создавать маппинги.

     Например, если вы поставите эту галочку для типа метаданных Status Mapping, статус тест-кейса «Черновик» будет экспортироваться как «Draft», «Ревью» — как «Review».

   • Default value — введите значение типа метаданных (его ID) из Allure TestOps, которое будет использоваться по умолчанию, если в настройках маппинга не указано иное значение.

     Например, если для Status Mapping вы укажете статус «Review» как значение по умолчанию и оставите пустыми остальные настройки маппинга, все экспортированные тест-кейсы будут иметь статус «Review».

   • Mappings — нажмите + Добавить, чтобы создать маппинг:

     • Source ID — введите исходное значение типа метаданных (его ID) из ТестОпс.
     • Target ID — введите желаемое значение типа метаданных (его ID) из Allure TestOps. Если вы не укажете Target ID и оставите поле Default value пустым, значение соответствующего типа метаданных будет удалено при экспорте.

Автоматическое отключение синхронизации

Синхронизация ТестОпс с Allure TestOps автоматически отключится, если API-токен, указанный на шаге 2 или шаге 3, недействителен, был отозван или имеет недостаточный уровень доступа.

Чтобы возобновить синхронизацию, введите актуальный API-токен с достаточным уровнем доступа.

Удаление подключений и интеграции с Allure TestOps

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

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

Важно

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

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

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

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

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

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

Важно

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

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

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

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

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