Вебхуки для работы с автотестами

Вебхук для запуска автотестов

HTTP-запрос передается при запуске автотестов из интерфейса Test IT. При настройке вебхуков могут использоваться глобальный идентификатор (ID) проекта или тест-плана. Их можно найти в колонке ID в списке в разделах Проекты и Тест-планы.

Использование переменных `$CONFIGURATIONS_PARAMETERS[KEY]` и `$CUSTOM_PARAMETERS[KEY]`

  • Переменная $CONFIGURATIONS_PARAMETERS[KEY] передает доступ к значениям параметра конфигурации, на которой запускается автотест.
    Пример: Для параметра "OS — Windows" укажите:
      {
    "OperatingSystem": "$CONFIGURATIONS_PARAMETERS[OS]"
  }
    В теле вебхука отобразится:
      {
    "OperatingSystem": "Windows"
  }
    При указании несуществующего ключа параметра в [KEY] отобразится пустое значение.
  • Переменная $CUSTOM_PARAMETERS[KEY]используется аналогичным образом, но значения берутся из параметров, задаваемых при параметризации запуска автотестов.
Доступные специальные переменные
ПеременнаяОписание
$AUTO_TESTS_COUNTКоличество автотестов, участвующих в запуске
$BUILDНомер сборки, указанный при создании тест-плана
$PRODUCT_NAMEНазвание продукта, указанное при создании тест-плана
$PROJECT_GLOBAL_IDГлобальный идентификатор проекта, к которому относятся запускаемые автотесты
$PROJECT_IDИдентификатор проекта в формате GUID, к которому относятся запускаемые автотесты
$PROJECT_NAMEНазвание проекта, к которому относятся запускаемые автотесты
$START_DATEДата планируемого начала тест-плана
$TEST_PLAN_GLOBAL_IDГлобальный идентификатор тест-плана, в рамках которого происходит запуск автотестов
$TEST_PLAN_IDИдентификатор тест-плана в формате GUID, в рамках которого происходит запуск автотестов
$TEST_PLAN_URLСсылка на тест-план в Test IT
$TEST_POINTS_COUNTКоличество тестовых случаев, участвующих в запуске
$TEST_RUN_IDИдентификатор запуска автотестов
$SERVER_URLСсылка на систему Test IT
$USER_NAMEИмя пользователя, выполнившего запуск автотестов
$COMPLETED_ON_DATEДата и время перевода тест-плана в статус Завершен
$CONFIGURATION_IDSИдентификаторы конфигураций
$CONFIGURATION_NAMESНазвания конфигураций
$CONFIGURATIONS_PARAMETERS[KEY]Доступ к значениям параметра конфигурации, на которой запускается автотест
$CUSTOM_PARAMETERS[KEY]Доступ к значениям параметра конфигурации, на которой запускается автотест. Значения берутся из параметризации запуска автотеста
$END_DATEДата планируемого окончания тест-плана
$PROJECT_URLСсылка на проект в Test IT, к которому относятся автотесты
$STARTED_ON_DATEДата и время перевода тест-плана в статус В процессе
$TEST_PLAN_DESCRIPTIONОписание тест-плана
$TEST_PLAN_DURATIONПродолжительность тест-плана
$TEST_PLAN_NAMEНазвание тест-плана
$TEST_PLAN_STATUSСтатус тест-плана
$TEST_RUN_COMPLETED_DATEДата и время завершения тест-рана
$TEST_RUN_DESCRIPTIONОписание тест-рана
$TEST_RUN_NAMEНазвание тест-рана
$TEST_RUN_STARTED_DATEДата запуска тест-рана
$TEST_RUN_URLСсылка на тест-ран в Test IT
Пример стандартного тела HTTP

При выборе опции Отправлять стандартный контекст в поле Тело HTTP Test IT передает следующую структуру данных:

