Поделиться через


TestRestClient class

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

Extends

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

TestRestClient(IVssRestClientOptions)

Свойства

RESOURCE_AREA_ID

Методы

addCustomFields(CustomTestFieldDefinition[], string)
addTestCasesToSuite(string, number, number, string)

Добавление тестовых случаев в набор.

addTestResultsToTestRun(TestCaseResult[], string, number)

Добавьте результаты теста в тестовый запуск.

addWorkItemToTestLinks(WorkItemToTestLinks, string)
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)

Вложение файла к результату тестового шага

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Вложите файл в результат теста.

createTestRun(RunCreateModel, string)

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

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Вложите файл в тестовый запуск.

createTestSession(TestSession, TeamContext)

Создание тестового сеанса

createTestSettings(TestSettings, string)
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)

Вложение файла к результату теста

deleteSharedParameter(string, number)
deleteSharedStep(string, number)
deleteTestCase(string, number)

Удаление тестового случая.

deleteTestMethodToWorkItemLink(string, string, number)
deleteTestRun(string, number)

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

deleteTestSettings(string, number)
getBugsLinkedToTestResult(string, number, number)
getBuildCodeCoverage(string, number, number)

Получение данных об объеме протестированного кода для сборки.

getCodeCoverageSummary(string, number, number)

Получение сводки объема протестированного кода для сборки.

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)
getPoint(string, number, number, number, string)

Получение точки тестирования.

getPoints(string, number, number, string, string, string, string, boolean, number, number)

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

getPointsByQuery(TestPointsQuery, string, number, number)

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

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

Получение параметров хранения результатов теста

getTestCaseById(string, number, number, number)

Получение конкретного тестового случая в наборе тестов с идентификатором тестового случая.

getTestCases(string, number, number)

Получение всех тестовых случаев в наборе.

getTestIteration(string, number, number, number, boolean)

Получение итерации для результата

getTestIterations(string, number, number, 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)
getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)
getTestResults(string, number, ResultDetails, number, number, TestOutcome[])

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

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

Этот API будет возвращать результаты по идентификаторам с указанными полями или тенденциями для определенного автоматизированного метода тестирования. Мы все еще совершенствуем этот API и не завершили правильную подпись и контракт.

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

Скачайте вложение тестового запуска по его идентификатору.

getTestRunAttachments(string, number)

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

getTestRunAttachmentZip(string, number, number)

Скачайте вложение тестового запуска по его идентификатору.

getTestRunById(string, number, boolean)

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

getTestRunCodeCoverage(string, number, number)

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

getTestRunLogs(string, number)

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

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

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

getTestRunStatistics(string, number)

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

getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)

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

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

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

getTestSubResultAttachments(string, number, number, number)

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

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

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

publishTestResultDocument(TestResultDocument, string, number)
queryCustomFields(string, CustomTestFieldScope)
queryResultTrendForBuild(TestResultTrendFilter, string)
queryResultTrendForRelease(TestResultTrendFilter, string)
queryTestHistory(TestHistoryQuery, string)

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

queryTestMethodLinkedWorkItems(string, string)
queryTestResultHistory(ResultsFilter, string)
queryTestResultsMetaData(string[], string)

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

queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)
queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
queryTestResultsSummaryForReleases(ReleaseReference[], string)
queryTestResultWorkItems(string, string, string, number, Date, number, number)
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, string)

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

queryTestSummaryByRequirement(TestResultsContext, string, number[])
removeTestCasesFromSuiteUrl(string, number, number, string)

Точки тестирования, связанные с тестовыми случаями, удаляются из набора тестов. Рабочий элемент тестового случая не удаляется из системы. Чтобы окончательно удалить тестовый случай, ознакомьтесь с ресурсом тестовых случаев.

updateCodeCoverageSummary(CodeCoverageData, string, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Request: Json of code coverage summary

updateResultRetentionSettings(ResultRetentionSettings, string)

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

updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)

Обновления свойства связи тестовых случаев в наборе.

