Runs - Create

Service:

Test

API Version:

7.1-preview.3

Создание тестового запуска.

POST https://dev.azure.com/{organization}/{project}/_apis/test/runs?api-version=7.1-preview.3

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
project	path	True	string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.3.

Текст запроса

Имя	Тип	Описание
automated	boolean	Значение true, если тестовый запуск выполняется автоматически, в противном случае — false. По умолчанию это значение равно false.
build	ShallowReference	Абстрактная ссылка на сборку, к которой она принадлежит.
buildDropLocation	string	Удалите расположение сборки, используемой для тестового запуска.
buildFlavor	string	Разновидность сборки, используемой для тестового запуска. (Например, выпуск, отладка)
buildPlatform	string	Платформа сборки, используемой для тестового запуска. (Например, x86, amd64)
buildReference	BuildConfiguration	BuildReference тестового запуска.
comment	string	Комментарии, введенные теми, кто анализирует выполнение.
completeDate	string	Дата завершения выполнения.
configurationIds	integer[]	Идентификаторы конфигураций теста, связанных с запуском.
controller	string	Имя контроллера тестирования, используемого для автоматического запуска.
customTestFields	CustomTestField[]	Дополнительные свойства тестового запуска.
dtlAutEnvironment	ShallowReference	Абстрактная ссылка на DtlAutEnvironment.
dtlTestEnvironment	ShallowReference	Абстрактная ссылка на DtlTestEnvironment.
dueDate	string	Дата и время выполнения теста.
environmentDetails	DtlEnvironmentDetails	Это временный класс для предоставления сведений о среде тестового запуска.
errorMessage	string	Сообщение об ошибке, связанное с выполнением.
filter	RunFilter	Фильтр, используемый для обнаружения запуска.
iteration	string	Итерация, в которой создается запуск. Корневая итерация командного проекта будет использоваться по умолчанию
name	string	Имя тестового запуска.
owner	IdentityRef	Отображаемое имя владельца запуска.
pipelineReference	PipelineReference	Ссылка на конвейер, к которому принадлежит этот тестовый запуск. PipelineReference.PipelineId должен быть равен RunCreateModel.Build.Id
plan	ShallowReference	Абстрактная ссылка на принадлежащий ему план.
pointIds	integer[]	Идентификаторы тестовых точек, используемых в выполнении.
releaseEnvironmentUri	string	URI среды выпуска, связанной с выполнением.
releaseReference	ReleaseReference	Ссылка на выпуск, связанный с тестового запуска.
releaseUri	string	URI выпуска, связанного с выполнением.
runSummary	RunSummaryModel[]	Сводка по запуску для типа выполнения = NoConfigRun.
runTimeout	string	Интервал времени до запуска истекает.
sourceWorkflow	string	SourceWorkFlow(CI/CD) тестового запуска.
startDate	string	Дата начала выполнения.
state	string	Состояние выполнения. Тип TestRunState— Допустимые состояния — NotStarted, InProgress, Waiting
tags	TestTag[]	Теги для вложения при тестовом запуске. Для запуска можно добавить не более 5 тегов.
testConfigurationsMapping	string	TestConfigurationMapping тестового запуска.
testEnvironmentId	string	Идентификатор тестовой среды, связанной с запуском.
testSettings	ShallowReference	Абстрактная ссылка на ресурс параметров тестирования.
type	string	Тип допустимых значений run(RunType): (Unspecified, Normal, Blocking, Web, MtrRunInitiatedFromWeb, RunWithDtlEnv, NoConfigRun)

Ответы

Имя	Тип	Описание
200 OK	TestRun	успешная операция

Безопасность

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Имя	Описание
vso.test_write	Предоставляет возможность читать, создавать и обновлять планы тестирования, случаи, результаты и другие артефакты, связанные с управлением тестами.

Примеры

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/runs?api-version=7.1-preview.3

{
  "name": "NewTestRun",
  "plan": {
    "id": "1"
  },
  "pointIds": [
    1,
    1
  ]
}

Sample Response

Status code:

200

