TestRestClient class

Referência

Pacote:: azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS

Extends: RestClientBase

Construtores

TestRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

addCustomFields(CustomTestFieldDefinition[], string)
addTestCasesToSuite(string, number, number, string)	Adicione casos de teste ao pacote.
addTestResultsToTestRun(TestCaseResult[], string, number)	Adicionar resultados de teste a uma execução de teste.
addWorkItemToTestLinks(WorkItemToTestLinks, string)
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)	Anexar um arquivo ao resultado da etapa de teste
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)	Anexe um arquivo a um resultado de teste.
createTestRun(RunCreateModel, string)	Crie uma nova execução de teste.
createTestRunAttachment(TestAttachmentRequestModel, string, number)	Anexe um arquivo a uma execução de teste.
createTestSession(TestSession, TeamContext)	Criar uma sessão de teste
createTestSettings(TestSettings, string)
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)	Anexar um arquivo a um resultado de teste
deleteSharedParameter(string, number)
deleteSharedStep(string, number)
deleteTestCase(string, number)	Exclua um caso de teste.
deleteTestMethodToWorkItemLink(string, string, number)
deleteTestRun(string, number)	Exclua uma execução de teste por sua ID.
deleteTestSettings(string, number)
getBugsLinkedToTestResult(string, number, number)
getBuildCodeCoverage(string, number, number)	Obter dados de cobertura de código para um build.
getCodeCoverageSummary(string, number, number)	Obter resumo de cobertura de código para build.
getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)
getPoint(string, number, number, number, string)	Obtenha um ponto de teste.
getPoints(string, number, number, string, string, string, string, boolean, number, number)	Obtenha uma lista de pontos de teste.
getPointsByQuery(TestPointsQuery, string, number, number)	Obtenha pontos de teste usando a consulta.
getResultGroupsByBuild(string, number, string, string[], string)
getResultGroupsByRelease(string, number, string, number, string[], string)
getResultRetentionSettings(string)	Obter configurações de retenção de resultados de teste
getTestCaseById(string, number, number, number)	Obtenha um caso de teste específico em um conjunto de testes com a ID do caso de teste.
getTestCases(string, number, number)	Obtenha todos os casos de teste em um pacote.
getTestIteration(string, number, number, number, boolean)	Obter iteração para um resultado
getTestIterations(string, number, number, boolean)	Obter iterações para um resultado
getTestResultAttachmentContent(string, number, number, number)	Baixe um anexo de resultado de teste por sua ID.
getTestResultAttachments(string, number, number)	Obter a lista de referência de anexos de resultado de teste.
getTestResultAttachmentZip(string, number, number, number)	Baixe um anexo de resultado de teste por sua ID.
getTestResultById(string, number, number, ResultDetails)	Obtenha um resultado de teste para uma execução de teste.
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[])	Obter resultados de teste para uma execução de teste.
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByQuery(TestResultsQuery, string)	Essa API retornará resultados por IDs com campos especificados/tendência para um método de teste automatizado específico. Ainda estamos melhorando essa API e não finalizamos a assinatura e o contrato adequados.
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
getTestRunAttachmentContent(string, number, number)	Baixe um anexo de execução de teste por sua ID.
getTestRunAttachments(string, number)	Obter a lista de referência de anexos de execução de teste.
getTestRunAttachmentZip(string, number, number)	Baixe um anexo de execução de teste por sua ID.
getTestRunById(string, number, boolean)	Obtenha uma execução de teste por sua ID.
getTestRunCodeCoverage(string, number, number)	Obter dados de cobertura de código para uma execução de teste
getTestRunLogs(string, number)	Obter logs de mensagens de execução de teste
getTestRuns(string, string, string, string, number, boolean, boolean, number, number)	Obtenha uma lista de execuções de teste.
getTestRunStatistics(string, number)	Obtenha estatísticas de execução de teste , usadas quando queremos obter o resumo de uma execução por resultado.
getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)	Obter uma lista de sessões de teste
getTestSettingsById(string, number)
getTestSubResultAttachmentContent(string, number, number, number, number)	Baixar um anexo de sub-resultado de teste
getTestSubResultAttachments(string, number, number, number)	Obter lista de anexos de sub-resultado de teste
getTestSubResultAttachmentZip(string, number, number, number, number)	Baixar um anexo de sub-resultado de teste
publishTestResultDocument(TestResultDocument, string, number)
queryCustomFields(string, CustomTestFieldScope)
queryResultTrendForBuild(TestResultTrendFilter, string)
queryResultTrendForRelease(TestResultTrendFilter, string)
queryTestHistory(TestHistoryQuery, string)	Obter o histórico de um método de teste usando TestHistoryQuery
queryTestMethodLinkedWorkItems(string, string)
queryTestResultHistory(ResultsFilter, string)
queryTestResultsMetaData(string[], string)	Obter lista de detalhes de metadados do resultado do teste para testcasereferenceId correspondente
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)	Execuções de teste de consulta com base em filtros. Os campos obrigatórios são minLastUpdatedDate e maxLastUpdatedDate.
queryTestSummaryByRequirement(TestResultsContext, string, number[])
removeTestCasesFromSuiteUrl(string, number, number, string)	Os pontos de teste associados aos casos de teste são removidos do conjunto de testes. O item de trabalho do caso de teste não é excluído do sistema. Confira o recurso de casos de teste para excluir um caso de teste permanentemente.
updateCodeCoverageSummary(CodeCoverageData, string, number)	http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Solicitação: Json do resumo da cobertura de código
updateResultRetentionSettings(ResultRetentionSettings, string)	Atualizar as configurações de retenção de resultado do teste
updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)	Atualizações as propriedades da associação de caso de teste em um pacote.
updateTestPoints(PointUpdateModel, string, number, number, string)	Atualizar pontos de teste.
updateTestResults(TestCaseResult[], string, number)	Atualizar os resultados do teste em uma execução de teste.
updateTestRun(RunUpdateModel, string, number)	Atualizar a execução de teste por sua ID.
updateTestSession(TestSession, TeamContext)	Atualizar uma sessão de teste

