TestResultsRestClient class

应使用基类(派生自)向 VSS REST API 发出请求

扩展

构造函数

TestResultsRestClient(IVssRestClientOptions)

属性

RESOURCE_AREA_ID

方法

addCustomFields(CustomTestFieldDefinition[], string)
addTestResultsToTestRun(TestCaseResult[], string, number)
addTestResultsToTestRunSession(TestCaseResult[], string, number)

添加测试结果以测试运行会话

addWorkItemToTestLinks(WorkItemToTestLinks, string)
createAnalysis(TestSessionAnalysis[], string, number)

在给定会话的 TCM 数据存储中创建会话分析对象

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

在 LogStore 中为指定的 buildId 创建附件。

createEnvironment(TestSessionEnvironment[], string)

在 TCM 数据存储中创建 Environment 对象

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

对于提供的 sessionId,请在 TCM 数据存储中创建环境、配置和计算机对象

createFailureType(TestResultFailureTypeRequestModel, string)

创建新的测试失败类型

createNotification(TestSessionNotification[], string, number)

在给定会话的 TCM 数据存储中创建 Notification 对象

createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)
createTestRun(RunCreateModel, string)
createTestRunAttachment(TestAttachmentRequestModel, string, number)
createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

在 LogStore 中为指定的 runId 创建附件。

createTestSession(TestResultsSession, string)

在 TCM 数据存储中创建 TestResultsSession 对象

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

删除具有指定 failureTypeId 的测试失败类型

deleteTestMethodToWorkItemLink(string, string, number)
deleteTestResultAttachment(string, number, number, number)
deleteTestRun(string, number)
deleteTestRunAttachment(string, number, number)
deleteTestRunLogStoreAttachment(string, number, string)

从 LogStore 中删除具有指定 runId 的指定文件名的附件。

deleteTestSettings(string, number)
fetchSourceCodeCoverageReport(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 请求:生成 ID 和增量生成 ID(可选)

getCoverageStatusBadge(string, string, string, string)

<p>获取定义最后一次成功生成的覆盖状态,可以选择限定为特定分支</p>

getFailureTypes(string)

返回测试失败类型的列表。

getFileLevelCodeCoverage(FileCoverageRequest, string)

获取指定文件的文件覆盖率

getFlakyTestResultsByBuildDefinitionId(string, number, Date)
getFlakyTestResultsByTestRun(string, number)
getResultGroupsByBuild(string, number, string, string[], string)
getResultGroupsByRelease(string, number, string, number, string[], string)
getSessionNotifications(string, number)

检索 TCM 数据存储中的 TestResultsSession 通知对象

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

获取其失败与所提供的结果匹配的结果列表。

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)

获取生成附件的 SAS URI

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

获取测试结果附件的 SAS URI

getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)

获取测试运行附件的 SAS URI

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

获取测试子请求附件的 SAS URI

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)
getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)
getTestResultLogs(string, number, number, TestLogType, string, string, boolean, number, String)

获取测试结果附件参考列表

getTestResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByPipeline(string, number, string, string, string, TestOutcome[], number, String)

获取结果列表。

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)
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)

从 LogStore 返回具有指定 runId 的指定文件名的附件。

getTestRunLogStoreAttachments(string, number)

返回 LogStore 中指定 runId 的附件列表。

getTestRunLogStoreAttachmentZip(string, number, string)

从 LogStore 返回具有指定 runId 的指定文件名的附件。

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)

检索 TCM 数据存储中的 TestResultsSession 元数据对象

getTestSessionLayout(string, string)

检索 TCM 数据存储中的 TestResultsSession Layout 对象

getTestSessionLayoutBySessionId(string, number)

检索 TCM 数据存储中的 TestResultsSession Layout 对象

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)

获取发布中的所有标记。

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, 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

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

基于筛选器的查询测试运行。 必需字段为 minLastUpdatedDate 和 maxLastUpdatedDate。

queryTestSummaryByRequirement(TestResultsContext, string, number[])
testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)

创建和获取生成容器的 sas URI

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

为结果创建空文件,并获取文件的 Sas URI

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

