Интеграция с TeamCity с помощью allurectl

Важно

Эта инструкция описывает ограниченный вариант интеграции с TeamCity с помощью приложения командной строки allurectl.

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

Интеграция с TeamCity позволит вам получать результаты тестов из сборок TeamCity и автоматически создавать соответствующие тест-кейсы в ТестОпс.

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

Чтобы настроить интеграцию с TeamCity с помощью allurectl:

1. Создайте API-токен в ТестОпс.
2. Укажите созданный API-токен и другие переменные окружения в настройках проекта TeamCity.
3. Измените шаг сборки в TeamCity, чтобы он включал запуск allurectl для загрузки результатов тестов.

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

1. В ТестОпс нажмите на ваш аватар и перейдите в раздел API-токены.

2. Нажмите + Токен.

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

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

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

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

   Cохраните токен в безопасном месте, он понадобится для настройки интеграции в TeamCity.

2. Укажите переменные окружения в TeamCity

1. В TeamCity перейдите на страницу настроек вашего проекта.

2. В сайдбаре слева перейдите в раздел Parameters.

3. Нажмите Add new parameter и добавьте следующие переменные окружения (environment variable):

   Имя	Значение
   env.ALLURE_CI_TYPE	teamcity
   env.ALLURE_ENDPOINT	URL-адрес вашего инстанса ТестОпс. Пример: https://testops.example.com
   env.ALLURE_JOB_NAME	%system.teamcity.buildConfName%
   env.ALLURE_JOB_RUN_NAME	%teamcity.build.id%
   env.ALLURE_JOB_RUN_UID	%teamcity.build.id%
   env.ALLURE_JOB_RUN_URL	https://teamcity.example.com/viewLog.html?buildId=%teamcity.build.id%
   env.ALLURE_JOB_UID	%system.teamcity.buildType.id%
   env.ALLURE_LAUNCH_NAME	teamcity via allurectl - %build.number%
   env.ALLURE_PROJECT_ID	ID вашего проекта ТестОпс
   env.ALLURE_RESULTS	Путь к директории с результатами тестов. Пример: build/allure-results
   env.ALLURE_TOKEN	API-токен, который вы создали в ТестОпс

3. Измените шаг сборки в TeamCity

1. В TeamCity перейдите на страницу настроек вашей сборки.

2. В сайдбаре слева перейдите в раздел Build Step: Command Line.

3. Нажмите Edit напротив шага сборки.

4. Измените сборочный скрипт, обернув команду, запускающую тесты, в вызов allurectl.

   Например, если вы используете Gradle для запуска тестов, замените строку запуска тестов:

   ./gradlew clean test

   на строки:

   curl -fsSL https://github.com/allure-framework/allurectl/releases/latest/download/allurectl_linux_amd64 -o allurectl
   chmod +x allurectl
   ./allurectl watch -- ./gradlew clean test