Detalhes do construtor

TestRestClient(IVssRestClientOptions)

new TestRestClient(options: IVssRestClientOptions)

Parâmetros

options: IVssRestClientOptions

Detalhes da propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor da propriedade

string

Detalhes do método

addCustomFields(CustomTestFieldDefinition[], string)

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

Parâmetros

newFields: CustomTestFieldDefinition[]

project: string

ID do projeto ou nome do projeto

Retornos

Promise<CustomTestFieldDefinition[]>

addTestCasesToSuite(string, number, number, string)

Adicione casos de teste ao pacote.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de teste que contém o pacote.

suiteId: number

ID do conjunto de testes ao qual os casos de teste devem ser adicionados.

testCaseIds: string

IDs dos casos de teste a serem adicionados ao pacote. As IDs são especificadas no formato separado por vírgulas.

Retornos

Promise<SuiteTestCase[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

Adicionar resultados de teste a uma execução de teste.

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

Parâmetros

results: TestCaseResult[]

Lista de resultados de teste a serem adicionados.

project: string

ID do projeto ou nome do projeto

runId: number

ID de execução de teste na qual os resultados do teste serão adicionados.

Retornos

Promise<TestCaseResult[]>

addWorkItemToTestLinks(WorkItemToTestLinks, string)

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

Parâmetros

workItemToTestLinks: WorkItemToTestLinks

project: string

ID do projeto ou nome do projeto

Retornos

Promise<WorkItemToTestLinks>

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

Anexar um arquivo ao resultado da etapa de teste

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

Parâmetros

attachmentRequestModel: TestAttachmentRequestModel

Detalhes do anexo TestAttachmentRequestModel

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução de teste que contém o resultado.

testCaseResultId: number

ID do resultado do teste que contém a iteração

iterationId: number

ID da iteração do resultado do teste.

actionPath: string

Valor hexadecimal do caminho da ação do resultado do teste.

Retornos

Promise<TestAttachmentReference>

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Anexe um arquivo a um resultado de teste.

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

Parâmetros

attachmentRequestModel: TestAttachmentRequestModel

Detalhes do anexo TestAttachmentRequestModel

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução de teste que contém o resultado.

testCaseResultId: number

ID do resultado do teste em relação ao qual o anexo deve ser carregado.

Retornos

Promise<TestAttachmentReference>

createTestRun(RunCreateModel, string)

Crie uma nova execução de teste.

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

Parâmetros

testRun: RunCreateModel

Detalhes da execução RunCreateModel

project: string

ID do projeto ou nome do projeto

Retornos

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Anexe um arquivo a uma execução de teste.

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

Parâmetros

attachmentRequestModel: TestAttachmentRequestModel

Detalhes do anexo TestAttachmentRequestModel

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução de teste na qual o anexo deve ser carregado.

Retornos

Promise<TestAttachmentReference>

createTestSession(TestSession, TeamContext)

Criar uma sessão de teste

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

Parâmetros

testSession: TestSession

Detalhes da sessão de teste para criação

teamContext: TeamContext

O contexto da equipe para a operação

Retornos

Promise<TestSession>

createTestSettings(TestSettings, string)

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

Parâmetros

testSettings: TestSettings

project: string

ID do projeto ou nome do projeto

Retornos

Promise<number>

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

Anexar um arquivo a um resultado de teste

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

Parâmetros

attachmentRequestModel: TestAttachmentRequestModel

Modelo de solicitação de anexo.

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução de teste que contém o resultado.

testCaseResultId: number

ID dos resultados do teste que contém o sub-resultado.

testSubResultId: number

ID dos sub-resultados do teste em relação ao qual o anexo deve ser carregado.

Retornos

Promise<TestAttachmentReference>

deleteSharedParameter(string, number)

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

Parâmetros

project: string

ID do projeto ou nome do projeto

sharedParameterId: number

Retornos

Promise<void>

deleteSharedStep(string, number)

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

Parâmetros

project: string

ID do projeto ou nome do projeto

sharedStepId: number

Retornos

Promise<void>

deleteTestCase(string, number)

Exclua um caso de teste.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

testCaseId: number

ID do caso de teste a ser excluído.

Retornos

Promise<void>

deleteTestMethodToWorkItemLink(string, string, number)

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

Parâmetros

project: string

ID do projeto ou nome do projeto

testName: string

workItemId: number

Retornos

Promise<boolean>

deleteTestRun(string, number)

Exclua uma execução de teste por sua ID.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução a ser excluída.

Retornos

Promise<void>

deleteTestSettings(string, number)

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

Parâmetros

project: string

ID do projeto ou nome do projeto

testSettingsId: number

Retornos

Promise<void>

getBugsLinkedToTestResult(string, number, number)

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

testCaseResultId: number

Retornos

Promise<WorkItemReference[]>

getBuildCodeCoverage(string, number, number)

Obter dados de cobertura de código para um build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

ID do build para o qual os dados de cobertura de código precisam ser buscados.

flags: number

O valor dos sinalizadores determina o nível de detalhes de cobertura de código a ser buscado. Os sinalizadores são aditivos. Os valores esperados são 1 para Módulos, 2 para Funções, 4 para BlockData.

Retornos

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

Obter resumo de cobertura de código para build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

ID do build para o qual os dados de cobertura de código precisam ser buscados.

deltaBuildId: number

ID do Build Delta (opcional)

Retornos

Promise<CodeCoverageSummary>

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)

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