为文件创建空文件并获取文件的 Sas URI

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

获取所有可用的组详细信息,并获取这些组失败和中止的结果。

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)

在 TCM 数据存储中创建 TestResultsMRX 对象以获取现有测试结果

updateTestRun(RunUpdateModel, string, number)
updateTestRunTags(TestTagsUpdateModel, string, number)

更新运行的标记,可以添加和删除标记

构造函数详细信息

TestResultsRestClient(IVssRestClientOptions)

new TestResultsRestClient(options: IVssRestClientOptions)

参数

属性详细信息

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

属性值

string

方法详细信息

addCustomFields(CustomTestFieldDefinition[], string)

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

参数

project

string

项目 ID 或项目名称

返回

addTestResultsToTestRun(TestCaseResult[], string, number)

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

参数

results

TestCaseResult[]

project

string

项目 ID 或项目名称

runId

number

返回

Promise<TestCaseResult[]>

addTestResultsToTestRunSession(TestCaseResult[], string, number)

添加测试结果以测试运行会话

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

参数

results

TestCaseResult[]

project

string

项目 ID 或项目名称

runId

number

测试运行的 RunId

返回

Promise<TestCaseResult[]>

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

参数

workItemToTestLinks
WorkItemToTestLinks
project

string

项目 ID 或项目名称

返回

createAnalysis(TestSessionAnalysis[], string, number)

在给定会话的 TCM 数据存储中创建会话分析对象

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

参数

analysis

TestSessionAnalysis[]

会话分析详细信息

project

string

项目 ID 或项目名称

sessionId

number

用于添加通知的会话 ID

返回

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

在 LogStore 中为指定的 buildId 创建附件。

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

参数

attachmentRequestModel
TestAttachmentRequestModel

包含诸如 stream、filename、comment、attachmentType 等附件信息

project

string

项目 ID 或项目名称

buildId

number

BuildId

返回

Promise<void>

createEnvironment(TestSessionEnvironment[], string)

在 TCM 数据存储中创建 Environment 对象

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

参数

environments

TestSessionEnvironment[]

Received Environment 对象。

project

string

项目 ID 或项目名称

返回

Promise<void>

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

对于提供的 sessionId,请在 TCM 数据存储中创建环境、配置和计算机对象

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

参数

sessionEnvironmentAndMachine
SessionEnvironmentAndMachine
project

string

项目 ID 或项目名称

sessionId

number

返回

Promise<void>

createFailureType(TestResultFailureTypeRequestModel, string)

创建新的测试失败类型

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

参数

testResultFailureType
TestResultFailureTypeRequestModel
project

string

项目 ID 或项目名称

返回

createNotification(TestSessionNotification[], string, number)

在给定会话的 TCM 数据存储中创建 Notification 对象

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

参数

notifications

TestSessionNotification[]

要为指定的 sessionId 添加的通知(s)

project

string

项目 ID 或项目名称

sessionId

number

用于添加通知的会话 ID

返回

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

项目 ID 或项目名称

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
project

string

项目 ID 或项目名称

runId

number

testCaseResultId

number

返回

createTestRun(RunCreateModel, string)

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

参数

testRun
RunCreateModel
project

string

项目 ID 或项目名称

返回

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

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

参数

attachmentRequestModel
TestAttachmentRequestModel
project

string

项目 ID 或项目名称

runId

number

返回

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

在 LogStore 中为指定的 runId 创建附件。

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

参数

attachmentRequestModel
TestAttachmentRequestModel

包含诸如 stream、filename、comment、attachmentType 等附件信息

project

string

项目 ID 或项目名称

runId

number

测试 RunId

返回

createTestSession(TestResultsSession, string)

在 TCM 数据存储中创建 TestResultsSession 对象

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

参数

session
TestResultsSession

收到的会话对象。

project

string

项目 ID 或项目名称

返回

Promise<number>

createTestSettings(TestSettings, string)

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

参数

testSettings
TestSettings
project

string

项目 ID 或项目名称

返回

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

项目 ID 或项目名称

runId

number

