TestRestClient class

Riferimento

Pacchetto:: azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST di VSS

Extends: RestClientBase

Costruttori

TestRestClient(IVssRestClientOptions)

Proprietà

RESOURCE_AREA_ID

Metodi

addCustomFields(CustomTestFieldDefinition[], string)
addTestCasesToSuite(string, number, number, string)	Aggiungere test case alla suite.
addTestResultsToTestRun(TestCaseResult[], string, number)	Aggiungere i risultati del test a un'esecuzione di test.
addWorkItemToTestLinks(WorkItemToTestLinks, string)
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)	Allegare un file al risultato del passaggio di test
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)	Allegare un file a un risultato del test.
createTestRun(RunCreateModel, string)	Creare una nuova esecuzione di test.
createTestRunAttachment(TestAttachmentRequestModel, string, number)	Allegare un file a un'esecuzione di test.
createTestSession(TestSession, TeamContext)	Creare una sessione di test
createTestSettings(TestSettings, string)
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)	Allegare un file a un risultato del test
deleteSharedParameter(string, number)
deleteSharedStep(string, number)
deleteTestCase(string, number)	Eliminare un test case.
deleteTestMethodToWorkItemLink(string, string, number)
deleteTestRun(string, number)	Eliminare un test eseguito in base al relativo ID.
deleteTestSettings(string, number)
getBugsLinkedToTestResult(string, number, number)
getBuildCodeCoverage(string, number, number)	Ottenere i dati di code coverage per una compilazione.
getCodeCoverageSummary(string, number, number)	Ottenere il riepilogo del code coverage per la compilazione.
getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)
getPoint(string, number, number, number, string)	Ottenere un punto di test.
getPoints(string, number, number, string, string, string, string, boolean, number, number)	Ottenere un elenco di punti di test.
getPointsByQuery(TestPointsQuery, string, number, number)	Ottenere i punti di test usando la query.
getResultGroupsByBuild(string, number, string, string[], string)
getResultGroupsByRelease(string, number, string, number, string[], string)
getResultRetentionSettings(string)	Ottenere le impostazioni di conservazione dei risultati dei test
getTestCaseById(string, number, number, number)	Ottenere un test case specifico in un gruppo di test con ID test case.
getTestCases(string, number, number)	Ottenere tutti i test case in un gruppo.
getTestIteration(string, number, number, number, boolean)	Ottenere l'iterazione per un risultato
getTestIterations(string, number, number, boolean)	Ottenere iterazioni per un risultato
getTestResultAttachmentContent(string, number, number, number)	Scaricare un allegato del risultato del test in base al relativo ID.
getTestResultAttachments(string, number, number)	Ottenere l'elenco dei riferimenti agli allegati dei risultati del test.
getTestResultAttachmentZip(string, number, number, number)	Scaricare un allegato del risultato del test in base al relativo ID.
getTestResultById(string, number, number, ResultDetails)	Ottenere un risultato del test per un'esecuzione di test.
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[])	Ottenere i risultati dei test per un'esecuzione di test.
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByQuery(TestResultsQuery, string)	Questa API restituirà i risultati in base agli ID con campi specificati/tendenza per un metodo di test automatizzato specifico. Stiamo ancora migliorando questa API e non abbiamo finalizzato la firma e il contratto appropriati.
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
getTestRunAttachmentContent(string, number, number)	Scaricare un allegato di esecuzione del test in base al relativo ID.
getTestRunAttachments(string, number)	Ottenere l'elenco di riferimenti agli allegati di esecuzione del test.
getTestRunAttachmentZip(string, number, number)	Scaricare un allegato di esecuzione del test in base al relativo ID.
getTestRunById(string, number, boolean)	Ottenere un'esecuzione di test in base al relativo ID.
getTestRunCodeCoverage(string, number, number)	Ottenere i dati di code coverage per un'esecuzione di test
getTestRunLogs(string, number)	Ottenere i log dei messaggi di esecuzione dei test
getTestRuns(string, string, string, string, number, boolean, boolean, number, number)	Ottenere un elenco di esecuzioni di test.
getTestRunStatistics(string, number)	Ottiene le statistiche di esecuzione dei test, usato quando si vuole ottenere il riepilogo di un'esecuzione in base al risultato.
getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)	Ottenere un elenco di sessioni di test
getTestSettingsById(string, number)
getTestSubResultAttachmentContent(string, number, number, number, number)	Scaricare un allegato di risultati secondari del test
getTestSubResultAttachments(string, number, number, number)	Ottenere l'elenco degli allegati dei risultati secondari del test
getTestSubResultAttachmentZip(string, number, number, number, number)	Scaricare un allegato di risultati secondari del test
publishTestResultDocument(TestResultDocument, string, number)
queryCustomFields(string, CustomTestFieldScope)
queryResultTrendForBuild(TestResultTrendFilter, string)
queryResultTrendForRelease(TestResultTrendFilter, string)
queryTestHistory(TestHistoryQuery, string)	Ottenere la cronologia di un metodo di test usando TestHistoryQuery
queryTestMethodLinkedWorkItems(string, string)
queryTestResultHistory(ResultsFilter, string)
queryTestResultsMetaData(string[], string)	Ottenere l'elenco dei dettagli dei metadati dei risultati del test per il testcasereferenceId corrispondente
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)	Esecuzione di test di query in base ai filtri. I campi obbligatori sono minLastUpdatedDate e maxLastUpdatedDate.
queryTestSummaryByRequirement(TestResultsContext, string, number[])
removeTestCasesFromSuiteUrl(string, number, number, string)	I punti di test associati ai test case vengono rimossi dalla suite di test. L'elemento di lavoro del test case non viene eliminato dal sistema. Vedere la risorsa test case per eliminare definitivamente un test case.
updateCodeCoverageSummary(CodeCoverageData, string, number)	http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Request: Json of code coverage summary
updateResultRetentionSettings(ResultRetentionSettings, string)	Aggiornare le impostazioni di conservazione dei risultati del test
updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)	Aggiornamenti le proprietà dell'associazione di test case in una suite.
updateTestPoints(PointUpdateModel, string, number, number, string)	Aggiornare i punti di test.
updateTestResults(TestCaseResult[], string, number)	Aggiornare i risultati del test in un'esecuzione di test.
updateTestRun(RunUpdateModel, string, number)	Aggiornare il test eseguito dall'ID.
updateTestSession(TestSession, TeamContext)	Aggiornare una sessione di test