Parâmetros

workItemQuery: LinkedWorkItemsQuery

project: string

ID do projeto ou nome do projeto

Retornos

Promise<LinkedWorkItemsQueryResult[]>

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

Obtenha um ponto de teste.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de teste.

suiteId: number

ID do pacote que contém o ponto.

pointIds: number

ID do ponto de teste a ser obtido.

witFields: string

Lista separada por vírgulas de nomes de campo de item de trabalho.

Retornos

Promise<TestPoint>

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

Obtenha uma lista de pontos de teste.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de teste.

suiteId: number

ID do pacote que contém os pontos.

witFields: string

Lista separada por vírgulas de nomes de campo de item de trabalho.

configurationId: string

Obtenha pontos de teste para uma configuração específica.

testCaseId: string

Obtenha pontos de teste para um caso de teste específico, válido quando configurationId não está definido.

testPointIds: string

Obtenha pontos de teste para uma lista separada por vírgulas de IDs de ponto de teste, válida somente quando configurationId e testCaseId não estiverem definidos.

includePointDetails: boolean

Inclua todas as propriedades do ponto de teste.

skip: number

Número de pontos de teste a serem ignoradas.

top: number

Número de pontos de teste a serem retornados.

Retornos

Promise<TestPoint[]>

getPointsByQuery(TestPointsQuery, string, number, number)