testCaseResultId

number

testSubResultId

number

返回

deleteCustomFieldById(string, number)

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

参数

project

string

项目 ID 或项目名称

testExtensionFieldId

number

返回

Promise<void>

deleteFailureType(string, number)

删除具有指定 failureTypeId 的测试失败类型

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

参数

project

string

项目 ID 或项目名称

failureTypeId

number

返回

Promise<void>

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

参数

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

runId

number

testCaseResultId

number

attachmentId

number

返回

Promise<void>

deleteTestRun(string, number)

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

参数

project

string

项目 ID 或项目名称

runId

number

返回

Promise<void>

deleteTestRunAttachment(string, number, number)

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

参数

project

string

项目 ID 或项目名称

runId

number

attachmentId

number

返回

Promise<void>

deleteTestRunLogStoreAttachment(string, number, string)

从 LogStore 中删除具有指定 runId 的指定文件名的附件。

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

参数

project

string

项目 ID 或项目名称

runId

number

测试 RunId

filename

string

Attachment FileName

返回

Promise<void>

deleteTestSettings(string, number)

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

参数

project

string

项目 ID 或项目名称

testSettingsId

number

返回

Promise<void>

fetchSourceCodeCoverageReport(string, number)

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

参数

project

string

项目 ID 或项目名称

buildId

number

返回

getBugsLinkedToTestResult(string, number, number)

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

参数

project

string

项目 ID 或项目名称

runId

number

testCaseResultId

number

返回

Promise<WorkItemReference[]>

getBuildCodeCoverage(string, number, number)

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

参数

project

string

项目 ID 或项目名称

buildId

number

flags

number

返回

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10&deltaBuildId=9 请求:生成 ID 和增量生成 ID(可选)

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

参数

project

string

项目 ID 或项目名称

buildId

number

deltaBuildId

number

返回

getCoverageStatusBadge(string, string, string, string)

<p>获取定义最后一次成功生成的覆盖状态,可以选择限定为特定分支</p>

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

参数

project

string

项目 ID 或项目名称

definition

string

定义的 ID 或名称。

branchName

string

分支名称。

label

string

替换锁屏提醒左侧的默认文本的字符串。

返回

Promise<string>

getFailureTypes(string)

返回测试失败类型的列表。

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

参数

project

string

项目 ID 或项目名称

返回

getFileLevelCodeCoverage(FileCoverageRequest, string)

获取指定文件的文件覆盖率

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

参数

fileCoverageRequest
FileCoverageRequest

使用拉取请求迭代上下文的文件详细信息

project

string

项目 ID 或项目名称

返回

Promise<string>

getFlakyTestResultsByBuildDefinitionId(string, number, Date)

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

参数

project

string

项目 ID 或项目名称

buildDefinitionId

number

minBuildCreatedDate

Date

返回

Promise<TestCaseResult[]>

getFlakyTestResultsByTestRun(string, number)

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

参数

project

string

项目 ID 或项目名称

runId

number

返回

Promise<TestCaseResult[]>

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

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

参数

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

releaseId

number

publishContext

string

releaseEnvId

number

fields

string[]

continuationToken

string

返回

getSessionNotifications(string, number)

检索 TCM 数据存储中的 TestResultsSession 通知对象

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

参数

project

string

项目 ID 或项目名称

sessionId

number

要为其获取通知的 TestResults 会话的 ID。

返回

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

项目 ID 或项目名称

runId

number

测试运行 ID

testResultId

number

测试运行中的测试结果的 ID

testSubResultId

number

测试结果中的子对象的 ID

top

number

要返回的最大结果数

continuationToken

String

要传递 continuationToken 的标头

返回

Promise<TestCaseResult[]>

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

返回测试迭代附件

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

参数

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

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

项目 ID 或项目名称

buildId

number

要获取的生成 ID

type
TestLogType

要获取的附件的类型

directoryPath

string

需要附件的目录路径

fileNamePrefix

string

用于筛选附件列表的文件名前缀

fetchMetaData

boolean

默认值为 false,如果需要元数据,则设置

top

number