updateTestPoints(PointUpdateModel, string, number, number, string)

Обновление тестовых точек.

updateTestResults(TestCaseResult[], string, number)

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

updateTestRun(RunUpdateModel, string, number)

Обновите тестовый запуск по его идентификатору.

updateTestSession(TestSession, TeamContext)

Обновление тестового сеанса

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

TestRestClient(IVssRestClientOptions)

new TestRestClient(options: IVssRestClientOptions)

Параметры

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

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

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

string

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

addCustomFields(CustomTestFieldDefinition[], string)

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

Параметры

project

string

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

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

addTestCasesToSuite(string, number, number, string)

Добавление тестовых случаев в набор.

function addTestCasesToSuite(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>

Параметры

project

string

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

planId

number

Идентификатор плана тестирования, содержащего набор.

suiteId

number

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

testCaseIds

string

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

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

Promise<SuiteTestCase[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

Добавьте результаты теста в тестовый запуск.

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

Параметры

results

TestCaseResult[]

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

project

string

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

runId

number

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

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

Promise<TestCaseResult[]>

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

Параметры

workItemToTestLinks
WorkItemToTestLinks
project

string

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

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

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

Сведения о вложении TestAttachmentRequestModel

project

string

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

runId

number

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

testCaseResultId

number

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

iterationId

number

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

actionPath

string

Шестнадцатеричное значение пути к действию результата теста.

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

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Вложите файл в результат теста.

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

Параметры

attachmentRequestModel
TestAttachmentRequestModel

Сведения о вложении TestAttachmentRequestModel

project

string

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

runId

number

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

testCaseResultId

number

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

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

createTestRun(RunCreateModel, string)

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

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

Параметры

testRun
RunCreateModel

Сведения о запуске RunCreateModel

project

string

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

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

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Вложите файл в тестовый запуск.

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

Параметры

attachmentRequestModel
TestAttachmentRequestModel

Сведения о вложении TestAttachmentRequestModel

project

string

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

runId

number

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

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

createTestSession(TestSession, TeamContext)

Создание тестового сеанса

function createTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>

Параметры

testSession
TestSession

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

teamContext
TeamContext

Контекст команды для операции

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

Promise<TestSession>

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

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

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

deleteSharedParameter(string, number)

function deleteSharedParameter(project: string, sharedParameterId: number): Promise<void>

Параметры

project

string

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

sharedParameterId

number

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

Promise<void>

deleteSharedStep(string, number)

function deleteSharedStep(project: string, sharedStepId: number): Promise<void>

Параметры

project

string

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

sharedStepId

number

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

Promise<void>

deleteTestCase(string, number)

Удаление тестового случая.

function deleteTestCase(project: string, testCaseId: number): Promise<void>

Параметры

project

string

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

testCaseId

number

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

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

Promise<void>

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

Параметры

project

string

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

testName

string

workItemId

number

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

Promise<boolean>

deleteTestRun(string, number)

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

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

Параметры

project

string

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

runId

number

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

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

Promise<void>

deleteTestSettings(string, number)

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

Параметры

project

string

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

testSettingsId

number

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

Promise<void>

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

Значение флагов определяет уровень сведений об объеме протестированного кода. Флаги являются аддитивными. Ожидаемые значения: 1 для модулей, 2 для Функций, 4 для BlockData.

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

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

Получение сводки объема протестированного кода для сборки.

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

Параметры

project

string

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

buildId

number

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

deltaBuildId

number

Идентификатор разностной сборки (необязательно)

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

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)

function getLinkedWorkItemsByQuery(workItemQuery: LinkedWorkItemsQuery, project: string): Promise<LinkedWorkItemsQueryResult[]>

Параметры

workItemQuery
LinkedWorkItemsQuery
project

string

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

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

getPoint(string, number, number, number, string)

Получение точки тестирования.

function getPoint(project: string, planId: number, suiteId: number, pointIds: number, witFields?: string): Promise<TestPoint>

Параметры

project

string

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

planId

number

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

suiteId

number

Идентификатор набора, содержащего точку.

pointIds

number

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

witFields

string

Разделенный запятыми список имен полей рабочих элементов.

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

Promise<TestPoint>

getPoints(string, number, number, string, string, string, string, boolean, number, number)

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

function getPoints(project: string, planId: number, suiteId: number, witFields?: string, configurationId?: string, testCaseId?: string, testPointIds?: string, includePointDetails?: boolean, skip?: number, top?: number): Promise<TestPoint[]>

Параметры

project

string

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

planId

number

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

suiteId

number

Идентификатор набора, содержащего точки.

witFields

string

Разделенный запятыми список имен полей рабочих элементов.

configurationId

string

Получение точек тестирования для определенной конфигурации.

testCaseId

string

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

testPointIds

string

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

includePointDetails

boolean

Включите все свойства для точки тестирования.

skip

number

Количество пропускаемых тестовых точек.

top

number

Количество возвращаемых тестовых точек.

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

Promise<TestPoint[]>

getPointsByQuery(TestPointsQuery, string, number, number)

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

function getPointsByQuery(query: TestPointsQuery, project: string, skip?: number, top?: number): Promise<TestPointsQuery>

Параметры

query
TestPointsQuery

TestPointsQuery для получения тестовых точек.

project

string

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

skip

number

Количество пропускаемых тестовых точек.

top

number

Количество возвращаемых тестовых точек.

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

Promise<TestPointsQuery>

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

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

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

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

getResultRetentionSettings(string)

Получение параметров хранения результатов теста

function getResultRetentionSettings(project: string): Promise<ResultRetentionSettings>

Параметры

project

string

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

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

getTestCaseById(string, number, number, number)

Получение конкретного тестового случая в наборе тестов с идентификатором тестового случая.

function getTestCaseById(project: string, planId: number, suiteId: number, testCaseIds: number): Promise<SuiteTestCase>

Параметры

project

string

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

planId

number

Идентификатор плана тестирования, содержащего наборы.

suiteId

number

Идентификатор набора, содержащего тестовый случай.

testCaseIds

number

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

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

Promise<SuiteTestCase>

getTestCases(string, number, number)

Получение всех тестовых случаев в наборе.

function getTestCases(project: string, planId: number, suiteId: number): Promise<SuiteTestCase[]>

Параметры

project

string

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

planId

number

Идентификатор плана тестирования, содержащего наборы.

suiteId

number

Идентификатор получаемого набора.

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

Promise<SuiteTestCase[]>

getTestIteration(string, number, number, number, boolean)

Получение итерации для результата

function getTestIteration(project: string, runId: number, testCaseResultId: number, iterationId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel>

Параметры

project

string

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

runId

number

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

testCaseResultId

number

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

iterationId

number

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

includeActionResults

boolean

Включите сведения о результатах для каждого действия, выполняемого в итерации теста. ActionResults — это результаты (пройденные или неудачные) этапы тестирования, выполняемые в рамках выполнения теста вручную. Включение флага ActionResults возвращает результат шагов тестирования в разделе actionResults и параметры теста в разделе параметров для каждой итерации теста.

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

getTestIterations(string, number, number, boolean)

Получение итераций для результата

function getTestIterations(project: string, runId: number, testCaseResultId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel[]>

Параметры

project

string

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

runId

number

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

testCaseResultId

number

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

includeActionResults

boolean

Включите сведения о результатах для каждого действия, выполняемого в итерации теста. ActionResults — это результаты (пройденные или неудачные) этапы тестирования, выполняемые в рамках выполнения теста вручную. Включение флага ActionResults возвращает результат шагов тестирования в разделе actionResults и параметры теста в разделе параметров для каждой итерации теста.

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

getTestResultAttachmentContent(string, number, number, number)

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

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

Параметры

project

string

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

runId

number

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

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.

testCaseResultId

number

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

attachmentId

number

Идентификатор загружаемого вложения результатов теста.

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

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

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

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

Параметры

project

string

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

runId

number

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

testCaseResultId

number

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

detailsToInclude
ResultDetails

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

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

Promise<TestCaseResult>

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

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

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

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

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

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

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

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

Параметры

project

string

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

runId

number

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

detailsToInclude
ResultDetails

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

skip

number

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

top

number

Количество возвращаемых результатов теста. Максимальное значение равно 1000, если detailsToInclude равно None, и 200 в противном случае.

outcomes

TestOutcome[]

Разделенный запятыми список результатов теста для фильтрации результатов теста.

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

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

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

getTestResultsByQuery(TestResultsQuery, string)

Этот API будет возвращать результаты по идентификаторам с указанными полями или тенденциями для определенного автоматизированного метода тестирования. Мы все еще совершенствуем этот API и не завершили правильную подпись и контракт.

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

Параметры

project

string

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

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

Promise<TestResultsQuery>

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

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

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[]>

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)

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

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

Параметры

project

string

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

runId

number

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

includeDetails

boolean

Значение по умолчанию — true. Он включает в себя такие сведения, как статистика выполнения, выпуск, сборка, тестовая среда, состояние после процесса и многое другое.

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

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

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

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

Параметры

project

string

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

runId

number

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

flags

number

Значение флагов определяет уровень сведений о покрытии кода, которые необходимо получить. Флаги являются аддитивными. Ожидаемые значения: 1 для модулей, 2 для функций, 4 для BlockData.

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

Promise<TestRunCoverage[]>

getTestRunLogs(string, number)

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

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

Параметры

project

string

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

runId

number

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

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

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

URI сборки, используемой запусками.

owner

string

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

tmiRunId

string

planId

number

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

includeRunDetails

boolean

Если задано значение true, включите все свойства запусков.

automated

boolean

Если задано значение true, возвращается только автоматический запуск.

skip

number

Количество пропустить тестовых запусков.

top

number

Количество возвращаемых тестовых запусков.

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

Promise<TestRun[]>

getTestRunStatistics(string, number)

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

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

Параметры

project

string

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

runId

number

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

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

Promise<TestRunStatistic>

getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)

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

function getTestSessions(teamContext: TeamContext, period?: number, allSessions?: boolean, includeAllProperties?: boolean, source?: TestSessionSource, includeOnlyCompletedSessions?: boolean): Promise<TestSession[]>

Параметры

teamContext
TeamContext

Контекст команды для операции

period

number

Период в днях, для которого извлекаются тестовые сеансы.

allSessions

boolean

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

includeAllProperties

boolean

Если значение равно true, возвращается все свойства тестовых сеансов. В противном случае возвращается тощая версия.

source
TestSessionSource

Источник тестового сеанса.

includeOnlyCompletedSessions

boolean

Если значение равно true, оно возвращает тестовые сеансы в завершенном состоянии. В противном случае он возвращает тестовые сеансы для всех состояний.

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

Promise<TestSession[]>

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>

publishTestResultDocument(TestResultDocument, string, number)

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

Параметры

project

string

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

runId

number

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

queryCustomFields(string, CustomTestFieldScope)

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

Параметры

project

string

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

scopeFilter
CustomTestFieldScope

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

queryResultTrendForBuild(TestResultTrendFilter, string)

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

Параметры

project

string

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

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

queryResultTrendForRelease(TestResultTrendFilter, string)

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

Параметры

project

string

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

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

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

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

queryTestResultHistory(ResultsFilter, string)

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

Параметры

filter
ResultsFilter
project

string

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

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

queryTestResultsMetaData(string[], string)

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

function queryTestResultsMetaData(testReferenceIds: string[], project: string): Promise<TestResultMetaData[]>

Параметры

testReferenceIds

string[]

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

project

string

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

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

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

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

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

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

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)

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

