TestResultsRestClient class

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Конструкторы

TestResultsRestClient(IVssRestClientOptions)

Свойства

Методы

addCustomFields(CustomTestFieldDefinition[], string)	Создает настраиваемые поля тестирования на основе предоставленных данных.
addTestResultsToTestRun(TestCaseResult[], string, number)
addTestResultsToTestRunSession(TestCaseResult[], string, number)	Добавление результатов теста для тестового сеанса выполнения
addWorkItemToTestLinks(WorkItemToTestLinks, string)
callbackTestAgent(TestAgentCallbackRequest, string)
completeGitHubAuth(string, string)	Конечная точка обратного вызова OAuth. GitHub перенаправляется здесь после авторизации пользователем. Обменивается кодом авторизации для маркеров и сохраняет их в TCM StrongBox. Требуется, чтобы URL-адрес обратного вызова был зарегистрирован в параметрах приложения OAuth GitHub.
createAnalysis(TestSessionAnalysis[], string, number)	Создает объект анализа сеансов в хранилище данных TCM для данного сеанса
createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)	Создает вложение в LogStore для указанного идентификатора сборки.
createEnvironment(TestSessionEnvironment[], string)	Создает объект Среды в хранилище данных TCM
createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)	Для предоставленного идентификатора сеанса создает среду, конфигурацию и объекты компьютера в хранилище данных TCM
createFailureType(TestResultFailureTypeRequestModel, string)	Создает новый тип сбоя теста
createNotification(TestSessionNotification[], string, number)	Создает объект Notification в хранилище данных TCM для заданного сеанса
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)
createTestResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number)	Регистрирует метаданные для тестового вложения на уровне результата, содержимое которого уже было загружено вызывающим в хранилище dedup. Запрос содержит только метаданные вложения (dedup id, размер, имя файла, тип и т.д.) и не содержит байтов файла.
createTestResultMachines(TestResultMachine[], string, number)	Создает компьютеры результатов теста для предоставленного TestRunId
createTestRun(RunCreateModel, string)
createTestRunAttachment(TestAttachmentRequestModel, string, number)
createTestRunAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number)	Регистрирует метаданные для тестового вложения на уровне выполнения, содержимое которого уже было загружено вызывающим в хранилище dedup. Запрос содержит только метаданные вложения (dedup id, размер, имя файла, тип и т.д.) и не содержит байтов файла.
createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)	Создает вложение в LogStore для указанного runId.
createTestSession(TestResultsSession, string)	Создает объект TestResultsSession в хранилище данных TCM
createTestSettings(TestSettings, string)
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)
createTestSubResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number, number)	Регистрирует метаданные для тестового вложения на уровне подрезультата, содержимое которого уже было загружено вызывающим в хранилище dedup. Запрос содержит только метаданные вложения (dedup id, размер, имя файла, тип и т.д.) и не содержит байтов файла.
deleteCustomFieldById(string, number)	Возвращает сведения о настраиваемом поле тестирования для указанного testExtensionFieldId.
deleteFailureType(string, number)	Удаляет тип тестового сбоя с указанным типом failureTypeId
deleteFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)	Удалять нестандартные идентификаторы тестовых случаев по информации о ветках и репозиториях
deleteTestMethodToWorkItemLink(string, string, number)
deleteTestResultAttachment(string, number, number, number)
deleteTestRun(string, number)
deleteTestRunAttachment(string, number, number)
deleteTestRunLogStoreAttachment(string, number, string)	Удаляет вложение с указанным именем файла для указанного runId из LogStore.
deleteTestSettings(string, number)
enhanceCoverage(string, string, number)	Кликаемая в браузере точка входа для ссылки «Улучшить diff coverage», отображаемой в комментариях PR-покрытия. Отправляет coverage_test_generation задачу в ADOAgenticService для данного pull request и перенаправляет пользователя обратно на страницу pull request.
fetchSourceCodeCoverageReport(string, number)
generateTestPlanFromWorkItem(GenerateTestPlanFromWorkItemModel, string, number)	Генерирует ручной план тестирования из рабочего элемента с помощью ИИ. Если у пользователя нет действительного токена Copilot, он возвращает needsAuth=true с authUrl вместо очереди на задание.
getAfdTcmEndpoint(string)
getBranchesByFlakyTestCaseRefId(string, number)	Получение списка ветвей, в которых отслоился идентификатор ссылки на тестовый случай
getBugsLinkedToTestResult(string, number, number)
getBuildCodeCoverage(string, number, number)
getCodeCoverageSummary(string, number, number)	http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10&deltaBuildId=9 Request: идентификатор сборки и идентификатор разностной сборки (необязательно)
getCoverageStatusBadge(string, string, string, string)	<p>Возвращает состояние покрытия для последней успешной сборки определения, при необходимости в пределах определенной ветви</p>
getFailureTypes(string)	Возвращает список типов тестового сбоя.
getFileLevelCodeCoverage(FileCoverageRequest, string)	Получение охвата файла для указанного файла
getFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)
getFlakyTestResultsByBuildDefinitionId(string, number, Date)
getFlakyTestResultsByTestRun(string, number)
getLatestTestResultsByTestCaseIds(TestCaseLatestResultsQuery, string)	Получите последний результат по каждому запрошенному TestCaseId. Тестовые случаи, которые так и не были выполнены (нет результата в неудалённом запуске), опускаются в ответе — вызывающий воспринимает их отсутствие как «никогда не запускается».
getResultGroupsByBuild(string, number, string, string[], string)
getResultGroupsByRelease(string, number, string, number, string[], string)
getSessionNotifications(string, number)	Извлекает объекты Уведомлений TestResultsSession в хранилище данных TCM
getSimilarTestResults(string, number, number, number, number, String)	Возвращает список результатов, сбой которых совпадает с предоставленным.
getTestAgentToken()	Возвращает токен GitHub OAuth текущего пользователя с разрешением на доступ к API Copilot, заблокированным за флагом функции.
getTestIterationAttachmentContent(string, number, number, number, number)	Возвращает вложение тестовой итерации
getTestIterationAttachmentZip(string, number, number, number, number)	Возвращает вложение тестовой итерации
getTestLogsForBuild(string, number, TestLogType, string, string, boolean, number, String)	Получение списка ссылок на вложения сборки
getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)	Получение URI SAS для вложения сборки
getTestLogStoreEndpointDetailsForResultLog(string, number, number, TestLogType, string)	Получение URI SAS для вложения результатов теста
getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)	Получение URI SAS для вложения тестового запуска
getTestLogStoreEndpointDetailsForSubResultLog(string, number, number, number, TestLogType, string)	Получение URI SAS для вложения тестового подресулта
getTestPipelineMetrics(string, number, string, string, string, Metrics[], boolean)	Получение сводки результатов теста.
getTestResultAttachmentContent(string, number, number, number)	Возвращает вложение результатов теста
getTestResultAttachments(string, number, number)
getTestResultAttachmentZip(string, number, number, number)	Возвращает вложение результатов теста
getTestResultById(string, number, number, ResultDetails)
getTestResultDetailsForBuild(string, number, string, string, string, string, boolean, boolean)	Получение сводки результатов теста для сборки. Чтобы получить полный файл TestCaseResult, вызовите результаты — Get.
getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)
getTestResultLogs(string, number, number, TestLogType, string, string, boolean, number, String)	Получение списка ссылок на вложения результатов теста
getTestResultMachines(string, number)	Возвращает компьютеры результатов теста для предоставленного TestRunId
getTestResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByPipeline(string, number, string, string, string, TestOutcome[], boolean, number, String)	Получение списка результатов.
getTestResultsByPipelineMRX(string, number, string, string, string, TestOutcome[], boolean, number, String)	Возвращает полные объекты TestCaseResult с подробными сведениями 1MRX для предоставленного конвейера
getTestResultsByQuery(TestResultsQuery, string)
getTestResultsByQueryWiql(QueryModel, string, boolean, boolean, number, number)
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
getTestResultsSettings(string, TestResultsSettingsType)	Получение данных TestResultsSettings
getTestResultWorkItemsById(string, number, number)
getTestRunAttachmentContent(string, number, number)	Возвращает вложение тестового запуска
getTestRunAttachments(string, number)
getTestRunAttachmentUploadDetails(string, number)	Предполёт для загрузки вложений напрямую в BlobStore: обеспечивает разрешение на публикацию и возвращает домен dedup для публикации. Агент вызывает это до загрузки любых байт.
getTestRunAttachmentZip(string, number, number)	Возвращает вложение тестового запуска
getTestRunById(string, number, boolean, boolean)
getTestRunCodeCoverage(string, number, number)
getTestRunLogs(string, number, TestLogType, string, string, boolean, number, String)	Получение списка ссылок на вложения тестового запуска
getTestRunLogStoreAttachmentContent(string, number, string)	Возвращает вложение с указанным именем файла для указанного runId из LogStore.
getTestRunLogStoreAttachments(string, number)	Возвращает список вложений для указанного runId из LogStore.
getTestRunLogStoreAttachmentZip(string, number, string)	Возвращает вложение с указанным именем файла для указанного runId из LogStore.
getTestRunMessageLogs(string, number)	Получение журналов сообщений тестового запуска
getTestRuns(string, string, string, string, number, boolean, boolean, number, number)
getTestRunsBySessionId(string, number)	Получение тестовых запусков, связанных с сеансом
getTestRunStatistics(string, number)	Получение статистики тестового запуска, используемой при получении сводки по результатам выполнения.
getTestRunSummaryByOutcome(string, number)	Получение сводки тестового запуска, используемой при получении сводки по результатам выполнения. Тестовое выполнение должно находиться в состоянии завершения.
getTestSession(string, number)	Извлекает объект метаданных TestResultsSession в хранилище данных TCM
getTestSessionLayout(string, string)	Извлекает объект Layout TestResultsSession в хранилище данных TCM
getTestSessionLayoutBySessionId(string, number)	Извлекает объект Layout TestResultsSession в хранилище данных TCM
getTestSessionResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestSettingsById(string, number)
getTestSubResultAttachmentContent(string, number, number, number, number)	Возвращает вложенное вложение тестового результата
getTestSubResultAttachments(string, number, number, number)	Возвращает ссылки на вложения для тестового вложенного результата.
getTestSubResultAttachmentZip(string, number, number, number, number)	Возвращает вложенное вложение тестового результата
getTestSubResultLogs(string, number, number, number, TestLogType, string, string, boolean, number, String)	Получение списка ссылок на тестовые вложенные вложения
getTestTagsForBuild(string, number)	Получение всех тегов в сборке.
getTestTagsForRelease(string, number, number)	Получение всех тегов в выпуске.
getTestTagSummaryForBuild(string, number)	Получение всех тегов в сборке.
getTestTagSummaryForRelease(string, number, number)	Получение всех тегов в выпуске.
getTestWeightedScoreByTestRun(string, string, boolean, boolean)	Рассчитать взвешенный балл по тесту для заданного списка идентификаторов тестовых забегов.
publishTestResultDocument(TestResultDocument, string, number)
queryCustomFields(string, CustomTestFieldScope)	Возвращает список настраиваемых полей тестирования для заданной области настраиваемого тестового поля.
queryResultTrendForBuild(TestResultTrendFilter, string)
queryResultTrendForRelease(TestResultTrendFilter, string)
queryTestHistory(TestHistoryQuery, string)	Получение журнала метода тестирования с помощью TestHistoryQuery
queryTestMethodLinkedWorkItems(string, string)
queryTestResultAttachmentsMetadata(string, number, number, string, string, number, boolean)	Возвращает метаданные для тестовых вложений на уровне результатов, поддерживаемых BlobStore, имя которых начинается с fileNamePrefix, или для единственного вложения, идентифицируемого attachmentId при его предоставлении.
queryTestResultHistory(ResultsFilter, string)
queryTestResultsMetaData(string[], string, ResultMetaDataDetails)	Получение списка метаданных результатов теста для соответствующих testcasereferenceId
queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)
queryTestResultsReportForPipeline(string, number, string, string, string, boolean)	Получение сводки результатов теста.
queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
queryTestResultsSummaryForReleases(ReleaseReference[], string)
queryTestResultWorkItems(string, string, string, number, Date, number, number)	Результаты теста запросов WorkItems на основе фильтра
queryTestRunAttachmentsMetadata(string, number, string, string, number, boolean)	Возвращает метаданные для тестовых вложений, поддерживаемых BlobStore, для которых имя файла начинается с fileNamePrefix, или для единственного вложения, идентифицируемого attachmentId при предоставлении. Агент использует это для перечисления тестовых журналов BlobStore (dedup), которые отсутствуют в классическом контейнере LogStore SAS и поэтому не могут быть перечислены агентом напрямую.
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, TestRunSortOrderType, string)	Выполнение тестов запросов на основе фильтров. Обязательные поля : minLastUpdatedDate и maxLastUpdatedDate.
queryTestSubResultAttachmentsMetadata(string, number, number, number, string, string, number, boolean)	Возвращает метаданные для тестовых вложений, поддерживаемых BlobStore, на уровне результата, имя которых начинается с fileNamePrefix, или для единственного вложения, идентифицируемого attachmentId при его предоставлении.
queryTestSummaryByRequirement(TestResultsContext, string, number[])
testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)	Создание и получение URI sas контейнера сборки
testLogStoreEndpointDetailsForResult(string, number, number, number, string, TestLogType)	Создание пустого файла для результата и получение URI Sas для файла
testLogStoreEndpointDetailsForRun(string, number, TestLogStoreOperationType, string, TestLogType)	Создание пустого файла для запуска и получения URI Sas для файла
testResultsGroupDetails(string, number, string, string, string, boolean, boolean)	Получите все доступные сведения о группах и для этих групп получить неудачные и прерванные результаты.
triggerTestAgent(TestAgentTriggerRequest, string)
updateCodeCoverageSummary(string, number, CodeCoverageData)	http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Запрос: Json сводки покрытия кода
updateCustomField(CustomTestFieldUpdateDefinition, string)	Возвращает сведения о настраиваемом поле теста, которое обновляется.
updatePipelinesTestSettings(TestResultsUpdateSettings, string)	Обновление параметров проекта результатов теста
updateTestResults(TestCaseResult[], string, number)
updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)	Обновление свойств метаданных результатов теста
updateTestResultsToTestRunSession(TestCaseResult[], string, number)	Создает объекты TestResultsMRX в хранилище данных TCM для существующих результатов теста
updateTestRun(RunUpdateModel, string, number)
updateTestRunsBySessionId(TestSessionTestRun, string, number)	Обновление тестов, связанных с сеансом
updateTestRunTags(TestTagsUpdateModel, string, number)	Обновление тегов выполнения, теги можно добавить и удалить
updateTestSession(TestResultsSession, string, number)	Обновляет объект тестового сеанса, связанный с идентификатором сеанса