要返回的测试附件引用数

continuationToken

String

要传递 continuationToken 的标头

返回

Promise<PagedList<TestLog>>

getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)

获取生成附件的 SAS URI

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

参数

project

string

项目 ID 或项目名称

build

number

要获取的生成 ID

type
TestLogType

文件的类型

filePath

string

需要 SAS URI 的 filePath

返回

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

获取测试结果附件的 SAS URI

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

参数

project

string

项目 ID 或项目名称

runId

number

包含结果的测试运行 ID

resultId

number

需要下载其文件的测试结果的 ID

type
TestLogType

文件的类型

filePath

string

需要 SAS URI 的 filePath

返回

getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)

获取测试运行附件的 SAS URI

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

参数

project

string

项目 ID 或项目名称

runId

number

必须下载其文件的测试运行 ID

type
TestLogType

文件的类型

filePath

string

需要 SAS URI 的 filePath

返回

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

获取测试子请求附件的 SAS URI

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

参数

project

string

项目 ID 或项目名称

runId

number

包含结果的测试运行 ID

resultId

number

包含子结果的测试结果的 ID

subResultId

number

需要其文件 SAS URI 的测试子实例的 ID

type
TestLogType

文件的类型

filePath

string

需要 SAS URI 的 filePath

返回

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

项目 ID 或项目名称

pipelineId

number

管道 ID。这与生成 ID 相同。

stageName

string

阶段的名称。 名称支持的最大长度为 256 个字符。

phaseName

string

阶段的名称。 名称支持的最大长度为 256 个字符。

jobName

string

YAML 中的矩阵生成具有不同输入的作业副本。 JobName 是这些输入的名称。 名称支持的最大长度为 256 个字符。

metricNames

Metrics[]

groupByNode

boolean

pipleine 继承权的每个节点的分组摘要

返回

getTestResultAttachmentContent(string, number, number, number)

返回测试结果附件

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

参数

project

string

项目 ID 或项目名称

runId

number

testCaseResultId

number

attachmentId

number

返回

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

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

参数

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

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

项目 ID 或项目名称

runId

number

testResultId

number

detailsToInclude
ResultDetails

返回

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

项目 ID 或项目名称

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

项目 ID 或项目名称

releaseId

number

releaseEnvId

number

publishContext

string

groupBy

string

filter

string

orderby

string

shouldIncludeResults

boolean

queryRunSummaryForInProgress

boolean

返回

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

项目 ID 或项目名称

runId

number

包含结果的测试运行 ID

resultId

number

测试结果的 ID

type
TestLogType

要获取的附件类型

directoryPath

string

要获取的附件的目录路径

fileNamePrefix

string

用于筛选附件列表的文件名前缀

fetchMetaData

boolean

默认值为 false,如果需要元数据,则设置

top

number

要返回的附件引用的编号

continuationToken

String

要传递 continuationToken 的标头

返回

Promise<PagedList<TestLog>>

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

项目 ID 或项目名称

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

项目 ID 或项目名称

buildId

number

publishContext

string

outcomes

TestOutcome[]

top

number

continuationToken

string

返回

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

获取结果列表。

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

参数

project

string

项目 ID 或项目名称

pipelineId

number

管道 ID。这与生成 ID 相同。

stageName

string

阶段的名称。 名称支持的最大长度为 256 个字符。

phaseName

string

阶段的名称。 名称支持的最大长度为 256 个字符。

jobName

string

YAML 中的矩阵生成具有不同输入的作业副本。 JobName 是这些输入的名称。 名称支持的最大长度为 256 个字符。

outcomes

TestOutcome[]

结果列表

top

number

要返回的最大结果数

continuationToken

String

要传递 continuationToken 的标头

返回

getTestResultsByQuery(TestResultsQuery, string)

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

参数

project

string

项目 ID 或项目名称

返回

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

项目 ID 或项目名称

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

项目 ID 或项目名称

releaseId

number

releaseEnvid

number

publishContext

string

outcomes

TestOutcome[]

top

number

continuationToken

string

返回

getTestResultsSettings(string, TestResultsSettingsType)