Obtenha pontos de teste usando a consulta.

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

Parâmetros

query: TestPointsQuery

TestPointsQuery para obter pontos de teste.

project: string

ID do projeto ou nome do projeto

skip: number

Número de pontos de teste a serem ignoradas.

top: number

Número de pontos de teste a serem retornados.

Retornos

Promise<TestPointsQuery>

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

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

publishContext: string

fields: string[]

continuationToken: string

Retornos

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

Parâmetros

project: string

ID do projeto ou nome do projeto

releaseId: number

publishContext: string

releaseEnvId: number

fields: string[]

continuationToken: string

Retornos

Promise<PagedList<FieldDetailsForTestResults>>

getResultRetentionSettings(string)

Obter configurações de retenção de resultados de teste

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

Parâmetros

project: string

ID do projeto ou nome do projeto

Retornos

Promise<ResultRetentionSettings>

getTestCaseById(string, number, number, number)

Obtenha um caso de teste específico em um conjunto de testes com a ID do caso de teste.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de teste que contém os pacotes.

suiteId: number

ID do pacote que contém o caso de teste.

testCaseIds: number

ID do caso de teste a ser obtido.

Retornos

Promise<SuiteTestCase>

getTestCases(string, number, number)

Obtenha todos os casos de teste em um pacote.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de teste que contém os pacotes.

suiteId: number

ID da suíte a ser obtido.

Retornos

Promise<SuiteTestCase[]>

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

Obter iteração para um resultado

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução de teste que contém o resultado.

testCaseResultId: number

ID do resultado do teste que contém as iterações.

iterationId: number

Id dos resultados do teste Iteração.

includeActionResults: boolean

Inclua detalhes de resultado para cada ação executada na iteração de teste. ActionResults refere-se ao resultado (aprovação/falha) das etapas de teste executadas como parte de um teste manual em execução. A inclusão do sinalizador ActionResults obtém o resultado das etapas de teste na seção actionResults e os parâmetros de teste na seção de parâmetros para cada iteração de teste.

Retornos

Promise<TestIterationDetailsModel>

getTestIterations(string, number, number, boolean)

Obter iterações para um resultado

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução de teste que contém o resultado.

testCaseResultId: number

ID do resultado do teste que contém as iterações.

includeActionResults: boolean

Retornos

Promise<TestIterationDetailsModel[]>

getTestResultAttachmentContent(string, number, number, number)

Baixe um anexo de resultado de teste por sua ID.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução de teste que contém testCaseResultId.

testCaseResultId: number

ID do resultado do teste cujo anexo deve ser baixado.

attachmentId: number

ID do anexo de resultado do teste a ser baixado.

Retornos

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

Obter a lista de referência de anexos de resultado de teste.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução de teste que contém o resultado.

testCaseResultId: number

ID do resultado do teste.

Retornos

Promise<TestAttachment[]>

getTestResultAttachmentZip(string, number, number, number)

Baixe um anexo de resultado de teste por sua ID.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução de teste que contém testCaseResultId.

testCaseResultId: number

ID do resultado do teste cujo anexo deve ser baixado.