TestResultsRestClient(IVssRestClientOptions)

new TestResultsRestClient(options: IVssRestClientOptions)

Параметры

options: IVssRestClientOptions

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: "c83eaf52-edf3-4034-ae11-17d38f25404c" = "c83eaf52-edf3-4034-ae11-17d38f25404c"

Значение свойства

"c83eaf52-edf3-4034-ae11-17d38f25404c"

addCustomFields(CustomTestFieldDefinition[], string)

Создает настраиваемые поля тестирования на основе предоставленных данных.

function addCustomFields(newFields: CustomTestFieldDefinition[], project: string): Promise<CustomTestFieldDefinition[]>

Параметры

newFields: CustomTestFieldDefinition[]

NewFields — это массив типа CustomTestFieldDefinition.

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<CustomTestFieldDefinition[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

function addTestResultsToTestRun(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>

Параметры

results: TestCaseResult[]

project: string

Идентификатор проекта или имя проекта

runId: number

Возвращаемое значение

Promise<TestCaseResult[]>

addTestResultsToTestRunSession(TestCaseResult[], string, number)

Добавление результатов теста для тестового сеанса выполнения

function addTestResultsToTestRunSession(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>

Параметры

results: TestCaseResult[]

project: string

Идентификатор проекта или имя проекта

runId: number

RunId тестового запуска

Возвращаемое значение

Promise<TestCaseResult[]>

addWorkItemToTestLinks(WorkItemToTestLinks, string)

function addWorkItemToTestLinks(workItemToTestLinks: WorkItemToTestLinks, project: string): Promise<WorkItemToTestLinks>

Параметры

workItemToTestLinks: WorkItemToTestLinks

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<WorkItemToTestLinks>

callbackTestAgent(TestAgentCallbackRequest, string)

function callbackTestAgent(request: TestAgentCallbackRequest, project: string): Promise<boolean>

Параметры

request: TestAgentCallbackRequest

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<boolean>

completeGitHubAuth(string, string)

Конечная точка обратного вызова OAuth. GitHub перенаправляется здесь после авторизации пользователем. Обменивается кодом авторизации для маркеров и сохраняет их в TCM StrongBox. Требуется, чтобы URL-адрес обратного вызова был зарегистрирован в параметрах приложения OAuth GitHub.

function completeGitHubAuth(project: string, code: string): Promise<string>

Параметры

project: string

Идентификатор проекта или имя проекта

code: string

Код авторизации, возвращенный GitHub после согласия пользователя

Возвращаемое значение

Promise<string>

createAnalysis(TestSessionAnalysis[], string, number)

Создает объект анализа сеансов в хранилище данных TCM для данного сеанса

function createAnalysis(analysis: TestSessionAnalysis[], project: string, sessionId: number): Promise<AnalysisFailureGroupReturn[]>

Параметры

analysis: TestSessionAnalysis[]

Сведения о анализе сеансов

project: string

Идентификатор проекта или имя проекта

sessionId: number

Идентификатор сеанса для добавления уведомления

Возвращаемое значение

Promise<AnalysisFailureGroupReturn[]>

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

Создает вложение в LogStore для указанного идентификатора сборки.

function createBuildAttachmentInLogStore(attachmentRequestModel: TestAttachmentRequestModel, project: string, buildId: number): Promise<void>

Параметры

attachmentRequestModel: TestAttachmentRequestModel

Содержит сведения о вложениях, например stream, filename, comment, attachmentType

project: string

Идентификатор проекта или имя проекта

buildId: number

BuildId

Возвращаемое значение

Promise<void>

createEnvironment(TestSessionEnvironment[], string)

Создает объект Среды в хранилище данных TCM

function createEnvironment(environments: TestSessionEnvironment[], project: string): Promise<void>

Параметры

environments: TestSessionEnvironment[]

Полученный объект Environment.

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<void>

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Для предоставленного идентификатора сеанса создает среду, конфигурацию и объекты компьютера в хранилище данных TCM

function createEnvironmentAndMachine(sessionEnvironmentAndMachine: SessionEnvironmentAndMachine, project: string, sessionId: number): Promise<void>

Параметры

sessionEnvironmentAndMachine: SessionEnvironmentAndMachine

project: string

Идентификатор проекта или имя проекта

sessionId: number

Возвращаемое значение

Promise<void>

createFailureType(TestResultFailureTypeRequestModel, string)

Создает новый тип сбоя теста

function createFailureType(testResultFailureType: TestResultFailureTypeRequestModel, project: string): Promise<TestResultFailureType>

Параметры

testResultFailureType: TestResultFailureTypeRequestModel

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<TestResultFailureType>

createNotification(TestSessionNotification[], string, number)

Создает объект Notification в хранилище данных TCM для заданного сеанса

function createNotification(notifications: TestSessionNotification[], project: string, sessionId: number): Promise<number[]>

Параметры

notifications: TestSessionNotification[]

Уведомления для добавления для указанного идентификатора сеанса

project: string

Идентификатор проекта или имя проекта

sessionId: number

Идентификатор сеанса для добавления уведомления

Возвращаемое значение

Promise<number[]>

createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)

function createTestIterationResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, iterationId: number, actionPath?: string): Promise<TestAttachmentReference>

Параметры

attachmentRequestModel: TestAttachmentRequestModel

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

iterationId: number

actionPath: string

Возвращаемое значение

Promise<TestAttachmentReference>

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

function createTestResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number): Promise<TestAttachmentReference>

