Bagikan melalui


TestRestClient class

Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api

Memperluas

Konstruktor

TestRestClient(IVssRestClientOptions)

Properti

RESOURCE_AREA_ID

Metode

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

Tambahkan kasus pengujian ke suite.

addTestResultsToTestRun(TestCaseResult[], string, number)

Tambahkan hasil pengujian ke uji coba.

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

Melampirkan file ke hasil langkah pengujian

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Lampirkan file ke hasil pengujian.

createTestRun(RunCreateModel, string)

Buat uji coba baru.

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Lampirkan file ke uji coba.

createTestSession(TestSession, TeamContext)

Membuat sesi pengujian

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

Melampirkan file ke hasil pengujian

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

Hapus kasus pengujian.

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

Hapus pengujian yang dijalankan berdasarkan ID-nya.

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

Dapatkan data cakupan kode untuk build.

getCodeCoverageSummary(string, number, number)

Dapatkan Ringkasan Cakupan Kode untuk Build.

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

Dapatkan poin pengujian.

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

Dapatkan daftar poin pengujian.

getPointsByQuery(TestPointsQuery, string, number, number)

Dapatkan titik pengujian menggunakan kueri.

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

Mendapatkan setelan retensi hasil pengujian

getTestCaseById(string, number, number, number)

Dapatkan kasus pengujian tertentu dalam rangkaian pengujian dengan id kasus pengujian.

getTestCases(string, number, number)

Dapatkan semua kasus pengujian dalam satu suite.

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

Dapatkan iterasi untuk hasil

getTestIterations(string, number, number, boolean)

Mendapatkan iterasi untuk hasil

getTestResultAttachmentContent(string, number, number, number)

Unduh lampiran hasil pengujian dengan ID-nya.

getTestResultAttachments(string, number, number)

Dapatkan daftar referensi lampiran hasil pengujian.

getTestResultAttachmentZip(string, number, number, number)

Unduh lampiran hasil pengujian dengan ID-nya.

getTestResultById(string, number, number, ResultDetails)

Dapatkan hasil pengujian untuk uji coba.

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

Dapatkan hasil pengujian untuk uji coba.

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

API ini akan mengembalikan hasil berdasarkan Id dengan bidang yang ditentukan/tren untuk metode pengujian otomatis tertentu. Kami masih meningkatkan API ini dan belum menyelesaikan tanda tangan dan kontrak yang tepat.

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

Unduh lampiran uji coba berdasarkan ID-nya.

getTestRunAttachments(string, number)

Dapatkan daftar referensi lampiran uji coba.

getTestRunAttachmentZip(string, number, number)

Unduh lampiran uji coba berdasarkan ID-nya.

getTestRunById(string, number, boolean)

Dapatkan pengujian yang dijalankan berdasarkan ID-nya.

getTestRunCodeCoverage(string, number, number)

Mendapatkan data cakupan kode untuk uji coba

getTestRunLogs(string, number)

Mendapatkan log pesan uji coba

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

Dapatkan daftar uji coba.

getTestRunStatistics(string, number)

Dapatkan statistik uji coba , digunakan ketika kita ingin mendapatkan ringkasan eksekusi berdasarkan hasil.

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

Mendapatkan daftar sesi pengujian

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

Unduh lampiran hasil sub pengujian

getTestSubResultAttachments(string, number, number, number)

Dapatkan daftar lampiran sub hasil pengujian

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

Unduh lampiran hasil sub pengujian

processSuitesForStaging(StagedSuitesRequestModel, string, number)

Memproses kumpulan rangkaian pengujian dan mengembalikan model respons yang berisi detail suite dan kasus pengujian.

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

Mendapatkan riwayat metode pengujian menggunakan TestHistoryQuery

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

Dapatkan daftar detail data meta Hasil pengujian untuk testcasereferenceId yang sesuai

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)

Uji Kueri Berjalan berdasarkan filter. Bidang wajib adalah minLastUpdatedDate dan maxLastUpdatedDate.

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