{
  "id": 31,
  "name": "NewTestRun",
  "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Runs/31",
  "isAutomated": false,
  "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
  "owner": {
    "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabrikamfiber3@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
  },
  "project": {
    "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
    "name": "Fabrikam-Fiber-TFVC",
    "url": "https://dev.azure.com/fabrikam/_apis/projects/Fabrikam-Fiber-TFVC"
  },
  "startedDate": "2014-05-28T16:39:00.44Z",
  "state": "InProgress",
  "plan": {
    "id": "1",
    "name": "sprint1",
    "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1"
  },
  "postProcessState": "Complete",
  "totalTests": 2,
  "incompleteTests": 2,
  "createdDate": "2014-05-28T16:39:00.4Z",
  "lastUpdatedDate": "2014-05-28T16:39:00.44Z",
  "lastUpdatedBy": {
    "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabrikamfiber3@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
  },
  "revision": 2
}

Определения

Имя	Описание
BuildConfiguration	Сведения о сборкеКонфигурация.
CustomTestField	Сведения о настраиваемом поле. Allowed Key : Value pairs - ( AttemptId: int value, IsTestResultFlaky: bool)
DtlEnvironmentDetails	Это временный класс для предоставления сведений о среде тестового запуска.
IdentityRef
JobReference	Задание в конвейере. Это связано с матрицированием в YAML.
PhaseReference	Этап в конвейере
PipelineReference	Справочник по конвейеру
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
ReleaseReference	Ссылка на выпуск.
ResultMetadata	ResultMetadata для заданного результата или счетчика.
RunCreateModel	Сведения о создании тестового запуска.
RunFilter	Этот класс используется для предоставления фильтров, используемых для обнаружения.
RunStatistic	Статистика тестового выполнения для каждого результата.
RunSummaryModel	Выполните сводку по каждому типу выходных данных теста.
ShallowReference	Абстрактная ссылка на какой-то другой ресурс. Этот класс используется для предоставления контрактам данных сборки единообразного способа ссылки на другие ресурсы таким образом, чтобы обеспечить простой обход по ссылкам.
StageReference	Этап в конвейере
TestEnvironment	Сведения о тестовой среде.
TestOutcome
TestResolutionState	Сведения о состоянии разрешения теста.
TestRun	Сведения о тестовом запуске.
TestRunSubstate	Типы вложенных состояний для тестового запуска.
TestTag	Тег, присоединенный к выполнению или результату.

BuildConfiguration

Сведения о сборкеКонфигурация.

Имя	Тип	Описание
branchName	string	Имя ветви, для которой создается сборка.
buildDefinitionId	integer	BuildDefinitionId для сборки.
buildSystem	string	Сборка системы.
creationDate	string	Дата создания сборки.
flavor	string	Вариант сборки (например, сборка или выпуск).
id	integer	BuildConfiguration Id.
number	string	Номер сборки.
platform	string	BuildConfiguration Platform.
project	ShallowReference	Проект, связанный с этой buildConfiguration.
repositoryGuid	string	Guid репозитория для сборки.
repositoryType	string	Тип репозитория (например, TFSGit).
sourceVersion	string	Была активирована исходная версия (/первая фиксация) для сборки.
targetBranchName	string	Имя целевой ветви.
uri	string	URI сборки.

CustomTestField

Сведения о настраиваемом поле. Allowed Key : Value pairs - ( AttemptId: int value, IsTestResultFlaky: bool)

Имя	Тип	Описание
fieldName	string	имя поля;
value	object	Значение поля.

DtlEnvironmentDetails

Это временный класс для предоставления сведений о среде тестового запуска.

Имя	Тип	Описание
csmContent	string
csmParameters	string
subscriptionName	string

IdentityRef

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string	Нерекомендуемый — можно получить, запросив пользователя Graph, на который ссылается запись self словаря IdentityRef _links.
displayName	string	Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника.
id	string
imageUrl	string	Не рекомендуется — доступно в записи "аватар" словаря IdentityRef "_links"
inactive	boolean	Не рекомендуется — можно получить, запросив состояние членства Graph, указанное в записи membershipState словаря GraphUser _links.
isAadIdentity	boolean	Не рекомендуется — может выводиться из типа субъекта дескриптора (descriptor.IsAadUserType/descriptor.IsAadGroupType).
isContainer	boolean	Не рекомендуется — может выводиться из типа субъекта дескриптора (Descriptor.IsGroupType).
isDeletedInOrigin	boolean
profileUrl	string	Нерекомендуемый — не используется в большинстве уже существовающих реализаций ToIdentityRef.
uniqueName	string	Нерекомендуемый — используйте вместо этого домен+имя_субъекта
url	string	Этот URL-адрес является полным маршрутом к исходному ресурсу этого субъекта графа.

