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

Интеграция с TestRail позволяет автоматически экспортировать тест-кейсы и запуски из ТестОпс в TestRail. Вы можете использовать AQL, чтобы выбрать нужный набор данных для экспорта.

Важно

ТестОпс поддерживает экспорт только в проекты TestRail типа Multiple Test Suites (с несколькими тестовыми наборами).

Тест-кейсы ТестОпс после экспорта добавляются в один раздел одного тестового набора TestRail, указанного в настройках интеграции.

Примечание

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

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

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

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

1. Включите API в TestRail

Включите API в TestRail согласно официальной документации, поставив галочки напротив параметров:

• Enable API;
• Enable session authentication for API.

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

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

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

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

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

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

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

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

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

   • Версия TestRail — нажмите на выпадающий список и выберите версию вашего инстанса TestRail.

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

     Примечание

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

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

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

   1. Введите имя пользователя нужной учетной записи в TestRail.

      Примечание

      В TestRail имя пользователя, как правило, совпадает с адресом электронной почты.

   2. Введите API-ключ, который вы сохранили на шаге 2.

7. При необходимости проверьте соединение с TestRail, чтобы убедиться в корректности указанных данных.

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

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

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

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

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

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

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

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

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

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

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

   1. Введите имя пользователя нужной учетной записи в TestRail.

      Примечание

      В TestRail имя пользователя, как правило, совпадает с адресом электронной почты.

   2. Введите API-ключ, который вы сохранили на шаге 2.

8. При необходимости проверьте соединение с TestRail, чтобы убедиться в корректности указанных данных.

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

5. Получите ID раздела и тестового набора из проекта TestRail

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

2. Откройте проект TestRail, в который будут экспортироваться данные из ТестОпс.

3. Перейдите на вкладку Test Suites & Cases и откройте тестовый набор, в который будут экспортироваться данные из ТестОпс.

4. Скопируйте и сохраните ID тестового набора, он понадобится для настройки правил экспорта в ТестОпс.

   Примечание

   В TestRail ID тестового набора отображается рядом с его названием и имеет префикс S, например S29. Для настройки интеграции сохраните только числовую часть ID, например 29.

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

6. В URL-адресе скопируйте и сохраните значение параметра group_id — ID раздела, которое понадобится для настройки правил экспорта в ТестОпс.

   Пример

   Предположим, URL-адрес открытого раздела выглядит как https://example.testrail.io/index.php?/suites/view/29&group_by=cases:section_id&group_order=asc&display_deleted_cases=0&group_id=16. Число 16 в данном случае — ID раздела, которое необходимо скопировать и сохранить.

   

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

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

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

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

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

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

   • Project — нажмите на выпадающий список и выберите проект TestRail, в который будут экспортироваться данные из ТестОпс.
   • Test Case AQL — введите AQL-запрос, чтобы отфильтровать тест-кейсы, которые вы хотите экспортировать. Оставьте поле пустым, чтобы экспортировать все тест-кейсы.
   • Launches AQL — введите AQL-запрос, чтобы отфильтровать запуски, которые будут экспортированы для выбранных тест-кейсов. Оставьте поле пустым, чтобы экспортировать все запуски.
   • Disable Launches sync — поставьте галочку, если вы хотите отключить экспорт всех запусков.
   • Email for notifications — введите электронную почту для получения уведомлений от интеграции, если синхронизация с TestRail автоматически отключится.
   • Suite ID — введите ID тестового набора TestRail, который вы сохранили на шаге 5.
   • Section ID — введите ID раздела TestRail, который вы сохранили на шаге 5.

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

Совет

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

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

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

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

7. Настройте маппинг метаданных тест-кейсов между TestRail и ТестОпс

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

7.1. Создайте пользовательское поле для описаний тест-кейсов в TestRail

1. Перейдите в ваш инстанс TestRail → раздел Admin → Customizations → вкладка CASE FIELDS.

2. Нажмите Add Field.

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

   • Label — введите метку, под которой должно отображаться описание в деталях тест-кейса в TestRail (например, Description).
   • System Name — введите уникальный идентификатор поля, который будет использоваться ТестОпс при экспорте описания (например, description).
   • Type — нажмите на выпадающий список и выберите Text.

4. В нижней части окна нажмите Add Projects & Options → вкладка SELECTED PROJECTS.

5. Выберите These options apply to the following projects only и поставьте галочку напротив названия вашего проекта TestRail.

6. Нажмите OK.

7. Нажмите Add Field.

7.2. Создайте пользовательские статусы тест-кейсов в TestRail

1. В TestRail перейдите в раздел Admin → Customizations → вкладка CASE FIELDS.

2. Нажмите Add Field.

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

   • Label — введите метку, под которой должен отображаться статус в деталях тест-кейса в TestRail (например, Status).
   • System Name — введите уникальный идентификатор поля, который будет использоваться ТестОпс при экспорте статуса (например, status).
   • Type — нажмите на выпадающий список и выберите Dropdown.

4. В нижней части окна нажмите Add Projects & Options → вкладка OPTIONS.

5. Введите ID и названия статусов, которые вы хотите добавить в TestRail (например, 1, Draft).

   Важно

   ID должны быть положительными числами и уникальными. Каждая строка должна содержать один ID и одно название, разделенные запятой и пробелом.

6. Перейдите на вкладку SELECTED PROJECTS.

7. Выберите These options apply to the following projects only и поставьте галочку напротив названия вашего проекта TestRail.

8. Нажмите OK.

9. Нажмите Add Field.

7.3. Определите ID статусов тест-кейсов в ТестОпс

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

1. Перейдите в ваш инстанс ТестОпс → раздел Администрирование → Статусы.
2. Слева от названия каждого статуса найдите его ID.
3. Сохраните полученные ID, они понадобятся во время настройки маппинга метаданных тест-кейсов.

7.4. Настройте маппинг метаданных тест-кейсов

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

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

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

4. Напротив нужного правила экспорта нажмите Редактировать.

5. В секции Settings заполните поля для секций тест-кейсов, которые нужно экспортировать:

   • Description (Описание) — введите префикс custom_, после него — уникальный идентификатор поля, который вы указали в TestRail на шаге 7.1.

   • Precondition (Предусловие) — введите custom_preconds.

   • Expected (Ожидаемый результат) — введите custom_expected.

   • Separate scenario или Scenario as text (Сценарий) — введите custom_steps_separated или custom_steps соответственно.

     Примечание

     Если вы планируете экспортировать сценарии тест-кейсов:

     • в виде шагов — используйте поле Separate scenario;
     • в виде единого текста — используйте поле Scenario as text.

6. В секции Status Mapping заполните поля:

   • Field name — введите префикс custom_ и уникальный идентификатор поля, который вы указали в TestRail на шаге 7.2 (например, custom_status).

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

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

7. Для каждого статуса тест-кейсов, который нужно экспортировать, в поле Mappings нажмите + Добавить и заполните поля:

   • Source ID — введите ID исходного статуса в ТестОпс, который вы определили на шаге 7.3.
   • Target ID — введите ID желаемого статуса в TestRail, который вы указали на шаге 7.2.

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

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

Синхронизация ТестОпс с TestRail автоматически отключится, если API-ключ, указанный на шаге 3 или шаге 4, недействителен, был отозван или имеет недостаточный уровень доступа. У правил экспорта в этом подключении к TestRail будет поставлена галочка Disable export.

Чтобы возобновить синхронизацию:

1. Введите актуальный API-ключ с достаточным уровнем доступа в настройках подключения на шаге 3 или шаге 4.
2. Перейдите в ваш проект ТестОпс → раздел Настройки → Интеграции.
3. В списке настроенных интеграций найдите и откройте интеграцию с TestRail.
4. В списке настроенных подключений найдите и откройте ваше подключение к TestRail.
5. Напротив нужного правила экспорта нажмите Редактировать.
6. Уберите галочку напротив Disable export.
7. Нажмите Отправить.

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

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

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

Важно

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

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

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

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

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

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

Важно

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

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

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

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

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