Titik pengujian yang terkait dengan kasus pengujian dihapus dari rangkaian pengujian. Item kerja kasus pengujian tidak dihapus dari sistem. Lihat sumber daya kasus pengujian untuk menghapus kasus pengujian secara permanen.

updateCodeCoverageSummary(CodeCoverageData, string, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Permintaan: Json ringkasan cakupan kode

updateResultRetentionSettings(ResultRetentionSettings, string)

Perbarui setelan retensi hasil pengujian

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

Memperbarui properti asosiasi kasus pengujian dalam suite.

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

Perbarui titik pengujian.

updateTestResults(TestCaseResult[], string, number)

Perbarui hasil pengujian dalam uji coba.

updateTestRun(RunUpdateModel, string, number)

Perbarui pengujian yang dijalankan berdasarkan ID-nya.

updateTestSession(TestSession, TeamContext)

Memperbarui sesi pengujian

Detail Konstruktor

TestRestClient(IVssRestClientOptions)

new TestRestClient(options: IVssRestClientOptions)

Parameter

Detail Properti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Nilai Properti

string

Detail Metode

addCustomFields(CustomTestFieldDefinition[], string)

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

Parameter

project

string

ID proyek atau nama proyek

Mengembalikan

addTestCasesToSuite(string, number, number, string)

Tambahkan kasus pengujian ke suite.

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

Parameter

project

string

ID proyek atau nama proyek

planId

number

ID rencana pengujian yang berisi suite.

suiteId

number

ID rangkaian pengujian tempat kasus pengujian harus ditambahkan.

testCaseIds

string

ID kasus pengujian untuk ditambahkan ke suite. ID ditentukan dalam format yang dipisahkan koma.

Mengembalikan

Promise<SuiteTestCase[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

Tambahkan hasil pengujian ke uji coba.

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

Parameter

results

TestCaseResult[]

Daftar hasil tes untuk ditambahkan.

project

string

ID proyek atau nama proyek

runId

number

ID uji coba ke dalam hasil pengujian yang akan ditambahkan.

Mengembalikan

Promise<TestCaseResult[]>

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

Parameter

workItemToTestLinks
WorkItemToTestLinks
project

string

ID proyek atau nama proyek

Mengembalikan

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

Melampirkan file ke hasil langkah pengujian

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

Parameter

attachmentRequestModel
TestAttachmentRequestModel

Detail lampiran TestAttachmentRequestModel

project

string

ID proyek atau nama proyek

runId

number

ID uji coba yang berisi hasilnya.

testCaseResultId

number

ID hasil pengujian yang berisi iterasi

iterationId

number

ID iterasi hasil pengujian.

actionPath

string

Nilai hex jalur tindakan hasil pengujian.

Mengembalikan

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Lampirkan file ke hasil pengujian.

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

Parameter

attachmentRequestModel
TestAttachmentRequestModel

Detail lampiran TestAttachmentRequestModel

project

string

ID proyek atau nama proyek

runId

number

ID uji coba yang berisi hasilnya.

testCaseResultId

number

ID hasil pengujian yang harus diunggah lampiran.

Mengembalikan

createTestRun(RunCreateModel, string)

Buat uji coba baru.

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

Parameter

testRun
RunCreateModel

Detail jalankan RunCreateModel

project

string

ID proyek atau nama proyek

Mengembalikan

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Lampirkan file ke uji coba.

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

Parameter

attachmentRequestModel
TestAttachmentRequestModel

Detail lampiran TestAttachmentRequestModel

project

string

ID proyek atau nama proyek

runId

number

ID uji coba yang harus diunggah lampiran.

Mengembalikan

createTestSession(TestSession, TeamContext)

Membuat sesi pengujian

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

Parameter

testSession
TestSession

Detail sesi pengujian untuk pembuatan

teamContext
TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<TestSession>

createTestSettings(TestSettings, string)

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

Parameter

testSettings
TestSettings
project

string

ID proyek atau nama proyek

Mengembalikan

Promise<number>

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

Melampirkan file ke hasil pengujian

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

Parameter

attachmentRequestModel
TestAttachmentRequestModel

Model Permintaan Lampiran.

project

string

ID proyek atau nama proyek

runId

number

ID uji coba yang berisi hasilnya.

testCaseResultId

number

ID hasil pengujian yang berisi sub hasil.

testSubResultId

number

ID hasil sub pengujian yang lampiran harus diunggah.

Mengembalikan

deleteSharedParameter(string, number)

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

Parameter

project

string

ID proyek atau nama proyek

sharedParameterId

number

Mengembalikan

Promise<void>

deleteSharedStep(string, number)

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

Parameter

project

string

ID proyek atau nama proyek

sharedStepId

number

Mengembalikan

Promise<void>

deleteTestCase(string, number)

Hapus kasus pengujian.

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

Parameter

project

string

ID proyek atau nama proyek

testCaseId

number

Id kasus uji untuk dihapus.

Mengembalikan

Promise<void>

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

Parameter

project

string

ID proyek atau nama proyek

testName

string

workItemId

number

Mengembalikan

Promise<boolean>

deleteTestRun(string, number)

Hapus pengujian yang dijalankan berdasarkan ID-nya.

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID eksekusi yang akan dihapus.

Mengembalikan

Promise<void>

deleteTestSettings(string, number)

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

Parameter

project

string

ID proyek atau nama proyek

testSettingsId

number

Mengembalikan

Promise<void>

getBugsLinkedToTestResult(string, number, number)

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

testCaseResultId

number

Mengembalikan

Promise<WorkItemReference[]>

getBuildCodeCoverage(string, number, number)

Dapatkan data cakupan kode untuk build.

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

Parameter

project

string

ID proyek atau nama proyek

buildId

number

ID build yang data cakupan kode perlu diambil.

flags

number

Nilai bendera menentukan tingkat detail cakupan kode yang akan diambil. Bendera bersifat aditif. Nilai yang Diharapkan adalah 1 untuk Modul, 2 untuk Fungsi, 4 untuk BlockData.

Mengembalikan

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

Dapatkan Ringkasan Cakupan Kode untuk Build.

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

Parameter

project

string

ID proyek atau nama proyek

buildId

number

ID build yang data cakupan kode perlu diambil.

deltaBuildId

number

ID Build Delta (opsional)

Mengembalikan

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)

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

Parameter

workItemQuery
LinkedWorkItemsQuery
project

string

ID proyek atau nama proyek

Mengembalikan

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

Dapatkan poin pengujian.

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

Parameter

project

string

ID proyek atau nama proyek

planId

number

ID rencana pengujian.

suiteId

number

ID rangkaian yang berisi titik.

pointIds

number

ID titik pengujian yang akan didapatkan.

witFields

string

Daftar nama bidang item kerja yang dipisahkan koma.

Mengembalikan

Promise<TestPoint>

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

Dapatkan daftar poin pengujian.

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

Parameter

project

string

ID proyek atau nama proyek

planId

number

ID rencana pengujian.

suiteId

number

ID rangkaian yang berisi poin.

witFields

string

Daftar nama bidang item kerja yang dipisahkan koma.

configurationId

string

Dapatkan titik pengujian untuk konfigurasi tertentu.

testCaseId

string

Dapatkan titik pengujian untuk kasus pengujian tertentu, valid saat configurationId tidak diatur.

testPointIds

string

Dapatkan titik pengujian untuk daftar ID titik pengujian yang dipisahkan koma, hanya valid jika configurationId dan testCaseId tidak diatur.

includePointDetails

boolean

Sertakan semua properti untuk titik pengujian.

skip

number

Jumlah titik tes yang harus dilewati..

top

number

Jumlah titik uji untuk dikembalikan.

Mengembalikan

Promise<TestPoint[]>

getPointsByQuery(TestPointsQuery, string, number, number)

Dapatkan titik pengujian menggunakan kueri.

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

Parameter

query
TestPointsQuery

TestPointsQuery untuk mendapatkan poin pengujian.

project

string

ID proyek atau nama proyek

skip

number

Jumlah titik tes yang harus dilewati..

top

number

Jumlah titik uji untuk dikembalikan.

Mengembalikan

Promise<TestPointsQuery>

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

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

Parameter

project

string

ID proyek atau nama proyek

buildId

number

publishContext

string

fields

string[]

continuationToken

string

Mengembalikan

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

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

Parameter

project

string

ID proyek atau nama proyek

releaseId

number

publishContext

string

releaseEnvId

number

fields

string[]

continuationToken

string

Mengembalikan

getResultRetentionSettings(string)

Mendapatkan setelan retensi hasil pengujian

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

Parameter

project

string

ID proyek atau nama proyek

Mengembalikan

getTestCaseById(string, number, number, number)

Dapatkan kasus pengujian tertentu dalam rangkaian pengujian dengan id kasus pengujian.

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

Parameter

project

string

ID proyek atau nama proyek

planId

number

ID rencana pengujian yang berisi suite.

suiteId

number

ID rangkaian yang berisi kasus pengujian.

testCaseIds

number

ID kasus uji yang akan didapatkan.

Mengembalikan

Promise<SuiteTestCase>

getTestCases(string, number, number)

Dapatkan semua kasus pengujian dalam satu suite.

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

Parameter

project

string

ID proyek atau nama proyek

planId

number

ID rencana pengujian yang berisi suite.

suiteId

number

ID suite yang akan didapatkan.

Mengembalikan

Promise<SuiteTestCase[]>

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

Dapatkan iterasi untuk hasil

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID uji coba yang berisi hasilnya.

testCaseResultId

number

ID hasil pengujian yang berisi iterasi.

iterationId

number

Id hasil pengujian Iterasi.

includeActionResults

boolean

Sertakan detail hasil untuk setiap tindakan yang dilakukan dalam iterasi pengujian. ActionResults mengacu pada hasil (lulus/gagal) dari langkah-langkah pengujian yang dijalankan sebagai bagian dari menjalankan pengujian manual. Menyertakan bendera ActionResults mendapatkan hasil langkah pengujian di bagian actionResults dan parameter pengujian di bagian parameter untuk setiap iterasi pengujian.

Mengembalikan

getTestIterations(string, number, number, boolean)

Mendapatkan iterasi untuk hasil

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID uji coba yang berisi hasilnya.

testCaseResultId

number

ID hasil pengujian yang berisi iterasi.

includeActionResults

boolean

Sertakan detail hasil untuk setiap tindakan yang dilakukan dalam iterasi pengujian. ActionResults mengacu pada hasil (lulus/gagal) dari langkah-langkah pengujian yang dijalankan sebagai bagian dari menjalankan pengujian manual. Menyertakan bendera ActionResults mendapatkan hasil langkah pengujian di bagian actionResults dan parameter pengujian di bagian parameter untuk setiap iterasi pengujian.

Mengembalikan

getTestResultAttachmentContent(string, number, number, number)

Unduh lampiran hasil pengujian dengan ID-nya.

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID uji coba yang berisi testCaseResultId.

testCaseResultId

number

ID hasil pengujian yang lampirannya harus diunduh.

attachmentId

number

ID lampiran hasil pengujian yang akan diunduh.

Mengembalikan

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

Dapatkan daftar referensi lampiran hasil pengujian.

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID uji coba yang berisi hasilnya.

testCaseResultId

number

ID hasil tes.

Mengembalikan

Promise<TestAttachment[]>

getTestResultAttachmentZip(string, number, number, number)

Unduh lampiran hasil pengujian dengan ID-nya.

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID uji coba yang berisi testCaseResultId.

testCaseResultId

number

ID hasil pengujian yang lampirannya harus diunduh.

attachmentId

number

ID lampiran hasil pengujian yang akan diunduh.

Mengembalikan

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

Dapatkan hasil pengujian untuk uji coba.

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID uji coba hasil pengujian yang akan diambil.

testCaseResultId

number

ID hasil pengujian.

detailsToInclude
ResultDetails

Detail untuk disertakan dengan hasil tes. Defaultnya adalah Tidak Ada. Nilai lainnya adalah Iterations, WorkItems, dan SubResults.

Mengembalikan

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>

Parameter

project

string

ID proyek atau nama proyek

buildId

number

publishContext

string

groupBy

string

filter

string

orderby

string

shouldIncludeResults

boolean

queryRunSummaryForInProgress

boolean

Mengembalikan

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>

Parameter

project

string

ID proyek atau nama proyek

releaseId

number

releaseEnvId

number

publishContext

string

groupBy

string

filter

string

orderby

string

shouldIncludeResults

boolean

queryRunSummaryForInProgress

boolean

Mengembalikan

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

Dapatkan hasil pengujian untuk uji coba.

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID uji coba hasil pengujian yang akan diambil.

detailsToInclude
ResultDetails

Detail untuk disertakan dengan hasil tes. Defaultnya adalah Tidak Ada. Nilai lainnya adalah Iterasi dan WorkItems.

skip

number

Jumlah hasil tes yang harus dilewati dari awal.

top

number

Jumlah hasil tes untuk dikembalikan. Maksimum adalah 1000 ketika detailsToInclude adalah Tidak Ada dan 200 sebaliknya.

outcomes

TestOutcome[]

Daftar hasil pengujian yang dipisahkan koma untuk memfilter hasil pengujian.

Mengembalikan

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

Parameter

project

string

ID proyek atau nama proyek

buildId

number

publishContext

string

outcomes

TestOutcome[]

top

number

continuationToken

string

Mengembalikan

getTestResultsByQuery(TestResultsQuery, string)

API ini akan mengembalikan hasil berdasarkan Id dengan bidang yang ditentukan/tren untuk metode pengujian otomatis tertentu. Kami masih meningkatkan API ini dan belum menyelesaikan tanda tangan dan kontrak yang tepat.

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

Parameter

project

string

ID proyek atau nama proyek

Mengembalikan

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

Parameter

project

string

ID proyek atau nama proyek

releaseId

number

releaseEnvid

number

publishContext

string

outcomes

TestOutcome[]

top

number

continuationToken

string

Mengembalikan

getTestRunAttachmentContent(string, number, number)

Unduh lampiran uji coba berdasarkan ID-nya.

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID uji coba yang lampirannya harus diunduh.

attachmentId

number

ID lampiran uji coba yang akan diunduh.

Mengembalikan

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

Dapatkan daftar referensi lampiran uji coba.

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID uji coba.

Mengembalikan

Promise<TestAttachment[]>

getTestRunAttachmentZip(string, number, number)

Unduh lampiran uji coba berdasarkan ID-nya.

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID uji coba yang lampirannya harus diunduh.

attachmentId

number

ID lampiran uji coba yang akan diunduh.

Mengembalikan

Promise<ArrayBuffer>

getTestRunById(string, number, boolean)

Dapatkan pengujian yang dijalankan berdasarkan ID-nya.

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID eksekusi yang akan didapatkan.

includeDetails

boolean

Nilai defaultnya adalah true. Ini mencakup detail seperti statistik eksekusi, rilis, build, lingkungan pengujian, status pasca proses, dan banyak lagi.

Mengembalikan

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

Mendapatkan data cakupan kode untuk uji coba

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID uji coba yang data cakupan kode mana perlu diambil.

flags

number

Nilai bendera menentukan tingkat detail cakupan kode yang akan diambil. Bendera bersifat aditif. Nilai yang Diharapkan adalah 1 untuk Modul, 2 untuk Fungsi, 4 untuk BlockData.

Mengembalikan

Promise<TestRunCoverage[]>

getTestRunLogs(string, number)

Mendapatkan log pesan uji coba

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID eksekusi yang akan didapatkan.

Mengembalikan

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

Dapatkan daftar uji coba.

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

Parameter

project

string

ID proyek atau nama proyek

buildUri

string

URI build yang digunakan eksekusi.

owner

string

ID fondasi tim pemilik eksekusi.

tmiRunId

string

planId

number

ID rencana pengujian yang merupakan bagian dari eksekusi.

includeRunDetails

boolean

Jika true, sertakan semua properti eksekusi.

automated

boolean

Jika true, hanya menampilkan eksekusi otomatis.

skip

number

Jumlah uji coba yang harus dilewati.

top

number

Jumlah uji coba yang akan dikembalikan.

Mengembalikan

Promise<TestRun[]>

getTestRunStatistics(string, number)

Dapatkan statistik uji coba , digunakan ketika kita ingin mendapatkan ringkasan eksekusi berdasarkan hasil.

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID eksekusi yang akan didapatkan.

Mengembalikan

Promise<TestRunStatistic>

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

Mendapatkan daftar sesi pengujian

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

Parameter

teamContext
TeamContext

Konteks tim untuk operasi

period

number

Periode dalam beberapa hari dari sekarang, di mana sesi tes diambil.

allSessions

boolean

Jika false, menampilkan sesi pengujian untuk pengguna saat ini. Jika tidak, ini akan mengembalikan sesi pengujian untuk semua pengguna

includeAllProperties

boolean

Jika true, ini mengembalikan semua properti sesi pengujian. Jika tidak, itu mengembalikan versi kurus.

source
TestSessionSource

Sumber sesi pengujian.

includeOnlyCompletedSessions

boolean

Jika true, ini mengembalikan sesi pengujian dalam status selesai. Jika tidak, ini mengembalikan sesi pengujian untuk semua status

Mengembalikan

Promise<TestSession[]>

getTestSettingsById(string, number)

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

Parameter

project

string

ID proyek atau nama proyek

testSettingsId

number

Mengembalikan

Promise<TestSettings>

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

Unduh lampiran hasil sub pengujian

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID uji coba yang berisi hasilnya.

testCaseResultId

number

ID hasil pengujian yang berisi sub hasil.

attachmentId

number

ID lampiran hasil pengujian yang akan diunduh

testSubResultId

number

ID sub hasil pengujian yang lampirannya harus diunduh

Mengembalikan

Promise<ArrayBuffer>

getTestSubResultAttachments(string, number, number, number)

Dapatkan daftar lampiran sub hasil pengujian

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID uji coba yang berisi hasilnya.

testCaseResultId

number

ID hasil pengujian yang berisi sub hasil.

testSubResultId

number

ID sub hasil pengujian yang lampirannya harus diunduh

Mengembalikan

Promise<TestAttachment[]>

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

Unduh lampiran hasil sub pengujian

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

ID uji coba yang berisi hasilnya.

testCaseResultId

number

ID hasil pengujian yang berisi sub hasil.

attachmentId

number

ID lampiran hasil pengujian yang akan diunduh

testSubResultId

number

ID sub hasil pengujian yang lampirannya harus diunduh

Mengembalikan

Promise<ArrayBuffer>

processSuitesForStaging(StagedSuitesRequestModel, string, number)

Memproses kumpulan rangkaian pengujian dan mengembalikan model respons yang berisi detail suite dan kasus pengujian.

function processSuitesForStaging(request: StagedSuitesRequestModel, project: string, workItemId: number): Promise<StagedSuitesResponseModel>

Parameter

request
StagedSuitesRequestModel

Model permintaan yang berisi rangkaian pengujian yang akan diproses. Tidak boleh null.

project

string

ID proyek atau nama proyek

workItemId

number

Mengembalikan

publishTestResultDocument(TestResultDocument, string, number)

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

Parameter

project

string

ID proyek atau nama proyek

runId

number

Mengembalikan

queryCustomFields(string, CustomTestFieldScope)

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

Parameter

project

string

ID proyek atau nama proyek

scopeFilter
CustomTestFieldScope

Mengembalikan

queryResultTrendForBuild(TestResultTrendFilter, string)

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

Parameter

project

string

ID proyek atau nama proyek

Mengembalikan

queryResultTrendForRelease(TestResultTrendFilter, string)

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

Parameter

project

string

ID proyek atau nama proyek

Mengembalikan

queryTestHistory(TestHistoryQuery, string)

Mendapatkan riwayat metode pengujian menggunakan TestHistoryQuery

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

Parameter

filter
TestHistoryQuery

TestHistoryQuery untuk mendapatkan riwayat

project

string

ID proyek atau nama proyek

Mengembalikan

Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems(string, string)

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

Parameter

project

string

ID proyek atau nama proyek

testName

string

Mengembalikan

queryTestResultHistory(ResultsFilter, string)

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

Parameter

filter
ResultsFilter
project

string

ID proyek atau nama proyek

Mengembalikan

queryTestResultsMetaData(string[], string)

Dapatkan daftar detail data meta Hasil pengujian untuk testcasereferenceId yang sesuai

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

Parameter

testReferenceIds

string[]

TestCaseReference Ids dari pengujian Hasil yang akan dikueri, daftar id valid yang dipisahkan koma (nomor batas id 200).

project

string

ID proyek atau nama proyek

Mengembalikan

Promise<TestResultMetaData[]>

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

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

Parameter

project

string

ID proyek atau nama proyek

buildId

number

publishContext

string

includeFailureDetails

boolean

buildToCompare
BuildReference

Mengembalikan

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

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

Parameter

project

string

ID proyek atau nama proyek

releaseId

number

releaseEnvId

number

publishContext

string

includeFailureDetails

boolean

releaseToCompare
ReleaseReference

Mengembalikan

queryTestResultsSummaryForReleases(ReleaseReference[], string)

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

Parameter

releases

ReleaseReference[]

project

string

ID proyek atau nama proyek

Mengembalikan

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

Parameter

project

string

ID proyek atau nama proyek

workItemCategory

string

automatedTestName

string

testCaseId

number

maxCompleteDate

Date

days

number

workItemCount

number

Mengembalikan

Promise<WorkItemReference[]>

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

Uji Kueri Berjalan berdasarkan filter. Bidang wajib adalah minLastUpdatedDate dan 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>>

Parameter

project

string

ID proyek atau nama proyek

minLastUpdatedDate

Date

Tanggal Modifikasi Terakhir Minimum untuk dikueri (Wajib).

maxLastUpdatedDate

Date

Tanggal Modifikasi Terakhir Maksimum eksekusi yang akan dikueri (Wajib, selisih antara tanggal min dan maksimal dapat paling lama 7 hari).

state
TestRunState

Status Eksekusi saat ini yang akan dikueri.

planIds

number[]

Id Rencana Eksekusi yang akan dikueri, daftar id valid yang dipisahkan koma (nomor batas id 10).

isAutomated

boolean

Jenis otomatisasi Eksekusi yang akan dikueri.

publishContext
TestRunPublishContext

PublishContext dari Eksekusi yang akan dikueri.

buildIds

number[]

Build Id dari Eksekusi yang akan dikueri, daftar id valid yang dipisahkan koma (batas jumlah id 10).

buildDefIds

number[]

Build Definition Ids dari Run yang akan dikueri, daftar id valid yang dipisahkan koma (batas no. ids 10).

branchName

string

Nama Cabang Sumber dari Eksekusi yang akan dikueri.

releaseIds

number[]

Rilis ID dari Eksekusi yang akan dikueri, daftar id valid yang dipisahkan koma (batas jumlah id 10).

releaseDefIds

number[]

Definisi Rilis ID dari Eksekusi yang akan dikueri, daftar id valid yang dipisahkan koma (jumlah batas id 10).

releaseEnvIds

number[]

Rilis ID Lingkungan dari Eksekusi yang akan dikueri, daftar id valid yang dipisahkan koma (jumlah batas id 10).

releaseEnvDefIds

number[]

Rilis Definisi Lingkungan Id dari Eksekusi yang akan dikueri, daftar id valid yang dipisahkan koma (batas jumlah id 10).

runTitle

string

Jalankan Judul Eksekusi yang akan dikueri.

top

number

Jumlah eksekusi yang akan dikueri. Batasnya adalah 100

continuationToken

string

continuationToken yang diterima dari batch sebelumnya atau null untuk batch pertama. Itu tidak seharusnya dibuat (atau diubah, jika diterima dari batch terakhir) oleh pengguna.

Mengembalikan

Promise<PagedList<TestRun>>

queryTestSummaryByRequirement(TestResultsContext, string, number[])

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

Parameter

resultsContext
TestResultsContext
project

string

ID proyek atau nama proyek

workItemIds

number[]

Mengembalikan

removeTestCasesFromSuiteUrl(string, number, number, string)

Titik pengujian yang terkait dengan kasus pengujian dihapus dari rangkaian pengujian. Item kerja kasus pengujian tidak dihapus dari sistem. Lihat sumber daya kasus pengujian untuk menghapus kasus pengujian secara permanen.

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

Parameter

project

string

ID proyek atau nama proyek

planId

number

ID rencana pengujian yang berisi suite.

suiteId

number

ID suite yang akan didapatkan.

testCaseIds

string

ID kasus pengujian untuk dihapus dari suite.

Mengembalikan

Promise<void>

updateCodeCoverageSummary(CodeCoverageData, string, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Permintaan: Json ringkasan cakupan kode

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

Parameter

coverageData
CodeCoverageData
project

string

ID proyek atau nama proyek

buildId

number

Mengembalikan

Promise<void>

updateResultRetentionSettings(ResultRetentionSettings, string)

Perbarui setelan retensi hasil pengujian

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

Parameter

retentionSettings
ResultRetentionSettings

Detail pengaturan retensi hasil pengujian akan diperbarui

project

string

ID proyek atau nama proyek

Mengembalikan

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

Memperbarui properti asosiasi kasus pengujian dalam suite.

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

Parameter

suiteTestCaseUpdateModel
SuiteTestCaseUpdateModel

Model untuk memperbarui properti asosiasi rangkaian kasus pengujian.

project

string

ID proyek atau nama proyek

planId

number

ID rencana pengujian yang berisi suite.

suiteId

number

ID rangkaian pengujian tempat kasus pengujian harus ditambahkan.

testCaseIds

string

ID kasus pengujian untuk ditambahkan ke suite. ID ditentukan dalam format yang dipisahkan koma.

Mengembalikan

Promise<SuiteTestCase[]>

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

Perbarui titik pengujian.

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

Parameter

pointUpdateModel
PointUpdateModel

Data untuk diperbarui.

project

string

ID proyek atau nama proyek

planId

number

ID rencana pengujian.

suiteId

number

ID rangkaian yang berisi poin.

pointIds

string

ID titik pengujian yang akan didapatkan. Gunakan daftar ID yang dipisahkan koma untuk memperbarui beberapa titik pengujian.

Mengembalikan

Promise<TestPoint[]>

updateTestResults(TestCaseResult[], string, number)

Perbarui hasil pengujian dalam uji coba.

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

Parameter

results

TestCaseResult[]

Daftar hasil tes untuk diperbarui.

project

string

ID proyek atau nama proyek

runId

number

ID uji coba yang hasil pengujiannya akan diperbarui.

Mengembalikan

Promise<TestCaseResult[]>

updateTestRun(RunUpdateModel, string, number)

Perbarui pengujian yang dijalankan berdasarkan ID-nya.

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

Parameter

runUpdateModel
RunUpdateModel

Rincian eksekusi RunUpdateModel

project

string

ID proyek atau nama proyek

runId

number

ID eksekusi untuk diperbarui.

Mengembalikan

Promise<TestRun>

updateTestSession(TestSession, TeamContext)

Memperbarui sesi pengujian

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

Parameter

testSession
TestSession

Detail sesi pengujian untuk pembaruan

teamContext
TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<TestSession>