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

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

Важно

ТестОпс поддерживает экспорт только в проекты TestRail, которые используют несколько тестовых наборов. См. Проекты и их типы в документации TestRail, чтобы изменить тип вашего проекта, если это необходимо.

Примечание

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

• Администрирование — необходимы права администратора инстанса;
• Настройки в конкретном проекте — необходима роль владельца этого проекта.

Настройка интеграции

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

1. Включите API и создайте API-ключ в TestRail.

2. На уровне инстанса ТестОпс добавьте интеграцию с TestRail, указав:

   • название интеграции;
   • URL-адрес TestRail;
   • версию TestRail.

3. На уровне инстанса или проекта ТестОпс включите добавленную интеграцию для проекта, указав учетные данные с созданным API-ключом из TestRail.

4. Получите данные из проекта TestRail, необходимые для синхронизации между TestRail и ТестОпс.

5. Включите синхронизацию между TestRail и ТестОпс.

6. Настройте маппинг полей между TestRail и ТестОпс.

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

1. Включение базовой синхронизации

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

1. В TestRail перейдите в раздел Administration → Site Settings → API.
2. Поставьте галочки напротив Enable API и Enable session authentication for API.
3. Нажмите Save Settings.

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

1. В TestRail нажмите на ваше имя в правом верхнем углу и выберите My Settings.

2. Перейдите на вкладку API Keys.

3. Нажмите Add Key.

4. В появившемся окне введите название, которое поможет вам распознать API-ключ, например, «Ключ для ТестОпс».

5. Нажмите Generate Key.

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

6. Нажмите Add Key, затем Save Settings.

1.3. Добавьте интеграцию с TestRail в ТестОпс

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

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

3. Нажмите + Добавить интеграцию в правом верхнем углу страницы.

4. В появившемся окне выберите TestRail.

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

   • Название — название, которое поможет вам распознать интеграцию, например, TestRail production.
   • Endpoint — URL-адрес инстанса TestRail, например, https://example.testrail.io/.
   • Версия TestRail — 6.7 or later.

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

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

1.4. Включите интеграцию для проекта ТестОпс

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

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

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

3. Перейдите на вкладку Проекты.

4. Справа от поля поиска нажмите +.

5. В выпадающем списке Проект выберите нужный проект ТестОпс.

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

   • Имя пользователя — адрес электронной почты, который вы используете для входа в TestRail.
   • API-ключ — API-ключ, который вы получили на шаге 1.2.

7. Нажмите Проверить соединение. Если учетные данные верны, через несколько секунд появится сообщение «Соединение установлено».

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

1.5. Получите необходимые данные из проекта TestRail

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

1. В панели управления TestRail нажмите на проект, в который вы хотите включить экспорт.

   Запомните название проекта. Это название понадобится на шаге 1.6 для поля Project.

   

2. Перейдите на вкладку Test Suites & Cases.

   Нажмите на тестовый набор, в который вы хотите включить экспорт. При необходимости вы можете создать новый тестовый набор.

   Обратите внимание на ID рядом с названием. Это Suite ID, который вам понадобится на шаге 1.6.

   

3. В древовидном представлении справа нажмите на раздел, в который вы хотите включить экспорт. При необходимости вы можете создать новый тестовый набор.

   Обратите внимание на параметр group_id, который появится в адресной строке веб-браузера. Это Section ID, который вам понадобится на шаге 1.6.

   

1.6. Включите синхронизацию в ТестОпс

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

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

3. В секции Добавленные интеграции найдите и откройте вашу интеграцию с TestRail.

4. Перейдите на вкладку Синхронизация с TMS.

5. Нажмите + Создать.

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

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

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

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

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

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

1. На вкладке Синхронизация с TMS откройте нужную конфигурацию экспорта.
2. Поставьте галочку напротив Disable export.

2. Настройка маппинга полей

Некоторые из экспортируемых полей тест-кейсов не стандартизированы в TestRail, а именно:

• описание,
• предусловие,
• ожидаемый результат,
• сценарий.

Вы можете создать поля в TestRail и указать их названия в ТестОпс.

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