Dettagli costruttore

TestRestClient(IVssRestClientOptions)

new TestRestClient(options: IVssRestClientOptions)

Parametri

options: IVssRestClientOptions

Dettagli proprietà

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valore della proprietà

string

Dettagli metodo

addCustomFields(CustomTestFieldDefinition[], string)

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

Parametri

newFields: CustomTestFieldDefinition[]

project: string

ID progetto o nome del progetto

Restituisce

Promise<CustomTestFieldDefinition[]>

addTestCasesToSuite(string, number, number, string)

Aggiungere test case alla suite.

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

Parametri

project: string

ID progetto o nome del progetto

planId: number

ID del piano di test che contiene la suite.

suiteId: number

ID del gruppo di test a cui devono essere aggiunti i test case.

testCaseIds: string

ID dei test case da aggiungere alla suite. Gli ID vengono specificati in formato delimitato da virgole.

Restituisce

Promise<SuiteTestCase[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

Aggiungere i risultati del test a un'esecuzione di test.

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

Parametri

results: TestCaseResult[]

Elenco dei risultati dei test da aggiungere.

project: string

ID progetto o nome del progetto

runId: number

ID esecuzione test in cui aggiungere i risultati del test.

Restituisce

Promise<TestCaseResult[]>

addWorkItemToTestLinks(WorkItemToTestLinks, string)

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

Parametri

workItemToTestLinks: WorkItemToTestLinks

project: string

ID progetto o nome del progetto

Restituisce

Promise<WorkItemToTestLinks>

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

Allegare un file al risultato del passaggio di test

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

Parametri

attachmentRequestModel: TestAttachmentRequestModel

Dettagli degli allegati TestAttachmentRequestModel

project: string

ID progetto o nome del progetto

runId: number

ID dell'esecuzione del test che contiene il risultato.

testCaseResultId: number

ID del risultato del test che contiene l'iterazione

iterationId: number

ID dell'iterazione dei risultati del test.

actionPath: string

Valore esadecimale del percorso dell'azione del risultato del test.

Restituisce

Promise<TestAttachmentReference>

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Allegare un file a un risultato del test.

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

Parametri

attachmentRequestModel: TestAttachmentRequestModel

Dettagli degli allegati TestAttachmentRequestModel

project: string

ID progetto o nome del progetto

runId: number

ID dell'esecuzione del test che contiene il risultato.

testCaseResultId: number

ID del risultato del test in base al quale deve essere caricato l'allegato.

Restituisce

Promise<TestAttachmentReference>

createTestRun(RunCreateModel, string)

Creare una nuova esecuzione di test.

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

Parametri

testRun: RunCreateModel

Dettagli esecuzione RunCreateModel

project: string

ID progetto o nome del progetto

Restituisce

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Allegare un file a un'esecuzione di test.

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

Parametri

attachmentRequestModel: TestAttachmentRequestModel

Dettagli degli allegati TestAttachmentRequestModel

project: string

ID progetto o nome del progetto

runId: number

ID dell'esecuzione del test in cui deve essere caricato l'allegato.

Restituisce

Promise<TestAttachmentReference>

createTestSession(TestSession, TeamContext)

Creare una sessione di test

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

Parametri

testSession: TestSession

Dettagli della sessione di test per la creazione

teamContext: TeamContext

Contesto del team per l'operazione

Restituisce

Promise<TestSession>

createTestSettings(TestSettings, string)

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

Parametri

testSettings: TestSettings

project: string

ID progetto o nome del progetto

Restituisce

Promise<number>

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

Allegare un file a un risultato del test

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

Parametri

attachmentRequestModel: TestAttachmentRequestModel

Modello di richiesta allegato.

project: string

ID progetto o nome del progetto

runId: number

ID dell'esecuzione del test che contiene il risultato.

testCaseResultId: number

ID dei risultati del test che contiene il risultato secondario.

testSubResultId: number

ID dei risultati secondari del test in base al quale deve essere caricato l'allegato.

Restituisce

Promise<TestAttachmentReference>

deleteSharedParameter(string, number)

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

Parametri

project: string

ID progetto o nome del progetto

sharedParameterId: number

Restituisce

Promise<void>

deleteSharedStep(string, number)

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

Parametri

project: string

ID progetto o nome del progetto

sharedStepId: number

Restituisce

Promise<void>

deleteTestCase(string, number)

Eliminare un test case.

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

Parametri

project: string

ID progetto o nome del progetto

testCaseId: number

ID del test case da eliminare.

Restituisce

Promise<void>

deleteTestMethodToWorkItemLink(string, string, number)

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

Parametri

project: string

ID progetto o nome del progetto

testName: string

workItemId: number

Restituisce

Promise<boolean>

deleteTestRun(string, number)

Eliminare un test eseguito in base al relativo ID.

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

Parametri

project: string

ID progetto o nome del progetto

runId: number

ID dell'esecuzione da eliminare.

Restituisce

Promise<void>

deleteTestSettings(string, number)

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

Parametri

project: string

ID progetto o nome del progetto

testSettingsId: number

Restituisce

Promise<void>

getBugsLinkedToTestResult(string, number, number)

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

Parametri

project: string

ID progetto o nome del progetto

runId: number

testCaseResultId: number

Restituisce

Promise<WorkItemReference[]>

getBuildCodeCoverage(string, number, number)

Ottenere i dati di code coverage per una compilazione.

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

ID della compilazione per cui è necessario recuperare i dati di code coverage.

flags: number

Il valore dei flag determina il livello di dettagli del code coverage da recuperare. I flag sono additivi. I valori previsti sono 1 per i moduli, 2 per Funzioni, 4 per BlockData.

Restituisce

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

Ottenere il riepilogo del code coverage per la compilazione.

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

ID della compilazione per cui è necessario recuperare i dati di code coverage.

deltaBuildId: number

ID build delta (facoltativo)

Restituisce

Promise<CodeCoverageSummary>

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)

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