{
    "AutoTests": [
        {
            "Classname": "WorkItemServiceTest.cs",
            "ExternalId": "10004",
            "ExternalKey": null,
            "Id": "0101d818-ceee-4bc5-bf07-351195d4f962",
            "Name": "WorkItem valid creation test",
            "Namespace": "UnitTest.Core",
            "ProjectId": "915a9144-9803-42a3-8076-dbc685bfdd1d"
        },
        {
            "Classname": "WorkItemServiceTest.cs",
            "ExternalId": "10003",
            "ExternalKey": null,
            "Id": "01893e23-a953-4509-8cac-650354fa83e3",
            "Name": "WorkItem valid creation test",
            "Namespace": "UnitTest.Core",
            "ProjectId": "915a9144-9803-42a3-8076-dbc685bfdd1d"
        }
    ],
    "Build": "build",
    "Configurations": [
        {
            "Id": "7faad2ea-8222-4791-8822-284f0db94649",
            "Name": "Any",
            "Parameters": {
                "Browser": "chrome"
            },
            "ProjectId": "915a9144-9803-42a3-8076-dbc685bfdd1d"
        }
    ],
    "CustomParameters": {
        "OperatingSystem": "windows"
    },
    "Name": "TestRun_2024-04-24T11:25:43",
    "ProductName": "my product",
    "Status": "NotStarted",
    "TestPlanGlobalId": 30,
    "TestPlanId": "9dd8429d-f4ee-4fc0-8ed5-31af29de5cc0",
    "TestPointIds": [
        "4a0663fb-fd47-41f4-9f42-bde8a68d93f6",
        "5358d2a6-7486-4435-944c-f57516cef0f4"
    ],
    "TestRunId": "7823ae8b-92a5-47bd-98bb-eb09a27807d4"
}

Вебхук для создания, редактирования и удаления карточек автотестов

HTTP-запрос передается, когда карточка автотеста была создана, отредактирована или удалена.

Доступные специальные переменные
ПеременнаяОписание
$EVENT_TYPEТип события
$AUTOTEST_IDИдентификатор автотеста
$AUTOTEST_NAMEНазвание автотеста
$AUTOTEST_URLСсылка на автотест в Test IT
$PROJECT_IDИдентификатор проекта в формате GUID, к которому относятся автотесты
$PROJECT_NAMEНазвание проекта, к которому относятся автотесты
$PROJECT_URLСсылка на проект в Test IT, к которому относятся автотесты
$AUTOTEST_CLASSNAMEНазвание класса автотеста
$PROJECT_GLOBAL_IDГлобальный идентификатор проекта, к которому относится автотест
$USER_NAMEИмя пользователя, который создал, отредактировал или удалил карточку автотеста
Пример стандартного тела HTTP

Пример вебхука для создания автотеста. При выборе опции Отправлять стандартный контекст в поле Тело HTTP Test IT передает следующую структуру данных:

{
  "eventType": "CREATED",
  "autotestId": "a4f60cc2-3f2b-4949-b779-7c532485efa1",
  "autotestName": "string",
  "autotestUrl": "https://test.testit.ru/projects/1586/autotests/1588",
  "projectId": "cf76841e-fb42-42ab-ae07-2a5d02b04fc3",
  "projectName": "вебхуки",
  "projectUrl": "https://test.testit.ru/projects/1586"
}

Вебхук для прохождения всех автотестов

HTTP-запрос передается, когда все автотесты в тест-ране (прогоне) пройдены: всем автотестам был проставлен результат Успешен, Провален, Пропущен или Заблокирован, и автотестов со статусами В процессе или Ожидает не осталось.

Доступные специальные переменные
ПеременнаяОписание
$TEST_RUN_IDИдентификатор тест-рана
$TEST_RUN_NAMEНазвание тест-рана
$TEST_RUN_URLСсылка на тест-ран в Test IT
$TEST_PLAN_IDИдентификатор тест-плана (не заполняется, если тест-ран был запущен не в рамках тест-плана)
$TEST_PLAN_URLСсылка на тест-план в Test IT (не заполняется, если тест-ран был запущен не в рамках тест-плана)
$PROJECT_IDИдентификатор проекта в формате GUID, к которому относится тест-ран
$PROJECT_NAMEНазвание проекта, к которому относится тест-ран
$PROJECT_URLСсылка на проект в Test IT
$BUILDНомер сборки, указанный при создании тест-плана
$COMPLETED_ON_DATEДата и время перевода тест-плана в статус Завершен
$END_DATEДата планируемого окончания тест-плана
$PRODUCT_NAMEНазвание продукта
$PROJECT_GLOBAL_IDГлобальный идентификатор проекта, к которому относятся автотесты
$START_DATEДата планируемого начала тест-плана
$STARTED_ON_DATEДата и время перевода тест-плана в статус В процессе
$TEST_PLAN_DESCRIPTIONОписание тест-плана
$TEST_PLAN_DURATIONПродолжительность тест-плана
$TEST_PLAN_GLOBAL_IDГлобальный идентификатор тест-плана
$TEST_PLAN_STATUSСтатус тест-плана
$TEST_RUN_COMPLETED_DATEДата и время завершения тест-рана
$TEST_RUN_DESCRIPTIONОписание тест-рана
$TEST_RUN_STARTED_DATEДата запуска тест-рана
Пример стандартного тела HTTP