获取 TestResultsSettings 数据

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

参数

project

string

项目 ID 或项目名称

返回

getTestResultWorkItemsById(string, number, number)

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

参数

project

string

项目 ID 或项目名称

runId

number

testCaseResultId

number

返回

Promise<WorkItemReference[]>

getTestRunAttachmentContent(string, number, number)

返回测试运行附件

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

参数

project

string

项目 ID 或项目名称

runId

number

attachmentId

number

返回

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

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

参数

project

string

项目 ID 或项目名称

runId

number

返回

Promise<TestAttachment[]>

getTestRunAttachmentZip(string, number, number)

返回测试运行附件

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

参数

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

runId

number

includeDetails

boolean

includeTags

boolean

返回

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

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

参数

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

runId

number

测试运行的 ID

type
TestLogType

要获取的附件的类型

directoryPath

string

需要附件的目录路径

fileNamePrefix

string

用于筛选附件列表的文件名前缀

fetchMetaData

boolean

默认值为 false,如果需要元数据,则设置

top

number

要返回的附件引用数

continuationToken

String

要传递 continuationToken 的标头

返回

Promise<PagedList<TestLog>>

getTestRunLogStoreAttachmentContent(string, number, string)

从 LogStore 返回具有指定 runId 的指定文件名的附件。

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

参数

project

string

项目 ID 或项目名称

runId

number

测试 RunId

filename

string

Attachment FileName

返回

Promise<ArrayBuffer>

getTestRunLogStoreAttachments(string, number)

返回 LogStore 中指定 runId 的附件列表。

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

参数

project

string

项目 ID 或项目名称

runId

number

测试 RunId

返回

getTestRunLogStoreAttachmentZip(string, number, string)

从 LogStore 返回具有指定 runId 的指定文件名的附件。

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

参数

project

string

项目 ID 或项目名称

runId

number

测试 RunId

filename

string

Attachment FileName

返回

Promise<ArrayBuffer>

getTestRunMessageLogs(string, number)

获取测试运行消息日志

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

参数

project

string

项目 ID 或项目名称

runId

number

要获取的运行 ID。

返回

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

项目 ID 或项目名称

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

项目 ID 或项目名称

sessionId

number

要为其获取测试运行的 TestResults 会话的 ID。

返回

Promise<number[]>

getTestRunStatistics(string, number)

获取测试运行统计信息,当我们想要按结果获取运行摘要时使用。

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

参数

project

string

项目 ID 或项目名称

runId

number

要获取的运行 ID。

返回

Promise<TestRunStatistic>

getTestRunSummaryByOutcome(string, number)

获取测试运行摘要,当我们想要按结果获取运行摘要时使用。 测试运行应处于已完成状态。

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

参数

project

string

项目 ID 或项目名称

runId

number

要获取的运行 ID。

返回

Promise<TestRunStatistic>

getTestSession(string, number)

检索 TCM 数据存储中的 TestResultsSession 元数据对象

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

参数

project

string

项目 ID 或项目名称

buildId

number

返回

Promise<TestResultsSession[]>

getTestSessionLayout(string, string)

检索 TCM 数据存储中的 TestResultsSession Layout 对象

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

参数

project

string

项目 ID 或项目名称

sessionId

string

返回

Promise<any[]>

getTestSessionLayoutBySessionId(string, number)

检索 TCM 数据存储中的 TestResultsSession Layout 对象

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

参数

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

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

项目 ID 或项目名称

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

项目 ID 或项目名称

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

项目 ID 或项目名称

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

项目 ID 或项目名称

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

项目 ID 或项目名称

runId

number

包含结果的测试运行 ID

resultId

number

包含子结果的测试结果的 ID

subResultId

number

测试子实例的 ID

type
TestLogType

要获取的附件的类型

directoryPath

string

要获取的附件的目录路径

fileNamePrefix

string

用于筛选附件列表的文件名前缀

fetchMetaData

boolean

默认值为 false,如果需要元数据,则设置

top

number

要返回的附件引用数

continuationToken

String

要传递 continuationToken 的标头

