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

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

HTTP-запрос передается при запуске автотестов из интерфейса Test IT. Вы можете использовать следующие специальные переменные:

ПеременнаяОписание
$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Имя пользователя выполнившего запуск автотестов
Пример стандартного тела HTTP (развернуть)

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

[
 {
 "testRunId": "string",
 "testPlanGlobalId": 0,
 "productName": "string",
 "build": "string",
 "configurations": [
 {
 "entityTypeName": "string",
 "createdDate": "2019-08-15T10:01:51.412Z",
 "modifiedDate": "2019-08-15T10:01:51.412Z",
 "createdById": "string",
 "modifiedById": "string",
 "name": "string",
 "description": "string",
 "isActive": true,
 "capabilities": {},
 "projectId": "string",
 "globalId": 0,
 "id": "string",
 "isDeleted": true
 }
 ],
 "autoTests": [
 {
 "createdDate": "2019-08-15T10:01:51.413Z",
 "modifiedDate": "2019-08-15T10:01:51.413Z",
 "createdById": "string",
 "modifiedById": "string",
 "workItems": [
 {
 "createdDate": "2019-08-15T10:01:51.413Z",
 "modifiedDate": "2019-08-15T10:01:51.413Z",
 "createdById": "string",
 "modifiedById": "string",
 "isAutomated": true,
 "attachments": [
 {
 "name": "string",
 "fileId": "string",
 "type": "string",
 "size": 0,
 "createdDate": "2019-08-15T10:01:51.413Z",
 "modifiedDate": "2019-08-15T10:01:51.413Z",
 "createdById": "string",
 "modifiedById": "string",
 "workItemId": "string",
 "id": "string",
 "isDeleted": true
 }
 ],
 "autoTests": [
 null
 ],
 "name": "string",
 "entityTypeName": "string",
 "projectId": "string",
 "sectionId": "string",
 "description": "string",
 "state": "string",
 "priority": 1,
 "globalId": 0,
 "steps": [
 {
 "action": "string",
 "expected": "string",
 "workItemId": "string"
 }
 ],
 "duration": 0,
 "attributes": [
 {
 "attributeId": "string",
 "value": "string"
 }
 ],
 "tags": [
 {
 "id": "string",
 "name": "string",
 "createdDate": "2019-08-15T10:01:51.413Z",
 "modifiedDate": "2019-08-15T10:01:51.413Z",
 "createdById": "string",
 "modifiedById": "string"
 }
 ],
 "links": [
 {
 "id": "string",
 "isDeleted": true,
 "title": "string",
 "url": "string",
 "description": "string"
 }
 ],
 "id": "string",
 "isDeleted": true
 }
 ],
 "autotestExternalId": "string",
 "testLinkInRepository": "string",
 "id": "string",
 "isDeleted": true
 }
 ],
 "testPoints": [
 {
 "configurationGlobalId": 0,
 "autoTestIds": [
 "string"
 ]
 }
 ],
 "status": "string"
 }
]

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

HTTP-запрос передается, когда автотест был создан, отредактирован или удален. Вы можете использовать следующие специальные переменные:

ПеременнаяОписание
$EVENT_TYPEТип события
$AUTOTEST_IDИдентификатор автотеста
$AUTOTEST_NAMEНазвание автотеста
$AUTOTEST_URLСсылка на автотест в системе Test IT
$PROJECT_IDИдентификатор проекта в формате GUID, к которому относятся автотесты
$PROJECT_NAMEНазвание проекта, к которому относятся автотесты
$PROJECT_URLСсылка на проект, к которому относятся автотесты, в системе Test IT
Пример стандартного тела 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
Пример стандартного тела 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
Пример стандартного тела 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
Пример стандартного тела 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
Пример стандартного тела 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"
}
Обновлено: