Compartilhar via


TestResultsRestClient class

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

Extends

Construtores

TestResultsRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

addCustomFields(CustomTestFieldDefinition[], string)
addTestResultsToTestRun(TestCaseResult[], string, number)
addTestResultsToTestRunSession(TestCaseResult[], string, number)

Adicionar resultados de teste para testar a sessão de execução

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

Cria um anexo no LogStore para o buildId especificado.

createEnvironment(TestSessionEnvironment[], string)

Cria o objeto Environment no armazenamento de dados do TCM

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Para a sessionId fornecida, cria objetos de ambiente, configuração e computador no armazenamento de dados do TCM

createFailureType(TestResultFailureTypeRequestModel, string)

Cria um novo tipo de falha de teste

createNotification(TestSessionNotification[], string, number)

Cria o objeto Notification no armazenamento de dados do TCM para uma determinada sessão

createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)
createTestRun(RunCreateModel, string)
createTestRunAttachment(TestAttachmentRequestModel, string, number)
createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

Cria um anexo no LogStore para o runId especificado.

createTestSession(TestResultsSession, string)

Cria o objeto TestResultsSession no armazenamento de dados do TCM

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

Exclui um tipo de falha de teste com failureTypeId especificado

deleteTestMethodToWorkItemLink(string, string, number)
deleteTestResultAttachment(string, number, number, number)
deleteTestRun(string, number)
deleteTestRunAttachment(string, number, number)
deleteTestRunLogStoreAttachment(string, number, string)

Exclui o anexo com o nome de arquivo especificado para o runId especificado do LogStore.

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

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10&deltaBuildId=9 Solicitação: id de build e ID de build delta (opcional)

getCoverageStatusBadge(string, string, string, string)

<p>Obtém o status de cobertura para o último build bem-sucedido de uma definição, opcionalmente com escopo para um branch</p específico>

getFailureTypes(string)

Retorna a lista de tipos de falha de teste.

getFileLevelCodeCoverage(FileCoverageRequest, string)

Obter cobertura de arquivo para o arquivo especificado

getFlakyTestResultsByBuildDefinitionId(string, number, Date)
getFlakyTestResultsByTestRun(string, number)
getResultGroupsByBuild(string, number, string, string[], string)
getResultGroupsByRelease(string, number, string, number, string[], string)
getSessionNotifications(string, number)

Recupera objetos TestResultsSession Notification no armazenamento de dados do TCM

getSimilarTestResults(string, number, number, number, number, String)

Obtém a lista de resultados cuja falha corresponde à fornecida.

getTestIterationAttachmentContent(string, number, number, number, number)

Retorna um anexo de iteração de teste

getTestIterationAttachmentZip(string, number, number, number, number)

Retorna um anexo de iteração de teste

getTestLogsForBuild(string, number, TestLogType, string, string, boolean, number, String)

Obter a lista de referência de anexos de build

getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)

Obter Uri sas de um anexo de build

getTestLogStoreEndpointDetailsForResultLog(string, number, number, TestLogType, string)

Obter Uri sas de um anexo de resultados de teste

getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)

Obter Uri sas de um anexo de execução de teste

getTestLogStoreEndpointDetailsForSubResultLog(string, number, number, number, TestLogType, string)

Obter Uri sas de um anexo de sub-resultados de teste

getTestPipelineMetrics(string, number, string, string, string, Metrics[], boolean)

Obter resumo dos resultados do teste.

getTestResultAttachmentContent(string, number, number, number)

Retorna um anexo de resultado de teste

getTestResultAttachments(string, number, number)
getTestResultAttachmentZip(string, number, number, number)

Retorna um anexo de resultado de teste

getTestResultById(string, number, number, ResultDetails)
getTestResultDetailsForBuild(string, number, string, string, string, string, boolean, boolean)
getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)
getTestResultLogs(string, number, number, TestLogType, string, string, boolean, number, String)

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

getTestResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByPipeline(string, number, string, string, string, TestOutcome[], number, String)

Obtenha uma lista de resultados.

getTestResultsByQuery(TestResultsQuery, string)
getTestResultsByQueryWiql(QueryModel, string, boolean, boolean, number, number)
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
getTestResultsSettings(string, TestResultsSettingsType)

Obter dados testResultsSettings

getTestResultWorkItemsById(string, number, number)
getTestRunAttachmentContent(string, number, number)

Retorna um anexo de execução de teste

getTestRunAttachments(string, number)
getTestRunAttachmentZip(string, number, number)

Retorna um anexo de execução de teste

getTestRunById(string, number, boolean, boolean)
getTestRunCodeCoverage(string, number, number)
getTestRunLogs(string, number, TestLogType, string, string, boolean, number, String)

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

getTestRunLogStoreAttachmentContent(string, number, string)

Retorna o anexo com o nome de arquivo especificado para o runId especificado do LogStore.

getTestRunLogStoreAttachments(string, number)

Retorna uma lista de anexos para o runId especificado do LogStore.

getTestRunLogStoreAttachmentZip(string, number, string)

Retorna o anexo com o nome de arquivo especificado para o runId especificado do LogStore.

getTestRunMessageLogs(string, number)

Obter logs de mensagens de execução de teste

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

Recupera execuções de teste associadas a uma sessão

getTestRunStatistics(string, number)

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

getTestRunSummaryByOutcome(string, number)

Obtenha o resumo da execução de teste, usado quando queremos obter o resumo de uma execução por resultado. A execução do teste deve estar no estado concluído.

getTestSession(string, number)

Recupera o objeto de metadados TestResultsSession no armazenamento de dados do TCM

getTestSessionLayout(string, string)

Recupera o objeto TestResultsSession Layout no armazenamento de dados do TCM

getTestSessionLayoutBySessionId(string, number)

Recupera o objeto TestResultsSession Layout no armazenamento de dados do TCM

getTestSessionResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestSettingsById(string, number)
getTestSubResultAttachmentContent(string, number, number, number, number)

Retorna um anexo de sub-resultado de teste

getTestSubResultAttachments(string, number, number, number)

Retorna referências de anexo para o sub resulto de teste.

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

Retorna um anexo de sub-resultado de teste

getTestSubResultLogs(string, number, number, number, TestLogType, string, string, boolean, number, String)

Obter a lista de referência de anexos de subresult de teste

getTestTagsForBuild(string, number)

Obtenha todas as marcas em um build.

getTestTagsForRelease(string, number, number)

Obtenha todas as marcas em uma versão.

getTestTagSummaryForBuild(string, number)

Obtenha todas as marcas em um build.

getTestTagSummaryForRelease(string, number, number)

Obtenha todas as marcas em uma versão.

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, ResultMetaDataDetails)

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

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

Obtenha o resumo dos resultados do teste.

queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
queryTestResultsSummaryForReleases(ReleaseReference[], string)
queryTestResultWorkItems(string, string, string, number, Date, number, number)

Trabalho de Resultado do Teste de ConsultaItems com base no filtro

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[])
testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)

Criar e obter sas uri do contêiner de build

testLogStoreEndpointDetailsForResult(string, number, number, number, string, TestLogType)

Criar um arquivo vazio para um resultado e Obter uri sas para o arquivo

testLogStoreEndpointDetailsForRun(string, number, TestLogStoreOperationType, string, TestLogType)

Criar um arquivo vazio para uma execução e Obter uri sas para o arquivo

testResultsGroupDetails(string, number, string, string, string, boolean, boolean)

Obtenha todos os detalhes dos grupos disponíveis e, para esses grupos, obtenha resultados com falha e anulação.

updateCodeCoverageSummary(string, number, CodeCoverageData)

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

updateCustomField(CustomTestFieldUpdateDefinition, string)
updatePipelinesTestSettings(TestResultsUpdateSettings, string)

Atualizar as configurações do projeto dos resultados do teste

updateTestResults(TestCaseResult[], string, number)
updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)

Atualizar propriedades dos metadados de resultado do teste

updateTestResultsToTestRunSession(TestCaseResult[], string, number)

Cria objetos TestResultsMRX no armazenamento de dados TCM para resultados de teste existentes

updateTestRun(RunUpdateModel, string, number)
updateTestRunTags(TestTagsUpdateModel, string, number)

Atualizar marcas de uma execução, marcas podem ser adicionadas e excluídas

Detalhes do construtor

TestResultsRestClient(IVssRestClientOptions)

new TestResultsRestClient(options: IVssRestClientOptions)

Parâmetros

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

project

string

ID do projeto ou nome do projeto

Retornos

addTestResultsToTestRun(TestCaseResult[], string, number)

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

Parâmetros

results

TestCaseResult[]

project

string

ID do projeto ou nome do projeto

runId

number

Retornos

Promise<TestCaseResult[]>

addTestResultsToTestRunSession(TestCaseResult[], string, number)

Adicionar resultados de teste para testar a sessão de execução

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

Parâmetros

results

TestCaseResult[]

project

string

ID do projeto ou nome do projeto

runId

number

RunId da execução de teste

Retornos

Promise<TestCaseResult[]>

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

Parâmetros

workItemToTestLinks
WorkItemToTestLinks
project

string

ID do projeto ou nome do projeto

Retornos

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

Cria um anexo no LogStore para o buildId especificado.

function createBuildAttachmentInLogStore(attachmentRequestModel: TestAttachmentRequestModel, project: string, buildId: number): Promise<void>

Parâmetros

attachmentRequestModel
TestAttachmentRequestModel

Contém informações de anexo como stream, filename, comment, attachmentType

project

string

ID do projeto ou nome do projeto

buildId

number

BuildId

Retornos

Promise<void>

createEnvironment(TestSessionEnvironment[], string)

Cria o objeto Environment no armazenamento de dados do TCM

function createEnvironment(environments: TestSessionEnvironment[], project: string): Promise<void>

Parâmetros

environments

TestSessionEnvironment[]

Objeto Received Environment.

project

string

ID do projeto ou nome do projeto

Retornos

Promise<void>

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Para a sessionId fornecida, cria objetos de ambiente, configuração e computador no armazenamento de dados do TCM

function createEnvironmentAndMachine(sessionEnvironmentAndMachine: SessionEnvironmentAndMachine, project: string, sessionId: number): Promise<void>

Parâmetros

sessionEnvironmentAndMachine
SessionEnvironmentAndMachine
project

string

ID do projeto ou nome do projeto

sessionId

number

Retornos

Promise<void>

createFailureType(TestResultFailureTypeRequestModel, string)

Cria um novo tipo de falha de teste

function createFailureType(testResultFailureType: TestResultFailureTypeRequestModel, project: string): Promise<TestResultFailureType>

Parâmetros

testResultFailureType
TestResultFailureTypeRequestModel
project

string

ID do projeto ou nome do projeto

Retornos

createNotification(TestSessionNotification[], string, number)

Cria o objeto Notification no armazenamento de dados do TCM para uma determinada sessão

function createNotification(notifications: TestSessionNotification[], project: string, sessionId: number): Promise<number[]>

Parâmetros

notifications

TestSessionNotification[]

Notificação a ser adicionada para a sessionId especificada

project

string

ID do projeto ou nome do projeto

sessionId

number

ID da sessão para adicionar notificação

Retornos

Promise<number[]>

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

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

Parâmetros

attachmentRequestModel
TestAttachmentRequestModel
project

string

ID do projeto ou nome do projeto

runId

number

testCaseResultId

number

iterationId

number

actionPath

string

Retornos

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

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

Parâmetros

attachmentRequestModel
TestAttachmentRequestModel
project

string

ID do projeto ou nome do projeto

runId

number

testCaseResultId

number

Retornos

createTestRun(RunCreateModel, string)

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

Parâmetros

testRun
RunCreateModel
project

string

ID do projeto ou nome do projeto

Retornos

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

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

Parâmetros

attachmentRequestModel
TestAttachmentRequestModel
project

string

ID do projeto ou nome do projeto

runId

number

Retornos

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

Cria um anexo no LogStore para o runId especificado.

function createTestRunLogStoreAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestLogStoreAttachmentReference>

Parâmetros

attachmentRequestModel
TestAttachmentRequestModel

Contém informações de anexo como stream, filename, comment, attachmentType

project

string

ID do projeto ou nome do projeto

runId

number

RunId de teste

Retornos

createTestSession(TestResultsSession, string)

Cria o objeto TestResultsSession no armazenamento de dados do TCM

function createTestSession(session: TestResultsSession, project: string): Promise<number>

Parâmetros

session
TestResultsSession

Objeto de sessão recebido.

project

string

ID do projeto ou nome do projeto

Retornos

Promise<number>

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)

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

Parâmetros

attachmentRequestModel
TestAttachmentRequestModel
project

string

ID do projeto ou nome do projeto

runId

number

testCaseResultId

number

testSubResultId

number

Retornos

deleteCustomFieldById(string, number)

function deleteCustomFieldById(project: string, testExtensionFieldId: number): Promise<void>

Parâmetros

project

string

ID do projeto ou nome do projeto

testExtensionFieldId

number

Retornos

Promise<void>

deleteFailureType(string, number)

Exclui um tipo de falha de teste com failureTypeId especificado

function deleteFailureType(project: string, failureTypeId: number): Promise<void>

Parâmetros

project

string

ID do projeto ou nome do projeto

failureTypeId

number

Retornos

Promise<void>

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>

deleteTestResultAttachment(string, number, number, number)

function deleteTestResultAttachment(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<void>

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

testCaseResultId

number

attachmentId

number

Retornos

Promise<void>

deleteTestRun(string, number)

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

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

Retornos

Promise<void>

deleteTestRunAttachment(string, number, number)

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

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

attachmentId

number

Retornos

Promise<void>

deleteTestRunLogStoreAttachment(string, number, string)

Exclui o anexo com o nome de arquivo especificado para o runId especificado do LogStore.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

RunId de teste

filename

string

Attachment FileName

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>

fetchSourceCodeCoverageReport(string, number)

function fetchSourceCodeCoverageReport(project: string, buildId: number): Promise<SourceViewBuildCoverage[]>

Parâmetros

project

string

ID do projeto ou nome do projeto

buildId

number

Retornos

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)

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

Parâmetros

project

string

ID do projeto ou nome do projeto

buildId

number

flags

number

Retornos

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10&deltaBuildId=9 Solicitação: id de build e ID de build delta (opcional)

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

Parâmetros

project

string

ID do projeto ou nome do projeto

buildId

number

deltaBuildId

number

Retornos

getCoverageStatusBadge(string, string, string, string)

<p>Obtém o status de cobertura para o último build bem-sucedido de uma definição, opcionalmente com escopo para um branch</p específico>

function getCoverageStatusBadge(project: string, definition: string, branchName?: string, label?: string): Promise<string>

Parâmetros

project

string

ID do projeto ou nome do projeto

definition

string

A ID ou o nome da definição.

branchName

string

O nome do branch.

label

string

A Cadeia de caracteres para substituir o texto padrão no lado esquerdo do selo.

Retornos

Promise<string>

getFailureTypes(string)

Retorna a lista de tipos de falha de teste.

function getFailureTypes(project: string): Promise<TestResultFailureType[]>

Parâmetros

project

string

ID do projeto ou nome do projeto

Retornos

getFileLevelCodeCoverage(FileCoverageRequest, string)

Obter cobertura de arquivo para o arquivo especificado

function getFileLevelCodeCoverage(fileCoverageRequest: FileCoverageRequest, project: string): Promise<string>

Parâmetros

fileCoverageRequest
FileCoverageRequest

Detalhes do arquivo com contexto de iteração de solicitação de pull

project

string

ID do projeto ou nome do projeto

Retornos

Promise<string>

getFlakyTestResultsByBuildDefinitionId(string, number, Date)

function getFlakyTestResultsByBuildDefinitionId(project: string, buildDefinitionId: number, minBuildCreatedDate: Date): Promise<TestCaseResult[]>

Parâmetros

project

string

ID do projeto ou nome do projeto

buildDefinitionId

number

minBuildCreatedDate

Date

Retornos

Promise<TestCaseResult[]>

getFlakyTestResultsByTestRun(string, number)

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

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

Retornos

Promise<TestCaseResult[]>

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

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

getSessionNotifications(string, number)

Recupera objetos TestResultsSession Notification no armazenamento de dados do TCM

function getSessionNotifications(project: string, sessionId: number): Promise<TestSessionNotification[]>

Parâmetros

project

string

ID do projeto ou nome do projeto

sessionId

number

ID da sessão TestResults para a qual obter Notificações.

Retornos

getSimilarTestResults(string, number, number, number, number, String)

Obtém a lista de resultados cuja falha corresponde à fornecida.

function getSimilarTestResults(project: string, runId: number, testResultId: number, testSubResultId: number, top?: number, continuationToken?: String): Promise<TestCaseResult[]>

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

ID da execução de teste

testResultId

number

ID do resultado do teste dentro de uma execução de teste

testSubResultId

number

id de subresult dentro de um resultado de teste

top

number

Número máximo de resultados a serem retornados.

continuationToken

String

Cabeçalho para passar a continuaçãoToken

Retornos

Promise<TestCaseResult[]>

getTestIterationAttachmentContent(string, number, number, number, number)

Retorna um anexo de iteração de teste

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

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

testCaseResultId

number

attachmentId

number

iterationId

number

Retornos

Promise<ArrayBuffer>

getTestIterationAttachmentZip(string, number, number, number, number)

Retorna um anexo de iteração de teste

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

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

testCaseResultId

number

attachmentId

number

iterationId

number

Retornos

Promise<ArrayBuffer>

getTestLogsForBuild(string, number, TestLogType, string, string, boolean, number, String)

Obter a lista de referência de anexos de build

function getTestLogsForBuild(project: string, buildId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Parâmetros

project

string

ID do projeto ou nome do projeto

buildId

number

Id do build a ser obtido

type
TestLogType

tipo do anexo a ser obtido

directoryPath

string

caminho de diretório para o qual os anexos são necessários

fileNamePrefix

string

prefixo de nome de arquivo para filtrar a lista de anexos

fetchMetaData

boolean

O padrão é false, definido se os metadados forem necessários

top

number

Referência de número de anexos de teste a serem retornados

continuationToken

String

Cabeçalho para passar a continuaçãoToken

Retornos

Promise<PagedList<TestLog>>

getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)

Obter Uri sas de um anexo de build

function getTestLogStoreEndpointDetailsForBuildLog(project: string, build: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Parâmetros

project

string

ID do projeto ou nome do projeto

build

number

Id do build a ser obtido

type
TestLogType

tipo do arquivo

filePath

string

filePath para o qual sas uri é necessário

Retornos

getTestLogStoreEndpointDetailsForResultLog(string, number, number, TestLogType, string)

Obter Uri sas de um anexo de resultados de teste

function getTestLogStoreEndpointDetailsForResultLog(project: string, runId: number, resultId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

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

resultId

number

Id do resultado do teste cujos arquivos precisam ser baixados

type
TestLogType

tipo do arquivo

filePath

string

filePath para o qual sas uri é necessário

Retornos

getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)

Obter Uri sas de um anexo de execução de teste

function getTestLogStoreEndpointDetailsForRunLog(project: string, runId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

Id da execução de teste cujo arquivo deve ser baixado

type
TestLogType

tipo do arquivo

filePath

string

filePath para o qual sas uri é necessário

Retornos

getTestLogStoreEndpointDetailsForSubResultLog(string, number, number, number, TestLogType, string)

Obter Uri sas de um anexo de sub-resultados de teste

function getTestLogStoreEndpointDetailsForSubResultLog(project: string, runId: number, resultId: number, subResultId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

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

resultId

number

Id do resultado do teste que contém subresult

subResultId

number

Id do subresult de teste cujo arquivo sas uri é necessário

type
TestLogType

tipo do arquivo

filePath

string

filePath para o qual sas uri é necessário

Retornos

getTestPipelineMetrics(string, number, string, string, string, Metrics[], boolean)

Obter resumo dos resultados do teste.

function getTestPipelineMetrics(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, metricNames?: Metrics[], groupByNode?: boolean): Promise<PipelineTestMetrics>

Parâmetros

project

string

ID do projeto ou nome do projeto

pipelineId

number

ID do pipeline. Isso é o mesmo que a ID de build.

stageName

string

Nome do estágio. O comprimento máximo com suporte para o nome é de 256 caracteres.

phaseName

string

Nome da fase. O comprimento máximo com suporte para o nome é de 256 caracteres.

jobName

string

A matriz no YAML gera cópias de um trabalho com entradas diferentes na matriz. JobName é o nome dessas entradas. O comprimento máximo com suporte para o nome é de 256 caracteres.

metricNames

Metrics[]

groupByNode

boolean

Resumo do grupo para cada nó da herdeira pipleine

Retornos

getTestResultAttachmentContent(string, number, number, number)

Retorna um anexo de resultado de teste

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

testCaseResultId

number

attachmentId

number

Retornos

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

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

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

testCaseResultId

number

Retornos

Promise<TestAttachment[]>

getTestResultAttachmentZip(string, number, number, number)

Retorna um anexo de resultado de teste

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

testCaseResultId

number

attachmentId

number

Retornos

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

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

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

testResultId

number

detailsToInclude
ResultDetails

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

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

getTestResultLogs(string, number, number, TestLogType, string, string, boolean, number, String)

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

function getTestResultLogs(project: string, runId: number, resultId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

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

resultId

number

ID do resultado do teste

type
TestLogType

tipo de anexos a serem obtidos

directoryPath

string

caminho de diretório de anexos a serem obtidos

fileNamePrefix

string

prefixo de nome de arquivo para filtrar a lista de anexos

fetchMetaData

boolean

O padrão é false, definido se os metadados forem necessários

top

number

Entorpecimento da referência de anexos a serem retornados

continuationToken

String

Cabeçalho para passar a continuaçãoToken

Retornos

Promise<PagedList<TestLog>>

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

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

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

detailsToInclude
ResultDetails
skip

number

top

number

outcomes

TestOutcome[]

newTestsOnly

boolean

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

getTestResultsByPipeline(string, number, string, string, string, TestOutcome[], number, String)

Obtenha uma lista de resultados.

function getTestResultsByPipeline(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: String): Promise<PagedList<ShallowTestCaseResult>>

Parâmetros

project

string

ID do projeto ou nome do projeto

pipelineId

number

ID do pipeline. Isso é o mesmo que a ID de build.

stageName

string

Nome do estágio. O comprimento máximo com suporte para o nome é de 256 caracteres.

phaseName

string

Nome da fase. O comprimento máximo com suporte para o nome é de 256 caracteres.

jobName

string

A matriz no YAML gera cópias de um trabalho com entradas diferentes na matriz. JobName é o nome dessas entradas. O comprimento máximo com suporte para o nome é de 256 caracteres.

outcomes

TestOutcome[]

Lista de resultados

top

number

Número máximo de resultados a serem retornados.

continuationToken

String

Cabeçalho para passar a continuaçãoToken

Retornos

getTestResultsByQuery(TestResultsQuery, string)

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

Parâmetros

project

string

ID do projeto ou nome do projeto

Retornos

Promise<TestResultsQuery>

getTestResultsByQueryWiql(QueryModel, string, boolean, boolean, number, number)

function getTestResultsByQueryWiql(queryModel: QueryModel, project: string, includeResultDetails?: boolean, includeIterationDetails?: boolean, skip?: number, top?: number): Promise<TestCaseResult[]>

Parâmetros

queryModel
QueryModel
project

string

ID do projeto ou nome do projeto

includeResultDetails

boolean

includeIterationDetails

boolean

skip

number

top

number

Retornos

Promise<TestCaseResult[]>

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

getTestResultsSettings(string, TestResultsSettingsType)

Obter dados testResultsSettings

function getTestResultsSettings(project: string, settingsType?: TestResultsSettingsType): Promise<TestResultsSettings>

Parâmetros

project

string

ID do projeto ou nome do projeto

Retornos

getTestResultWorkItemsById(string, number, number)

function getTestResultWorkItemsById(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[]>

getTestRunAttachmentContent(string, number, number)

Retorna um anexo de execução de teste

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

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

attachmentId

number

Retornos

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

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

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

Retornos

Promise<TestAttachment[]>

getTestRunAttachmentZip(string, number, number)

Retorna um anexo de execução de teste

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

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

attachmentId

number

Retornos

Promise<ArrayBuffer>

getTestRunById(string, number, boolean, boolean)

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

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

includeDetails

boolean

includeTags

boolean

Retornos

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

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

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

flags

number

Retornos

Promise<TestRunCoverage[]>

getTestRunLogs(string, number, TestLogType, string, string, boolean, number, String)

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

function getTestRunLogs(project: string, runId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

ID da execução de teste

type
TestLogType

tipo dos anexos a serem obtidos

directoryPath

string

caminho de diretório para o qual os anexos são necessários

fileNamePrefix

string

prefixo de nome de arquivo para filtrar a lista de anexos

fetchMetaData

boolean

O padrão é false, definido se os metadados forem necessários

top

number

Número de referências de anexos a serem retornados

continuationToken

String

Cabeçalho para passar o continuationToken

Retornos

Promise<PagedList<TestLog>>

getTestRunLogStoreAttachmentContent(string, number, string)

Retorna o anexo com o nome de arquivo especificado para o runId especificado do LogStore.

function getTestRunLogStoreAttachmentContent(project: string, runId: number, filename: string): Promise<ArrayBuffer>

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

RunId de teste

filename

string

Attachment FileName

Retornos

Promise<ArrayBuffer>

getTestRunLogStoreAttachments(string, number)

Retorna uma lista de anexos para o runId especificado do LogStore.

function getTestRunLogStoreAttachments(project: string, runId: number): Promise<TestLogStoreAttachment[]>

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

RunId de teste

Retornos

getTestRunLogStoreAttachmentZip(string, number, string)

Retorna o anexo com o nome de arquivo especificado para o runId especificado do LogStore.

function getTestRunLogStoreAttachmentZip(project: string, runId: number, filename: string): Promise<ArrayBuffer>

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

RunId de teste

filename

string

Attachment FileName

Retornos

Promise<ArrayBuffer>

getTestRunMessageLogs(string, number)

Obter logs de mensagens de execução de teste

function getTestRunMessageLogs(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

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

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

owner

string

tmiRunId

string

planId

number

includeRunDetails

boolean

automated

boolean

skip

number

top

number

Retornos

Promise<TestRun[]>

getTestRunsBySessionId(string, number)

Recupera execuções de teste associadas a uma sessão

function getTestRunsBySessionId(project: string, sessionId: number): Promise<number[]>

Parâmetros

project

string

ID do projeto ou nome do projeto

sessionId

number

ID da sessão TestResults para a qual obter execuções de teste.

Retornos

Promise<number[]>

getTestRunStatistics(string, number)

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

getTestRunSummaryByOutcome(string, number)

Obtenha o resumo da execução de teste, usado quando queremos obter o resumo de uma execução por resultado. A execução do teste deve estar no estado concluído.

function getTestRunSummaryByOutcome(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>

getTestSession(string, number)

Recupera o objeto de metadados TestResultsSession no armazenamento de dados do TCM

function getTestSession(project: string, buildId: number): Promise<TestResultsSession[]>

Parâmetros

project

string

ID do projeto ou nome do projeto

buildId

number

Retornos

Promise<TestResultsSession[]>

getTestSessionLayout(string, string)

Recupera o objeto TestResultsSession Layout no armazenamento de dados do TCM

function getTestSessionLayout(project: string, sessionId: string): Promise<any[]>

Parâmetros

project

string

ID do projeto ou nome do projeto

sessionId

string

Retornos

Promise<any[]>

getTestSessionLayoutBySessionId(string, number)

Recupera o objeto TestResultsSession Layout no armazenamento de dados do TCM

function getTestSessionLayoutBySessionId(project: string, sessionId: number): Promise<any[]>

Parâmetros

project

string

ID do projeto ou nome do projeto

sessionId

number

Recuperar objeto de sessão.

Retornos

Promise<any[]>

getTestSessionResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)

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

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

detailsToInclude
ResultDetails
skip

number

top

number

outcomes

TestOutcome[]

newTestsOnly

boolean

Retornos

Promise<TestCaseResult[]>

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)

Retorna 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

testCaseResultId

number

attachmentId

number

testSubResultId

number

Retornos

Promise<ArrayBuffer>

getTestSubResultAttachments(string, number, number, number)

Retorna referências de anexo para o sub resulto 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

testCaseResultId

number

testSubResultId

number

Retornos

Promise<TestAttachment[]>

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

Retorna 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

testCaseResultId

number

attachmentId

number

testSubResultId

number

Retornos

Promise<ArrayBuffer>

getTestSubResultLogs(string, number, number, number, TestLogType, string, string, boolean, number, String)

Obter a lista de referência de anexos de subresult de teste

function getTestSubResultLogs(project: string, runId: number, resultId: number, subResultId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

ID da execução de teste que contém os resultados

resultId

number

ID do resultado do teste que contém o subresult

subResultId

number

ID do subresulto de teste

type
TestLogType

tipo dos anexos a serem obtidos

directoryPath

string

caminho do diretório do anexo a ser obtido

fileNamePrefix

string

prefixo de nome de arquivo para filtrar a lista de anexos

fetchMetaData

boolean

O padrão é false, definido se os metadados forem necessários

top

number

Número de referências de anexos a serem retornados

continuationToken

String

Cabeçalho para passar o continuationToken

Retornos

Promise<PagedList<TestLog>>

getTestTagsForBuild(string, number)

Obtenha todas as marcas em um build.

function getTestTagsForBuild(project: string, buildId: number): Promise<TestTag[]>

Parâmetros

project

string

ID do projeto ou nome do projeto

buildId

number

Build ID

Retornos

Promise<TestTag[]>

getTestTagsForRelease(string, number, number)

Obtenha todas as marcas em uma versão.

function getTestTagsForRelease(project: string, releaseId: number, releaseEnvId: number): Promise<TestTag[]>

Parâmetros

project

string

ID do projeto ou nome do projeto

releaseId

number

ID da versão

releaseEnvId

number

ID do ambiente de versão

Retornos

Promise<TestTag[]>

getTestTagSummaryForBuild(string, number)

Obtenha todas as marcas em um build.

function getTestTagSummaryForBuild(project: string, buildId: number): Promise<TestTagSummary>

Parâmetros

project

string

ID do projeto ou nome do projeto

buildId

number

Build ID

Retornos

Promise<TestTagSummary>

getTestTagSummaryForRelease(string, number, number)

Obtenha todas as marcas em uma versão.

function getTestTagSummaryForRelease(project: string, releaseId: number, releaseEnvId: number): Promise<TestTagSummary>

Parâmetros

project

string

ID do projeto ou nome do projeto

releaseId

number

ID da versão

releaseEnvId

number

ID do ambiente de versão

Retornos

Promise<TestTagSummary>

publishTestResultDocument(TestResultDocument, string, number)

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

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

Retornos

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

queryResultTrendForBuild(TestResultTrendFilter, string)

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

Parâmetros

project

string

ID do projeto ou nome do projeto

Retornos

queryResultTrendForRelease(TestResultTrendFilter, string)

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

Parâmetros

project

string

ID do projeto ou nome do projeto

Retornos

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

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

queryTestResultsMetaData(string[], string, ResultMetaDataDetails)

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

function queryTestResultsMetaData(testCaseReferenceIds: string[], project: string, detailsToInclude?: ResultMetaDataDetails): Promise<TestResultMetaData[]>

Parâmetros

testCaseReferenceIds

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

detailsToInclude
ResultMetaDataDetails

Detalhes a serem incluídos com metadados de resultados de teste. O padrão é None. Outros valores são FlakyIdentifiers.

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

queryTestResultsReportForPipeline(string, number, string, string, string, boolean)

Obtenha o resumo dos resultados do teste.

function queryTestResultsReportForPipeline(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, includeFailureDetails?: boolean): Promise<TestResultSummary>

Parâmetros

project

string

ID do projeto ou nome do projeto

pipelineId

number

ID do pipeline. Isso é o mesmo que a ID de build.

stageName

string

Nome do estágio. O comprimento máximo com suporte para o nome é de 256 caracteres.

phaseName

string

Nome da fase. O comprimento máximo com suporte para o nome é de 256 caracteres.

jobName

string

A matriz no YAML gera cópias de um trabalho com entradas diferentes na matriz. JobName é o nome dessas entradas. O comprimento máximo com suporte para o nome é de 256 caracteres.

includeFailureDetails

boolean

Se true retornar insights de falha

Retornos

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

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)

Trabalho de Resultado do Teste de ConsultaItems com base no filtro

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

pode obter valores Microsoft.BugCategory ou all(para obter todos os workitems)

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.

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.

buildDefIds

number[]

Criar IDs de Definição das Execuções a serem consultadas, lista separada por vírgulas de IDs válidas.

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.

releaseDefIds

number[]

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

releaseEnvIds

number[]

Liberar IDs de Ambiente das Execuções a serem consultadas, lista separada por vírgulas de IDs válidas.

releaseEnvDefIds

number[]

Liberar IDs de Definição de Ambiente das Execuções a serem consultadas, lista separada por vírgulas de IDs válidas.

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

testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)

Criar e obter sas uri do contêiner de build

function testLogStoreEndpointDetailsForBuild(project: string, buildId: number, testLogStoreOperationType: TestLogStoreOperationType): Promise<TestLogStoreEndpointDetails>

Parâmetros

project

string

ID do projeto ou nome do projeto

buildId

number

Id do build a ser obtido

testLogStoreOperationType
TestLogStoreOperationType

Tipo de operação a ser executada usando sas uri

Retornos

testLogStoreEndpointDetailsForResult(string, number, number, number, string, TestLogType)

Criar um arquivo vazio para um resultado e Obter uri sas para o arquivo

function testLogStoreEndpointDetailsForResult(project: string, runId: number, resultId: number, subResultId: number, filePath: string, type: TestLogType): Promise<TestLogStoreEndpointDetails>

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

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

resultId

number

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

subResultId

number

Id do sub resulto de teste cujo arquivo sas uri é necessário

filePath

string

caminho do arquivo dentro do sub resulto para o qual sas uri é necessário

type
TestLogType

Tipo do arquivo para download

Retornos

testLogStoreEndpointDetailsForRun(string, number, TestLogStoreOperationType, string, TestLogType)

Criar um arquivo vazio para uma execução e Obter uri sas para o arquivo

function testLogStoreEndpointDetailsForRun(project: string, runId: number, testLogStoreOperationType: TestLogStoreOperationType, filePath?: string, type?: TestLogType): Promise<TestLogStoreEndpointDetails>

Parâmetros

project

string

ID do projeto ou nome do projeto

runId

number

Id da execução para obter detalhes do ponto de extremidade

testLogStoreOperationType
TestLogStoreOperationType

Tipo de operação a ser executada usando sas uri

filePath

string

caminho do arquivo para criar um arquivo vazio

type
TestLogType

O padrão é GeneralAttachment, tipo de arquivo vazio a ser criado

Retornos

testResultsGroupDetails(string, number, string, string, string, boolean, boolean)

Obtenha todos os detalhes dos grupos disponíveis e, para esses grupos, obtenha resultados com falha e anulação.

function testResultsGroupDetails(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, shouldIncludeFailedAndAbortedResults?: boolean, queryGroupSummaryForInProgress?: boolean): Promise<TestResultsDetails>

Parâmetros

project

string

ID do projeto ou nome do projeto

pipelineId

number

ID do pipeline. Isso é o mesmo que a ID de build.

stageName

string

Nome do estágio. O comprimento máximo com suporte para o nome é de 256 caracteres.

phaseName

string

Nome da fase. O comprimento máximo com suporte para o nome é de 256 caracteres.

jobName

string

A matriz no YAML gera cópias de um trabalho com entradas diferentes na matriz. JobName é o nome dessas entradas. O comprimento máximo com suporte para o nome é de 256 caracteres.

shouldIncludeFailedAndAbortedResults

boolean

Se for true, ele retornará IDs de resultados com falha e anulados para cada grupo de teste

queryGroupSummaryForInProgress

boolean

Se for true, ele calculará o resumo das execuções do InProgress também.

Retornos

updateCodeCoverageSummary(string, number, CodeCoverageData)

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

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

Parâmetros

project

string

ID do projeto ou nome do projeto

buildId

number

coverageData
CodeCoverageData

Retornos

Promise<void>

updateCustomField(CustomTestFieldUpdateDefinition, string)

function updateCustomField(updateCustomTestField: CustomTestFieldUpdateDefinition, project: string): Promise<CustomTestFieldDefinition>

Parâmetros

updateCustomTestField
CustomTestFieldUpdateDefinition
project

string

ID do projeto ou nome do projeto

Retornos

updatePipelinesTestSettings(TestResultsUpdateSettings, string)

Atualizar as configurações do projeto dos resultados do teste

function updatePipelinesTestSettings(testResultsUpdateSettings: TestResultsUpdateSettings, project: string): Promise<TestResultsSettings>

Parâmetros

testResultsUpdateSettings
TestResultsUpdateSettings
project

string

ID do projeto ou nome do projeto

Retornos

updateTestResults(TestCaseResult[], string, number)

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

Parâmetros

results

TestCaseResult[]

project

string

ID do projeto ou nome do projeto

runId

number

Retornos

Promise<TestCaseResult[]>

updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)

Atualizar propriedades dos metadados de resultado do teste

function updateTestResultsMetaData(testResultMetaDataUpdateInput: TestResultMetaDataUpdateInput, project: string, testCaseReferenceId: number): Promise<TestResultMetaData>

Parâmetros

testResultMetaDataUpdateInput
TestResultMetaDataUpdateInput

TestResultMetaData atualização de entrada TestResultMetaDataUpdateInput

project

string

ID do projeto ou nome do projeto

testCaseReferenceId

number

TestCaseReference Id do Resultado do Teste a ser atualizado.

Retornos

updateTestResultsToTestRunSession(TestCaseResult[], string, number)

Cria objetos TestResultsMRX no armazenamento de dados TCM para resultados de teste existentes

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

Parâmetros

results

TestCaseResult[]

Objeto Results com apenas resultados de teste propriedades MRX e testResultId existentes

project

string

ID do projeto ou nome do projeto

runId

number

RunId da execução de teste

Retornos

Promise<number[]>

updateTestRun(RunUpdateModel, string, number)

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

Parâmetros

runUpdateModel
RunUpdateModel
project

string

ID do projeto ou nome do projeto

runId

number

Retornos

Promise<TestRun>

updateTestRunTags(TestTagsUpdateModel, string, number)

Atualizar marcas de uma execução, marcas podem ser adicionadas e excluídas

function updateTestRunTags(testTagsUpdateModel: TestTagsUpdateModel, project: string, runId: number): Promise<TestTag[]>

Parâmetros

testTagsUpdateModel
TestTagsUpdateModel

TestTagsUpdateModel

project

string

ID do projeto ou nome do projeto

runId

number

RunId da execução

Retornos

Promise<TestTag[]>