Параметры

attachmentRequestModel: TestAttachmentRequestModel

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

Возвращаемое значение

Promise<TestAttachmentReference>

createTestResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number)

Регистрирует метаданные для тестового вложения на уровне результата, содержимое которого уже было загружено вызывающим в хранилище dedup. Запрос содержит только метаданные вложения (dedup id, размер, имя файла, тип и т.д.) и не содержит байтов файла.

function createTestResultAttachmentMetadata(attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel, project: string, runId: number, testCaseResultId: number): Promise<TestAttachmentReference>

Параметры

attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

Возвращаемое значение

Promise<TestAttachmentReference>

createTestResultMachines(TestResultMachine[], string, number)

Создает компьютеры результатов теста для предоставленного TestRunId

function createTestResultMachines(testResultMachines: TestResultMachine[], project: string, runId: number): Promise<void>

Параметры

testResultMachines: TestResultMachine[]

Список компьютеров для результатов тестирования во время выполнения

project: string

Идентификатор проекта или имя проекта

runId: number

Идентификатор TestRun для добавления компьютеров

Возвращаемое значение

Promise<void>

createTestRun(RunCreateModel, string)

function createTestRun(testRun: RunCreateModel, project: string): Promise<TestRun>

Параметры

testRun: RunCreateModel

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

function createTestRunAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestAttachmentReference>

Параметры

attachmentRequestModel: TestAttachmentRequestModel

project: string

Идентификатор проекта или имя проекта

runId: number

Возвращаемое значение

Promise<TestAttachmentReference>

createTestRunAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number)

Регистрирует метаданные для тестового вложения на уровне выполнения, содержимое которого уже было загружено вызывающим в хранилище dedup. Запрос содержит только метаданные вложения (dedup id, размер, имя файла, тип и т.д.) и не содержит байтов файла.

function createTestRunAttachmentMetadata(attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel, project: string, runId: number): Promise<TestAttachmentReference>

Параметры

attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel

project: string

Идентификатор проекта или имя проекта

runId: number

Возвращаемое значение

Promise<TestAttachmentReference>

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

Создает вложение в LogStore для указанного runId.

function createTestRunLogStoreAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestLogStoreAttachmentReference>

Параметры

attachmentRequestModel: TestAttachmentRequestModel

Содержит сведения о вложениях, например stream, filename, comment, attachmentType

project: string

Идентификатор проекта или имя проекта

runId: number

Тестовый идентификатор runId

Возвращаемое значение

Promise<TestLogStoreAttachmentReference>

createTestSession(TestResultsSession, string)

Создает объект TestResultsSession в хранилище данных TCM

function createTestSession(session: TestResultsSession, project: string): Promise<number>

Параметры

session: TestResultsSession

Полученный объект сеанса.

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<number>

createTestSettings(TestSettings, string)

function createTestSettings(testSettings: TestSettings, project: string): Promise<number>

Параметры

testSettings: TestSettings

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<number>

createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)

function createTestSubResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachmentReference>

Параметры

attachmentRequestModel: TestAttachmentRequestModel

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

testSubResultId: number

Возвращаемое значение

Promise<TestAttachmentReference>

createTestSubResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number, number)

Регистрирует метаданные для тестового вложения на уровне подрезультата, содержимое которого уже было загружено вызывающим в хранилище dedup. Запрос содержит только метаданные вложения (dedup id, размер, имя файла, тип и т.д.) и не содержит байтов файла.

function createTestSubResultAttachmentMetadata(attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel, project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachmentReference>

Параметры

attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

testSubResultId: number

Возвращаемое значение

Promise<TestAttachmentReference>

deleteCustomFieldById(string, number)

Возвращает сведения о настраиваемом поле тестирования для указанного testExtensionFieldId.

function deleteCustomFieldById(project: string, testExtensionFieldId: number): Promise<void>

Параметры

project: string

Идентификатор проекта или имя проекта

testExtensionFieldId: number

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

Возвращаемое значение

Promise<void>

deleteFailureType(string, number)

Удаляет тип тестового сбоя с указанным типом failureTypeId

function deleteFailureType(project: string, failureTypeId: number): Promise<void>

Параметры

project: string

Идентификатор проекта или имя проекта

failureTypeId: number

Возвращаемое значение

Promise<void>

deleteFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)

Удалять нестандартные идентификаторы тестовых случаев по информации о ветках и репозиториях

function deleteFlakyTestCaseRefIdsByBranch(project: string, repositoryId: string, branchInfo: BranchInfo): Promise<number>

Параметры

project: string

Идентификатор проекта или имя проекта

repositoryId: string

Руководство хранилища

branchInfo: BranchInfo

Информация о ветке, содержащая название и тип Примечание: Операции на защищённых ветвях, таких как «мастер» или «основной», не поддерживаются.

Возвращаемое значение

Promise<number>

deleteTestMethodToWorkItemLink(string, string, number)

function deleteTestMethodToWorkItemLink(project: string, testName: string, workItemId: number): Promise<boolean>

Параметры

project: string

Идентификатор проекта или имя проекта

testName: string

workItemId: number

Возвращаемое значение

Promise<boolean>

deleteTestResultAttachment(string, number, number, number)