JobReference

Задание в конвейере. Это связано с матрицированием в YAML.

Имя	Тип	Описание
attempt	integer	Номер попытки задания
jobName	string	При матрице в YAML создаются копии задания с разными входными данными в матрице. JobName — это имя этих входных данных. Максимальная поддерживаемая длина имени — 256 символов.

PhaseReference

Этап в конвейере

Имя	Тип	Описание
attempt	integer	Номер попытки этапа
phaseName	string	Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

PipelineReference

Справочник по конвейеру

Имя	Тип	Описание
jobReference	JobReference	Справочник по заданию
phaseReference	PhaseReference	Ссылка на этап.
pipelineId	integer	Ссылка на конвейер, с которым связан этот экземпляр конвейера.
stageReference	StageReference	Ссылка на этап.

ReferenceLinks

Класс, представляющий коллекцию ссылок REST.

Имя	Тип	Описание
links	object	Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.

ReleaseReference

Ссылка на выпуск.

Имя	Тип	Описание
attempt	integer	Число попыток выпуска.
creationDate	string	Дата создания выпуска (UTC).
definitionId	integer	Идентификатор определения выпуска.
environmentCreationDate	string	Дата создания среды (UTC).
environmentDefinitionId	integer	Идентификатор определения среды выпуска.
environmentDefinitionName	string	Имя определения среды выпуска.
environmentId	integer	Идентификатор среды выпуска.
environmentName	string	Имя среды выпуска.
id	integer	Идентификатор выпуска.
name	string	Имя выпуска.

ResultMetadata

ResultMetadata для заданного результата или счетчика.

Имя	Тип	Описание
flaky	string	Ненадежные метаданные
rerun	string	Повторный запуск метаданных

RunCreateModel

Сведения о создании тестового запуска.

Имя	Тип	Описание
automated	boolean	Значение true, если тестовый запуск выполняется автоматически, в противном случае — false. По умолчанию это значение равно false.
build	ShallowReference	Абстрактная ссылка на сборку, к которой она принадлежит.
buildDropLocation	string	Удалите расположение сборки, используемой для тестового запуска.
buildFlavor	string	Разновидность сборки, используемой для тестового запуска. (Например, выпуск, отладка)
buildPlatform	string	Платформа сборки, используемой для тестового запуска. (Например, x86, amd64)
buildReference	BuildConfiguration	BuildReference тестового запуска.
comment	string	Комментарии, введенные теми, кто анализирует выполнение.
completeDate	string	Дата завершения выполнения.
configurationIds	integer[]	Идентификаторы конфигураций теста, связанных с запуском.
controller	string	Имя контроллера тестирования, используемого для автоматического запуска.
customTestFields	CustomTestField[]	Дополнительные свойства тестового запуска.
dtlAutEnvironment	ShallowReference	Абстрактная ссылка на DtlAutEnvironment.
dtlTestEnvironment	ShallowReference	Абстрактная ссылка на DtlTestEnvironment.
dueDate	string	Дата и время выполнения теста.
environmentDetails	DtlEnvironmentDetails	Это временный класс для предоставления сведений о среде тестового запуска.
errorMessage	string	Сообщение об ошибке, связанное с выполнением.
filter	RunFilter	Фильтр, используемый для обнаружения запуска.
iteration	string	Итерация, в которой создается запуск. Корневая итерация командного проекта будет использоваться по умолчанию
name	string	Имя тестового запуска.
owner	IdentityRef	Отображаемое имя владельца запуска.
pipelineReference	PipelineReference	Ссылка на конвейер, к которому принадлежит этот тестовый запуск. PipelineReference.PipelineId должен быть равен RunCreateModel.Build.Id
plan	ShallowReference	Абстрактная ссылка на принадлежащий ему план.
pointIds	integer[]	Идентификаторы тестовых точек, используемых в выполнении.
releaseEnvironmentUri	string	URI среды выпуска, связанной с выполнением.
releaseReference	ReleaseReference	Ссылка на выпуск, связанный с тестового запуска.
releaseUri	string	URI выпуска, связанного с выполнением.
runSummary	RunSummaryModel[]	Сводка по запуску для типа выполнения = NoConfigRun.
runTimeout	string	Интервал времени до запуска истекает.
sourceWorkflow	string	SourceWorkFlow(CI/CD) тестового запуска.
startDate	string	Дата начала выполнения.
state	string	Состояние выполнения. Тип TestRunState— Допустимые состояния — NotStarted, InProgress, Waiting
tags	TestTag[]	Теги для вложения при тестовом запуске. Для запуска можно добавить не более 5 тегов.
testConfigurationsMapping	string	TestConfigurationMapping тестового запуска.
testEnvironmentId	string	Идентификатор тестовой среды, связанной с запуском.
testSettings	ShallowReference	Абстрактная ссылка на ресурс параметров тестирования.
type	string	Тип допустимых значений run(RunType): (Unspecified, Normal, Blocking, Web, MtrRunInitiatedFromWeb, RunWithDtlEnv, NoConfigRun)