返回

Promise<PagedList<TestLog>>

getTestTagsForBuild(string, number)

获取生成中的所有标记。

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

参数

project

string

项目 ID 或项目名称

buildId

number

生成 ID

返回

Promise<TestTag[]>

getTestTagsForRelease(string, number, number)

获取发布中的所有标记。

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

参数

project

string

项目 ID 或项目名称

releaseId

number

发布 ID

releaseEnvId

number

发布环境 ID

返回

Promise<TestTag[]>

getTestTagSummaryForBuild(string, number)

获取生成中的所有标记。

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

参数

project

string

项目 ID 或项目名称

buildId

number

生成 ID

返回

Promise<TestTagSummary>

getTestTagSummaryForRelease(string, number, number)

获取发布中的所有标记。

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

参数

project

string

项目 ID 或项目名称

releaseId

number

发布 ID

releaseEnvId

number

发布环境 ID

返回

Promise<TestTagSummary>

publishTestResultDocument(TestResultDocument, string, number)

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

参数

project

string

项目 ID 或项目名称

runId

number

返回

queryCustomFields(string, CustomTestFieldScope)

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

参数

project

string

项目 ID 或项目名称

scopeFilter
CustomTestFieldScope

返回

queryResultTrendForBuild(TestResultTrendFilter, string)

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

参数

project

string

项目 ID 或项目名称

返回

queryResultTrendForRelease(TestResultTrendFilter, string)

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

参数

project

string

项目 ID 或项目名称

返回

queryTestHistory(TestHistoryQuery, string)

使用 TestHistoryQuery 获取测试方法的历史记录

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

参数

filter
TestHistoryQuery

TestHistoryQuery 以获取历史记录

project

string

项目 ID 或项目名称

返回

Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems(string, string)

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

参数

project

string

项目 ID 或项目名称

testName

string

返回

queryTestResultHistory(ResultsFilter, string)

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

参数

filter
ResultsFilter
project

string

项目 ID 或项目名称

返回

queryTestResultsMetaData(string[], string, ResultMetaDataDetails)

获取相应 testcasereferenceId 的测试结果元数据详细信息列表

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

参数

testCaseReferenceIds

string[]

要查询的测试结果的 TestCaseReference ID,以逗号分隔的有效 ID 列表(限制 id 为 200)。

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

buildId

number

publishContext

string

includeFailureDetails

boolean

buildToCompare
BuildReference

返回

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

项目 ID 或项目名称

pipelineId

number

管道 ID。这与生成 ID 相同。

stageName

string

阶段的名称。 名称支持的最大长度为 256 个字符。

phaseName

string

阶段的名称。 名称支持的最大长度为 256 个字符。

jobName

string

YAML 中的矩阵生成具有不同输入的作业副本。 JobName 是这些输入的名称。 名称支持的最大长度为 256 个字符。

includeFailureDetails

boolean

如果 true 返回失败见解

返回

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

项目 ID 或项目名称

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

项目 ID 或项目名称

返回

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

项目 ID 或项目名称

workItemCategory

string

可以获取值Microsoft.BugCategory 或 all(用于获取所有工作项)

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

项目 ID 或项目名称

minLastUpdatedDate

Date

要查询的上次修改日期(必需)。

maxLastUpdatedDate

Date

要查询的上次修改日期上限(必需,最小和最大日期之间的差值可能最多为 7 天)。

state
TestRunState

要查询的运行的当前状态。

planIds

number[]

要查询的运行计划 ID,以逗号分隔的有效 ID 列表。

isAutomated

boolean

要查询的运行的自动化类型。

publishContext
TestRunPublishContext

要查询的运行的 PublishContext。

buildIds

number[]

要查询的运行的内部 ID,以逗号分隔的有效 ID 列表。

buildDefIds

number[]

要查询的运行生成定义 ID,以逗号分隔的有效 ID 列表。

branchName

string

要查询的运行的源分支名称。

releaseIds

number[]

要查询的运行的版本 ID,以逗号分隔的有效 ID 列表。

releaseDefIds

number[]