Параметры

project

string

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

workItemCategory

string

automatedTestName

string

testCaseId

number

maxCompleteDate

Date

days

number

workItemCount

number

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

Promise<WorkItemReference[]>

queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, 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, continuationToken?: string): Promise<PagedList<TestRun>>

Параметры

project

string

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

minLastUpdatedDate

Date

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

maxLastUpdatedDate

Date

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

state
TestRunState

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

planIds

number[]

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

isAutomated

boolean

Тип автоматизации для запрашиваемых запусков.

publishContext
TestRunPublishContext

PublishContext для выполнения запроса.

buildIds

number[]

Идентификаторы сборки запрашиваемых запусков, разделенные запятыми список допустимых идентификаторов (ограничение no. идентификаторов 10).

buildDefIds

number[]

Идентификаторы определений сборки для запрашиваемых запусков, разделенные запятыми список допустимых идентификаторов (ограничение no. идентификаторов 10).

branchName

string

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

releaseIds

number[]

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

releaseDefIds

number[]

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

releaseEnvIds

number[]

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

releaseEnvDefIds

number[]

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

runTitle

string

Заголовок запуска для запрашиваемых запусков.

top

number

Число выполнений, которые необходимо запрашивать. Ограничение — 100

continuationToken

string

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

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

Promise<PagedList<TestRun>>

queryTestSummaryByRequirement(TestResultsContext, string, number[])

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

Параметры

resultsContext
TestResultsContext
project

string

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

workItemIds

number[]

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

removeTestCasesFromSuiteUrl(string, number, number, string)

Точки тестирования, связанные с тестовыми случаями, удаляются из набора тестов. Рабочий элемент тестового случая не удаляется из системы. Чтобы окончательно удалить тестовый случай, ознакомьтесь с ресурсом тестовых случаев.

function removeTestCasesFromSuiteUrl(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<void>

Параметры

project

string

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

planId

number

Идентификатор плана тестирования, содержащего набор.

suiteId

number

Идентификатор набора, который нужно получить.

testCaseIds

string

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

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

Promise<void>

updateCodeCoverageSummary(CodeCoverageData, string, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Request: Json of code coverage summary

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

Параметры

coverageData
CodeCoverageData
project

string

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

buildId

number

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

Promise<void>

updateResultRetentionSettings(ResultRetentionSettings, string)

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

function updateResultRetentionSettings(retentionSettings: ResultRetentionSettings, project: string): Promise<ResultRetentionSettings>

Параметры

retentionSettings
ResultRetentionSettings

Сведения о параметрах хранения результатов теста для обновления

project

string

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

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

updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)

Обновления свойства связи тестовых случаев в наборе.

function updateSuiteTestCases(suiteTestCaseUpdateModel: SuiteTestCaseUpdateModel, project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>

Параметры

suiteTestCaseUpdateModel
SuiteTestCaseUpdateModel

Модель для updation свойств сопоставления набора тестовых случаев.

project

string

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

planId

number

Идентификатор плана тестирования, содержащего набор.

suiteId

number

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

testCaseIds

string

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

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

Promise<SuiteTestCase[]>

updateTestPoints(PointUpdateModel, string, number, number, string)

Обновление тестовых точек.

function updateTestPoints(pointUpdateModel: PointUpdateModel, project: string, planId: number, suiteId: number, pointIds: string): Promise<TestPoint[]>

Параметры

pointUpdateModel
PointUpdateModel

Обновляемая информация.

project

string

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

planId

number

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

suiteId

number

Идентификатор набора, содержащего точки.

pointIds

string

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

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

Promise<TestPoint[]>

updateTestResults(TestCaseResult[], string, number)

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

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

Параметры

results

TestCaseResult[]

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

project

string

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

runId

number

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

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

Promise<TestCaseResult[]>

updateTestRun(RunUpdateModel, string, number)

Обновите тестовый запуск по его идентификатору.

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

Параметры

runUpdateModel
RunUpdateModel

Сведения о запуске RunUpdateModel

project

string

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

runId

number

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

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

Promise<TestRun>

updateTestSession(TestSession, TeamContext)

Обновление тестового сеанса

function updateTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>

Параметры

testSession
TestSession

Сведения о сеансе тестирования для обновления

teamContext
TeamContext

Контекст команды для операции

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

Promise<TestSession>