RunFilter

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

Имя	Тип	Описание
sourceFilter	string	фильтр для источников тестовых случаев (тестовые контейнеры)
testCaseFilter	string	фильтр для тестовых случаев

RunStatistic

Статистика тестового выполнения для каждого результата.

Имя	Тип	Описание
count	integer	Количество результатов теста для заданного результата.
outcome	string	Результат теста
resolutionState	TestResolutionState	Состояние разрешения тестового запуска.
resultMetadata	ResultMetadata	ResultMetadata для заданного результата или счетчика.
state	string	Состояние тестового запуска

RunSummaryModel

Выполните сводку по каждому типу выходных данных теста.

Имя	Тип	Описание
duration	integer	Общее время, затраченное в миллисекундах.
resultCount	integer	Число результатов для Outcome TestOutcome
testOutcome	TestOutcome	Сводка основана на результатах

ShallowReference

Абстрактная ссылка на какой-то другой ресурс. Этот класс используется для предоставления контрактам данных сборки единообразного способа ссылки на другие ресурсы таким образом, чтобы обеспечить простой обход по ссылкам.

Имя	Тип	Описание
id	string	Идентификатор ресурса
name	string	Имя связанного ресурса (имя определения, имя контроллера и т. д.)
url	string	Полная ссылка http на ресурс

StageReference

Этап в конвейере

Имя	Тип	Описание
attempt	integer	Число попыток этапа
stageName	string	Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

TestEnvironment

Сведения о тестовой среде.

Имя	Тип	Описание
environmentId	string	Идентификатор тестовой среды.
environmentName	string	Имя тестовой среды.

TestOutcome

Имя	Тип	Описание
aborted	string	Тест был прерван. Это было вызвано не жестом пользователя, а решением платформы.
blocked	string	Тест имел шанс на выполнение, но не был, так как ITestElement.IsRunnable == false.
error	string	При попытке выполнить тест произошла системная ошибка.
failed	string	Тест был выполнен, но были проблемы. Проблемы могут быть связаны с исключениями или неудачными утверждениями.
inProgress	string	В настоящее время выполняется тест. Добавлен для диаграмм TCM.
inconclusive	string	Тест завершен, но мы не можем сказать, пройдена ли она или завершилась ошибкой. Может использоваться для прерванных тестов...
none	string	Тест не завершен или тип теста не сообщает о пройденных или неудачных действиях.
notApplicable	string	Тест неприменим для выполнения.
notExecuted	string	Тест не был выполнен. Это было вызвано жестом пользователя, например нажатием кнопки "Остановить".
notImpacted	string	Тест не затрагивается. Добавлена fot TIA.
passed	string	Тест был выполнен без каких-либо проблем.
paused	string	Тест приостановлен.
timeout	string	Истекло время ожидания теста
unspecified	string	Используется только во время обновления для сохранения существующего значения.
warning	string	Используется результатами уровня выполнения. Это не сбой.

TestResolutionState

Сведения о состоянии разрешения теста.

Имя	Тип	Описание
id	integer	Идентификатор состояния разрешения теста.
name	string	Имя состояния разрешения теста.
project	ShallowReference	Абстрактная ссылка на какой-то другой ресурс. Этот класс используется для предоставления контрактам данных сборки единообразного способа ссылки на другие ресурсы таким образом, чтобы обеспечить простой обход по ссылкам.

TestRun

Сведения о тестовом запуске.