Parametri

workItemQuery: LinkedWorkItemsQuery

project: string

ID progetto o nome del progetto

Restituisce

Promise<LinkedWorkItemsQueryResult[]>

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

Ottenere un punto di test.

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

Parametri

project: string

ID progetto o nome del progetto

planId: number

ID del piano di test.

suiteId: number

ID della suite che contiene il punto.

pointIds: number

ID del punto di test da ottenere.

witFields: string

Elenco delimitato da virgole dei nomi dei campi degli elementi di lavoro.

Restituisce

Promise<TestPoint>

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

Ottenere un elenco di punti di test.

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

Parametri

project: string

ID progetto o nome del progetto

planId: number

ID del piano di test.

suiteId: number

ID della suite che contiene i punti.

witFields: string

Elenco delimitato da virgole dei nomi dei campi degli elementi di lavoro.

configurationId: string

Ottenere i punti di test per una configurazione specifica.

testCaseId: string

Ottiene i punti di test per un test case specifico, valido quando configurationId non è impostato.

testPointIds: string

Ottiene i punti di test per l'elenco delimitato da virgole di ID punto di test, valido solo quando configurationId e testCaseId non sono impostati.

includePointDetails: boolean

Includere tutte le proprietà per il punto di test.

skip: number

Numero di punti di test da ignorare.

top: number

Numero di punti di test da restituire.

Restituisce

Promise<TestPoint[]>

getPointsByQuery(TestPointsQuery, string, number, number)

Ottenere i punti di test usando la query.

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

Parametri

query: TestPointsQuery

TestPointsQuery per ottenere i punti di test.

project: string

ID progetto o nome del progetto

skip: number

Numero di punti di test da ignorare.

top: number

Numero di punti di test da restituire.

Restituisce

Promise<TestPointsQuery>

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

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

publishContext: string

fields: string[]

continuationToken: string

Restituisce

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

Parametri

project: string

ID progetto o nome del progetto

releaseId: number

publishContext: string

releaseEnvId: number

fields: string[]

continuationToken: string

Restituisce

Promise<PagedList<FieldDetailsForTestResults>>

getResultRetentionSettings(string)

Ottenere le impostazioni di conservazione dei risultati dei test

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

Parametri

project: string

ID progetto o nome del progetto

Restituisce

Promise<ResultRetentionSettings>

getTestCaseById(string, number, number, number)

Ottenere un test case specifico in un gruppo di test con ID test case.

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

Parametri

project: string

ID progetto o nome del progetto

planId: number

ID del piano di test che contiene i gruppi.

suiteId: number

ID della suite che contiene il test case.

testCaseIds: number

ID del test case da ottenere.

Restituisce

Promise<SuiteTestCase>

getTestCases(string, number, number)

Ottenere tutti i test case in un gruppo.

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

Parametri

project: string

ID progetto o nome del progetto

planId: number

ID del piano di test che contiene i gruppi.

suiteId: number

ID della suite da ottenere.

Restituisce

Promise<SuiteTestCase[]>

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

Ottenere l'iterazione per un risultato

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

Parametri

project: string

ID progetto o nome del progetto

runId: number

ID dell'esecuzione del test che contiene il risultato.

testCaseResultId: number

ID del risultato del test contenente le iterazioni.

iterationId: number

ID dell'iterazione dei risultati del test.

includeActionResults: boolean

Includere i dettagli dei risultati per ogni azione eseguita nell'iterazione di test. ActionResults fa riferimento al risultato (superato/negativo) dei passaggi di test eseguiti come parte di un test manuale. L'inclusione del flag ActionResults ottiene il risultato dei passaggi di test nella sezione actionResults e i parametri di test nella sezione parametri per ogni iterazione di test.

Restituisce

Promise<TestIterationDetailsModel>

getTestIterations(string, number, number, boolean)

Ottenere iterazioni per un risultato

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

Parametri

project: string

ID progetto o nome del progetto

runId: number

ID dell'esecuzione del test che contiene il risultato.

testCaseResultId: number

ID del risultato del test contenente le iterazioni.

includeActionResults: boolean

Restituisce

Promise<TestIterationDetailsModel[]>

getTestResultAttachmentContent(string, number, number, number)

Scaricare un allegato del risultato del test in base al relativo ID.

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

Parametri

project: string

ID progetto o nome del progetto

runId: number

ID dell'esecuzione del test contenente testCaseResultId.

testCaseResultId: number

ID del risultato del test il cui allegato deve essere scaricato.

attachmentId: number

ID dell'allegato del risultato del test da scaricare.

Restituisce

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

Ottenere l'elenco dei riferimenti agli allegati dei risultati del test.

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

Parametri

project: string

ID progetto o nome del progetto

runId: number

ID dell'esecuzione del test che contiene il risultato.

testCaseResultId: number

ID del risultato del test.

Restituisce

Promise<TestAttachment[]>

getTestResultAttachmentZip(string, number, number, number)

Scaricare un allegato del risultato del test in base al relativo ID.

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

Parametri

project: string

ID progetto o nome del progetto

runId: number

ID dell'esecuzione del test contenente testCaseResultId.

testCaseResultId: number

ID del risultato del test il cui allegato deve essere scaricato.

attachmentId: number

ID dell'allegato del risultato del test da scaricare.

Restituisce

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

Ottenere un risultato del test per un'esecuzione di test.

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

Parametri

project: string

ID progetto o nome del progetto

runId: number

ID esecuzione test di un risultato del test da recuperare.

testCaseResultId: number

ID risultato del test.

detailsToInclude: ResultDetails

Dettagli da includere con i risultati del test. L'impostazione predefinita è None. Altri valori sono Iterazioni, WorkItems e SubResults.

Restituisce

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>

Parametri

project: string

ID progetto o nome del progetto

buildId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Restituisce

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>

Parametri

project: string

ID progetto o nome del progetto

releaseId: number

releaseEnvId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Restituisce

Promise<TestResultsDetails>

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

Ottenere i risultati dei test per un'esecuzione di test.

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

Parametri

project: string

ID progetto o nome del progetto

runId: number

ID esecuzione test dei risultati del test da recuperare.

detailsToInclude: ResultDetails

Dettagli da includere con i risultati del test. L'impostazione predefinita è None. Altri valori sono Iterazioni e WorkItems.

skip: number

Numero di risultati dei test da ignorare dall'inizio.

top: number

Numero di risultati del test da restituire. Il valore massimo è 1000 quando detailsToInclude è Nessuno e 200 in caso contrario.

outcomes: TestOutcome[]

Elenco delimitato da virgole dei risultati dei test per filtrare i risultati dei test.

Restituisce

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

Parametri

project: string

ID progetto o nome del progetto

buildId: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Restituisce

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsByQuery(TestResultsQuery, string)

Questa API restituirà i risultati in base agli ID con campi specificati/tendenza per un metodo di test automatizzato specifico. Stiamo ancora migliorando questa API e non abbiamo finalizzato la firma e il contratto appropriati.

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

Parametri

query: TestResultsQuery

project: string

ID progetto o nome del progetto

Restituisce

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

Parametri

project: string

ID progetto o nome del progetto

releaseId: number

releaseEnvid: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Restituisce

Promise<PagedList<ShallowTestCaseResult>>

getTestRunAttachmentContent(string, number, number)

Scaricare un allegato di esecuzione del test in base al relativo ID.

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

Parametri

project: string

ID progetto o nome del progetto

runId: number

ID dell'esecuzione del test il cui allegato deve essere scaricato.

attachmentId: number

ID dell'allegato di esecuzione del test da scaricare.

Restituisce

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

Ottenere l'elenco di riferimenti agli allegati di esecuzione del test.

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

Parametri

project: string

ID progetto o nome del progetto

runId: number

ID dell'esecuzione del test.

Restituisce

Promise<TestAttachment[]>

getTestRunAttachmentZip(string, number, number)

Scaricare un allegato di esecuzione del test in base al relativo ID.

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

Parametri

project: string

ID progetto o nome del progetto

runId: number

ID dell'esecuzione del test il cui allegato deve essere scaricato.

attachmentId: number

ID dell'allegato di esecuzione del test da scaricare.

Restituisce

Promise<ArrayBuffer>

getTestRunById(string, number, boolean)

Ottenere un'esecuzione di test in base al relativo ID.

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

Parametri

project: string

ID progetto o nome del progetto

runId: number

ID dell'esecuzione da ottenere.

includeDetails: boolean

Il valore predefinito è true. Include dettagli come le statistiche di esecuzione, il rilascio, la compilazione, l'ambiente di test, lo stato post-processo e altro ancora.

Restituisce

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

Ottenere i dati di code coverage per un'esecuzione di test

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

Parametri

project: string

ID progetto o nome del progetto

runId: number

ID dell'esecuzione del test per cui è necessario recuperare i dati di code coverage.

flags: number

Il valore dei flag determina il livello di dettagli del code coverage da recuperare. I flag sono additivi. I valori previsti sono 1 per i moduli, 2 per Funzioni, 4 per BlockData.

Restituisce

Promise<TestRunCoverage[]>

getTestRunLogs(string, number)

Ottenere i log dei messaggi di esecuzione dei test

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

Parametri

project: string

ID progetto o nome del progetto

runId: number

ID dell'esecuzione da ottenere.

Restituisce

Promise<TestMessageLogDetails[]>

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

Ottenere un elenco di esecuzioni di test.

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

Parametri

project: string

ID progetto o nome del progetto

buildUri: string

URI della compilazione utilizzata dall'oggetto .

owner: string

ID di base del team del proprietario delle esecuzioni.

tmiRunId: string

planId: number

ID del piano di test di cui fanno parte le esecuzioni.

includeRunDetails: boolean

Se true, includere tutte le proprietà delle esecuzioni.

automated: boolean

Se true, restituisce solo esecuzioni automatizzate.

skip: number

Numero di esecuzioni di test da ignorare.

top: number

Numero di esecuzioni di test da restituire.

Restituisce

Promise<TestRun[]>

getTestRunStatistics(string, number)

Ottiene le statistiche di esecuzione dei test, usato quando si vuole ottenere il riepilogo di un'esecuzione in base al risultato.

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

Parametri

project: string

ID progetto o nome del progetto

runId: number

ID dell'esecuzione da ottenere.

Restituisce

Promise<TestRunStatistic>

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

Ottenere un elenco di sessioni di test

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

Parametri

teamContext: TeamContext

Contesto del team per l'operazione

period: number

Periodo in giorni da ora, per cui vengono recuperate le sessioni di test.

allSessions: boolean

Se false, restituisce sessioni di test per l'utente corrente. In caso contrario, restituisce sessioni di test per tutti gli utenti

includeAllProperties: boolean

Se true, restituisce tutte le proprietà delle sessioni di test. In caso contrario, restituisce la versione skinny.

source: TestSessionSource

Origine della sessione di test.

includeOnlyCompletedSessions: boolean

Se true, restituisce sessioni di test nello stato completato. In caso contrario, restituisce sessioni di test per tutti gli stati

Restituisce

Promise<TestSession[]>

getTestSettingsById(string, number)

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

Parametri

project: string

ID progetto o nome progetto

testSettingsId: number

Restituisce

Promise<TestSettings>

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

Scaricare un allegato di risultati secondari del test

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

Parametri

project: string

ID progetto o nome progetto

runId: number

ID dell'esecuzione del test contenente il risultato.

testCaseResultId: number

ID dei risultati del test che contiene i risultati secondari.

attachmentId: number

ID dell'allegato del risultato del test da scaricare

testSubResultId: number

ID del risultato secondario del test il cui allegato deve essere scaricato

Restituisce

Promise<ArrayBuffer>

getTestSubResultAttachments(string, number, number, number)

Ottenere l'elenco degli allegati dei risultati secondari del test

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

Parametri

project: string

ID progetto o nome progetto

runId: number

ID dell'esecuzione del test contenente il risultato.

testCaseResultId: number

ID dei risultati del test che contiene i risultati secondari.

testSubResultId: number

ID del risultato secondario del test il cui allegato deve essere scaricato

Restituisce

Promise<TestAttachment[]>

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

Scaricare un allegato di risultati secondari del test

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

Parametri

project: string

ID progetto o nome progetto

runId: number

ID dell'esecuzione del test contenente il risultato.

testCaseResultId: number

ID dei risultati del test che contiene i risultati secondari.

attachmentId: number

ID dell'allegato del risultato del test da scaricare

testSubResultId: number

ID del risultato secondario del test il cui allegato deve essere scaricato

Restituisce

Promise<ArrayBuffer>

publishTestResultDocument(TestResultDocument, string, number)

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

Parametri

document: TestResultDocument

project: string

ID progetto o nome progetto

runId: number

Restituisce

Promise<TestResultDocument>

queryCustomFields(string, CustomTestFieldScope)

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

Parametri

project: string

ID progetto o nome progetto

scopeFilter: CustomTestFieldScope

Restituisce

Promise<CustomTestFieldDefinition[]>

queryResultTrendForBuild(TestResultTrendFilter, string)

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

Parametri

filter: TestResultTrendFilter

project: string

ID progetto o nome progetto

Restituisce

Promise<AggregatedDataForResultTrend[]>

queryResultTrendForRelease(TestResultTrendFilter, string)

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

Parametri

filter: TestResultTrendFilter

project: string

ID progetto o nome progetto

Restituisce

Promise<AggregatedDataForResultTrend[]>

queryTestHistory(TestHistoryQuery, string)

Ottenere la cronologia di un metodo di test usando TestHistoryQuery

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

Parametri

filter: TestHistoryQuery

TestHistoryQuery per ottenere la cronologia

project: string

ID progetto o nome progetto

Restituisce

Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems(string, string)

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

Parametri

project: string

ID progetto o nome progetto

testName: string

Restituisce