При выборе опции Отправлять стандартный контекст в поле Тело HTTP Test IT передает следующую структуру данных:

{
  "testRunId": "227f2b6b-5361-4196-bbb3-7859ac88891b",
  "testRunName": "TestRun_2023-06-15T11:38:57",
  "testRunUrl": "https://test.testit.ru/projects/1586/test-plans/1590/test-runs/227f2b6b-5361-4196-bbb3-7859ac88891b",
  "testPlanId": "9c294e9c-e79c-44a2-8ba7-6ee649fc3202", 
  "testPlanName": "23",
  "testPlanUrl": "https://test.testit.ru/projects/1586/test-plans/1590/plan",
  "projectId": "cf76841e-fb42-42ab-ae07-2a5d02b04fc3",
  "projectName": "вебхуки",
  "projectUrl": "https://test.testit.ru/projects/1586"
}

Вебхук для остановки тест-рана

HTTP-запрос передается при остановке тест-рана с помощью API-метода POST/api/v2/testRuns/{id}/stop.

Доступные специальные переменные
ПеременнаяОписание
$TEST_RUN_IDИдентификатор тест-рана
$TEST_RUN_NAMEНазвание тест-рана
$TEST_RUN_URLСсылка на тест-ран в Test IT
$TEST_PLAN_IDИдентификатор тест-рана (не заполняется, если тест-ран запущен не в рамках тест-плана)
$TEST_PLAN_NAMEНазвание тест-рана (не заполняется, если тест-ран запущен не в рамках тест-плана)
$TEST_PLAN_URLСсылка на тест-план в Test IT (не заполняется, если тест-ран запущен не в рамках тест-плана)
$PROJECT_IDИдентификатор проекта в формате GUID, к которому относится тест-ран
$PROJECT_NAMEНазвание проекта, к которому относится тест-ран
$PROJECT_URLСсылка на проект в Test IT, к которому относится тест-ран
$BUILDНомер сборки, указанный при создании тест-плана
$COMPLETED_ON_DATEДата и время перевода тест-плана в статус Завершен
$END_DATEДата планируемого окончания тест-плана
$PRODUCT_NAMEНазвание продукта
$PROJECT_GLOBAL_IDГлобальный идентификатор проекта, к которому относится тест-план
$START_DATEДата планируемого начала тест-плана
$STARTED_ON_DATEДата и время перевода тест-плана в статус В процессе
$TEST_PLAN_DESCRIPTIONОписание тест-плана
$TEST_PLAN_DURATIONПродолжительность тест-плана
$TEST_PLAN_GLOBAL_IDГлобальный идентификатор тест-плана
$TEST_PLAN_STATUSСтатус тест-плана
$TEST_RUN_COMPLETED_DATEДата и время завершения тест-рана
$TEST_RUN_DESCRIPTIONОписание тест-рана
$TEST_RUN_STARTED_DATEДата запуска тест-рана
Пример стандартного тела HTTP

При выборе опции Отправлять стандартный контекст в поле Тело HTTP Test IT передает следующую структуру данных:

{
  "projectId": "cf76841e-fb42-42ab-ae07-2a5d02b04fc3",
  "projectName": "вебхуки",
  "projectUrl": "https://test.testit.ru/projects/1586",
  "testPlanId": "9c294e9c-e79c-44a2-8ba7-6ee649fc3202",
  "testPlanName": "23",
  "testPlanUrl": "https://test.testit.ru/projects/1586/test-plans/1590/plan",
  "testRunId": "7c0400f8-ad43-4e45-9cf7-382047f4044f",
  "testRunName": "TestRun_2023-06-15T11:46:31",
  "testRunUrl": "https://test.testit.ru/projects/1586/test-plans/1590/test-runs/7c0400f8-ad43-4e45-9cf7-382047f4044f"
}

Вебхук для прохождения автотеста