attachmentId: number

ID do anexo de resultado do teste a ser baixado.

Retornos

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

Obtenha um resultado de teste para uma execução de teste.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

Testar a ID de execução de um resultado de teste a ser buscado.

testCaseResultId: number

ID do resultado do teste.

detailsToInclude: ResultDetails

Detalhes a serem incluídos com os resultados do teste. O padrão é None. Outros valores são Iterações, WorkItems e SubResults.

Retornos

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>

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Retornos

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>

Parâmetros

project: string

ID do projeto ou nome do projeto

releaseId: number

releaseEnvId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Retornos

Promise<TestResultsDetails>

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

Obter resultados de teste para uma execução de teste.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

Testar a ID de execução dos resultados do teste a serem buscados.

detailsToInclude: ResultDetails

Detalhes a serem incluídos com os resultados do teste. O padrão é None. Outros valores são iterações e WorkItems.

skip: number

Número de resultados de teste a serem ignoradas desde o início.

top: number

Número de resultados de teste a serem retornados. O máximo é 1000 quando detailsToInclude for None e 200 caso contrário.

outcomes: TestOutcome[]

Lista separada por vírgulas de resultados de teste para filtrar os resultados do teste.

Retornos

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Retornos

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsByQuery(TestResultsQuery, string)

Essa API retornará resultados por IDs com campos especificados/tendência para um método de teste automatizado específico. Ainda estamos melhorando essa API e não finalizamos a assinatura e o contrato adequados.

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

Parâmetros

query: TestResultsQuery

project: string

ID do projeto ou nome do projeto

Retornos

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

Parâmetros

project: string

ID do projeto ou nome do projeto

releaseId: number

releaseEnvid: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Retornos

Promise<PagedList<ShallowTestCaseResult>>

getTestRunAttachmentContent(string, number, number)

Baixe um anexo de execução de teste por sua ID.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução de teste cujo anexo deve ser baixado.

attachmentId: number

ID do anexo de execução de teste a ser baixado.

Retornos

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

Obter a lista de referência de anexos de execução de teste.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução do teste.

Retornos

Promise<TestAttachment[]>

getTestRunAttachmentZip(string, number, number)

Baixe um anexo de execução de teste por sua ID.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução de teste cujo anexo deve ser baixado.

attachmentId: number

ID do anexo de execução de teste a ser baixado.

Retornos

Promise<ArrayBuffer>

getTestRunById(string, number, boolean)

Obtenha uma execução de teste por sua ID.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução a ser obtido.

includeDetails: boolean

O valor padrão é true. Ele inclui detalhes como estatísticas de execução, versão, build, ambiente de teste, estado pós-processo e muito mais.

Retornos

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

Obter dados de cobertura de código para uma execução de teste

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução de teste para a qual os dados de cobertura de código precisam ser buscados.

flags: number

O valor dos sinalizadores determina o nível de detalhes de cobertura de código a serem buscados. Os sinalizadores são aditivos. Os valores esperados são 1 para Módulos, 2 para Funções, 4 para BlockData.

Retornos

Promise<TestRunCoverage[]>

getTestRunLogs(string, number)

Obter logs de mensagens de execução de teste

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução a ser obtido.

Retornos

Promise<TestMessageLogDetails[]>

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

Obtenha uma lista de execuções de teste.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildUri: string

URI do build usado pelas execuções.

owner: string

ID da base de equipe do proprietário das execuções.

tmiRunId: string

planId: number

ID do plano de teste do qual as execuções fazem parte.

includeRunDetails: boolean

Se for true, inclua todas as propriedades das execuções.

automated: boolean

Se true, retorna apenas execuções automatizadas.

skip: number

Número de execuções de teste a serem ignoradas.

top: number

Número de execuções de teste a serem retornadas.

Retornos

Promise<TestRun[]>

getTestRunStatistics(string, number)

Obtenha estatísticas de execução de teste , usadas quando queremos obter o resumo de uma execução por resultado.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução a ser obtido.

