TestRestClient class

Referens

Paket:: azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST API:erna

Extends: RestClientBase

Konstruktorer

TestRestClient(IVssRestClientOptions)

Egenskaper

RESOURCE_AREA_ID

Metoder

addCustomFields(CustomTestFieldDefinition[], string)
addTestCasesToSuite(string, number, number, string)	Lägg till testfall i sviten.
addTestResultsToTestRun(TestCaseResult[], string, number)	Lägg till testresultat i en testkörning.
addWorkItemToTestLinks(WorkItemToTestLinks, string)
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)	Bifoga en fil för att testa stegresultatet
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)	Bifoga en fil i ett testresultat.
createTestRun(RunCreateModel, string)	Skapa en ny testkörning.
createTestRunAttachment(TestAttachmentRequestModel, string, number)	Koppla en fil till en testkörning.
createTestSession(TestSession, TeamContext)	Skapa en testsession
createTestSettings(TestSettings, string)
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)	Bifoga en fil i ett testresultat
deleteSharedParameter(string, number)
deleteSharedStep(string, number)
deleteTestCase(string, number)	Ta bort ett testfall.
deleteTestMethodToWorkItemLink(string, string, number)
deleteTestRun(string, number)	Ta bort ett test som körs med dess ID.
deleteTestSettings(string, number)
getBugsLinkedToTestResult(string, number, number)
getBuildCodeCoverage(string, number, number)	Hämta kodtäckningsdata för en version.
getCodeCoverageSummary(string, number, number)	Hämta kodtäckningssammanfattning för build.
getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)
getPoint(string, number, number, number, string)	Hämta en testpunkt.
getPoints(string, number, number, string, string, string, string, boolean, number, number)	Hämta en lista över testpunkter.
getPointsByQuery(TestPointsQuery, string, number, number)	Hämta testpunkter med hjälp av frågan.
getResultGroupsByBuild(string, number, string, string[], string)
getResultGroupsByRelease(string, number, string, number, string[], string)
getResultRetentionSettings(string)	Hämta kvarhållningsinställningar för testresultat
getTestCaseById(string, number, number, number)	Hämta ett specifikt testfall i en testsvit med testfalls-ID.
getTestCases(string, number, number)	Hämta alla testfall i en svit.
getTestIteration(string, number, number, number, boolean)	Hämta iteration för ett resultat
getTestIterations(string, number, number, boolean)	Hämta iterationer för ett resultat
getTestResultAttachmentContent(string, number, number, number)	Ladda ned en bifogad testresultatbilaga med dess ID.
getTestResultAttachments(string, number, number)	Hämta en lista över referensen för bifogade testresultat.
getTestResultAttachmentZip(string, number, number, number)	Ladda ned en bifogad testresultatbilaga med dess ID.
getTestResultById(string, number, number, ResultDetails)	Hämta ett testresultat för en testkörning.
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[])	Hämta testresultat för en testkörning.
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByQuery(TestResultsQuery, string)	Det här API:et returnerar resultat efter ID:n med angivna fält/trender för en viss automatiserad testmetod. Vi förbättrar fortfarande det här API:et och har inte slutfört korrekt signatur och kontrakt.
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
getTestRunAttachmentContent(string, number, number)	Ladda ned en testkörningsbilaga med dess ID.
getTestRunAttachments(string, number)	Hämta en lista över referensen för testkörningsbilagor.
getTestRunAttachmentZip(string, number, number)	Ladda ned en testkörningsbilaga med dess ID.
getTestRunById(string, number, boolean)	Få ett test som körs med dess ID.
getTestRunCodeCoverage(string, number, number)	Hämta kodtäckningsdata för en testkörning
getTestRunLogs(string, number)	Hämta meddelandeloggar för testkörning
getTestRuns(string, string, string, string, number, boolean, boolean, number, number)	Hämta en lista över testkörningar.
getTestRunStatistics(string, number)	Hämta testkörningsstatistik , som används när vi vill få en sammanfattning av en körning efter utfall.
getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)	Hämta en lista över testsessioner
getTestSettingsById(string, number)
getTestSubResultAttachmentContent(string, number, number, number, number)	Ladda ned en bifogad testunderresultatbilaga
getTestSubResultAttachments(string, number, number, number)	Hämta lista över bifogade testunderresultat
getTestSubResultAttachmentZip(string, number, number, number, number)	Ladda ned en bifogad testunderresultatbilaga
publishTestResultDocument(TestResultDocument, string, number)
queryCustomFields(string, CustomTestFieldScope)
queryResultTrendForBuild(TestResultTrendFilter, string)
queryResultTrendForRelease(TestResultTrendFilter, string)
queryTestHistory(TestHistoryQuery, string)	Hämta historik för en testmetod med TestHistoryQuery
queryTestMethodLinkedWorkItems(string, string)
queryTestResultHistory(ResultsFilter, string)
queryTestResultsMetaData(string[], string)	Hämta lista över testresultatmetadatainformation för motsvarande testcasereferenceId
queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)
queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
queryTestResultsSummaryForReleases(ReleaseReference[], string)
queryTestResultWorkItems(string, string, string, number, Date, number, number)
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, string)	Frågetestkörningar baserat på filter. Obligatoriska fält är minLastUpdatedDate och maxLastUpdatedDate.
queryTestSummaryByRequirement(TestResultsContext, string, number[])
removeTestCasesFromSuiteUrl(string, number, number, string)	Testpunkterna som är associerade med testfallen tas bort från testpaketet. Arbetsobjektet för testfall tas inte bort från systemet. Se testfallsresursen för att ta bort ett testfall permanent.
updateCodeCoverageSummary(CodeCoverageData, string, number)	http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Begäran: Json för kodtäckningssammanfattning
updateResultRetentionSettings(ResultRetentionSettings, string)	Uppdatera kvarhållningsinställningar för testresultat
updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)	Uppdateringar egenskaperna för testfallsassociationen i en svit.
updateTestPoints(PointUpdateModel, string, number, number, string)	Uppdatera testpunkter.
updateTestResults(TestCaseResult[], string, number)	Uppdatera testresultat i en testkörning.
updateTestRun(RunUpdateModel, string, number)	Uppdatera test som körs med dess ID.
updateTestSession(TestSession, TeamContext)	Uppdatera en testsession