要查询的运行的版本定义 ID,以逗号分隔的有效 ID 列表。

releaseEnvIds

number[]

要查询的运行的版本环境 ID,以逗号分隔的有效 ID 列表。

releaseEnvDefIds

number[]

要查询的运行的环境定义 ID,以逗号分隔的有效 ID 列表。

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

项目 ID 或项目名称

workItemIds

number[]

返回

testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)

创建和获取生成容器的 sas URI

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

参数

project

string

项目 ID 或项目名称

buildId

number

要获取的生成 ID

testLogStoreOperationType
TestLogStoreOperationType

使用 sas uri 执行的操作类型

返回

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

为结果创建空文件,并获取文件的 Sas URI

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

参数

project

string

项目 ID 或项目名称

runId

number

包含结果的测试运行 ID

resultId

number

包含子结果的测试结果的 ID

subResultId

number

需要其文件 sas URI 的测试子结果的 ID

filePath

string

需要 SAS URI 的子结果中的文件路径

type
TestLogType

要下载的文件的类型

返回

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

为文件创建空文件并获取文件的 Sas URI

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

参数

project

string

项目 ID 或项目名称

runId

number

用于获取终结点详细信息的运行 ID

testLogStoreOperationType
TestLogStoreOperationType

使用 sas uri 执行的操作类型

filePath

string

用于创建空文件的文件路径

type
TestLogType

默认值为 GeneralAttachment,要创建的空文件的类型

返回

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

项目 ID 或项目名称

pipelineId

number

管道 ID。这与生成 ID 相同。

stageName

string

阶段的名称。 名称支持的最大长度为 256 个字符。

phaseName

string

阶段的名称。 名称支持的最大长度为 256 个字符。

jobName

string

YAML 中的矩阵生成具有不同输入的作业副本。 JobName 是这些输入的名称。 名称支持的最大长度为 256 个字符。

shouldIncludeFailedAndAbortedResults

boolean

如果为 true,它将返回每个测试组失败和中止结果的 ID

queryGroupSummaryForInProgress

boolean

如果为 true,则它还会计算 InProgress 运行的摘要。

返回

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

项目 ID 或项目名称

buildId

number

coverageData
CodeCoverageData

返回

Promise<void>

updateCustomField(CustomTestFieldUpdateDefinition, string)

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

参数

updateCustomTestField
CustomTestFieldUpdateDefinition
project

string

项目 ID 或项目名称

返回

updatePipelinesTestSettings(TestResultsUpdateSettings, string)

更新测试结果的项目设置

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

参数

testResultsUpdateSettings
TestResultsUpdateSettings
project

string

项目 ID 或项目名称

返回

updateTestResults(TestCaseResult[], string, number)

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

参数

results

TestCaseResult[]

project

string

项目 ID 或项目名称

runId

number

返回

Promise<TestCaseResult[]>

updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)

更新测试结果元数据的属性

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

参数

testResultMetaDataUpdateInput
TestResultMetaDataUpdateInput

TestResultMetaData 更新输入 TestResultMetaDataUpdateInput

project

string

项目 ID 或项目名称

testCaseReferenceId

number

要更新的测试结果的 TestCaseReference ID。

返回

updateTestResultsToTestRunSession(TestCaseResult[], string, number)

在 TCM 数据存储中创建 TestResultsMRX 对象以获取现有测试结果

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

参数

results

TestCaseResult[]

仅测试结果 MRX 属性和现有 testResultId 的结果对象

project

string

项目 ID 或项目名称

runId

number

测试运行的 RunId

返回

Promise<number[]>

updateTestRun(RunUpdateModel, string, number)

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

参数

runUpdateModel
RunUpdateModel
project

string

项目 ID 或项目名称

runId

number

返回

Promise<TestRun>

updateTestRunTags(TestTagsUpdateModel, string, number)

更新运行的标记,可以添加和删除标记

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

参数

testTagsUpdateModel
TestTagsUpdateModel

TestTagsUpdateModel

project

string

项目 ID 或项目名称

runId

number

运行的 RunId

返回

Promise<TestTag[]>