function deleteTestResultAttachment(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<void>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

attachmentId: number

Возвращаемое значение

Promise<void>

deleteTestRun(string, number)

function deleteTestRun(project: string, runId: number): Promise<void>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Возвращаемое значение

Promise<void>

deleteTestRunAttachment(string, number, number)

function deleteTestRunAttachment(project: string, runId: number, attachmentId: number): Promise<void>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

attachmentId: number

Возвращаемое значение

Promise<void>

deleteTestRunLogStoreAttachment(string, number, string)

Удаляет вложение с указанным именем файла для указанного runId из LogStore.

function deleteTestRunLogStoreAttachment(project: string, runId: number, filename: string): Promise<void>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Тестовый идентификатор runId

filename: string

Имя файла вложения

Возвращаемое значение

Promise<void>

deleteTestSettings(string, number)

function deleteTestSettings(project: string, testSettingsId: number): Promise<void>

Параметры

project: string

Идентификатор проекта или имя проекта

testSettingsId: number

Возвращаемое значение

Promise<void>

enhanceCoverage(string, string, number)

Кликаемая в браузере точка входа для ссылки «Улучшить diff coverage», отображаемой в комментариях PR-покрытия. Отправляет coverage_test_generation задачу в ADOAgenticService для данного pull request и перенаправляет пользователя обратно на страницу pull request.

function enhanceCoverage(project: string, repository: string, pullRequestId: number): Promise<void>

Параметры

project: string

Идентификатор проекта или имя проекта

repository: string

pullRequestId: number

Возвращаемое значение

Promise<void>

fetchSourceCodeCoverageReport(string, number)

function fetchSourceCodeCoverageReport(project: string, buildId: number): Promise<SourceViewBuildCoverage[]>

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Возвращаемое значение

Promise<SourceViewBuildCoverage[]>

generateTestPlanFromWorkItem(GenerateTestPlanFromWorkItemModel, string, number)

Генерирует ручной план тестирования из рабочего элемента с помощью ИИ. Если у пользователя нет действительного токена Copilot, он возвращает needsAuth=true с authUrl вместо очереди на задание.

function generateTestPlanFromWorkItem(generateTestPlanFromWorkItemModel: GenerateTestPlanFromWorkItemModel, project: string, workItemId: number): Promise<boolean>

Параметры

generateTestPlanFromWorkItemModel: GenerateTestPlanFromWorkItemModel

project: string

Идентификатор проекта или имя проекта

workItemId: number

Возвращаемое значение

Promise<boolean>

getAfdTcmEndpoint(string)

function getAfdTcmEndpoint(key: string): Promise<string>

Параметры

key: string

Возвращаемое значение

Promise<string>

getBranchesByFlakyTestCaseRefId(string, number)

Получение списка ветвей, в которых отслоился идентификатор ссылки на тестовый случай

function getBranchesByFlakyTestCaseRefId(project: string, testCaseReferenceId: number): Promise<TestCaseFlakinessBranchInfo>

Параметры

project: string

Идентификатор проекта или имя проекта

testCaseReferenceId: number

Ссылочный идентификатор используемого теста по результату теста

Возвращаемое значение

Promise<TestCaseFlakinessBranchInfo>

getBugsLinkedToTestResult(string, number, number)

function getBugsLinkedToTestResult(project: string, runId: number, testCaseResultId: number): Promise<WorkItemReference[]>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

Возвращаемое значение

Promise<WorkItemReference[]>

getBuildCodeCoverage(string, number, number)

function getBuildCodeCoverage(project: string, buildId: number, flags: number): Promise<BuildCoverage[]>

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

flags: number

Возвращаемое значение

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10&deltaBuildId=9 Request: идентификатор сборки и идентификатор разностной сборки (необязательно)

function getCodeCoverageSummary(project: string, buildId: number, deltaBuildId?: number): Promise<CodeCoverageSummary>

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

deltaBuildId: number

Возвращаемое значение

Promise<CodeCoverageSummary>

getCoverageStatusBadge(string, string, string, string)

<p>Возвращает состояние покрытия для последней успешной сборки определения, при необходимости в пределах определенной ветви</p>

function getCoverageStatusBadge(project: string, definition: string, branchName?: string, label?: string): Promise<string>

Параметры

project: string

Идентификатор проекта или имя проекта

definition: string

Идентификатор или имя определения.

branchName: string

Имя ветви.

label: string

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

Возвращаемое значение

Promise<string>

getFailureTypes(string)

Возвращает список типов тестового сбоя.

function getFailureTypes(project: string): Promise<TestResultFailureType[]>

Параметры

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<TestResultFailureType[]>

getFileLevelCodeCoverage(FileCoverageRequest, string)

Получение охвата файла для указанного файла

function getFileLevelCodeCoverage(fileCoverageRequest: FileCoverageRequest, project: string): Promise<string>

Параметры

fileCoverageRequest: FileCoverageRequest

Сведения о файле с контекстом итерации запроса на вытягивание

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<string>

getFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)

function getFlakyTestCaseRefIdsByBranch(project: string, repositoryId: string, branchInfo: BranchInfo): Promise<TestCaseFlakinessBranchInfo[]>

Параметры

project: string

Идентификатор проекта или имя проекта

repositoryId: string

branchInfo: BranchInfo

Возвращаемое значение

Promise<TestCaseFlakinessBranchInfo[]>

getFlakyTestResultsByBuildDefinitionId(string, number, Date)

function getFlakyTestResultsByBuildDefinitionId(project: string, buildDefinitionId: number, minBuildCreatedDate: Date): Promise<TestCaseResult[]>

Параметры

project: string

Идентификатор проекта или имя проекта

buildDefinitionId: number

minBuildCreatedDate: Date

Возвращаемое значение

Promise<TestCaseResult[]>

getFlakyTestResultsByTestRun(string, number)

function getFlakyTestResultsByTestRun(project: string, runId: number): Promise<TestCaseResult[]>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Возвращаемое значение

Promise<TestCaseResult[]>

getLatestTestResultsByTestCaseIds(TestCaseLatestResultsQuery, string)

Получите последний результат по каждому запрошенному TestCaseId. Тестовые случаи, которые так и не были выполнены (нет результата в неудалённом запуске), опускаются в ответе — вызывающий воспринимает их отсутствие как «никогда не запускается».

function getLatestTestResultsByTestCaseIds(query: TestCaseLatestResultsQuery, project: string): Promise<TestCaseLatestResult[]>

Параметры

query: TestCaseLatestResultsQuery

TestCaseLatestResultsQuery с TestCaseIds для поиска.

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<TestCaseLatestResult[]>

getResultGroupsByBuild(string, number, string, string[], string)

function getResultGroupsByBuild(project: string, buildId: number, publishContext: string, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

publishContext: string

fields: string[]

continuationToken: string

Возвращаемое значение

Promise<PagedList<FieldDetailsForTestResults>>

getResultGroupsByRelease(string, number, string, number, string[], string)

function getResultGroupsByRelease(project: string, releaseId: number, publishContext: string, releaseEnvId?: number, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseId: number

publishContext: string

releaseEnvId: number

fields: string[]

continuationToken: string

Возвращаемое значение

Promise<PagedList<FieldDetailsForTestResults>>

getSessionNotifications(string, number)

Извлекает объекты Уведомлений TestResultsSession в хранилище данных TCM

function getSessionNotifications(project: string, sessionId: number): Promise<TestSessionNotification[]>

Параметры

project: string

Идентификатор проекта или имя проекта

sessionId: number

Идентификатор сеанса TestResults для получения уведомлений.

Возвращаемое значение

Promise<TestSessionNotification[]>

getSimilarTestResults(string, number, number, number, number, String)

Возвращает список результатов, сбой которых совпадает с предоставленным.

function getSimilarTestResults(project: string, runId: number, testResultId: number, testSubResultId: number, top?: number, continuationToken?: String): Promise<TestCaseResult[]>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Идентификатор тестового запуска

testResultId: number

Идентификатор результата теста внутри тестового запуска

testSubResultId: number

идентификатор подресулов внутри результата теста

top: number

Максимальное количество возвращаемых результатов

continuationToken: String

Заголовок для передачи продолженияToken

Возвращаемое значение

Promise<TestCaseResult[]>

getTestAgentToken()

Возвращает токен GitHub OAuth текущего пользователя с разрешением на доступ к API Copilot, заблокированным за флагом функции.

function getTestAgentToken(): Promise<string>

Возвращаемое значение

Promise<string>

getTestIterationAttachmentContent(string, number, number, number, number)

Возвращает вложение тестовой итерации

function getTestIterationAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number, iterationId: number): Promise<ArrayBuffer>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

attachmentId: number

iterationId: number

Возвращаемое значение

Promise<ArrayBuffer>

getTestIterationAttachmentZip(string, number, number, number, number)

Возвращает вложение тестовой итерации

function getTestIterationAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number, iterationId: number): Promise<ArrayBuffer>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

attachmentId: number

iterationId: number

Возвращаемое значение

Promise<ArrayBuffer>

getTestLogsForBuild(string, number, TestLogType, string, string, boolean, number, String)

Получение списка ссылок на вложения сборки

function getTestLogsForBuild(project: string, buildId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки для получения

type: TestLogType

тип вложения для получения

directoryPath: string

Путь к каталогу, для которого требуются вложения

fileNamePrefix: string

Префикс имени файла для фильтрации списка вложений

fetchMetaData: boolean

Значение по умолчанию равно false, если требуются метаданные

top: number

Количество ссылок на тестовые вложения для возврата

continuationToken: String

Заголовок для передачи продолженияToken

Возвращаемое значение

Promise<PagedList<TestLog>>

getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)

Получение URI SAS для вложения сборки