Konstruktorinformation

TestRestClient(IVssRestClientOptions)

new TestRestClient(options: IVssRestClientOptions)

Parametrar

options: IVssRestClientOptions

Egenskapsinformation

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Egenskapsvärde

string

Metodinformation

addCustomFields(CustomTestFieldDefinition[], string)

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

Parametrar

newFields: CustomTestFieldDefinition[]

project: string

Projekt-ID eller projektnamn

Returer

Promise<CustomTestFieldDefinition[]>

addTestCasesToSuite(string, number, number, string)

Lägg till testfall i sviten.

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

Parametrar

project: string

Projekt-ID eller projektnamn

planId: number

ID för testplanen som innehåller sviten.

suiteId: number

ID för testpaketet som testfallen måste läggas till i.

testCaseIds: string

ID:t för de testfall som ska läggas till i sviten. ID:t anges i kommaavgränsat format.

Returer

Promise<SuiteTestCase[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

Lägg till testresultat i en testkörning.

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

Parametrar

results: TestCaseResult[]

Lista över testresultat att lägga till.

project: string

Projekt-ID eller projektnamn

runId: number

Testkörnings-ID i vilket testresultat som ska läggas till.

Returer

Promise<TestCaseResult[]>

addWorkItemToTestLinks(WorkItemToTestLinks, string)

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

Parametrar

workItemToTestLinks: WorkItemToTestLinks

project: string

Projekt-ID eller projektnamn

Returer

Promise<WorkItemToTestLinks>

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

Bifoga en fil för att testa stegresultatet

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

Parametrar

attachmentRequestModel: TestAttachmentRequestModel

Information om bifogade filer TestAttachmentRequestModel

project: string

Projekt-ID eller projektnamn

runId: number

ID för testkörningen som innehåller resultatet.

testCaseResultId: number

ID för testresultatet som innehåller iterationen

iterationId: number

ID för iterationen av testresultatet.

actionPath: string

Hex-värdet för testresultatets åtgärdssökväg.

Returer

Promise<TestAttachmentReference>

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Bifoga en fil i ett testresultat.

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

Parametrar

attachmentRequestModel: TestAttachmentRequestModel

Information om bifogade filer TestAttachmentRequestModel

project: string

Projekt-ID eller projektnamn

runId: number

ID för testkörningen som innehåller resultatet.

testCaseResultId: number

ID för testresultatet som den bifogade filen måste laddas upp mot.

Returer

Promise<TestAttachmentReference>

createTestRun(RunCreateModel, string)

Skapa en ny testkörning.

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

Parametrar

testRun: RunCreateModel

Run details RunCreateModel

project: string

Projekt-ID eller projektnamn

Returer

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Koppla en fil till en testkörning.

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

Parametrar

attachmentRequestModel: TestAttachmentRequestModel

Information om bifogade filer TestAttachmentRequestModel

project: string

Projekt-ID eller projektnamn

runId: number

ID för testkörningen mot vilken bifogad fil måste laddas upp.

Returer

Promise<TestAttachmentReference>

createTestSession(TestSession, TeamContext)

Skapa en testsession

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

Parametrar

testSession: TestSession

Testsessionsinformation för skapande

teamContext: TeamContext

Teamkontexten för åtgärden

Returer

Promise<TestSession>

createTestSettings(TestSettings, string)

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

Parametrar

testSettings: TestSettings

project: string

Projekt-ID eller projektnamn

Returer

Promise<number>

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

Bifoga en fil i ett testresultat

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

Parametrar

attachmentRequestModel: TestAttachmentRequestModel

Modell för begäran om bifogade filer.

project: string

Projekt-ID eller projektnamn

runId: number

ID för testkörningen som innehåller resultatet.

testCaseResultId: number

ID för testresultaten som innehåller underresultat.

testSubResultId: number

ID för testunderresultatet som den bifogade filen måste laddas upp mot.

Returer

Promise<TestAttachmentReference>

deleteSharedParameter(string, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

sharedParameterId: number

Returer

Promise<void>

deleteSharedStep(string, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

sharedStepId: number

Returer

Promise<void>

deleteTestCase(string, number)

Ta bort ett testfall.

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

Parametrar

project: string

Projekt-ID eller projektnamn

testCaseId: number

Id för testfall som ska tas bort.

Returer

Promise<void>

deleteTestMethodToWorkItemLink(string, string, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

testName: string

workItemId: number

Returer

Promise<boolean>

deleteTestRun(string, number)

Ta bort ett test som körs med dess ID.

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

ID för körningen som ska tas bort.

Returer

Promise<void>

deleteTestSettings(string, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

testSettingsId: number

Returer

Promise<void>

getBugsLinkedToTestResult(string, number, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

testCaseResultId: number

Returer

Promise<WorkItemReference[]>

getBuildCodeCoverage(string, number, number)

Hämta kodtäckningsdata för en version.

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

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID för den version som kodtäckningsdata måste hämtas för.

flags: number

Värdet för flaggor avgör vilken nivå av kodtäckningsinformation som ska hämtas. Flaggor är additiva. Förväntade värden är 1 för moduler, 2 för Functions, 4 för BlockData.

Returer

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

Hämta kodtäckningssammanfattning för build.

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

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

ID för den version som kodtäckningsdata måste hämtas för.

deltaBuildId: number

Delta Build-ID (valfritt)

Returer

Promise<CodeCoverageSummary>

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)

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

Parametrar

workItemQuery: LinkedWorkItemsQuery

project: string

Projekt-ID eller projektnamn

Returer

Promise<LinkedWorkItemsQueryResult[]>

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

Hämta en testpunkt.

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

Parametrar

project: string

Projekt-ID eller projektnamn

planId: number

ID för testplanen.

suiteId: number

ID för den svit som innehåller punkten.

pointIds: number

ID för testpunkten som ska hämtas.

witFields: string

Kommaavgränsad lista över fältnamn för arbetsobjekt.

Returer

Promise<TestPoint>

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

Hämta en lista över testpunkter.

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

Parametrar

project: string

Projekt-ID eller projektnamn

planId: number

ID för testplanen.

suiteId: number

ID för sviten som innehåller punkterna.

witFields: string

Kommaavgränsad lista över fältnamn för arbetsobjekt.

configurationId: string

Hämta testpunkter för specifik konfiguration.

testCaseId: string

Hämta testpunkter för ett specifikt testfall, giltigt när configurationId inte har angetts.

testPointIds: string

Hämta testpunkter för kommaavgränsad lista över testpunkts-ID:t, som endast är giltiga när configurationId och testCaseId inte har angetts.

includePointDetails: boolean

Inkludera alla egenskaper för testpunkten.

skip: number

Antal testpunkter att hoppa över..

top: number

Antal testpunkter som ska returneras.

Returer

Promise<TestPoint[]>

getPointsByQuery(TestPointsQuery, string, number, number)

Hämta testpunkter med hjälp av frågan.

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

Parametrar

query: TestPointsQuery

TestPointsQuery för att hämta testpunkter.

project: string

Projekt-ID eller projektnamn

skip: number

Antal testpunkter att hoppa över..

top: number

Antal testpunkter som ska returneras.

Returer

Promise<TestPointsQuery>

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

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

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

publishContext: string

fields: string[]

continuationToken: string

Returer

Promise<PagedList<FieldDetailsForTestResults>>

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

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

publishContext: string

releaseEnvId: number

fields: string[]

continuationToken: string

Returer

Promise<PagedList<FieldDetailsForTestResults>>

getResultRetentionSettings(string)

Hämta kvarhållningsinställningar för testresultat

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

Parametrar

project: string

Projekt-ID eller projektnamn

Returer

Promise<ResultRetentionSettings>

getTestCaseById(string, number, number, number)

Hämta ett specifikt testfall i en testsvit med testfalls-ID.

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

Parametrar

project: string

Projekt-ID eller projektnamn

planId: number

ID för testplanen som innehåller sviterna.

suiteId: number

ID för den svit som innehåller testfallet.

testCaseIds: number

ID för testfallet som ska hämtas.

Returer

Promise<SuiteTestCase>

getTestCases(string, number, number)

Hämta alla testfall i en svit.

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

Parametrar

project: string

Projekt-ID eller projektnamn

planId: number

ID för testplanen som innehåller sviterna.

suiteId: number

ID för sviten att få.

Returer

Promise<SuiteTestCase[]>

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

Hämta iteration för ett resultat

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

ID för testkörningen som innehåller resultatet.

testCaseResultId: number

ID för testresultatet som innehåller iterationerna.

iterationId: number

ID för testresultatet Iteration.

includeActionResults: boolean

Inkludera resultatinformation för varje åtgärd som utförs i test-iterationen. ActionResults refererar till resultat (pass/fail) för teststeg som körs som en del av ett manuellt test. Om du inkluderar flaggan ActionResults får du resultatet av teststegen i avsnittet actionResults och testparametrar i avsnittet parametrar för varje test iteration.

Returer

Promise<TestIterationDetailsModel>

getTestIterations(string, number, number, boolean)

Hämta iterationer för ett resultat

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

ID för testkörningen som innehåller resultatet.

testCaseResultId: number

ID för testresultatet som innehåller iterationerna.

includeActionResults: boolean

Returer

Promise<TestIterationDetailsModel[]>

getTestResultAttachmentContent(string, number, number, number)

Ladda ned en bifogad testresultatbilaga med dess ID.

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

ID för testkörningen som innehåller testCaseResultId.

testCaseResultId: number

ID för testresultatet vars bifogade fil måste laddas ned.

attachmentId: number

ID för den bifogade testresultatbilaga som ska laddas ned.

Returer

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

Hämta en lista över referensen för bifogade testresultat.

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

ID för testkörningen som innehåller resultatet.

testCaseResultId: number

ID för testresultatet.

Returer

Promise<TestAttachment[]>

getTestResultAttachmentZip(string, number, number, number)

Ladda ned en bifogad testresultatbilaga med dess ID.

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

ID för testkörningen som innehåller testCaseResultId.

testCaseResultId: number

ID för testresultatet vars bifogade fil måste laddas ned.

attachmentId: number

ID för den bifogade testresultatbilaga som ska laddas ned.

Returer

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

Hämta ett testresultat för en testkörning.

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

Testkörnings-ID för ett testresultat som ska hämtas.

testCaseResultId: number

Testresultat-ID.

detailsToInclude: ResultDetails

Information som ska inkluderas med testresultat. Standardvärdet är Ingen. Andra värden är Iterations, WorkItems och SubResults.

Returer

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>

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Returer

Promise<TestResultsDetails>

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

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

releaseEnvId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Returer

Promise<TestResultsDetails>

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

Hämta testresultat för en testkörning.

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

Testkörnings-ID för testresultat som ska hämtas.

detailsToInclude: ResultDetails

Information som ska inkluderas med testresultat. Standardvärdet är Ingen. Andra värden är Iterationer och WorkItems.

skip: number

Antal testresultat som ska hoppa från början.

top: number

Antal testresultat som ska returneras. Maximum är 1000 när detailsToInclude är None och 200 annars.

outcomes: TestOutcome[]

Kommaavgränsad lista över testresultat för att filtrera testresultat.

Returer

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

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Returer

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsByQuery(TestResultsQuery, string)

Det här API:et returnerar resultat efter ID:n med angivna fält/trender för en viss automatiserad testmetod. Vi förbättrar fortfarande det här API:et och har inte slutfört korrekt signatur och kontrakt.

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

Parametrar

query: TestResultsQuery

project: string

Projekt-ID eller projektnamn

Returer

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

releaseEnvid: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Returer

Promise<PagedList<ShallowTestCaseResult>>

getTestRunAttachmentContent(string, number, number)

Ladda ned en testkörningsbilaga med dess ID.

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

ID för testkörningen vars bifogade fil måste laddas ned.

attachmentId: number

ID för den testkörningsbilaga som ska laddas ned.

Returer

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

Hämta en lista över referensen för testkörningsbilagor.

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

ID för testkörningen.

Returer

Promise<TestAttachment[]>

getTestRunAttachmentZip(string, number, number)

Ladda ned en testkörningsbilaga med dess ID.

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

ID för testkörningen vars bifogade fil måste laddas ned.

attachmentId: number

ID för den testkörningsbilaga som ska laddas ned.

Returer

Promise<ArrayBuffer>

getTestRunById(string, number, boolean)

Få ett test som körs med dess ID.

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

ID för körningen att hämta.

includeDetails: boolean

Standardvärdet är True. Den innehåller information som körningsstatistik, lansering, version, testmiljö, status efter process med mera.

Returer

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

Hämta kodtäckningsdata för en testkörning

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

ID för testkörningen som kodtäckningsdata måste hämtas för.

flags: number

Värdet för flaggor avgör vilken nivå av kodtäckningsinformation som ska hämtas. Flaggor är additiva. Förväntade värden är 1 för moduler, 2 för Functions, 4 för BlockData.

Returer

Promise<TestRunCoverage[]>

getTestRunLogs(string, number)

Hämta meddelandeloggar för testkörning

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

ID för körningen att hämta.

Returer

Promise<TestMessageLogDetails[]>

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

Hämta en lista över testkörningar.

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

Parametrar

project: string

Projekt-ID eller projektnamn

buildUri: string

URI för den version som körningarna använde.

owner: string

Teamfundament-ID för ägaren av körningarna.

tmiRunId: string

planId: number

ID för testplanen som körningarna ingår i.

includeRunDetails: boolean

Om det är sant tar du med alla egenskaper för körningarna.

automated: boolean

Om det är sant returnerar endast automatiserade körningar.

skip: number

Antal testkörningar som ska hoppa över.

top: number

Antal testkörningar som ska returneras.

Returer

Promise<TestRun[]>

getTestRunStatistics(string, number)

Hämta testkörningsstatistik , som används när vi vill få en sammanfattning av en körning efter utfall.

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

ID för körningen att hämta.

Returer

Promise<TestRunStatistic>

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

Hämta en lista över testsessioner

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

Parametrar

teamContext: TeamContext

Teamkontexten för åtgärden

period: number

Period i dagar från och med nu, för vilken testsessioner hämtas.

allSessions: boolean

Om det är falskt returneras testsessioner för den aktuella användaren. Annars returneras testsessioner för alla användare

includeAllProperties: boolean

Om det är sant returneras alla egenskaper för testsessionerna. Annars returneras den smala versionen.

source: TestSessionSource

Testsessionens källa.

includeOnlyCompletedSessions: boolean

Om det är sant returneras testsessioner i slutfört tillstånd. Annars returneras testsessioner för alla tillstånd

Returer

Promise<TestSession[]>

getTestSettingsById(string, number)

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

Parametrar

project: string

Projekt-ID eller projektnamn

testSettingsId: number

Returer

Promise<TestSettings>

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

Ladda ned en bifogad testunderresultatbilaga

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

ID för testkörningen som innehåller resultatet.

testCaseResultId: number

ID för testresultaten som innehåller underresultat.

attachmentId: number

ID för den bifogade testresultatbilaga som ska laddas ned

testSubResultId: number

ID för testunderresultatet vars bifogade fil måste laddas ned

Returer

Promise<ArrayBuffer>

getTestSubResultAttachments(string, number, number, number)

Hämta lista över bifogade testunderresultat

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

ID för testkörningen som innehåller resultatet.

testCaseResultId: number

ID för testresultaten som innehåller underresultat.

testSubResultId: number

ID för testunderresultatet vars bifogade fil måste laddas ned

Returer

Promise<TestAttachment[]>

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

Ladda ned en bifogad testunderresultatbilaga

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

Parametrar

project: string

Projekt-ID eller projektnamn

runId: number

ID för testkörningen som innehåller resultatet.

testCaseResultId: number

ID för testresultaten som innehåller underresultat.

attachmentId: number

ID för den bifogade testresultatbilaga som ska laddas ned

testSubResultId: number

ID för testunderresultatet vars bifogade fil måste laddas ned

Returer

Promise<ArrayBuffer>

publishTestResultDocument(TestResultDocument, string, number)

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

Parametrar

document: TestResultDocument

project: string

Projekt-ID eller projektnamn

runId: number

Returer

Promise<TestResultDocument>

queryCustomFields(string, CustomTestFieldScope)

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

Parametrar

project: string

Projekt-ID eller projektnamn

scopeFilter: CustomTestFieldScope

Returer

Promise<CustomTestFieldDefinition[]>

queryResultTrendForBuild(TestResultTrendFilter, string)

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

Parametrar

filter: TestResultTrendFilter

project: string

Projekt-ID eller projektnamn

Returer

Promise<AggregatedDataForResultTrend[]>

queryResultTrendForRelease(TestResultTrendFilter, string)

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

Parametrar

filter: TestResultTrendFilter

project: string

Projekt-ID eller projektnamn

Returer

Promise<AggregatedDataForResultTrend[]>

queryTestHistory(TestHistoryQuery, string)

Hämta historik för en testmetod med TestHistoryQuery

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

Parametrar

filter: TestHistoryQuery

TestHistoryQuery för att hämta historik

project: string

Projekt-ID eller projektnamn

Returer

Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems(string, string)

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

Parametrar

project: string

Projekt-ID eller projektnamn

testName: string

Returer

Promise<TestToWorkItemLinks>

queryTestResultHistory(ResultsFilter, string)

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

Parametrar

filter: ResultsFilter

project: string

Projekt-ID eller projektnamn

Returer

Promise<TestResultHistory>

queryTestResultsMetaData(string[], string)

Hämta lista över testresultatmetadatainformation för motsvarande testcasereferenceId

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

Parametrar

testReferenceIds: string[]

TestCaseReference-ID:n för testresultatet som ska efterfrågas, kommaavgränsad lista över giltiga ID:n (begränsa nej. för ID:n 200).

project: string

Projekt-ID eller projektnamn

Returer

Promise<TestResultMetaData[]>

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

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

Parametrar

project: string

Projekt-ID eller projektnamn

buildId: number

publishContext: string

includeFailureDetails: boolean

buildToCompare: BuildReference

Returer

Promise<TestResultSummary>

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

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

Parametrar

project: string

Projekt-ID eller projektnamn

releaseId: number

releaseEnvId: number

publishContext: string

includeFailureDetails: boolean

releaseToCompare: ReleaseReference

Returer

Promise<TestResultSummary>

queryTestResultsSummaryForReleases(ReleaseReference[], string)

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

Parametrar

releases: ReleaseReference[]

project: string

Projekt-ID eller projektnamn

Returer

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

Parametrar

project: string

Projekt-ID eller projektnamn

workItemCategory: string

automatedTestName: string

testCaseId: number

maxCompleteDate: Date

days: number

workItemCount: number

Returer

Promise<WorkItemReference[]>

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

Frågetestkörningar baserat på filter. Obligatoriska fält är minLastUpdatedDate och 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>>

Parametrar

project: string

Projekt-ID eller projektnamn

minLastUpdatedDate: Date

Minsta senast ändrade datum för körning som ska efterfrågas (obligatoriskt).

maxLastUpdatedDate: Date

Maximalt datum för senast ändrad körning som ska efterfrågas (Obligatoriskt, skillnaden mellan lägsta och högsta datum kan vara högst 7 dagar).

state: TestRunState

Aktuellt tillstånd för de körningar som ska efterfrågas.

planIds: number[]

Planera ID:n för de körningar som ska efterfrågas, kommaavgränsad lista över giltiga ID:n (begränsa nej. för ID:n 10).

isAutomated: boolean

Automationstyp för de körningar som ska efterfrågas.

publishContext: TestRunPublishContext

PublishContext för de körningar som ska efterfrågas.

buildIds: number[]

Bygg-ID:n för de körningar som ska efterfrågas, kommaavgränsad lista över giltiga ID:n (begränsa antal ID:n 10).

buildDefIds: number[]

Skapa definitions-ID:n för de körningar som ska efterfrågas, kommaavgränsad lista över giltiga ID:n (begränsa nej. för ID:n 10).

branchName: string

Källgrenens namn på de körningar som ska efterfrågas.

releaseIds: number[]

Versions-ID:n för de körningar som ska efterfrågas, kommaavgränsad lista över giltiga ID:n (begränsa nej. för ID:n 10).

releaseDefIds: number[]

Versionsdefinitions-ID:n för de körningar som ska efterfrågas, kommaavgränsad lista över giltiga ID:n (begränsa nej för ID:n 10).

releaseEnvIds: number[]

Versionsmiljö-ID:n för de körningar som ska efterfrågas, kommaavgränsad lista över giltiga ID:n (begränsa nej för ID:n 10).

releaseEnvDefIds: number[]

Versionsmiljödefinitions-ID:n för de körningar som ska efterfrågas, kommaavgränsad lista över giltiga ID:n (begränsa nej. för ID:n 10).

runTitle: string

Kör rubriken för de körningar som ska efterfrågas.

top: number

Antal körningar som ska efterfrågas. Gränsen är 100

continuationToken: string

continuationToken togs emot från föregående batch eller null för den första batchen. Den ska inte skapas (eller ändras, om den tas emot från den senaste batchen) av användaren.

Returer

Promise<PagedList<TestRun>>

queryTestSummaryByRequirement(TestResultsContext, string, number[])

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

Parametrar

resultsContext: TestResultsContext

project: string

Projekt-ID eller projektnamn

workItemIds: number[]

Returer

Promise<TestSummaryForWorkItem[]>

removeTestCasesFromSuiteUrl(string, number, number, string)

Testpunkterna som är associerade med testfallen tas bort från testpaketet. Arbetsobjektet för testfall tas inte bort från systemet. Se testfallsresursen för att ta bort ett testfall permanent.

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

Parametrar

project: string

Projekt-ID eller projektnamn

planId: number

ID för testplanen som innehåller sviten.

suiteId: number

ID för sviten att få.

testCaseIds: string

ID:t för testfallen som ska tas bort från sviten.

Returer

Promise<void>

updateCodeCoverageSummary(CodeCoverageData, string, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Begäran: Json för kodtäckningssammanfattning

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

Parametrar

coverageData: CodeCoverageData

project: string

Projekt-ID eller projektnamn

buildId: number

Returer

Promise<void>

updateResultRetentionSettings(ResultRetentionSettings, string)

Uppdatera kvarhållningsinställningar för testresultat

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

Parametrar

retentionSettings: ResultRetentionSettings

Information om kvarhållningsinställningar för testresultat som ska uppdateras

project: string

Projekt-ID eller projektnamn

Returer

Promise<ResultRetentionSettings>

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

Uppdateringar egenskaperna för testfallsassociationen i en svit.

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

Parametrar

suiteTestCaseUpdateModel: SuiteTestCaseUpdateModel

Modell för uppdation av egenskaperna för testfallssvitassociation.

project: string

Projekt-ID eller projektnamn

planId: number

ID för testplanen som innehåller sviten.

suiteId: number

ID för testpaketet som testfallen måste läggas till i.

testCaseIds: string

ID:t för de testfall som ska läggas till i sviten. ID:t anges i kommaavgränsat format.

Returer

Promise<SuiteTestCase[]>

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

Uppdatera testpunkter.

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

Parametrar

pointUpdateModel: PointUpdateModel

Data som ska uppdateras.

project: string

Projekt-ID eller projektnamn

planId: number

ID för testplanen.

suiteId: number

ID för sviten som innehåller punkterna.

pointIds: string

ID för testpunkten som ska hämtas. Använd en kommaavgränsad lista över ID:t för att uppdatera flera testpunkter.

Returer

Promise<TestPoint[]>

updateTestResults(TestCaseResult[], string, number)

Uppdatera testresultat i en testkörning.

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

Parametrar

results: TestCaseResult[]

Lista över testresultat som ska uppdateras.

project: string

Projekt-ID eller projektnamn

runId: number

Testkörnings-ID vars testresultat ska uppdateras.

Returer

Promise<TestCaseResult[]>

updateTestRun(RunUpdateModel, string, number)

Uppdatera test som körs med dess ID.

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

Parametrar

runUpdateModel: RunUpdateModel

Run details RunUpdateModel

project: string

Projekt-ID eller projektnamn

runId: number

ID för körningen som ska uppdateras.

Returer

Promise<TestRun>

updateTestSession(TestSession, TeamContext)

Uppdatera en testsession

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

Parametrar

testSession: TestSession

Testsessionsinformation för uppdatering

teamContext: TeamContext

Teamkontexten för åtgärden

Returer

Promise<TestSession>

Dela via

TestRestClient class

Konstruktorer

Egenskaper

Metoder

Konstruktorinformation

TestRestClient(IVssRestClientOptions)

Parametrar

Egenskapsinformation

RESOURCE_AREA_ID

Egenskapsvärde

Metodinformation

addCustomFields(CustomTestFieldDefinition[], string)

Parametrar

Returer

addTestCasesToSuite(string, number, number, string)

Parametrar

Returer

addTestResultsToTestRun(TestCaseResult[], string, number)

Parametrar

Returer

addWorkItemToTestLinks(WorkItemToTestLinks, string)

Parametrar

Returer

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

Parametrar

Returer

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Parametrar

Returer

createTestRun(RunCreateModel, string)

Parametrar

Returer

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Parametrar

Returer

createTestSession(TestSession, TeamContext)

Parametrar

Returer

createTestSettings(TestSettings, string)

Parametrar

Returer

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

Parametrar

Returer

deleteSharedParameter(string, number)

Parametrar

Returer

deleteSharedStep(string, number)

Parametrar

Returer

deleteTestCase(string, number)

Parametrar

Returer

deleteTestMethodToWorkItemLink(string, string, number)

Parametrar

Returer

deleteTestRun(string, number)

Parametrar

Returer

deleteTestSettings(string, number)

Parametrar

Returer

getBugsLinkedToTestResult(string, number, number)

Parametrar

Returer

getBuildCodeCoverage(string, number, number)

Parametrar

Returer

getCodeCoverageSummary(string, number, number)

Parametrar

Returer

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)

Parametrar

Returer

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

Parametrar

Returer

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

Parametrar