Имя	Тип	Описание
build	ShallowReference	Сборка, связанная с этим тестовом запуском.
buildConfiguration	BuildConfiguration	Сведения о конфигурации сборки, связанные с этим тестом.
comment	string	Комментарии, введенные теми, кто анализирует выполнение.
completedDate	string	Дата завершения выполнения.
controller	string	Контроллер тестового запуска.
createdDate	string	Тестовое выполнение CreatedDate.
customFields	CustomTestField[]	Список настраиваемых полей для TestRun.
dropLocation	string	Удалить расположение для тестового запуска.
dtlAutEnvironment	ShallowReference	Абстрактная ссылка на какой-то другой ресурс. Этот класс используется для предоставления контрактам данных сборки единообразного способа ссылки на другие ресурсы таким образом, чтобы обеспечить простой обход по ссылкам.
dtlEnvironment	ShallowReference	Абстрактная ссылка на какой-то другой ресурс. Этот класс используется для предоставления контрактам данных сборки единообразного способа ссылки на другие ресурсы таким образом, чтобы обеспечить простой обход по ссылкам.
dtlEnvironmentCreationDetails	DtlEnvironmentDetails	Это временный класс для предоставления сведений о среде тестового запуска.
dueDate	string	Дата и время выполнения теста.
errorMessage	string	Сообщение об ошибке, связанное с выполнением.
filter	RunFilter	Этот класс используется для предоставления фильтров, используемых для обнаружения.
id	integer	Идентификатор тестового запуска.
incompleteTests	integer	Количество неполных тестов.
isAutomated	boolean	Значение true, если тестовый запуск выполняется автоматически, в противном случае — false.
iteration	string	Итерация, которой принадлежит запуск.
lastUpdatedBy	IdentityRef	Team Foundation ID последнего обновленного тестового запуска.
lastUpdatedDate	string	Дата и время последнего обновления
name	string	Имя тестового запуска.
notApplicableTests	integer	Число неприменимых тестов.
owner	IdentityRef	Идентификатор Team Foundation владельца запусков.
passedTests	integer	Количество пройденных тестов в выполнении
phase	string	Этап или состояние для testRun.
pipelineReference	PipelineReference	Ссылка на конвейер, к которому принадлежит этот тестовый запуск.
plan	ShallowReference	План тестирования, связанный с этим тестового запуска.
postProcessState	string	Состояние после процесса.
project	ShallowReference	Проект, связанный с этим запуском.
release	ReleaseReference	Справочник по выпуску тестового запуска.
releaseEnvironmentUri	string	URI среды выпуска для TestRun.
releaseUri	string	URI выпуска для TestRun.
revision	integer
runStatistics	RunStatistic[]	RunSummary по результату.
startedDate	string	Дата начала выполнения.
state	string	Состояние выполнения. Допустимые состояния TestRunState — Unspecified , NotStarted, InProgress, Completed, Waiting, Aborted, NeedsInvestigation
substate	TestRunSubstate	TestRun Substate.
tags	TestTag[]	Теги, вложенные в этот тестовый запуск.
testEnvironment	TestEnvironment	Тестовая среда, связанная с выполнением.
testMessageLogId	integer
testSettings	ShallowReference	Абстрактная ссылка на какой-то другой ресурс. Этот класс используется для предоставления контрактам данных сборки единообразного способа ссылки на другие ресурсы таким образом, чтобы обеспечить простой обход по ссылкам.
totalTests	integer	Общее количество тестов в выполнении
unanalyzedTests	integer	Количество неудачных тестов в выполнении.
url	string	URL-адрес тестового запуска
webAccessUrl	string	URL-адрес веб-доступа для TestRun.

TestRunSubstate

Типы вложенных состояний для тестового запуска.

Имя	Тип	Описание
abortedBySystem	string	Состояние запуска, когда оно прервано системой.
analyzed	string	Состояние выполнения после анализа.
canceledByUser	string	Состояние выполнения при создании среды.
cancellationInProgress	string	Состояние выполнения при выполнении отмены.
creatingEnvironment	string	Состояние выполнения при создании среды.
none	string	Запуск с noState.
pendingAnalysis	string	Состояние выполнения при ожидании анализа.
runningTests	string	Состояние выполнения во время выполнения тестов.
timedOut	string	Состояние выполнения, если для выполнения установлено время ожидания.

TestTag

Тег, присоединенный к выполнению или результату.

Имя	Тип	Описание
name	string	Имя тега, буквенно-цифровое значение менее 30 символов