1. В TestRail перейдите в раздел Administration → Customizations.

   Должен появиться список Case Fields.

2. Для каждого поля, которое вы хотите экспортировать в TestRail:

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

   2. В появившейся форме заполните поля:

      • Label — метка, под которой должно отображаться поле в деталях тест-кейса в TestRail. Примеры значений: “Description”, “Precondition”, “Expected”.
      • System Name — уникальный идентификатор поля. Он будет использоваться ТестОпс при экспорте поля. Примеры значений: “description”, “preconds”, “expected”.
      • Type — Steps для поля, которое будет хранить сценарий теста как отдельные шаги. Text для всех остальных полей. Если вы предпочитаете экспортировать сценарий в виде простого текста, выберите Text для всех полей.

   3. В нижней части формы нажмите Add Projects & Options.

   4. В появившемся окне:

      1. Перейдите на вкладку Selected Projects.
      2. Выберите These options apply to the following projects only и поставьте галочку для вашего проекта.
      3. Нажмите OK, чтобы закрыть окно.

   5. Нажмите Add Field, чтобы закрыть форму и применить изменения.

2.2. Настройте маппинг в ТестОпс

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

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

3. В секции Добавленные интеграции найдите и откройте вашу интеграцию с TestRail.

4. Перейдите на вкладку Синхронизация с TMS.

5. Откройте нужную конфигурацию экспорта.

6. В открывшемся окне в секции Settings укажите значения полей, которые вы хотите экспортировать в TestRail. Для этого сначала введите префикс "custom_", после него — идентификатор, который вы указали как System Name в TestRail на шаге 2.1.

   Например, в поле Precondition может быть указано значение "custom_preconds".

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

3. Настройка маппинга статусов

И ТестОпс, и TestRail имеют настраиваемые системы статусов тестов. При настройке синхронизации рекомендуется создать в TestRail тот же набор статусов, который у вас есть в воркфлоу ТестОпс, а затем сопоставить их друг с другом.

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

1. В TestRail перейдите в раздел Administration → Customizations.

   Должен появиться список Case Fields.

2. Нажмите Add Field, чтобы создать новое поле, которое будет хранить статус тест-кейса. В качестве альтернативы вы можете использовать существующее поле типа Dropdown.

3. В появившейся форме заполните поля:

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

4. В нижней части формы нажмите Add Projects & Options.

   Должно появиться окно с вкладками Options и Selected Projects.

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

   Запомните ID каждого статуса. Они понадобятся вам на шаге 3.3.

   

6. На вкладке Selected Projects выберите These options apply to the following projects only и поставьте галочку для вашего проекта.

7. Нажмите OK, чтобы закрыть окно. Затем нажмите Add Field, чтобы закрыть форму и применить изменения.

3.2. Определите ID статусов в ТестОпс

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

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

3. Слева от названия каждого статуса найдите его ID.

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

3.3. Настройте маппинг в ТестОпс

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

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

3. В секции Добавленные интеграции найдите и откройте вашу интеграцию с TestRail.

4. Перейдите на вкладку Синхронизация с TMS.

5. Откройте нужную конфигурацию экспорта.

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

   • Field name — укажите системное имя поля, которое вы настроили в TestRail на шаге 3.1.
   • Default value — сначала введите префикс "custom_", после него — идентификатор статуса в TestRail. Это значение будет использоваться, когда нет другого применимого сопоставления.

7. Для каждого статуса, который у вас есть в воркфлоу ТестОпс, в секции Status Mapping нажмите + Добавить и заполните поля:

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

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

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

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

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

Удаление интеграции

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

Важно

Последствия удаления интеграции:

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

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

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

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

3. Перейдите на вкладку Проекты и убедитесь, что интеграция не используется в проектах ТестОпс.

   Если интеграция подключена к проектам, удалите ее из них. Для этого напротив названия каждого проекта нажмите иконку корзины → Удалять.

4. Перейдите на вкладку Конфигурация.

5. Нажмите Удалить интеграцию.

6. Нажмите Удалить.