Retornos

Promise<TestRunStatistic>

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

Obter uma lista de sessões de teste

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

Parâmetros

teamContext: TeamContext

O contexto da equipe para a operação

period: number

Período em dias a partir de agora, para o qual as sessões de teste são buscadas.

allSessions: boolean

Se for false, retornará sessões de teste para o usuário atual. Caso contrário, ele retornará sessões de teste para todos os usuários

includeAllProperties: boolean

Se for true, ele retornará todas as propriedades das sessões de teste. Caso contrário, ele retornará a versão skinny.

source: TestSessionSource

Origem da sessão de teste.

includeOnlyCompletedSessions: boolean

Se for true, ele retornará sessões de teste no estado concluído. Caso contrário, ele retornará sessões de teste para todos os estados

Retornos

Promise<TestSession[]>

getTestSettingsById(string, number)

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

Parâmetros

project: string

ID do projeto ou nome do projeto

testSettingsId: number

Retornos

Promise<TestSettings>

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

Baixar um anexo de sub-resultado de teste

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução de teste que contém o resultado.

testCaseResultId: number

ID dos resultados do teste que contém o sub-resultado.

attachmentId: number

ID do anexo de resultado do teste a ser baixado

testSubResultId: number

ID do sub resulto de teste cujo anexo deve ser baixado

Retornos

Promise<ArrayBuffer>

getTestSubResultAttachments(string, number, number, number)

Obter lista de anexos de sub-resultado de teste

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução de teste que contém o resultado.

testCaseResultId: number

ID dos resultados do teste que contém o sub-resultado.

testSubResultId: number

ID do sub resulto de teste cujo anexo deve ser baixado

Retornos

Promise<TestAttachment[]>

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

Baixar um anexo de sub-resultado de teste

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

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução de teste que contém o resultado.

testCaseResultId: number

ID dos resultados do teste que contém o sub-resultado.

attachmentId: number

ID do anexo de resultado do teste a ser baixado

testSubResultId: number

ID do sub resulto de teste cujo anexo deve ser baixado

Retornos

Promise<ArrayBuffer>

publishTestResultDocument(TestResultDocument, string, number)

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

Parâmetros

document: TestResultDocument

project: string

ID do projeto ou nome do projeto

runId: number

Retornos

Promise<TestResultDocument>

queryCustomFields(string, CustomTestFieldScope)

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

Parâmetros

project: string

ID do projeto ou nome do projeto

scopeFilter: CustomTestFieldScope

Retornos

Promise<CustomTestFieldDefinition[]>

queryResultTrendForBuild(TestResultTrendFilter, string)

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

Parâmetros

filter: TestResultTrendFilter

project: string

ID do projeto ou nome do projeto

Retornos

Promise<AggregatedDataForResultTrend[]>

queryResultTrendForRelease(TestResultTrendFilter, string)

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

Parâmetros

filter: TestResultTrendFilter

project: string

ID do projeto ou nome do projeto

Retornos

Promise<AggregatedDataForResultTrend[]>

queryTestHistory(TestHistoryQuery, string)

Obter o histórico de um método de teste usando TestHistoryQuery

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

Parâmetros

filter: TestHistoryQuery

TestHistoryQuery para obter o histórico

project: string

ID do projeto ou nome do projeto

Retornos

Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems(string, string)

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

Parâmetros

project: string

ID do projeto ou nome do projeto

testName: string

Retornos

Promise<TestToWorkItemLinks>

queryTestResultHistory(ResultsFilter, string)

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

Parâmetros

filter: ResultsFilter

project: string

ID do projeto ou nome do projeto

Retornos

Promise<TestResultHistory>

queryTestResultsMetaData(string[], string)

Obter lista de detalhes de metadados do resultado do teste para testcasereferenceId correspondente

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

Parâmetros

testReferenceIds: string[]

IDs TestCaseReference do resultado do teste a ser consultado, lista separada por vírgulas de IDs válidas (limite nº de IDs 200).

project: string

ID do projeto ou nome do projeto

Retornos

Promise<TestResultMetaData[]>

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

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

publishContext: string

includeFailureDetails: boolean

buildToCompare: BuildReference

Retornos

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>

Parâmetros

project: string

ID do projeto ou nome do projeto

releaseId: number

releaseEnvId: number

publishContext: string

includeFailureDetails: boolean

releaseToCompare: ReleaseReference

Retornos

Promise<TestResultSummary>

queryTestResultsSummaryForReleases(ReleaseReference[], string)

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

Parâmetros

releases: ReleaseReference[]

project: string

ID do projeto ou nome do projeto

Retornos

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

Parâmetros

project: string

ID do projeto ou nome do projeto

workItemCategory: string

automatedTestName: string

testCaseId: number

maxCompleteDate: Date

days: number

workItemCount: number

Retornos

Promise<WorkItemReference[]>

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

Execuções de teste de consulta com base em filtros. Os campos obrigatórios são 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>>

Parâmetros

project: string

ID do projeto ou nome do projeto

minLastUpdatedDate: Date

Data mínima da última modificação da execução a ser consultada (obrigatório).

maxLastUpdatedDate: Date

Data Máxima da Última Modificação da execução a ser consultada (obrigatório, a diferença entre data mínima e máxima pode ser de no máximo 7 dias).

state: TestRunState

Estado atual das Execuções a serem consultadas.

planIds: number[]

Planejar IDs das Execuções a serem consultadas, lista separada por vírgulas de IDs válidas (limite nº de IDs 10).

isAutomated: boolean

Tipo de automação das Execuções a serem consultadas.

publishContext: TestRunPublishContext

PublishContext das Execuções a serem consultadas.

buildIds: number[]

IDs de build das Execuções a serem consultadas, lista separada por vírgulas de IDs válidas (limite nº de IDs 10).

buildDefIds: number[]

IDs de definição de build das Execuções a serem consultadas, lista separada por vírgulas de IDs válidas (limite nº de IDs 10).

branchName: string

Nome do Branch de Origem das Execuções a serem consultadas.

releaseIds: number[]

IDs de versão das Execuções a serem consultadas, lista separada por vírgulas de IDs válidas (limite nº de IDs 10).

releaseDefIds: number[]

IDs de definição de versão das Execuções a serem consultadas, lista separada por vírgulas de IDs válidas (limite nº de IDs 10).

releaseEnvIds: number[]

Release Environment Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10).

releaseEnvDefIds: number[]

IDs de definição de ambiente de versão das execuções a serem consultadas, lista separada por vírgulas de IDs válidas (limite nº de IDs 10).

runTitle: string

Execute o Título das Execuções a serem consultadas.

top: number

Número de execuções a serem consultadas. O limite é 100

continuationToken: string

continuationToken recebido do lote anterior ou nulo para o primeiro lote. Ele não deve ser criado (ou alterado, se recebido do último lote) pelo usuário.

Retornos

Promise<PagedList<TestRun>>

queryTestSummaryByRequirement(TestResultsContext, string, number[])

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

Parâmetros

resultsContext: TestResultsContext

project: string

ID do projeto ou nome do projeto

workItemIds: number[]

Retornos

Promise<TestSummaryForWorkItem[]>

removeTestCasesFromSuiteUrl(string, number, number, string)

Os pontos de teste associados aos casos de teste são removidos do conjunto de testes. O item de trabalho do caso de teste não é excluído do sistema. Confira o recurso de casos de teste para excluir um caso de teste permanentemente.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de teste que contém o pacote.

suiteId: number

ID do pacote a ser obtido.

testCaseIds: string

IDs dos casos de teste a serem removidos do pacote.

Retornos

Promise<void>

updateCodeCoverageSummary(CodeCoverageData, string, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Solicitação: Json do resumo da cobertura de código

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

Parâmetros

coverageData: CodeCoverageData

project: string

ID do projeto ou nome do projeto

buildId: number

Retornos

Promise<void>

updateResultRetentionSettings(ResultRetentionSettings, string)

Atualizar as configurações de retenção de resultado do teste

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

Parâmetros

retentionSettings: ResultRetentionSettings

Detalhes das configurações de retenção de resultados de teste a serem atualizados

project: string

ID do projeto ou nome do projeto

Retornos

Promise<ResultRetentionSettings>

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

Atualizações as propriedades da associação de caso de teste em um pacote.

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

Parâmetros

suiteTestCaseUpdateModel: SuiteTestCaseUpdateModel

Modelo para a updation das propriedades da associação do conjunto de casos de teste.

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de teste que contém o pacote.

suiteId: number

ID do conjunto de testes ao qual os casos de teste devem ser adicionados.

testCaseIds: string

IDs dos casos de teste a serem adicionados ao pacote. As IDs são especificadas no formato separado por vírgulas.

Retornos

Promise<SuiteTestCase[]>

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

Atualizar pontos de teste.

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

Parâmetros

pointUpdateModel: PointUpdateModel

Dados a serem atualizados.

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de teste.

suiteId: number

ID do pacote que contém os pontos.

pointIds: string

ID do ponto de teste a ser obtido. Use uma lista separada por vírgulas de IDs para atualizar vários pontos de teste.

Retornos

Promise<TestPoint[]>

updateTestResults(TestCaseResult[], string, number)

Atualizar os resultados do teste em uma execução de teste.

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

Parâmetros

results: TestCaseResult[]

Lista de resultados de teste a serem atualizados.

project: string

ID do projeto ou nome do projeto

runId: number

ID de execução de teste cujos resultados de teste serão atualizados.

Retornos

Promise<TestCaseResult[]>

updateTestRun(RunUpdateModel, string, number)

Atualizar a execução de teste por sua ID.

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

Parâmetros

runUpdateModel: RunUpdateModel

Detalhes da execução RunUpdateModel

project: string

ID do projeto ou nome do projeto

runId: number

ID da execução a ser atualizada.

Retornos

Promise<TestRun>

updateTestSession(TestSession, TeamContext)

Atualizar uma sessão de teste

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

Parâmetros

testSession: TestSession

Detalhes da sessão de teste para atualização

teamContext: TeamContext

O contexto da equipe para a operação

Retornos

Promise<TestSession>

Compartilhar via

TestRestClient class

Construtores

Propriedades

Métodos

Detalhes do construtor

TestRestClient(IVssRestClientOptions)

Parâmetros

Detalhes da propriedade

RESOURCE_AREA_ID

Valor da propriedade

Detalhes do método

addCustomFields(CustomTestFieldDefinition[], string)

Parâmetros

Retornos

addTestCasesToSuite(string, number, number, string)

Parâmetros

Retornos

addTestResultsToTestRun(TestCaseResult[], string, number)

Parâmetros

Retornos

addWorkItemToTestLinks(WorkItemToTestLinks, string)

Parâmetros

Retornos

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

Parâmetros

Retornos

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Parâmetros

Retornos

createTestRun(RunCreateModel, string)

Parâmetros

Retornos

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Parâmetros

Retornos

createTestSession(TestSession, TeamContext)

Parâmetros

Retornos

createTestSettings(TestSettings, string)

Parâmetros

Retornos

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

Parâmetros

Retornos

deleteSharedParameter(string, number)

Parâmetros

Retornos

deleteSharedStep(string, number)

Parâmetros

Retornos

deleteTestCase(string, number)

Parâmetros

Retornos

deleteTestMethodToWorkItemLink(string, string, number)

Parâmetros

Retornos

deleteTestRun(string, number)

Parâmetros

Retornos

deleteTestSettings(string, number)

Parâmetros

Retornos

getBugsLinkedToTestResult(string, number, number)

Parâmetros

Retornos

getBuildCodeCoverage(string, number, number)

Parâmetros

Retornos

getCodeCoverageSummary(string, number, number)

Parâmetros

Retornos

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)

Parâmetros

Retornos

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

Parâmetros

Retornos

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

Parâmetros