HTTP-запрос передается, когда автотесту проставляется результат Успешен, Провален, Пропущен или Заблокирован.

Доступные специальные переменные
ПеременнаяОписание
$RESULT_NAMEРезультат автотеста: Успешен, Пропущен, Провален или Заблокирован
$RESULT_URLСсылка на результат автотеста
$AUTOTEST_IDИдентификатор автотеста
$AUTOTEST_NAMEНазвание автотеста
$AUTOTEST_URLСсылка на автотест
$TEST_RUN_IDИдентификатор тест-рана
$TEST_RUN_NAMEНазвание тест-рана
$TEST_RUN_URLСсылка на тест-ран в Test IT
$PROJECT_IDИдентификатор проекта в формате GUID, к которому относится тест-ран
$PROJECT_NAMEНазвание проекта, к которому относится тест-ран
$PROJECT_URLСсылка на проект в Test IT, к которому относится автотест
$AUTOTEST_CLASSNAMEНазвание класса автотеста
$PROJECT_GLOBAL_IDГлобальный идентификатор проекта, к которому относится тест-план
$TEST_RUN_COMPLETED_DATEДата и время завершения тест-рана
$TEST_RUN_DESCRIPTIONОписание тест-рана
$TEST_RUN_STARTED_DATEДата запуска тест-рана
Пример стандартного тела HTTP

При выборе опции Отправлять стандартный контекст в поле Тело HTTP Test IT передает следующую структуру данных:

{
  "resultName": "Passed",
  "resultUrl": "https://test.testit.ru/projects/1586/test-plans/1590/results?testResultId=471a0169-e327-4302-b500-4d68241282ef",
  "autotestId": "a4f60cc2-3f2b-4949-b779-7c532485efa1",
  "autotestName": "string",
  "autotestUrl": "https://test.testit.ru/projects/1586/autotests/1588",
  "testRunId": "227f2b6b-5361-4196-bbb3-7859ac88891b",
  "testRunName": "TestRun_2023-06-15T11:38:57",
  "testRunUrl": "https://test.testit.ru/projects/1586/test-plans/1590/test-runs/227f2b6b-5361-4196-bbb3-7859ac88891b",
  "projectId": "cf76841e-fb42-42ab-ae07-2a5d02b04fc3", 
  "projectName": "вебхуки",
  "projectUrl": "https://test.testit.ru/projects/1586"
}

Изменение связи между автотестом и рабочим элементом

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

Доступные специальные переменные
ПеременнаяОписание
$EVENT_TYPEТип события
$AUTOTEST_IDИдентификатор автотеста
$AUTOTEST_NAMEНазвание автотеста
$AUTOTEST_URLСсылка на автотест
$WORK_ITEM_IDИдентификатор рабочего элемента
$WORK_ITEM_NAMEНазвание рабочего элемента
$WORK_ITEM_URLСсылка на рабочий элемент
$PROJECT_IDИдентификатор проекта в формате GUID, к которому относятся запускаемые автотесты
$PROJECT_NAMEНазвание проекта, к которому относятся запускаемые автотесты
$ROJECT_URLСсылка на проект в Test IT, к которому относится автотест
$AUTOTEST_CLASSNAMEНазвание класса автотеста
$PROJECT_GLOBAL_IDГлобальный идентификатор проекта, к которому относится тест-план
$USER_NAMEИмя пользователя, который создал или удалил связь между ручным и автоматическим тестом
$WORK_ITEM_DURATIONПродолжительность прохождения ручного теста
$WORK_ITEM_PRIORITYПриоритет ручного теста
$WORK_ITEM_SECTIONСекция, к которой относится ручной тест
$WORK_ITEM_TYPEТип рабочего элемента (ручного теста)
Пример стандартного тела HTTP

При выборе опции Отправлять стандартный контекст в поле Тело HTTP Test IT передает следующую структуру данных:

{
  "eventType": "UPDATED",
  "workItemId": "e4428f83-fe7f-4740-9e4f-8a6136360ef6",
  "workItemName": "Test incremental search with multi-page document",
  "workItemType": "TestCases",
  "workItemUrl": "https://regress01.qa.enterprise.testit.ru/projects/1/tests/1347",
  "projectId": "7470422c-7db0-4402-8513-fbd7e23d04a4",
  "projectName": "lugg",
  "projectUrl": "https://regress01.qa.enterprise.testit.ru/projects/1"
}
Обновлено: