TestRestClient class

Référence

Paquet:: azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des api REST VSS

Extends: RestClientBase

Constructeurs

TestRestClient(IVssRestClientOptions)

Propriétés

RESOURCE_AREA_ID

Méthodes

addCustomFields(CustomTestFieldDefinition[], string)
addTestCasesToSuite(string, number, number, string)	Ajoutez des cas de test à la suite.
addTestResultsToTestRun(TestCaseResult[], string, number)	Ajoutez les résultats d’un test à une série de tests.
addWorkItemToTestLinks(WorkItemToTestLinks, string)
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)	Joindre un fichier au résultat de l’étape de test
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)	Joignez un fichier à un résultat de test.
createTestRun(RunCreateModel, string)	Créez une série de tests.
createTestRunAttachment(TestAttachmentRequestModel, string, number)	Joignez un fichier à une série de tests.
createTestSession(TestSession, TeamContext)	Créer une session de test
createTestSettings(TestSettings, string)
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)	Joindre un fichier à un résultat de test
deleteSharedParameter(string, number)
deleteSharedStep(string, number)
deleteTestCase(string, number)	Supprimer un cas de test.
deleteTestMethodToWorkItemLink(string, string, number)
deleteTestRun(string, number)	Supprimez une série de tests par son ID.
deleteTestSettings(string, number)
getBugsLinkedToTestResult(string, number, number)
getBuildCodeCoverage(string, number, number)	Obtenir des données de couverture du code pour une build.
getCodeCoverageSummary(string, number, number)	Obtenir le résumé de la couverture du code pour la génération.
getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)
getPoint(string, number, number, number, string)	Obtenez un point de test.
getPoints(string, number, number, string, string, string, string, boolean, number, number)	Obtenez la liste des points de test.
getPointsByQuery(TestPointsQuery, string, number, number)	Obtenir des points de test à l’aide d’une requête.
getResultGroupsByBuild(string, number, string, string[], string)
getResultGroupsByRelease(string, number, string, number, string[], string)
getResultRetentionSettings(string)	Obtenir les paramètres de rétention des résultats des tests
getTestCaseById(string, number, number, number)	Obtenez un cas de test spécifique dans une suite de tests avec l’ID de cas de test.
getTestCases(string, number, number)	Obtenez tous les cas de test dans une suite.
getTestIteration(string, number, number, number, boolean)	Obtenir l’itération pour un résultat
getTestIterations(string, number, number, boolean)	Obtenir des itérations pour un résultat
getTestResultAttachmentContent(string, number, number, number)	Téléchargez une pièce jointe de résultat de test par son ID.
getTestResultAttachments(string, number, number)	Obtenir la liste des informations de référence sur les pièces jointes des résultats de test.
getTestResultAttachmentZip(string, number, number, number)	Téléchargez une pièce jointe de résultat de test par son ID.
getTestResultById(string, number, number, ResultDetails)	Obtenez un résultat de test pour une série de tests.
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[])	Obtenez les résultats d’un test pour une série de tests.
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByQuery(TestResultsQuery, string)	Cette API retourne les résultats par ID avec des champs spécifiés/tendance pour une méthode de test automatisée particulière. Nous améliorons toujours cette API et n’avons pas finalisé la signature et le contrat appropriés.
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
getTestRunAttachmentContent(string, number, number)	Téléchargez une pièce jointe de série de test en fonction de son ID.
getTestRunAttachments(string, number)	Obtenez la liste des pièces jointes de référence de série de test.
getTestRunAttachmentZip(string, number, number)	Téléchargez une pièce jointe de série de test en fonction de son ID.
getTestRunById(string, number, boolean)	Obtenez une série de tests par son ID.
getTestRunCodeCoverage(string, number, number)	Obtenir des données de couverture du code pour une série de tests
getTestRunLogs(string, number)	Obtenir les journaux des messages de la série de test
getTestRuns(string, string, string, string, number, boolean, boolean, number, number)	Obtenez la liste des séries de tests.
getTestRunStatistics(string, number)	Obtenez les statistiques de série de tests , utilisées lorsque nous voulons obtenir le résumé d’une exécution par résultat.
getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)	Obtenir la liste des sessions de test
getTestSettingsById(string, number)
getTestSubResultAttachmentContent(string, number, number, number, number)	Télécharger une pièce jointe de sous-résultat de test
getTestSubResultAttachments(string, number, number, number)	Obtenir la liste des pièces jointes de sous-résultat de test
getTestSubResultAttachmentZip(string, number, number, number, number)	Télécharger une pièce jointe de sous-résultat de test
publishTestResultDocument(TestResultDocument, string, number)
queryCustomFields(string, CustomTestFieldScope)
queryResultTrendForBuild(TestResultTrendFilter, string)
queryResultTrendForRelease(TestResultTrendFilter, string)
queryTestHistory(TestHistoryQuery, string)	Obtenir l’historique d’une méthode de test à l’aide de TestHistoryQuery
queryTestMethodLinkedWorkItems(string, string)
queryTestResultHistory(ResultsFilter, string)
queryTestResultsMetaData(string[], string)	Obtenir la liste des détails des métadonnées de résultat de test pour testcasereferenceId correspondant
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)	Exécutions de tests de requête basées sur des filtres. Les champs obligatoires sont minLastUpdatedDate et maxLastUpdatedDate.
queryTestSummaryByRequirement(TestResultsContext, string, number[])
removeTestCasesFromSuiteUrl(string, number, number, string)	Les points de test associés aux cas de test sont supprimés de la suite de tests. L’élément de travail du cas de test n’est pas supprimé du système. Consultez la ressource cas de test pour supprimer définitivement un cas de test.
updateCodeCoverageSummary(CodeCoverageData, string, number)	http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Demande : Json du résumé de la couverture du code
updateResultRetentionSettings(ResultRetentionSettings, string)	Mettre à jour les paramètres de rétention des résultats de test
updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)	Mises à jour les propriétés de l’association de cas de test dans une suite.
updateTestPoints(PointUpdateModel, string, number, number, string)	Mettre à jour les points de test.
updateTestResults(TestCaseResult[], string, number)	Mettre à jour les résultats d’un test dans une série de tests.
updateTestRun(RunUpdateModel, string, number)	Mettez à jour l’exécution de test à l’aide de son ID.
updateTestSession(TestSession, TeamContext)	Mettre à jour une session de test

Détails du constructeur

TestRestClient(IVssRestClientOptions)

new TestRestClient(options: IVssRestClientOptions)

Paramètres

options: IVssRestClientOptions

Détails de la propriété

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valeur de propriété

string

Détails de la méthode

addCustomFields(CustomTestFieldDefinition[], string)

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

Paramètres

newFields: CustomTestFieldDefinition[]

project: string

ID de projet ou nom du projet

Retours

Promise<CustomTestFieldDefinition[]>

addTestCasesToSuite(string, number, number, string)

Ajoutez des cas de test à la suite.

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

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test qui contient la suite.

suiteId: number

ID de la suite de tests à laquelle les cas de test doivent être ajoutés.

testCaseIds: string

ID des cas de test à ajouter à la suite. Les ID sont spécifiés dans un format séparé par des virgules.

Retours

Promise<SuiteTestCase[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

Ajoutez les résultats d’un test à une série de tests.

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

Paramètres

results: TestCaseResult[]

Liste des résultats de test à ajouter.

project: string

ID de projet ou nom du projet

runId: number

ID de série de test dans lequel les résultats de test à ajouter.

Retours

Promise<TestCaseResult[]>

addWorkItemToTestLinks(WorkItemToTestLinks, string)

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

Paramètres

workItemToTestLinks: WorkItemToTestLinks

project: string

ID de projet ou nom du projet

Retours

Promise<WorkItemToTestLinks>

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

Joindre un fichier au résultat de l’étape de test

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

Paramètres

attachmentRequestModel: TestAttachmentRequestModel

Détails de la pièce jointe TestAttachmentRequestModel

project: string

ID de projet ou nom du projet

runId: number

ID de la série de tests qui contient le résultat.

testCaseResultId: number

ID du résultat du test qui contient l’itération

iterationId: number

ID de l’itération du résultat du test.

actionPath: string

Valeur hexadécimal du chemin d’action des résultats de test.

Retours

Promise<TestAttachmentReference>

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Joignez un fichier à un résultat de test.

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

Paramètres

attachmentRequestModel: TestAttachmentRequestModel

Détails de la pièce jointe TestAttachmentRequestModel

project: string

ID de projet ou nom du projet

runId: number

ID de la série de tests qui contient le résultat.

testCaseResultId: number

ID du résultat du test sur lequel la pièce jointe doit être chargée.

Retours

Promise<TestAttachmentReference>

createTestRun(RunCreateModel, string)

Créez une série de tests.

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

Paramètres

testRun: RunCreateModel

Détails de l’exécution RunCreateModel

project: string

ID de projet ou nom du projet

Retours

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Joignez un fichier à une série de tests.

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

Paramètres

attachmentRequestModel: TestAttachmentRequestModel

Détails de la pièce jointe TestAttachmentRequestModel

project: string

ID de projet ou nom du projet

runId: number

ID de la série de tests sur laquelle la pièce jointe doit être chargée.

Retours

Promise<TestAttachmentReference>

createTestSession(TestSession, TeamContext)

Créer une session de test

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

Paramètres

testSession: TestSession

Détails de la session de test pour la création

teamContext: TeamContext

Contexte d’équipe de l’opération

Retours

Promise<TestSession>

createTestSettings(TestSettings, string)

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

Paramètres

testSettings: TestSettings

project: string

ID de projet ou nom du projet

Retours

Promise<number>

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

Joindre un fichier à un résultat de test

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

Paramètres

attachmentRequestModel: TestAttachmentRequestModel

Modèle de demande de pièces jointes.

project: string

ID de projet ou nom du projet

runId: number

ID de la série de tests qui contient le résultat.

testCaseResultId: number

ID des résultats du test qui contient le sous-résultat.

testSubResultId: number

ID des sous-résultats de test sur lesquels la pièce jointe doit être chargée.

Retours

Promise<TestAttachmentReference>

deleteSharedParameter(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

sharedParameterId: number

Retours

Promise<void>

deleteSharedStep(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

sharedStepId: number

Retours

Promise<void>

deleteTestCase(string, number)

Supprimer un cas de test.

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

Paramètres

project: string

ID de projet ou nom du projet

testCaseId: number

ID du cas de test à supprimer.

Retours

Promise<void>

deleteTestMethodToWorkItemLink(string, string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

testName: string

workItemId: number

Retours

Promise<boolean>

deleteTestRun(string, number)

Supprimez une série de tests par son ID.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de l’exécution à supprimer.

Retours

Promise<void>

deleteTestSettings(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

testSettingsId: number

Retours

Promise<void>

getBugsLinkedToTestResult(string, number, number)

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

testCaseResultId: number

Retours

Promise<WorkItemReference[]>

getBuildCodeCoverage(string, number, number)

Obtenir des données de couverture du code pour une build.

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

ID de la build pour laquelle les données de couverture du code doivent être extraites.

flags: number

La valeur des indicateurs détermine le niveau de détails de couverture du code à extraire. Les indicateurs sont additifs. Les valeurs attendues sont 1 pour les modules, 2 pour functions et 4 pour BlockData.

Retours

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

Obtenir le résumé de la couverture du code pour la génération.

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

ID de la build pour laquelle les données de couverture du code doivent être extraites.

deltaBuildId: number

Id de build Delta (facultatif)

Retours

Promise<CodeCoverageSummary>

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)

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

Paramètres

workItemQuery: LinkedWorkItemsQuery

project: string

ID de projet ou nom du projet

Retours

Promise<LinkedWorkItemsQueryResult[]>

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

Obtenez un point de test.

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

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test.

suiteId: number

ID de la suite qui contient le point.

pointIds: number

ID du point de test à obtenir.

witFields: string

Liste séparée par des virgules des noms de champs d’éléments de travail.

Retours

Promise<TestPoint>

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

Obtenez la liste des points de 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[]>

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test.

suiteId: number

ID de la suite qui contient les points.

witFields: string

Liste séparée par des virgules des noms de champs d’éléments de travail.

configurationId: string

Obtenez des points de test pour une configuration spécifique.

testCaseId: string

Obtenez des points de test pour un cas de test spécifique, valides lorsque configurationId n’est pas défini.

testPointIds: string

Obtenez des points de test pour la liste séparée par des virgules d’ID de points de test, valides uniquement lorsque configurationId et testCaseId ne sont pas définis.

includePointDetails: boolean

Incluez toutes les propriétés du point de test.

skip: number

Nombre de points de test à ignorer..

top: number

Nombre de points de test à retourner.

Retours

Promise<TestPoint[]>

getPointsByQuery(TestPointsQuery, string, number, number)

Obtenir des points de test à l’aide d’une requête.

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

Paramètres

query: TestPointsQuery

TestPointsQuery pour obtenir des points de test.

project: string

ID de projet ou nom du projet

skip: number

Nombre de points de test à ignorer..

top: number

Nombre de points de test à retourner.

Retours

Promise<TestPointsQuery>

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

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

publishContext: string

fields: string[]

continuationToken: string

Retours

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

publishContext: string

releaseEnvId: number

fields: string[]

continuationToken: string

Retours

Promise<PagedList<FieldDetailsForTestResults>>

getResultRetentionSettings(string)

Obtenir les paramètres de rétention des résultats des tests

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

Paramètres

project: string

ID de projet ou nom du projet

Retours

Promise<ResultRetentionSettings>

getTestCaseById(string, number, number, number)

Obtenez un cas de test spécifique dans une suite de tests avec l’ID de cas de test.

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

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test qui contient les suites.

suiteId: number

ID de la suite qui contient le cas de test.

testCaseIds: number

ID du cas de test à obtenir.

Retours

Promise<SuiteTestCase>

getTestCases(string, number, number)

Obtenez tous les cas de test dans une suite.

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

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test qui contient les suites.

suiteId: number

ID de la suite à obtenir.

Retours

Promise<SuiteTestCase[]>

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

Obtenir l’itération pour un résultat

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de la série de tests qui contient le résultat.

testCaseResultId: number

ID du résultat du test qui contient les itérations.

iterationId: number

ID de l’itération des résultats du test.

includeActionResults: boolean

Incluez les détails des résultats pour chaque action effectuée dans l’itération de test. ActionResults fait référence au résultat (réussite/échec) des étapes de test exécutées dans le cadre d’un test manuel. L’inclusion de l’indicateur ActionResults obtient le résultat des étapes de test dans la section actionResults et les paramètres de test dans la section paramètres pour chaque itération de test.

Retours

Promise<TestIterationDetailsModel>

getTestIterations(string, number, number, boolean)

Obtenir des itérations pour un résultat

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de la série de tests qui contient le résultat.

testCaseResultId: number

ID du résultat du test qui contient les itérations.

includeActionResults: boolean

Retours

Promise<TestIterationDetailsModel[]>

getTestResultAttachmentContent(string, number, number, number)

Téléchargez une pièce jointe de résultat de test par son ID.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de la série de tests qui contient le testCaseResultId.

testCaseResultId: number

ID du résultat du test dont la pièce jointe doit être téléchargée.

attachmentId: number

ID de la pièce jointe de résultat de test à télécharger.

Retours

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

Obtenir la liste des informations de référence sur les pièces jointes des résultats de test.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de la série de tests qui contient le résultat.

testCaseResultId: number

ID du résultat du test.

Retours

Promise<TestAttachment[]>

getTestResultAttachmentZip(string, number, number, number)

Téléchargez une pièce jointe de résultat de test par son ID.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de la série de tests qui contient le testCaseResultId.

testCaseResultId: number

ID du résultat du test dont la pièce jointe doit être téléchargée.

attachmentId: number

ID de la pièce jointe de résultat de test à télécharger.

Retours

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

Obtenez un résultat de test pour une série de tests.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de série de test d’un résultat de test à extraire.

testCaseResultId: number

ID de résultat du test.

detailsToInclude: ResultDetails

Détails à inclure dans les résultats des tests. La valeur par défaut est None. Les autres valeurs sont Itérations, WorkItems et SubResults.

Retours

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>

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Retours

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>

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

releaseEnvId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Retours

Promise<TestResultsDetails>

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

Obtenez les résultats d’un test pour une série de tests.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID d’exécution de test des résultats de test à extraire.

detailsToInclude: ResultDetails

Détails à inclure dans les résultats des tests. La valeur par défaut est None. Les autres valeurs sont Itérations et WorkItems.

skip: number

Nombre de résultats de test à ignorer depuis le début.

top: number

Nombre de résultats de test à retourner. La valeur maximale est 1000 lorsque detailsToInclude a la valeur None et 200 dans le cas contraire.

outcomes: TestOutcome[]

Liste séparée par des virgules des résultats des tests pour filtrer les résultats des tests.

Retours

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Retours

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsByQuery(TestResultsQuery, string)

Cette API retourne les résultats par ID avec des champs spécifiés/tendance pour une méthode de test automatisée particulière. Nous améliorons toujours cette API et n’avons pas finalisé la signature et le contrat appropriés.

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

Paramètres

query: TestResultsQuery

project: string

ID de projet ou nom du projet

Retours

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

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

releaseEnvid: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Retours

Promise<PagedList<ShallowTestCaseResult>>

getTestRunAttachmentContent(string, number, number)

Téléchargez une pièce jointe de série de test en fonction de son ID.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de la série de tests dont la pièce jointe doit être téléchargée.

attachmentId: number

ID de la pièce jointe de la série de tests à télécharger.

Retours

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

Obtenez la liste des pièces jointes de référence de série de test.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de la série de tests.

Retours

Promise<TestAttachment[]>

getTestRunAttachmentZip(string, number, number)

Téléchargez une pièce jointe de série de test en fonction de son ID.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de la série de tests dont la pièce jointe doit être téléchargée.

attachmentId: number

ID de la pièce jointe de la série de tests à télécharger.

Retours

Promise<ArrayBuffer>

getTestRunById(string, number, boolean)

Obtenez une série de tests par son ID.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de l’exécution à obtenir.

includeDetails: boolean

La valeur par défaut est true. Il comprend des détails tels que les statistiques d’exécution, la mise en production, la build, l’environnement de test, l’état post-processus, etc.

Retours

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

Obtenir des données de couverture du code pour une série de tests

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de la série de tests pour laquelle les données de couverture du code doivent être extraites.

flags: number

Retours

Promise<TestRunCoverage[]>

getTestRunLogs(string, number)

Obtenir les journaux des messages de la série de test

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de l’exécution à obtenir.

Retours

Promise<TestMessageLogDetails[]>

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

Obtenez la liste des séries de tests.

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

Paramètres

project: string

ID de projet ou nom du projet

buildUri: string

URI de la build utilisée par l’exécution.

owner: string

ID de base d’équipe du propriétaire des exécutions.

tmiRunId: string

planId: number

ID du plan de test dont les exécutions font partie.

includeRunDetails: boolean

Si la valeur est true, incluez toutes les propriétés des exécutions.

automated: boolean

Si la valeur est true, retourne uniquement les exécutions automatisées.

skip: number

Nombre de séries de tests à ignorer.

top: number

Nombre de séries de tests à retourner.

Retours

Promise<TestRun[]>

getTestRunStatistics(string, number)

Obtenez les statistiques de série de tests , utilisées lorsque nous voulons obtenir le résumé d’une exécution par résultat.

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de l’exécution à obtenir.

Retours

Promise<TestRunStatistic>

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

Obtenir la liste des sessions de test

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

Paramètres

teamContext: TeamContext

Contexte d’équipe de l’opération

period: number

Période en jours à partir de laquelle les sessions de test sont extraites.

allSessions: boolean

Si la valeur est false, retourne des sessions de test pour l’utilisateur actuel. Sinon, il retourne des sessions de test pour tous les utilisateurs

includeAllProperties: boolean

Si la valeur est true, elle retourne toutes les propriétés des sessions de test. Sinon, il retourne la version maigre.

source: TestSessionSource

Source de la session de test.

includeOnlyCompletedSessions: boolean

Si la valeur est true, elle retourne les sessions de test à l’état terminé. Sinon, il retourne des sessions de test pour tous les états

Retours

Promise<TestSession[]>

getTestSettingsById(string, number)

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

Paramètres

project: string

ID de projet ou nom du projet

testSettingsId: number

Retours

Promise<TestSettings>

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

Télécharger une pièce jointe de sous-résultat de test

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de la série de tests qui contient le résultat.

testCaseResultId: number

ID des résultats du test qui contient le sous-résultat.

attachmentId: number

ID de la pièce jointe de résultat de test à télécharger

testSubResultId: number

ID du sous-résultat de test dont la pièce jointe doit être téléchargée

Retours

Promise<ArrayBuffer>

getTestSubResultAttachments(string, number, number, number)

Obtenir la liste des pièces jointes de sous-résultat de test

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de la série de tests qui contient le résultat.

testCaseResultId: number

ID des résultats du test qui contient le sous-résultat.

testSubResultId: number

ID du sous-résultat de test dont la pièce jointe doit être téléchargée

Retours

Promise<TestAttachment[]>

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

Télécharger une pièce jointe de sous-résultat de test

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

Paramètres

project: string

ID de projet ou nom du projet

runId: number

ID de la série de tests qui contient le résultat.

testCaseResultId: number

ID des résultats du test qui contient le sous-résultat.

attachmentId: number

ID de la pièce jointe de résultat de test à télécharger

testSubResultId: number

ID du sous-résultat de test dont la pièce jointe doit être téléchargée

Retours

Promise<ArrayBuffer>

publishTestResultDocument(TestResultDocument, string, number)

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

Paramètres

document: TestResultDocument

project: string

ID de projet ou nom du projet

runId: number

Retours

Promise<TestResultDocument>

queryCustomFields(string, CustomTestFieldScope)

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

Paramètres

project: string

ID de projet ou nom du projet

scopeFilter: CustomTestFieldScope

Retours

Promise<CustomTestFieldDefinition[]>

queryResultTrendForBuild(TestResultTrendFilter, string)

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

Paramètres

filter: TestResultTrendFilter

project: string

ID de projet ou nom du projet

Retours

Promise<AggregatedDataForResultTrend[]>

queryResultTrendForRelease(TestResultTrendFilter, string)

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

Paramètres

filter: TestResultTrendFilter

project: string

ID de projet ou nom du projet

Retours

Promise<AggregatedDataForResultTrend[]>

queryTestHistory(TestHistoryQuery, string)

Obtenir l’historique d’une méthode de test à l’aide de TestHistoryQuery

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

Paramètres

filter: TestHistoryQuery

TestHistoryQuery pour obtenir l’historique

project: string

ID de projet ou nom du projet

Retours

Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems(string, string)

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

Paramètres

project: string

ID de projet ou nom du projet

testName: string

Retours

Promise<TestToWorkItemLinks>

queryTestResultHistory(ResultsFilter, string)

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

Paramètres

filter: ResultsFilter

project: string

ID de projet ou nom du projet

Retours

Promise<TestResultHistory>

queryTestResultsMetaData(string[], string)

Obtenir la liste des détails des métadonnées de résultat de test pour testcasereferenceId correspondant

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

Paramètres

testReferenceIds: string[]

Ids TestCaseReference du résultat du test à interroger, liste séparée par des virgules des id valides (limite no. des ids 200).

project: string

ID de projet ou nom du projet

Retours

Promise<TestResultMetaData[]>

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

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

Paramètres

project: string

ID de projet ou nom du projet

buildId: number

publishContext: string

includeFailureDetails: boolean

buildToCompare: BuildReference

Retours

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>

Paramètres

project: string

ID de projet ou nom du projet

releaseId: number

releaseEnvId: number

publishContext: string

includeFailureDetails: boolean

releaseToCompare: ReleaseReference

Retours

Promise<TestResultSummary>

queryTestResultsSummaryForReleases(ReleaseReference[], string)

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

Paramètres

releases: ReleaseReference[]

project: string

ID de projet ou nom du projet

Retours

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

Paramètres

project: string

ID de projet ou nom du projet

workItemCategory: string

automatedTestName: string

testCaseId: number

maxCompleteDate: Date

days: number

workItemCount: number

Retours

Promise<WorkItemReference[]>

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

Exécutions de tests de requête basées sur des filtres. Les champs obligatoires sont minLastUpdatedDate et 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>>

Paramètres

project: string

ID de projet ou nom du projet

minLastUpdatedDate: Date

Date minimale de dernière modification de l’exécution à interroger (obligatoire).

maxLastUpdatedDate: Date

Date maximale de dernière modification de l’exécution à interroger (Obligatoire, la différence entre la date minimale et la date maximale peut être de 7 jours maximum).

state: TestRunState

État actuel des exécutions à interroger.

planIds: number[]

Plan IDs de la liste Exécutions à interroger, liste séparée par des virgules d’ID valides (limite no. des ids 10).

isAutomated: boolean

Type Automation des exécutions à interroger.

publishContext: TestRunPublishContext

PublishContext des exécutions à interroger.

buildIds: number[]

Id de build des exécutions à interroger, liste séparée par des virgules d’ID valides (limite no. des ids 10).

buildDefIds: number[]

Id de définition de build des exécutions à interroger, liste séparée par des virgules des id valides (limite no. des ids 10).

branchName: string

Nom de la branche source des exécutions à interroger.

releaseIds: number[]

Id de publication des exécutions à interroger, liste séparée par des virgules d’ID valides (limite no. des ids 10).

releaseDefIds: number[]

Libérer les ID de définition des exécutions à interroger, liste séparée par des virgules des ID valides (limite no. des ids 10).

releaseEnvIds: number[]

Libérer les ID d’environnement des exécutions à interroger, liste séparée par des virgules des ID valides (limite no. des ID 10).

releaseEnvDefIds: number[]

Libérer les ID de définition d’environnement des exécutions à interroger, liste séparée par des virgules des ID valides (limite no. des ids 10).

runTitle: string

Titre d’exécution des exécutions à interroger.

top: number

Nombre d’exécutions à interroger. La limite est de 100

continuationToken: string

continuationToken reçu à partir du lot précédent ou null pour le premier lot. Il n’est pas censé être créé (ou modifié, s’il est reçu à partir du dernier lot) par l’utilisateur.

Retours

Promise<PagedList<TestRun>>

queryTestSummaryByRequirement(TestResultsContext, string, number[])

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

Paramètres

resultsContext: TestResultsContext

project: string

ID de projet ou nom du projet

workItemIds: number[]

Retours

Promise<TestSummaryForWorkItem[]>

removeTestCasesFromSuiteUrl(string, number, number, string)

Les points de test associés aux cas de test sont supprimés de la suite de tests. L’élément de travail du cas de test n’est pas supprimé du système. Consultez la ressource cas de test pour supprimer définitivement un cas de test.

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

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test qui contient la suite.

suiteId: number

ID de la suite à obtenir.

testCaseIds: string

ID des cas de test à supprimer de la suite.

Retours

Promise<void>

updateCodeCoverageSummary(CodeCoverageData, string, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Demande : Json du résumé de la couverture du code

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

Paramètres

coverageData: CodeCoverageData

project: string

ID de projet ou nom du projet

buildId: number

Retours

Promise<void>

updateResultRetentionSettings(ResultRetentionSettings, string)

Mettre à jour les paramètres de rétention des résultats de test

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

Paramètres

retentionSettings: ResultRetentionSettings

Détails des paramètres de rétention des résultats de test à mettre à jour

project: string

ID de projet ou nom du projet

Retours

Promise<ResultRetentionSettings>

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

Mises à jour les propriétés de l’association de cas de test dans une suite.

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

Paramètres

suiteTestCaseUpdateModel: SuiteTestCaseUpdateModel

Modèle de mise à jour des propriétés de l’association de suite de cas de test.

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test qui contient la suite.

suiteId: number

ID de la suite de tests à laquelle les cas de test doivent être ajoutés.

testCaseIds: string

ID des cas de test à ajouter à la suite. Les ID sont spécifiés dans un format séparé par des virgules.

Retours

Promise<SuiteTestCase[]>

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

Mettre à jour les points de test.

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

Paramètres

pointUpdateModel: PointUpdateModel

Données à mettre à jour.

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test.

suiteId: number

ID de la suite qui contient les points.

pointIds: string

ID du point de test à obtenir. Utilisez une liste d’ID séparés par des virgules pour mettre à jour plusieurs points de test.

Retours

Promise<TestPoint[]>

updateTestResults(TestCaseResult[], string, number)

Mettre à jour les résultats d’un test dans une série de tests.

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

Paramètres

results: TestCaseResult[]

Liste des résultats des tests à mettre à jour.

project: string

ID de projet ou nom du projet

runId: number

ID de la série de tests dont les résultats de test doivent être mis à jour.

Retours

Promise<TestCaseResult[]>

updateTestRun(RunUpdateModel, string, number)

Mettez à jour l’exécution de test à l’aide de son ID.

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

Paramètres

runUpdateModel: RunUpdateModel

Détails de l’exécution RunUpdateModel

project: string

ID de projet ou nom du projet

runId: number

ID de l’exécution à mettre à jour.

Retours

Promise<TestRun>

updateTestSession(TestSession, TeamContext)

Mettre à jour une session de test

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

Paramètres

testSession: TestSession

Détails de la session de test pour la mise à jour

teamContext: TeamContext

Contexte d’équipe de l’opération

Retours

Promise<TestSession>

Partager via

TestRestClient class

Constructeurs

Propriétés

Méthodes

Détails du constructeur

TestRestClient(IVssRestClientOptions)

Paramètres

Détails de la propriété

RESOURCE_AREA_ID

Valeur de propriété

Détails de la méthode

addCustomFields(CustomTestFieldDefinition[], string)

Paramètres

Retours

addTestCasesToSuite(string, number, number, string)

Paramètres

Retours

addTestResultsToTestRun(TestCaseResult[], string, number)

Paramètres

Retours

addWorkItemToTestLinks(WorkItemToTestLinks, string)

Paramètres

Retours

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

Paramètres

Retours

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Paramètres

Retours

createTestRun(RunCreateModel, string)

Paramètres

Retours

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Paramètres

Retours

createTestSession(TestSession, TeamContext)

Paramètres

Retours

createTestSettings(TestSettings, string)

Paramètres

Retours

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

Paramètres

Retours

deleteSharedParameter(string, number)

Paramètres

Retours

deleteSharedStep(string, number)

Paramètres

Retours

deleteTestCase(string, number)

Paramètres

Retours

deleteTestMethodToWorkItemLink(string, string, number)

Paramètres

Retours

deleteTestRun(string, number)

Paramètres

Retours

deleteTestSettings(string, number)

Paramètres

Retours

getBugsLinkedToTestResult(string, number, number)

Paramètres

Retours

getBuildCodeCoverage(string, number, number)

Paramètres

Retours

getCodeCoverageSummary(string, number, number)

Paramètres

Retours

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)

Paramètres

Retours

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

Paramètres

Retours

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

Paramètres