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

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

• запускать план Bamboo из интерфейса ТестОпс через запуск джобы ТестОпс;
• автоматически передавать результаты тестов из сборки Bamboo в ТестОпс с помощью плагина;
• синхронизировать статус сборки сразу в обеих системах — ТестОпс и Bamboo.

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

Совет

Подробнее о планах и сборках Bamboo, а также о связях между ними см. в официальной документации Bamboo.

Примечание

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

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

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

1. Настройте связь от ТестОпс к Bamboo:

   1. Подключите интеграцию с Bamboo на уровне инстанса ТестОпс.
   2. Добавьте настроенное подключение к Bamboo в проект ТестОпс.

2. Настройте связь от Bamboo к ТестОпс:

   1. Создайте API-токен в ТестОпс.
   2. Установите плагин в Bamboo.
   3. Укажите параметры инстанса ТестОпс в Bamboo.
   4. Настройте план в Bamboo для импорта результатов тестов в ТестОпс.
   5. Запустите план и проверьте сборку в Bamboo.
   6. Настройте созданную джобу в ТестОпс.

3. Параметризируйте джобу в ТестОпс и план в Bamboo (при необходимости).

Важно

Плагин для Bamboo не поддерживает подключение к инстансам ТестОпс, использующим самоподписанные сертификаты.

Для работы интеграции используйте сертификат от доверенного центра сертификации или откройте ТестОпс для Bamboo по HTTP.

1. Настройте связь от ТестОпс к Bamboo

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

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

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

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

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

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

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

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

     Примечание

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

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

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

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

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

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

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

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

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

2. Настройте связь от Bamboo к ТестОпс

Выполните шаги ниже, чтобы настроить вторую часть двусторонней связи: отправку статусов сборок и результатов тестов из Bamboo в ТестОпс.

2.1. Создайте API-токен в ТестОпс

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

2.2. Установите плагин для Bamboo

1. Перейдите в ваш инстанс Bamboo.
2. Установите приложение Allure TestOps for Bamboo через Atlassian Marketplace.

Примечание

Для интеграции с Bamboo используется плагин от Allure TestOps, который совместим с ТестОпс.

2.3. Укажите параметры инстанса ТестОпс в Bamboo

1. В Bamboo перейдите в раздел Build → All build plans.

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

3. Нажмите Actions → Configure plan.

4. Перейдите на вкладку Other.

5. В разделе Allure Upload заполните поля:

   • Enable Allure Upload — убедитесь, что поле отмечено галочкой.

   • Server endpoint url — введите URL-адрес вашего инстанса ТестОпс (например, https://testops.example.com).

   • Server token — введите API-токен, который вы сохранили на шаге 2.1.

   • Project id — введите ID проекта ТестОпс, в который будут импортироваться результаты тестов. ID проекта отображается на главной странице.

   • Launch name — введите шаблон для названий запусков в ТестОпс.

     Совет

     По умолчанию для названий запусков указан шаблон ${buildPlanName} - #${buildNumber}. Вы можете его изменить, используя переменные Bamboo.

   • Launch tags — введите список тегов (через запятую), которые будут присвоены запускам в ТестОпс.

6. Нажмите Save.

2.4. Настройте план в Bamboo для импорта результатов тестов в ТестОпс

1. В Bamboo перейдите в раздел Build → All build plans.

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

3. Нажмите Actions → Configure plan.

4. Нажмите на джобу, которая запускает тесты.

5. Перейдите на вкладку Other.

6. В разделе Results path в поле Test Results Directories введите путь к директории с результатами тестов относительно рабочей директории джобы (например, build/allure-results).

   Совет

   Если в вашем проекте несколько директорий с результатами тестов, вы можете разделить их запятыми или использовать шаблон с подстановочными символами (например, modules/*/build/allure-results).

7. Нажмите Save.

8. Перейдите на вкладку Tasks.

9. В списке задач нажмите на задачу, которая запускает тесты.

   Примечание

   Во многих проектах Bamboo тесты запускает задача Script с помощью команды, специфичной для тестового фреймворка.

10. В поле Environment variables введите ALLURE_TESTPLAN_PATH=${bamboo.ALLURE_TESTPLAN_PATH}.

11. Нажмите Save.

2.5. Запустите план и проверьте сборку в Bamboo

1. В Bamboo запустите план, который вы настроили на шаге 2.3 и шаге 2.4.
2. Дождитесь завершения сборки.
3. Перейдите в ваш проект ТестОпс → раздел Запуски.
4. Откройте созданный запуск и карточку результата одного из тестов.
5. В строке под названием теста найдите название сборки Bamboo, из которой импортированы результаты этого теста.
6. Нажмите на название сборки Bamboo, чтобы открыть сборку и проверить корректность связи между Bamboo и ТестОпс.

2.6. Настройте джобу в ТестОпс

1. Перейдите в ваш проект ТестОпс → раздел Джобы.

   В списке будет отображаться новая джоба, автоматически добавленная во время запуска на шаге 2.5.

2. Напротив добавленной джобы нажмите ⋯ → Настроить.

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

   • Название — введите название, которое поможет вам распознать джобу.
   • Сервер сборки — нажмите на выпадающий список и выберите название подключения к Bamboo, которое вы добавили на шаге 1.1.
   • Джоба может быть использована для запуска тестов — поставьте галочку, чтобы пользователи могли запускать джобу из ТестОпс.

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

3. Параметризируйте джобу в ТестОпс и план в Bamboo

Bamboo использует переменные в планах для параметризации сборок. ТестОпс поддерживает эту функциональную возможность через Окружение, которое позволяет задавать параметры для новых джоб ТестОпс и просматривать параметры из сборок Bamboo.

Совет

Рекомендуется устанавливать одинаковые значения по умолчанию как в ТестОпс, так и в Bamboo. В таком случае план Bamboo получит одно и то же окружение независимо от источника запуска.

3.1. Укажите переменные в плане Bamboo

1. Перейдите в ваш инстанс Bamboo → раздел Build → All build plans.

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

3. Нажмите Actions → Configure plan.

4. Перейдите на вкладку Variables.

5. Для каждой переменной, которую вы хотите использовать:

   1. В поле Variable name введите название переменной окружения.
   2. В поле Value введите значение по умолчанию, которое будет использоваться, если для конкретного запуска не задано другое значение.
   3. Нажмите Add.

3.2. Добавьте глобальные переменные окружения в ТестОпс

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

1. Перейдите в ваш инстанс ТестОпс → раздел Администрирование → Окружения.

2. Для каждой переменной, которую вы хотите добавить:

   1. Нажмите + Создать.
   2. Введите название глобальной переменной.
   3. Нажмите Отправить.

   

   Важно

   Если план Bamboo использует несколько веток, обязательно создайте глобальную переменную окружения Branch и передайте ее в вашу джобу. Это специальное имя укажет Bamboo, какую ветку плана нужно запустить.

3.3. Сопоставьте переменные Bamboo с глобальными переменными окружения в ТестОпс

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

2. Для каждой переменной, которую вы хотите использовать:

   1. Нажмите + Создать, если переменной нет в списке. Если переменная уже существует, напротив ее названия нажмите иконку Редактировать.
   2. В поле Ключ введите название переменной в Bamboo из шага 3.1.
   3. В поле Переменная окружения нажмите на выпадающий список и выберите название глобальной переменной в ТестОпс из шага 3.2.
   4. Нажмите Отправить.

   

3.4. Добавьте параметры в джобу ТестОпс

1. Перейдите в ваш проект ТестОпс → раздел Джобы.

2. Напротив джобы, которую вы хотите параметризировать, нажмите иконку Обновить настройки джобы с сервера сборки.

   Названия переменных и их значения по умолчанию появятся в описании джобы.

3. Напротив джобы нажмите ⋯ → Настроить.

4. Для каждой переменной, которую вы хотите использовать, в секции Параметры → Переменная окружения нажмите на выпадающий список и выберите соответствующую глобальную переменную окружения в ТестОпс из шага 3.2.

   

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

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

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

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

Важно

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

• Подключения к интеграции с Bamboo перестанут отображаться в списке подключений проекта, но продолжат работать в других проектах инстанса, в которых они были добавлены, и сохранятся в разделе Администрирование → Интеграции.

• Интеграция с Bamboo перестанет отображаться в списке интеграций проекта, но сохранится в разделе Администрирование → Интеграции.

• Связь с инстансом Bamboo будет удалена из джоб ТестОпс, которые относятся к интеграции и находятся в этом проекте:

  • Иконки для запуска и обновления этих джоб в разделе Джобы останутся активными.
  • ТестОпс не сможет запустить тесты из проекта на стороне Bamboo. После закрытия запуска результаты этих тестов получат статус «Неизвестный».
  • Результаты запусков тестов из Bamboo не будут отправляться в проект ТестОпс.

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

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

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

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

Важно

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

• Подключения и интеграция с Bamboo будут полностью удалены.

• Связь с инстансом Bamboo будет удалена из всех джоб ТестОпс, которые относятся к интеграции:

  • Иконки для запуска и обновления этих джоб в разделе Джобы станут неактивными.
  • Результаты запусков тестов из Bamboo не будут отправляться в инстанс ТестОпс.

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

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

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