Promise<TestToWorkItemLinks>

queryTestResultHistory(ResultsFilter, string)

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

Parametri

filter: ResultsFilter

project: string

ID progetto o nome progetto

Restituisce

Promise<TestResultHistory>

queryTestResultsMetaData(string[], string)

Ottenere l'elenco dei dettagli dei metadati dei risultati del test per il testcasereferenceId corrispondente

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

Parametri

testReferenceIds: string[]

Id testCaseReference del risultato del test da eseguire query, elenco delimitato da virgole di ID validi (limite n. di id 200).

project: string

ID progetto o nome progetto

Restituisce

Promise<TestResultMetaData[]>

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

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

Parametri

project: string

ID progetto o nome progetto

buildId: number

publishContext: string

includeFailureDetails: boolean

buildToCompare: BuildReference

Restituisce

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>

Parametri

project: string

ID progetto o nome progetto

releaseId: number

releaseEnvId: number

publishContext: string

includeFailureDetails: boolean

releaseToCompare: ReleaseReference

Restituisce

Promise<TestResultSummary>

queryTestResultsSummaryForReleases(ReleaseReference[], string)

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

Parametri

releases: ReleaseReference[]

project: string

ID progetto o nome progetto

Restituisce

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

Parametri

project: string

ID progetto o nome progetto

workItemCategory: string

automatedTestName: string

testCaseId: number

maxCompleteDate: Date

days: number

workItemCount: number

Restituisce

Promise<WorkItemReference[]>

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

Esecuzione di test di query in base ai filtri. I campi obbligatori sono minLastUpdatedDate e 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>>

Parametri

project: string

ID progetto o nome progetto

minLastUpdatedDate: Date

Data minima di esecuzione dell'ultima modifica da eseguire con query (obbligatorio).

maxLastUpdatedDate: Date

Data massima di esecuzione modificata da eseguire con query (obbligatorio, differenza tra min e max date può essere massima di 7 giorni).

state: TestRunState

Stato corrente delle esecuzioni da eseguire una query.

planIds: number[]

Id piano delle esecuzioni da eseguire in query, elenco delimitato da virgole di ID validi (limite no. di id 10).

isAutomated: boolean

Tipo di automazione delle esecuzioni da eseguire una query.

publishContext: TestRunPublishContext

PublishContext delle esecuzioni da eseguire una query.

buildIds: number[]

ID di compilazione delle esecuzioni da eseguire una query, elenco delimitato da virgole di ID validi (limite no. di id 10).

buildDefIds: number[]

ID definizione di compilazione delle esecuzioni da eseguire in query, elenco delimitato da virgole di ID validi (limite no. di ID 10).

branchName: string

Nome del ramo di origine delle esecuzioni da eseguire query.

releaseIds: number[]

ID di rilascio delle esecuzioni da eseguire per la query, elenco delimitato da virgole di ID validi (limite no. di id 10).

releaseDefIds: number[]

ID definizione di versione delle esecuzioni da eseguire per la query, elenco delimitato da virgole di ID validi (limite no. di id 10).

releaseEnvIds: number[]

ID ambiente di rilascio delle esecuzioni da eseguire per la query, elenco delimitato da virgole di ID validi (limite no. di id 10).

releaseEnvDefIds: number[]

ID definizione dell'ambiente di rilascio delle esecuzioni da eseguire su query, elenco delimitato da virgole di ID validi (limite no. di id 10).

runTitle: string

Eseguire il titolo delle esecuzioni da eseguire per la query.

top: number

Numero di esecuzioni da eseguire query. Il limite è 100

continuationToken: string

continuationToken ricevuto dal batch precedente o null per il primo batch. Non dovrebbe essere creato (o modificato, se ricevuto dall'ultimo batch) dall'utente.

Restituisce

Promise<PagedList<TestRun>>

queryTestSummaryByRequirement(TestResultsContext, string, number[])

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

Parametri

resultsContext: TestResultsContext

project: string

ID progetto o nome progetto

workItemIds: number[]

Restituisce

Promise<TestSummaryForWorkItem[]>

removeTestCasesFromSuiteUrl(string, number, number, string)

I punti di test associati ai test case vengono rimossi dalla suite di test. L'elemento di lavoro del test case non viene eliminato dal sistema. Vedere la risorsa test case per eliminare definitivamente un test case.

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

Parametri

project: string

ID progetto o nome progetto

planId: number

ID del piano di test contenente la suite.

suiteId: number

ID della suite da ottenere.

testCaseIds: string

ID dei test case da rimuovere dalla suite.

Restituisce

Promise<void>

updateCodeCoverageSummary(CodeCoverageData, string, number)

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

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

Parametri

coverageData: CodeCoverageData

project: string

ID progetto o nome progetto

buildId: number

Restituisce

Promise<void>

updateResultRetentionSettings(ResultRetentionSettings, string)

Aggiornare le impostazioni di conservazione dei risultati del test

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

Parametri

retentionSettings: ResultRetentionSettings

Verificare i dettagli delle impostazioni di conservazione dei risultati da aggiornare

project: string

ID progetto o nome progetto

Restituisce

Promise<ResultRetentionSettings>

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

Aggiornamenti le proprietà dell'associazione di test case in una suite.

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

Parametri

suiteTestCaseUpdateModel: SuiteTestCaseUpdateModel

Modello per l'updation delle proprietà dell'associazione della suite di test case.

project: string

ID progetto o nome progetto

planId: number

ID del piano di test contenente la suite.

suiteId: number

ID della suite di test a cui devono essere aggiunti i test case.

testCaseIds: string

ID dei test case da aggiungere alla suite. Gli ID vengono specificati in formato delimitato da virgole.

Restituisce

Promise<SuiteTestCase[]>

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

Aggiornare i punti di test.

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

Parametri

pointUpdateModel: PointUpdateModel

Dati da aggiornare.

project: string

ID progetto o nome progetto

planId: number

ID del piano di test.

suiteId: number

ID della suite che contiene i punti.

pointIds: string

ID del punto di test da ottenere. Usare un elenco delimitato da virgole di ID per aggiornare più punti di test.

Restituisce

Promise<TestPoint[]>

updateTestResults(TestCaseResult[], string, number)

Aggiornare i risultati del test in un'esecuzione di test.

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

Parametri

results: TestCaseResult[]

Elenco dei risultati dei test da aggiornare.

project: string

ID progetto o nome progetto

runId: number

ID esecuzione di test i cui risultati del test da aggiornare.

Restituisce

Promise<TestCaseResult[]>

updateTestRun(RunUpdateModel, string, number)

Aggiornare il test eseguito dall'ID.

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

Parametri

runUpdateModel: RunUpdateModel

Eseguire dettagli RunUpdateModel

project: string

ID progetto o nome progetto

runId: number

ID dell'esecuzione da aggiornare.

Restituisce

Promise<TestRun>

updateTestSession(TestSession, TeamContext)

Aggiornare una sessione di test

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

Parametri

testSession: TestSession

Dettagli sessione di test per l'aggiornamento

teamContext: TeamContext

Contesto del team per l'operazione

Restituisce

Promise<TestSession>

Condividi tramite

TestRestClient class

Costruttori

Proprietà

Metodi

Dettagli costruttore

TestRestClient(IVssRestClientOptions)

Parametri

Dettagli proprietà

RESOURCE_AREA_ID

Valore della proprietà

Dettagli metodo

addCustomFields(CustomTestFieldDefinition[], string)

Parametri

Restituisce

addTestCasesToSuite(string, number, number, string)

Parametri

Restituisce

addTestResultsToTestRun(TestCaseResult[], string, number)

Parametri

Restituisce

addWorkItemToTestLinks(WorkItemToTestLinks, string)

Parametri

Restituisce

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

Parametri

Restituisce

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Parametri

Restituisce

createTestRun(RunCreateModel, string)

Parametri

Restituisce

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Parametri

Restituisce

createTestSession(TestSession, TeamContext)

Parametri

Restituisce

createTestSettings(TestSettings, string)

Parametri

Restituisce

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

Parametri

Restituisce

deleteSharedParameter(string, number)

Parametri

Restituisce

deleteSharedStep(string, number)

Parametri

Restituisce

deleteTestCase(string, number)

Parametri

Restituisce

deleteTestMethodToWorkItemLink(string, string, number)

Parametri

Restituisce

deleteTestRun(string, number)

Parametri

Restituisce

deleteTestSettings(string, number)

Parametri

Restituisce

getBugsLinkedToTestResult(string, number, number)

Parametri

Restituisce

getBuildCodeCoverage(string, number, number)

Parametri

Restituisce

getCodeCoverageSummary(string, number, number)

Parametri

Restituisce

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)

Parametri

Restituisce

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

Parametri

Restituisce

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

Parametri