function getTestLogStoreEndpointDetailsForBuildLog(project: string, build: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Параметры

project: string

Идентификатор проекта или имя проекта

build: number

Идентификатор сборки для получения

type: TestLogType

тип файла

filePath: string

filePath, для которого необходим URI sas

Возвращаемое значение

Promise<TestLogStoreEndpointDetails>

getTestLogStoreEndpointDetailsForResultLog(string, number, number, TestLogType, string)

Получение URI SAS для вложения результатов теста

function getTestLogStoreEndpointDetailsForResultLog(project: string, runId: number, resultId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Идентификатор тестового запуска, содержащего результат

resultId: number

Идентификатор результата теста, файлы которого необходимо скачать

type: TestLogType

тип файла

filePath: string

filePath, для которого необходим URI sas

Возвращаемое значение

Promise<TestLogStoreEndpointDetails>

getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)

Получение URI SAS для вложения тестового запуска

function getTestLogStoreEndpointDetailsForRunLog(project: string, runId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Идентификатор тестового запуска, файл которого необходимо скачать

type: TestLogType

тип файла

filePath: string

filePath, для которого необходим URI sas

Возвращаемое значение

Promise<TestLogStoreEndpointDetails>

getTestLogStoreEndpointDetailsForSubResultLog(string, number, number, number, TestLogType, string)

Получение URI SAS для вложения тестового подресулта

function getTestLogStoreEndpointDetailsForSubResultLog(project: string, runId: number, resultId: number, subResultId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Идентификатор тестового запуска, содержащего результат

resultId: number

Идентификатор результата теста, содержащего вложенный запрос

subResultId: number

Идентификатор тестового подресульта, uri файла sas которого необходим

type: TestLogType

тип файла

filePath: string

filePath, для которого необходим URI sas

Возвращаемое значение

Promise<TestLogStoreEndpointDetails>

getTestPipelineMetrics(string, number, string, string, string, Metrics[], boolean)

Получение сводки результатов теста.

function getTestPipelineMetrics(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, metricNames?: Metrics[], groupByNode?: boolean): Promise<PipelineTestMetrics>

Параметры

project: string

Идентификатор проекта или имя проекта

pipelineId: number

Идентификатор конвейера. Это совпадает с идентификатором сборки.

stageName: string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

phaseName: string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

jobName: string

Матрица в YAML создает копии задания с различными входными данными в матрице. JobName — это имя входных данных. Максимальная поддерживаемая длина имени — 256 символов.

metricNames: Metrics[]

groupByNode: boolean

Сводка по группам для каждого узла иерархии pipleine

Возвращаемое значение

Promise<PipelineTestMetrics>

getTestResultAttachmentContent(string, number, number, number)

Возвращает вложение результатов теста

function getTestResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

attachmentId: number

Возвращаемое значение

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

function getTestResultAttachments(project: string, runId: number, testCaseResultId: number): Promise<TestAttachment[]>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

Возвращаемое значение

Promise<TestAttachment[]>

getTestResultAttachmentZip(string, number, number, number)

Возвращает вложение результатов теста

function getTestResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

attachmentId: number

Возвращаемое значение

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

function getTestResultById(project: string, runId: number, testResultId: number, detailsToInclude?: ResultDetails): Promise<TestCaseResult>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

testResultId: number

detailsToInclude: ResultDetails

Возвращаемое значение

Promise<TestCaseResult>

getTestResultDetailsForBuild(string, number, string, string, string, string, boolean, boolean)

Получение сводки результатов теста для сборки. Чтобы получить полный файл TestCaseResult, вызовите результаты — Get.

function getTestResultDetailsForBuild(project: string, buildId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Возвращаемое значение

Promise<TestResultsDetails>

getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)

function getTestResultDetailsForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseId: number

releaseEnvId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Возвращаемое значение

Promise<TestResultsDetails>

getTestResultLogs(string, number, number, TestLogType, string, string, boolean, number, String)

Получение списка ссылок на вложения результатов теста

function getTestResultLogs(project: string, runId: number, resultId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Идентификатор тестового запуска, содержащего результат

resultId: number

Идентификатор результата теста

type: TestLogType

тип вложений для получения

directoryPath: string

Путь к каталогу вложений для получения

fileNamePrefix: string

Префикс имени файла для фильтрации списка вложений

fetchMetaData: boolean

Значение по умолчанию равно false, если требуются метаданные

top: number

Число ссылок на вложения для возврата

continuationToken: String

Заголовок для передачи продолженияToken

Возвращаемое значение

Promise<PagedList<TestLog>>

getTestResultMachines(string, number)

Возвращает компьютеры результатов теста для предоставленного TestRunId

function getTestResultMachines(project: string, runId: number): Promise<TestResultMachine[]>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Идентификатор TestRun для добавления компьютеров

Возвращаемое значение

Promise<TestResultMachine[]>

getTestResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)

function getTestResults(project: string, runId: number, detailsToInclude?: ResultDetails, skip?: number, top?: number, outcomes?: TestOutcome[], newTestsOnly?: boolean): Promise<TestCaseResult[]>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

detailsToInclude: ResultDetails

skip: number

top: number

outcomes: TestOutcome[]

newTestsOnly: boolean

Возвращаемое значение

Promise<TestCaseResult[]>

getTestResultsByBuild(string, number, string, TestOutcome[], number, string)

function getTestResultsByBuild(project: string, buildId: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Возвращаемое значение

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsByPipeline(string, number, string, string, string, TestOutcome[], boolean, number, String)

Получение списка результатов.

function getTestResultsByPipeline(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, outcomes?: TestOutcome[], includeAllBuildRuns?: boolean, top?: number, continuationToken?: String): Promise<PagedList<ShallowTestCaseResult>>

Параметры

project: string

Идентификатор проекта или имя проекта

pipelineId: number

Идентификатор конвейера. Это совпадает с идентификатором сборки.

stageName: string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

phaseName: string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

jobName: string

Матрица в YAML создает копии задания с различными входными данными в матрице. JobName — это имя входных данных. Максимальная поддерживаемая длина имени — 256 символов.

outcomes: TestOutcome[]

Список результатов

includeAllBuildRuns: boolean

Следует ли включать тестовые запуски из всех запусков сборки или нет.

top: number

Максимальное количество возвращаемых результатов

continuationToken: String

Заголовок для передачи продолженияToken

Возвращаемое значение

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsByPipelineMRX(string, number, string, string, string, TestOutcome[], boolean, number, String)

Возвращает полные объекты TestCaseResult с подробными сведениями 1MRX для предоставленного конвейера

function getTestResultsByPipelineMRX(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, outcomes?: TestOutcome[], includeAllBuildRuns?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestCaseResult>>

Параметры

project: string

Идентификатор проекта или имя проекта

pipelineId: number

Идентификатор конвейера. Это совпадает с идентификатором сборки.

stageName: string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

phaseName: string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

jobName: string

Матрица в YAML создает копии задания с различными входными данными в матрице. JobName — это имя входных данных. Максимальная поддерживаемая длина имени — 256 символов.

outcomes: TestOutcome[]

Список результатов

includeAllBuildRuns: boolean

Следует ли включать тестовые запуски из всех запусков сборки или нет. По умолчанию false.

top: number

Максимальное количество возвращаемых результатов. По умолчанию — 10000.

continuationToken: String

Заголовок для передачи продолженияToken

Возвращаемое значение

Promise<PagedList<TestCaseResult>>

getTestResultsByQuery(TestResultsQuery, string)

function getTestResultsByQuery(query: TestResultsQuery, project: string): Promise<TestResultsQuery>

Параметры

query: TestResultsQuery

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<TestResultsQuery>

getTestResultsByQueryWiql(QueryModel, string, boolean, boolean, number, number)

function getTestResultsByQueryWiql(queryModel: QueryModel, project: string, includeResultDetails?: boolean, includeIterationDetails?: boolean, skip?: number, top?: number): Promise<TestCaseResult[]>

Параметры

queryModel: QueryModel

project: string

Идентификатор проекта или имя проекта

includeResultDetails: boolean

includeIterationDetails: boolean

skip: number

top: number

Возвращаемое значение

Promise<TestCaseResult[]>

getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)

function getTestResultsByRelease(project: string, releaseId: number, releaseEnvid?: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseId: number

releaseEnvid: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Возвращаемое значение

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsSettings(string, TestResultsSettingsType)

Получение данных TestResultsSettings

function getTestResultsSettings(project: string, settingsType?: TestResultsSettingsType): Promise<TestResultsSettings>

Параметры

project: string

Идентификатор проекта или имя проекта

settingsType: TestResultsSettingsType

Возвращаемое значение

Promise<TestResultsSettings>

getTestResultWorkItemsById(string, number, number)

function getTestResultWorkItemsById(project: string, runId: number, testCaseResultId: number): Promise<WorkItemReference[]>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

Возвращаемое значение

Promise<WorkItemReference[]>

getTestRunAttachmentContent(string, number, number)

Возвращает вложение тестового запуска

function getTestRunAttachmentContent(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

attachmentId: number

Возвращаемое значение

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

function getTestRunAttachments(project: string, runId: number): Promise<TestAttachment[]>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Возвращаемое значение

Promise<TestAttachment[]>

getTestRunAttachmentUploadDetails(string, number)

Предполёт для загрузки вложений напрямую в BlobStore: обеспечивает разрешение на публикацию и возвращает домен dedup для публикации. Агент вызывает это до загрузки любых байт.

function getTestRunAttachmentUploadDetails(project: string, runId: number): Promise<TestAttachmentUploadDetails>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Возвращаемое значение

Promise<TestAttachmentUploadDetails>

getTestRunAttachmentZip(string, number, number)

Возвращает вложение тестового запуска

function getTestRunAttachmentZip(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

attachmentId: number

Возвращаемое значение

Promise<ArrayBuffer>

getTestRunById(string, number, boolean, boolean)

function getTestRunById(project: string, runId: number, includeDetails?: boolean, includeTags?: boolean): Promise<TestRun>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

includeDetails: boolean

includeTags: boolean

Возвращаемое значение

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

function getTestRunCodeCoverage(project: string, runId: number, flags: number): Promise<TestRunCoverage[]>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

flags: number

Возвращаемое значение

Promise<TestRunCoverage[]>

getTestRunLogs(string, number, TestLogType, string, string, boolean, number, String)

Получение списка ссылок на вложения тестового запуска

function getTestRunLogs(project: string, runId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Идентификатор тестового запуска

type: TestLogType

тип вложений для получения

directoryPath: string

Путь к каталогу, для которого требуются вложения

fileNamePrefix: string

Префикс имени файла для фильтрации списка вложений

fetchMetaData: boolean

Значение по умолчанию равно false, если требуются метаданные

top: number

Количество ссылок на вложения для возврата

continuationToken: String

Заголовок для передачи продолженияToken

Возвращаемое значение

Promise<PagedList<TestLog>>

getTestRunLogStoreAttachmentContent(string, number, string)

Возвращает вложение с указанным именем файла для указанного runId из LogStore.

function getTestRunLogStoreAttachmentContent(project: string, runId: number, filename: string): Promise<ArrayBuffer>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Тестовый идентификатор runId

filename: string

Имя файла вложения

Возвращаемое значение

Promise<ArrayBuffer>

getTestRunLogStoreAttachments(string, number)

Возвращает список вложений для указанного runId из LogStore.

function getTestRunLogStoreAttachments(project: string, runId: number): Promise<TestLogStoreAttachment[]>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Тестовый идентификатор runId

Возвращаемое значение

Promise<TestLogStoreAttachment[]>

getTestRunLogStoreAttachmentZip(string, number, string)

Возвращает вложение с указанным именем файла для указанного runId из LogStore.

function getTestRunLogStoreAttachmentZip(project: string, runId: number, filename: string): Promise<ArrayBuffer>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Тестовый идентификатор runId

filename: string

Имя файла вложения

Возвращаемое значение

Promise<ArrayBuffer>

getTestRunMessageLogs(string, number)

Получение журналов сообщений тестового запуска

function getTestRunMessageLogs(project: string, runId: number): Promise<TestMessageLogDetails[]>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Идентификатор запуска для получения.

Возвращаемое значение

Promise<TestMessageLogDetails[]>

getTestRuns(string, string, string, string, number, boolean, boolean, number, number)

function getTestRuns(project: string, buildUri?: string, owner?: string, tmiRunId?: string, planId?: number, includeRunDetails?: boolean, automated?: boolean, skip?: number, top?: number): Promise<TestRun[]>

Параметры

project: string

Идентификатор проекта или имя проекта

buildUri: string

owner: string

tmiRunId: string

planId: number

includeRunDetails: boolean

automated: boolean

skip: number

top: number

Возвращаемое значение

Promise<TestRun[]>

getTestRunsBySessionId(string, number)

Получение тестовых запусков, связанных с сеансом

function getTestRunsBySessionId(project: string, sessionId: number): Promise<number[]>

Параметры

project: string

Идентификатор проекта или имя проекта

sessionId: number

Идентификатор сеанса TestResults для получения тестовых запусков.

Возвращаемое значение

Promise<number[]>

getTestRunStatistics(string, number)

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

function getTestRunStatistics(project: string, runId: number): Promise<TestRunStatistic>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Идентификатор запуска для получения.

Возвращаемое значение

Promise<TestRunStatistic>

getTestRunSummaryByOutcome(string, number)

Получение сводки тестового запуска, используемой при получении сводки по результатам выполнения. Тестовое выполнение должно находиться в состоянии завершения.

function getTestRunSummaryByOutcome(project: string, runId: number): Promise<TestRunStatistic>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Идентификатор запуска для получения.

Возвращаемое значение

Promise<TestRunStatistic>

getTestSession(string, number)

Извлекает объект метаданных TestResultsSession в хранилище данных TCM

function getTestSession(project: string, buildId: number): Promise<TestResultsSession[]>

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Возвращаемое значение

Promise<TestResultsSession[]>

getTestSessionLayout(string, string)

Извлекает объект Layout TestResultsSession в хранилище данных TCM

function getTestSessionLayout(project: string, sessionId: string): Promise<any[]>

Параметры

project: string

Идентификатор проекта или имя проекта

sessionId: string

Возвращаемое значение

Promise<any[]>

getTestSessionLayoutBySessionId(string, number)

Извлекает объект Layout TestResultsSession в хранилище данных TCM

function getTestSessionLayoutBySessionId(project: string, sessionId: number): Promise<any[]>

Параметры

project: string

Идентификатор проекта или имя проекта

sessionId: number

Получение объекта сеанса.

Возвращаемое значение

Promise<any[]>

getTestSessionResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)

function getTestSessionResults(project: string, runId: number, detailsToInclude?: ResultDetails, skip?: number, top?: number, outcomes?: TestOutcome[], newTestsOnly?: boolean): Promise<TestCaseResult[]>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

detailsToInclude: ResultDetails

skip: number

top: number

outcomes: TestOutcome[]

newTestsOnly: boolean

Возвращаемое значение

Promise<TestCaseResult[]>

getTestSettingsById(string, number)

function getTestSettingsById(project: string, testSettingsId: number): Promise<TestSettings>

Параметры

project: string

Идентификатор проекта или имя проекта

testSettingsId: number

Возвращаемое значение

Promise<TestSettings>

getTestSubResultAttachmentContent(string, number, number, number, number)

Возвращает вложенное вложение тестового результата

function getTestSubResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

attachmentId: number

testSubResultId: number

Возвращаемое значение

Promise<ArrayBuffer>

getTestSubResultAttachments(string, number, number, number)

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

function getTestSubResultAttachments(project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachment[]>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

testSubResultId: number

Возвращаемое значение

Promise<TestAttachment[]>

getTestSubResultAttachmentZip(string, number, number, number, number)

Возвращает вложенное вложение тестового результата

function getTestSubResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

attachmentId: number

testSubResultId: number

Возвращаемое значение

Promise<ArrayBuffer>

getTestSubResultLogs(string, number, number, number, TestLogType, string, string, boolean, number, String)

Получение списка ссылок на тестовые вложенные вложения

function getTestSubResultLogs(project: string, runId: number, resultId: number, subResultId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Идентификатор тестового запуска, содержащего результаты

resultId: number

Идентификатор результата теста, содержащего вложенный запрос

subResultId: number

Идентификатор тестового подресульта

type: TestLogType

тип вложений для получения

directoryPath: string

Путь к каталогу для получения вложения

fileNamePrefix: string

Префикс имени файла для фильтрации списка вложений

fetchMetaData: boolean

Значение по умолчанию равно false, если требуются метаданные

top: number

Количество ссылок на вложения для возврата

continuationToken: String

Заголовок для передачи продолженияToken

Возвращаемое значение

Promise<PagedList<TestLog>>

getTestTagsForBuild(string, number)

Получение всех тегов в сборке.

function getTestTagsForBuild(project: string, buildId: number): Promise<TestTag[]>

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки

Возвращаемое значение

Promise<TestTag[]>

getTestTagsForRelease(string, number, number)

Получение всех тегов в выпуске.

function getTestTagsForRelease(project: string, releaseId: number, releaseEnvId: number): Promise<TestTag[]>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseId: number

Идентификатор выпуска

releaseEnvId: number

Идентификатор среды выпуска

Возвращаемое значение

Promise<TestTag[]>

getTestTagSummaryForBuild(string, number)

Получение всех тегов в сборке.

function getTestTagSummaryForBuild(project: string, buildId: number): Promise<TestTagSummary>

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки

Возвращаемое значение

Promise<TestTagSummary>

getTestTagSummaryForRelease(string, number, number)

Получение всех тегов в выпуске.

function getTestTagSummaryForRelease(project: string, releaseId: number, releaseEnvId: number): Promise<TestTagSummary>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseId: number

Идентификатор выпуска

releaseEnvId: number

Идентификатор среды выпуска

Возвращаемое значение

Promise<TestTagSummary>

getTestWeightedScoreByTestRun(string, string, boolean, boolean)

Рассчитать взвешенный балл по тесту для заданного списка идентификаторов тестовых забегов.

function getTestWeightedScoreByTestRun(project: string, runIds: string, includeAllOutcomes?: boolean, onlyFlakyResults?: boolean): Promise<TestCaseResult[]>

Параметры

project: string

Идентификатор проекта или имя проекта

runIds: string

Идентификаторы тестового запуска с разделённой комманом. Максимум поддерживается 100 человек.

includeAllOutcomes: boolean

Включите все результаты тестов для расчёта TWS. По умолчанию считается ложным

onlyFlakyResults: boolean

Есть возможность возвращать только нестабильные результаты тестов, которые определяются как неравномерные. По умолчанию true передаётся

Возвращаемое значение

Promise<TestCaseResult[]>

publishTestResultDocument(TestResultDocument, string, number)

function publishTestResultDocument(document: TestResultDocument, project: string, runId: number): Promise<TestResultDocument>

Параметры

document: TestResultDocument

project: string

Идентификатор проекта или имя проекта

runId: number

Возвращаемое значение

Promise<TestResultDocument>

queryCustomFields(string, CustomTestFieldScope)

Возвращает список настраиваемых полей тестирования для заданной области настраиваемого тестового поля.

function queryCustomFields(project: string, scopeFilter: CustomTestFieldScope): Promise<CustomTestFieldDefinition[]>

Параметры

project: string

Идентификатор проекта или имя проекта

scopeFilter: CustomTestFieldScope

Область настраиваемых полей тестирования, возвращаемых.

Возвращаемое значение

Promise<CustomTestFieldDefinition[]>

queryResultTrendForBuild(TestResultTrendFilter, string)

function queryResultTrendForBuild(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>

Параметры

filter: TestResultTrendFilter

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<AggregatedDataForResultTrend[]>

queryResultTrendForRelease(TestResultTrendFilter, string)

function queryResultTrendForRelease(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>

Параметры

filter: TestResultTrendFilter

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<AggregatedDataForResultTrend[]>

queryTestHistory(TestHistoryQuery, string)

Получение журнала метода тестирования с помощью TestHistoryQuery

function queryTestHistory(filter: TestHistoryQuery, project: string): Promise<TestHistoryQuery>

Параметры

filter: TestHistoryQuery

TestHistoryQuery для получения журнала

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems(string, string)

function queryTestMethodLinkedWorkItems(project: string, testName: string): Promise<TestToWorkItemLinks>

Параметры

project: string

Идентификатор проекта или имя проекта

testName: string

Возвращаемое значение

Promise<TestToWorkItemLinks>

queryTestResultAttachmentsMetadata(string, number, number, string, string, number, boolean)

Возвращает метаданные для тестовых вложений на уровне результатов, поддерживаемых BlobStore, имя которых начинается с fileNamePrefix, или для единственного вложения, идентифицируемого attachmentId при его предоставлении.

function queryTestResultAttachmentsMetadata(project: string, runId: number, testCaseResultId: number, attachmentType?: string, fileNamePrefix?: string, attachmentId?: number, fetchMetaData?: boolean): Promise<BlobStoreTestAttachment[]>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

attachmentType: string

fileNamePrefix: string

attachmentId: number

fetchMetaData: boolean

Возвращаемое значение

Promise<BlobStoreTestAttachment[]>

queryTestResultHistory(ResultsFilter, string)

function queryTestResultHistory(filter: ResultsFilter, project: string): Promise<TestResultHistory>

Параметры

filter: ResultsFilter

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<TestResultHistory>

queryTestResultsMetaData(string[], string, ResultMetaDataDetails)

Получение списка метаданных результатов теста для соответствующих testcasereferenceId

function queryTestResultsMetaData(testCaseReferenceIds: string[], project: string, detailsToInclude?: ResultMetaDataDetails): Promise<TestResultMetaData[]>

Параметры

testCaseReferenceIds: string[]

Идентификаторы TestCaseReference для запроса результата теста, разделенные запятыми, список допустимых идентификаторов (ограничение нет. идентификаторов 200).

project: string

Идентификатор проекта или имя проекта

detailsToInclude: ResultMetaDataDetails

Сведения о том, как включить метаданные результатов теста. Значение по умолчанию — None. Другие значения : FlakyIdentifiers.

Возвращаемое значение

Promise<TestResultMetaData[]>

queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)

function queryTestResultsReportForBuild(project: string, buildId: number, publishContext?: string, includeFailureDetails?: boolean, buildToCompare?: BuildReference): Promise<TestResultSummary>

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

publishContext: string

includeFailureDetails: boolean

buildToCompare: BuildReference

Возвращаемое значение

Promise<TestResultSummary>

queryTestResultsReportForPipeline(string, number, string, string, string, boolean)

Получение сводки результатов теста.

function queryTestResultsReportForPipeline(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, includeFailureDetails?: boolean): Promise<TestResultSummary>

Параметры

project: string

Идентификатор проекта или имя проекта

pipelineId: number

Идентификатор конвейера. Это совпадает с идентификатором сборки.

stageName: string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

phaseName: string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

jobName: string

Матрица в YAML создает копии задания с различными входными данными в матрице. JobName — это имя входных данных. Максимальная поддерживаемая длина имени — 256 символов.

includeFailureDetails: boolean

Если значение true возвращает аналитические сведения о сбоях

Возвращаемое значение

Promise<TestResultSummary>

queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)

function queryTestResultsReportForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, includeFailureDetails?: boolean, releaseToCompare?: ReleaseReference): Promise<TestResultSummary>

Параметры

project: string

Идентификатор проекта или имя проекта

releaseId: number

releaseEnvId: number

publishContext: string

includeFailureDetails: boolean

releaseToCompare: ReleaseReference

Возвращаемое значение

Promise<TestResultSummary>

queryTestResultsSummaryForReleases(ReleaseReference[], string)

function queryTestResultsSummaryForReleases(releases: ReleaseReference[], project: string): Promise<TestResultSummary[]>

Параметры

releases: ReleaseReference[]

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<TestResultSummary[]>

queryTestResultWorkItems(string, string, string, number, Date, number, number)

Результаты теста запросов WorkItems на основе фильтра

function queryTestResultWorkItems(project: string, workItemCategory: string, automatedTestName?: string, testCaseId?: number, maxCompleteDate?: Date, days?: number, workItemCount?: number): Promise<WorkItemReference[]>

Параметры

project: string

Идентификатор проекта или имя проекта

workItemCategory: string

может принимать значения Microsoft.BugCategory или all(для получения всех рабочих элементов)

automatedTestName: string

testCaseId: number

maxCompleteDate: Date

days: number

workItemCount: number

Возвращаемое значение

Promise<WorkItemReference[]>

queryTestRunAttachmentsMetadata(string, number, string, string, number, boolean)

Возвращает метаданные для тестовых вложений, поддерживаемых BlobStore, для которых имя файла начинается с fileNamePrefix, или для единственного вложения, идентифицируемого attachmentId при предоставлении. Агент использует это для перечисления тестовых журналов BlobStore (dedup), которые отсутствуют в классическом контейнере LogStore SAS и поэтому не могут быть перечислены агентом напрямую.

function queryTestRunAttachmentsMetadata(project: string, runId: number, attachmentType?: string, fileNamePrefix?: string, attachmentId?: number, fetchMetaData?: boolean): Promise<BlobStoreTestAttachment[]>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

attachmentType: string

fileNamePrefix: string

attachmentId: number

fetchMetaData: boolean

Возвращаемое значение

Promise<BlobStoreTestAttachment[]>

queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, TestRunSortOrderType, string)

Выполнение тестов запросов на основе фильтров. Обязательные поля : minLastUpdatedDate и maxLastUpdatedDate.

function queryTestRuns(project: string, minLastUpdatedDate: Date, maxLastUpdatedDate: Date, state?: TestRunState, planIds?: number[], isAutomated?: boolean, publishContext?: TestRunPublishContext, buildIds?: number[], buildDefIds?: number[], branchName?: string, releaseIds?: number[], releaseDefIds?: number[], releaseEnvIds?: number[], releaseEnvDefIds?: number[], runTitle?: string, top?: number, sortOrder?: TestRunSortOrderType, continuationToken?: string): Promise<PagedList<TestRun>>

Параметры

project: string

Идентификатор проекта или имя проекта

minLastUpdatedDate: Date

Минимальная дата последнего изменения запуска (обязательный).

maxLastUpdatedDate: Date

Максимальная дата последнего изменения выполнения запроса (обязательно, разница между минимальной и максимальной датой может быть максимум 7 дней).

state: TestRunState

Текущее состояние запросов к запускам.

planIds: number[]

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

isAutomated: boolean

Тип автоматизации запуска, запрашиваемого.

publishContext: TestRunPublishContext

PublishContext для запросов к запускам.

buildIds: number[]

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

buildDefIds: number[]

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

branchName: string

Имя исходной ветви запуска, запрашиваемой.

releaseIds: number[]

Идентификаторы выпуска запуска для запроса, разделенные запятыми, разделенный списком допустимых идентификаторов.

releaseDefIds: number[]

Идентификаторы определения выпуска для запросов к запускам, разделенные запятыми, разделенный списком допустимых идентификаторов.

releaseEnvIds: number[]

Идентификаторы среды выпуска для запросов к запускам, разделенные запятыми, разделенный списком допустимых идентификаторов.

releaseEnvDefIds: number[]

Идентификаторы определения среды выпуска для запрашиваемых запусков, разделенные запятыми, разделенный списком допустимых идентификаторов.

runTitle: string

Заголовок запуска запуска для запроса.

top: number

Количество запросов к выполнению. Ограничение равно 100

sortOrder: TestRunSortOrderType

Сортировка по lastUpdated для тестовых запусков.

continuationToken: string

continuationToken, полученный из предыдущего пакета или null для первого пакета. Он не должен быть создан (или изменен, если получен из последней пакетной службы) пользователем.

Возвращаемое значение

Promise<PagedList<TestRun>>

queryTestSubResultAttachmentsMetadata(string, number, number, number, string, string, number, boolean)

Возвращает метаданные для тестовых вложений, поддерживаемых BlobStore, на уровне результата, имя которых начинается с fileNamePrefix, или для единственного вложения, идентифицируемого attachmentId при его предоставлении.

function queryTestSubResultAttachmentsMetadata(project: string, runId: number, testCaseResultId: number, testSubResultId: number, attachmentType?: string, fileNamePrefix?: string, attachmentId?: number, fetchMetaData?: boolean): Promise<BlobStoreTestAttachment[]>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

testCaseResultId: number

testSubResultId: number

attachmentType: string

fileNamePrefix: string

attachmentId: number

fetchMetaData: boolean

Возвращаемое значение

Promise<BlobStoreTestAttachment[]>

queryTestSummaryByRequirement(TestResultsContext, string, number[])

function queryTestSummaryByRequirement(resultsContext: TestResultsContext, project: string, workItemIds?: number[]): Promise<TestSummaryForWorkItem[]>

Параметры

resultsContext: TestResultsContext

project: string

Идентификатор проекта или имя проекта

workItemIds: number[]

Возвращаемое значение

Promise<TestSummaryForWorkItem[]>

testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)

Создание и получение URI sas контейнера сборки

function testLogStoreEndpointDetailsForBuild(project: string, buildId: number, testLogStoreOperationType: TestLogStoreOperationType): Promise<TestLogStoreEndpointDetails>

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки для получения

testLogStoreOperationType: TestLogStoreOperationType

Тип операции для выполнения с помощью URI sas

Возвращаемое значение

Promise<TestLogStoreEndpointDetails>

testLogStoreEndpointDetailsForResult(string, number, number, number, string, TestLogType)

Создание пустого файла для результата и получение URI Sas для файла

function testLogStoreEndpointDetailsForResult(project: string, runId: number, resultId: number, subResultId: number, filePath: string, type: TestLogType): Promise<TestLogStoreEndpointDetails>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Идентификатор тестового запуска, содержащего результат

resultId: number

Идентификатор результатов теста, содержащих вложенный результат

subResultId: number

Идентификатор тестового вложенного результата, uri файла sas которого необходим

filePath: string

путь к файлу внутри вложенного результата, для которого необходим URI sas

type: TestLogType

Тип файла для скачивания

Возвращаемое значение

Promise<TestLogStoreEndpointDetails>

testLogStoreEndpointDetailsForRun(string, number, TestLogStoreOperationType, string, TestLogType)

Создание пустого файла для запуска и получения URI Sas для файла

function testLogStoreEndpointDetailsForRun(project: string, runId: number, testLogStoreOperationType: TestLogStoreOperationType, filePath?: string, type?: TestLogType): Promise<TestLogStoreEndpointDetails>

Параметры

project: string

Идентификатор проекта или имя проекта

runId: number

Идентификатор выполнения для получения сведений о конечной точке

testLogStoreOperationType: TestLogStoreOperationType

Тип операции для выполнения с помощью URI sas

filePath: string

Путь к файлу для создания пустого файла

type: TestLogType

Значение по умолчанию — GeneralAttachment, тип пустого файла для создания

Возвращаемое значение

Promise<TestLogStoreEndpointDetails>

testResultsGroupDetails(string, number, string, string, string, boolean, boolean)

Получите все доступные сведения о группах и для этих групп получить неудачные и прерванные результаты.

function testResultsGroupDetails(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, shouldIncludeFailedAndAbortedResults?: boolean, queryGroupSummaryForInProgress?: boolean): Promise<TestResultsDetails>

Параметры

project: string

Идентификатор проекта или имя проекта

pipelineId: number

Идентификатор конвейера. Это совпадает с идентификатором сборки.

stageName: string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

phaseName: string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

jobName: string

Матрица в YAML создает копии задания с различными входными данными в матрице. JobName — это имя входных данных. Максимальная поддерживаемая длина имени — 256 символов.

shouldIncludeFailedAndAbortedResults: boolean

Если задано значение true, он вернет идентификаторы неудачных и прерванных результатов для каждой тестовой группы

queryGroupSummaryForInProgress: boolean

Если значение true, оно также вычисляет сводку для выполнения InProgress.

Возвращаемое значение

Promise<TestResultsDetails>

triggerTestAgent(TestAgentTriggerRequest, string)

function triggerTestAgent(request: TestAgentTriggerRequest, project: string): Promise<boolean>

Параметры

request: TestAgentTriggerRequest

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<boolean>

updateCodeCoverageSummary(string, number, CodeCoverageData)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Запрос: Json сводки покрытия кода

function updateCodeCoverageSummary(project: string, buildId: number, coverageData?: CodeCoverageData): Promise<void>

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

coverageData: CodeCoverageData

Возвращаемое значение

Promise<void>

updateCustomField(CustomTestFieldUpdateDefinition, string)

Возвращает сведения о настраиваемом поле теста, которое обновляется.

function updateCustomField(updateCustomTestField: CustomTestFieldUpdateDefinition, project: string): Promise<CustomTestFieldDefinition>

Параметры

updateCustomTestField: CustomTestFieldUpdateDefinition

Настраиваемое поле теста, которое необходимо обновить.

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<CustomTestFieldDefinition>

updatePipelinesTestSettings(TestResultsUpdateSettings, string)

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

function updatePipelinesTestSettings(testResultsUpdateSettings: TestResultsUpdateSettings, project: string): Promise<TestResultsSettings>

Параметры

testResultsUpdateSettings: TestResultsUpdateSettings

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<TestResultsSettings>

updateTestResults(TestCaseResult[], string, number)

function updateTestResults(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>

Параметры

results: TestCaseResult[]

project: string

Идентификатор проекта или имя проекта

runId: number

Возвращаемое значение

Promise<TestCaseResult[]>

updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)

Обновление свойств метаданных результатов теста

function updateTestResultsMetaData(testResultMetaDataUpdateInput: TestResultMetaDataUpdateInput, project: string, testCaseReferenceId: number): Promise<TestResultMetaData>

Параметры

testResultMetaDataUpdateInput: TestResultMetaDataUpdateInput

TestResultMetaData обновить ввод TestResultMetaDataUpdateInput

project: string

Идентификатор проекта или имя проекта

testCaseReferenceId: number

Идентификатор TestCaseReference для обновления результата теста.

Возвращаемое значение

Promise<TestResultMetaData>

updateTestResultsToTestRunSession(TestCaseResult[], string, number)

Создает объекты TestResultsMRX в хранилище данных TCM для существующих результатов теста

function updateTestResultsToTestRunSession(results: TestCaseResult[], project: string, runId: number): Promise<number[]>

Параметры

results: TestCaseResult[]

Объект результатов с только свойствами MRX и существующими свойствами testResultId

project: string

Идентификатор проекта или имя проекта

runId: number

RunId тестового запуска

Возвращаемое значение

Promise<number[]>

updateTestRun(RunUpdateModel, string, number)

function updateTestRun(runUpdateModel: RunUpdateModel, project: string, runId: number): Promise<TestRun>

Параметры

runUpdateModel: RunUpdateModel

project: string

Идентификатор проекта или имя проекта

runId: number

Возвращаемое значение

Promise<TestRun>

updateTestRunsBySessionId(TestSessionTestRun, string, number)

Обновление тестов, связанных с сеансом

function updateTestRunsBySessionId(testRunIds: TestSessionTestRun, project: string, sessionId: number): Promise<number[]>

Параметры

testRunIds: TestSessionTestRun

project: string

Идентификатор проекта или имя проекта

sessionId: number

Идентификатор сеанса TestResults для обновления тестовых запусков.

Возвращаемое значение

Promise<number[]>

updateTestRunTags(TestTagsUpdateModel, string, number)

Обновление тегов выполнения, теги можно добавить и удалить

function updateTestRunTags(testTagsUpdateModel: TestTagsUpdateModel, project: string, runId: number): Promise<TestTag[]>

Параметры

testTagsUpdateModel: TestTagsUpdateModel

TestTagsUpdateModel

project: string

Идентификатор проекта или имя проекта

runId: number

RunId запуска

Возвращаемое значение

Promise<TestTag[]>

updateTestSession(TestResultsSession, string, number)

Обновляет объект тестового сеанса, связанный с идентификатором сеанса

function updateTestSession(session: TestResultsSession, project: string, sessionId: number): Promise<number>

Параметры

session: TestResultsSession

Обновление объекта Session

project: string

Идентификатор проекта или имя проекта

sessionId: number

Идентификатор сеанса TestResults для обновления объекта сеанса Test.

Возвращаемое значение

Promise<number>

TestResultsRestClient class

Конструкторы

Свойства

Методы

Сведения о конструкторе

TestResultsRestClient(IVssRestClientOptions)

Параметры

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

RESOURCE_AREA_ID

Значение свойства

Сведения о методе

addCustomFields(CustomTestFieldDefinition[], string)

Параметры

Возвращаемое значение

addTestResultsToTestRun(TestCaseResult[], string, number)

Параметры

Возвращаемое значение

addTestResultsToTestRunSession(TestCaseResult[], string, number)

Параметры

Возвращаемое значение

addWorkItemToTestLinks(WorkItemToTestLinks, string)

Параметры

Возвращаемое значение

callbackTestAgent(TestAgentCallbackRequest, string)

Параметры

Возвращаемое значение

completeGitHubAuth(string, string)

Параметры

Возвращаемое значение

createAnalysis(TestSessionAnalysis[], string, number)

Параметры

Возвращаемое значение

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

Параметры

Возвращаемое значение

createEnvironment(TestSessionEnvironment[], string)

Параметры

Возвращаемое значение

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Параметры

Возвращаемое значение

createFailureType(TestResultFailureTypeRequestModel, string)

Параметры

Возвращаемое значение

createNotification(TestSessionNotification[], string, number)

Параметры

Возвращаемое значение

createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)

Параметры

Возвращаемое значение

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Параметры

Возвращаемое значение

createTestResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number)

Параметры

Возвращаемое значение

createTestResultMachines(TestResultMachine[], string, number)

Параметры

Возвращаемое значение

createTestRun(RunCreateModel, string)

Параметры

Возвращаемое значение

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Параметры

Возвращаемое значение

createTestRunAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number)

Параметры

Возвращаемое значение

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

Параметры

Возвращаемое значение

createTestSession(TestResultsSession, string)

Параметры

Возвращаемое значение

createTestSettings(TestSettings, string)

Параметры

Возвращаемое значение

createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)

Параметры

Возвращаемое значение