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

Вебхук для изменения тест-плана

HTTP-запрос передается при создании, редактировании или архивации тест-плана.

Доступные специальные переменные
ПеременнаяОписание
$EVENT_TYPEТип события: создание, редактирование, архивация
$TEST_PLAN_IDИдентификатор тест-плана в формате GUID
$TEST_PLAN_NAMEНазвание тест-плана
$TEST_PLAN_URLСсылка на тест-план
$PROJECT_IDИдентификатор проекта в формате GUID, к которому относится тест-план
$PROJECT_NAMEНазвание проекта, к которому относится тест-план
$PROJECT_URLСсылка на проект, к которому относится тест-план
$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Статус, в который перешел тест-план
Пример стандартного тела HTTP

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

{
  "eventType": "CREATED",
  "testPlanId": "d94f04e7-2cc9-42c1-83a7-a9ae65e12199",
  "testPlanName": "а",
  "testPlanUrl": "https://test.testit.ru/projects/1586/test-plans/118621/plan",
  "projectId": "cf76841e-fb42-42ab-ae07-2a5d02b04fc3",
  "projectName": "вебхуки",
  "projectUrl": "https://test.testit.ru/projects/1586"
}

Вебхук для изменения статуса тест-плана

HTTP-запрос передается при изменении статуса тест-плана.

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

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

{
  "GlobalId": 0,
  "StateName": "string",
  "Name": "string",
  "StartDate": "11/29/2019 14:37:00",
  "EndDate": "11/29/2019 14:37:00",
  "Description": "string",
  "Build": "string",
  "ProjectId": "guid",
  "ProductName": "string",
  "Duration": "",
  "Tags": [],
  "Link": "string",
  "IsDeleted": false
}

Вебхук для создания задачи из тест-плана в Jira

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

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

Переменная $CONFIGURATIONS_PARAMETERS[KEY] передает доступ к значениям параметра конфигурации, на которой запускается автотест.
Пример: Для параметра "OS — Windows" укажите:

  {
    "OperatingSystem": "$CONFIGURATIONS_PARAMETERS[OS]"
  }

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

  {
    "OperatingSystem": "Windows"
  }

При указании несуществующего ключа параметра в [KEY] отобразится пустое значение.

Доступные специальные переменные
ПеременнаяОписание
$RESULT_NAMEРезультат, присвоенный тест-поинту: Успешен, Пропущен, Провален или Заблокирован
$TEST_POINT_IDИдентификатор тест-поинта в Test IT
$TEST_POINT_NAMEНазвание тест-поинта
$TEST_PLAN_IDИдентификатор тест-плана, в который входит тест-поинт
$TEST_PLAN_NAMEНазвание тест-плана, в который входит тест-поинт
$TEST_PLAN_URLСсылка на тест-план в Test IT, в котором создан тест поинт
$PROJECT_IDИдентификатор проекта, к которому относится тест-поинт, в формате GUID
$PROJECT_NAMEНазвание проекта
$PROJECT_URLСсылка на проект в Test IT, к которому относится тест-поинт
$BUILDНомер сборки, указанный при создании тест-плана
$COMPLETED_ON_DATEДата и время перевода тест-плана в статус Завершен
$CONFIGURATION_IDИдентификатор конфигурации
$CONFIGURATION_NAMEНазвание конфигурации
$CONFIGURATIONS_PARAMETERS[KEY]Доступ к значениям параметра конфигурации, на которой запускается автотест
$END_DATEДата планируемого окончания тест-плана
$PRODUCT_NAMEНазвание продукта, указанное при создании тест-плана
$PROJECT_GLOBAL_IDГлобальный идентификатор проекта, к которому относится тест-план
$RESULT_URLСсылка на результат теста
$START_DATEДата планируемого начала тест-плана
$STARTED_ON_DATEДата и время перевода тест-плана в статус В процессе
$TEST_PLAN_DESCRIPTIONОписание тест-плана
$TEST_PLAN_DURATIONПродолжительность тест-плана
$TEST_PLAN_GLOBAL_IDГлобальный идентификатор тест-плана
$TEST_PLAN_STATUSСтатус тест-плана
Пример стандартного тела 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",
  "testPointId": "6c1ff1bd-1f9c-45eb-aa16-b6deb2832d0c",
  "testPointName": "1",
  "testPointUrl": "https://test.testit.ru/projects/1586/test-plans/1590/results?testResultId=794e2ed6-2927-4fba-8824-1b55d6d8b2c9",
  "resultName": "Skipped"
}
Обновлено: