TestResultsRestClient class

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

Construtores

TestResultsRestClient(IVssRestClientOptions)

Propriedades

Métodos

addCustomFields(CustomTestFieldDefinition[], string)	Cria campos de teste personalizados com base nos dados fornecidos.
addTestResultsToTestRun(TestCaseResult[], string, number)
addTestResultsToTestRunSession(TestCaseResult[], string, number)	Adicionar resultados de teste à sessão de execução de teste
addWorkItemToTestLinks(WorkItemToTestLinks, string)
callbackTestAgent(TestAgentCallbackRequest, string)
completeGitHubAuth(string, string)	Endpoint de retorno de chamada OAuth. O GitHub redireciona para aqui depois de o utilizador autorizar. Troca o código de autorização dos tokens e armazena-os no TCM StrongBox. Requer que o URL de retorno de chamada esteja registado nas definições da aplicação GitHub OAuth.
createAnalysis(TestSessionAnalysis[], string, number)	Cria o objeto Análise de Sessão no armazenamento de dados TCM para uma determinada sessão
createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)	Cria um anexo no LogStore para o buildId especificado.
createEnvironment(TestSessionEnvironment[], string)	Cria o objeto Environment no armazenamento de dados TCM
createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)	Para o sessionId fornecido, cria objetos de ambiente, configuração e máquina no armazenamento de dados TCM
createFailureType(TestResultFailureTypeRequestModel, string)	Cria um novo tipo de falha de teste
createNotification(TestSessionNotification[], string, number)	Cria o objeto Notification no armazenamento de dados TCM para uma determinada sessão
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)
createTestResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number)	Regista metadados para um anexo de teste a nível de resultado cujo conteúdo já foi carregado para armazenamento de deduplicação pelo chamador. O pedido transporta apenas os metadados do anexo (id de duplicação, tamanho, nome do ficheiro, tipo, etc.) e nenhum byte de ficheiro.
createTestResultMachines(TestResultMachine[], string, number)	Cria máquinas de resultados de teste para o TestRunId fornecido
createTestRun(RunCreateModel, string)
createTestRunAttachment(TestAttachmentRequestModel, string, number)
createTestRunAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number)	Regista metadados para um anexo de teste ao nível da execução cujo conteúdo já foi carregado para armazenamento deduplicado pelo chamador. O pedido transporta apenas os metadados do anexo (id de duplicação, tamanho, nome do ficheiro, tipo, etc.) e nenhum byte de ficheiro.
createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)	Cria um anexo no LogStore para o runId especificado.
createTestSession(TestResultsSession, string)	Cria o objeto TestResultsSession no armazenamento de dados TCM
createTestSettings(TestSettings, string)
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)
createTestSubResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number, number)	Regista metadados para um anexo de teste sub-nível de resultado cujo conteúdo já foi carregado para armazenamento de deduplicação pelo chamador. O pedido transporta apenas os metadados do anexo (id de duplicação, tamanho, nome do ficheiro, tipo, etc.) e nenhum byte de ficheiro.
deleteCustomFieldById(string, number)	Retorna detalhes do campo de teste personalizado para o testExtensionFieldId especificado.
deleteFailureType(string, number)	Exclui um tipo de falha de teste com failureTypeId especificado
deleteFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)	Eliminar IDs de referência de casos de teste instáveis por informação de branch e repositório
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)
enhanceCoverage(string, string, number)	Ponto de entrada clicável no navegador para o link "Melhorar cobertura diferencial" apresentado nos comentários da cobertura de relações públicas. Despacha uma tarefa coverage_test_generation para o ADOAgenticService para o pull request dado e redireciona o utilizador de volta para a página de pull request.
fetchSourceCodeCoverageReport(string, number)
generateTestPlanFromWorkItem(GenerateTestPlanFromWorkItemModel, string, number)	Gera um plano de teste manual a partir de um item de trabalho usando IA. Se o utilizador não tiver um token Copilot válido, devolve needsAuth=true com um authUrl em vez de entrar na fila do trabalho.
getAfdTcmEndpoint(string)
getBranchesByFlakyTestCaseRefId(string, number)	Obter lista de ramificações onde um id de referência de caso de teste foi lascado
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: build id e delta build id (opcional)
getCoverageStatusBadge(string, string, string, string)	<p>Obtém o status de cobertura para a última compilação bem-sucedida de uma definição, opcionalmente com escopo para uma ramificação específica</p>
getFailureTypes(string)	Retorna a lista de tipos de falha de teste.
getFileLevelCodeCoverage(FileCoverageRequest, string)	Obter cobertura de arquivo para o arquivo especificado
getFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)
getFlakyTestResultsByBuildDefinitionId(string, number, Date)
getFlakyTestResultsByTestRun(string, number)
getLatestTestResultsByTestCaseIds(TestCaseLatestResultsQuery, string)	Obtenha os resultados mais recentes para cada TestCaseID solicitado. Casos de teste que nunca foram executados (sem resultado numa execução não eliminada) são omitidos da resposta – o chamador trata a sua ausência como "nunca foi executado".
getResultGroupsByBuild(string, number, string, string[], string)
getResultGroupsByRelease(string, number, string, number, string[], string)
getSessionNotifications(string, number)	Recupera objetos TestResultsSession Notification no armazenamento de dados TCM
getSimilarTestResults(string, number, number, number, number, String)	Obtém a lista de resultados cuja falha coincide com a fornecida.
getTestAgentToken()	Devolve o token GitHub OAuth do utilizador atual com permissão para aceder às APIs do Copilot, bloqueado por uma feature flag.
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 lista de referência de anexos de compilação
getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)	Obter Uri SAS de um anexo de compilação
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 subresultados de teste
getTestPipelineMetrics(string, number, string, string, string, Metrics[], boolean)	Obtenha um resumo dos resultados dos testes.
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)	Obtenha um resumo dos resultados dos testes de uma build. Para obter o TestCaseResult completo, chame Results - Get.
getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)
getTestResultLogs(string, number, number, TestLogType, string, string, boolean, number, String)	Obter lista de referência de anexos de resultados de teste
getTestResultMachines(string, number)	Obtém máquinas de resultado de teste para o TestRunId fornecido
getTestResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByPipeline(string, number, string, string, string, TestOutcome[], boolean, number, String)	Obtenha uma lista de resultados.
getTestResultsByPipelineMRX(string, number, string, string, string, TestOutcome[], boolean, number, String)	Obtém objetos TestCaseResult completos com detalhes 1MRX para o pipelineId fornecido
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)
getTestRunAttachmentUploadDetails(string, number)	Pré-voo para um carregamento de anexo de execução direto para o BlobStore: aplica permissão de publicação e devolve o domínio deduplicado para publicar. O agente chama isto antes de carregar quaisquer bytes.
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 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)	Obtenha estatísticas de execução de teste , usadas quando queremos obter um resumo de uma execução por resultado.
getTestRunSummaryByOutcome(string, number)	Obter resumo da execução de teste, usado quando queremos obter um 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 TCM
getTestSessionLayout(string, string)	Recupera o objeto TestResultsSession Layout no armazenamento de dados TCM
getTestSessionLayoutBySessionId(string, number)	Recupera o objeto TestResultsSession Layout no armazenamento de dados TCM
getTestSessionResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestSettingsById(string, number)
getTestSubResultAttachmentContent(string, number, number, number, number)	Retorna um anexo de subresultado de teste
getTestSubResultAttachments(string, number, number, number)	Retorna referências de anexo para o subresultado do teste.
getTestSubResultAttachmentZip(string, number, number, number, number)	Retorna um anexo de subresultado de teste
getTestSubResultLogs(string, number, number, number, TestLogType, string, string, boolean, number, String)	Obter lista de referência de anexos de subresultado de teste
getTestTagsForBuild(string, number)	Obtenha todas as tags em uma compilação.
getTestTagsForRelease(string, number, number)	Obtenha todas as tags em uma versão.
getTestTagSummaryForBuild(string, number)	Obtenha todas as tags em uma compilação.
getTestTagSummaryForRelease(string, number, number)	Obtenha todas as tags em uma versão.
getTestWeightedScoreByTestRun(string, string, boolean, boolean)	Calcular a Pontuação Ponderada do Teste para uma dada lista separada de Comman de Ids de Corridas de Teste.
publishTestResultDocument(TestResultDocument, string, number)
queryCustomFields(string, CustomTestFieldScope)	Retorna Lista de campos de teste personalizados para o escopo de campo de teste personalizado determinado.
queryResultTrendForBuild(TestResultTrendFilter, string)
queryResultTrendForRelease(TestResultTrendFilter, string)
queryTestHistory(TestHistoryQuery, string)	Obter histórico de um método de teste usando TestHistoryQuery
queryTestMethodLinkedWorkItems(string, string)
queryTestResultAttachmentsMetadata(string, number, number, string, string, number, boolean)	Devolve metadados para os anexos de teste suportados pelo BlobStore ao nível do resultado cujo nome de ficheiro começa com fileNamePrefix, ou para o único anexo identificado por attachmentId quando é fornecido.
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 um resumo dos resultados dos testes.
queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
queryTestResultsSummaryForReleases(ReleaseReference[], string)
queryTestResultWorkItems(string, string, string, number, Date, number, number)	Consultar Itens de Trabalho de Resultado de Teste com base no filtro
queryTestRunAttachmentsMetadata(string, number, string, string, number, boolean)	Devolve metadados para os anexos de teste suportados pelo BlobStore ao nível da execução cujo nome de ficheiro começa com fileNamePrefix, ou para o único anexo identificado pelo attachmentId quando é fornecido. O agente utiliza isto para enumerar registos de teste BlobStore (dedup), que não estão presentes no contentor SAS clássico LogStore e, por isso, não podem ser listados diretamente pelo agente.
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, TestRunSortOrderType, string)	O teste de consulta é executado com base em filtros. Os campos obrigatórios são minLastUpdatedDate e maxLastUpdatedDate.
queryTestSubResultAttachmentsMetadata(string, number, number, number, string, string, number, boolean)	Devolve metadados para os anexos de teste suportados por BlobStore ao nível de subresultado cujo nome de ficheiro começa com fileNamePrefix, ou para o anexo único identificado por attachmentId quando é fornecido.
queryTestSummaryByRequirement(TestResultsContext, string, number[])
testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)	Criar e obter sas uri do contêiner de compilação
testLogStoreEndpointDetailsForResult(string, number, number, number, string, TestLogType)	Criar arquivo vazio para um resultado e Obter Sas uri para o arquivo
testLogStoreEndpointDetailsForRun(string, number, TestLogStoreOperationType, string, TestLogType)	Criar arquivo vazio para uma execução e Obter Sas uri 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 reprovados e abortados.
triggerTestAgent(TestAgentTriggerRequest, string)
updateCodeCoverageSummary(string, number, CodeCoverageData)	http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Solicitação: Json do resumo da cobertura do código
updateCustomField(CustomTestFieldUpdateDefinition, string)	Retorna detalhes do campo de teste personalizado que é atualizado.
updatePipelinesTestSettings(TestResultsUpdateSettings, string)	Atualizar as configurações do projeto dos resultados do teste
updateTestResults(TestCaseResult[], string, number)
updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)	Atualizar propriedades de metadados de resultados de teste
updateTestResultsToTestRunSession(TestCaseResult[], string, number)	Cria objetos TestResultsMRX no armazenamento de dados TCM para resultados de teste existentes
updateTestRun(RunUpdateModel, string, number)
updateTestRunsBySessionId(TestSessionTestRun, string, number)	Atualizações O teste é executado associado a uma sessão
updateTestRunTags(TestTagsUpdateModel, string, number)	Atualizar tags de uma execução, tags podem ser adicionadas e excluídas
updateTestSession(TestResultsSession, string, number)	Atualiza o objeto de sessão de teste associado a um sessionId

TestResultsRestClient(IVssRestClientOptions)

new TestResultsRestClient(options: IVssRestClientOptions)

Parâmetros

options: IVssRestClientOptions

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: "c83eaf52-edf3-4034-ae11-17d38f25404c" = "c83eaf52-edf3-4034-ae11-17d38f25404c"

Valor de Propriedade

"c83eaf52-edf3-4034-ae11-17d38f25404c"

addCustomFields(CustomTestFieldDefinition[], string)

Cria campos de teste personalizados com base nos dados fornecidos.

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

Parâmetros

newFields: CustomTestFieldDefinition[]

NewFields é uma matriz do tipo CustomTestFieldDefinition.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<CustomTestFieldDefinition[]>

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

Devoluções

Promise<TestCaseResult[]>

addTestResultsToTestRunSession(TestCaseResult[], string, number)

Adicionar resultados de teste à sessão de execução de teste

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

Devoluções

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

Devoluções

Promise<WorkItemToTestLinks>

callbackTestAgent(TestAgentCallbackRequest, string)

function callbackTestAgent(request: TestAgentCallbackRequest, project: string): Promise<boolean>

Parâmetros

request: TestAgentCallbackRequest

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<boolean>

completeGitHubAuth(string, string)

Endpoint de retorno de chamada OAuth. O GitHub redireciona para aqui depois de o utilizador autorizar. Troca o código de autorização dos tokens e armazena-os no TCM StrongBox. Requer que o URL de retorno de chamada esteja registado nas definições da aplicação GitHub OAuth.

function completeGitHubAuth(project: string, code: string): Promise<string>

Parâmetros

project: string

ID do projeto ou nome do projeto

code: string

O código de autorização devolvido pelo GitHub após consentimento do utilizador

Devoluções

Promise<string>

createAnalysis(TestSessionAnalysis[], string, number)

Cria o objeto Análise de Sessão no armazenamento de dados TCM para uma determinada sessão

function createAnalysis(analysis: TestSessionAnalysis[], project: string, sessionId: number): Promise<AnalysisFailureGroupReturn[]>

Parâmetros

analysis: TestSessionAnalysis[]

Detalhes da Análise de Sessão

project: string

ID do projeto ou nome do projeto

sessionId: number

ID da sessão para adicionar notificação

Devoluções

Promise<AnalysisFailureGroupReturn[]>

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 fluxo, nome do arquivo, comentário, attachmentType

project: string

ID do projeto ou nome do projeto

buildId: number

BuildId

Devoluções

Promise<void>

createEnvironment(TestSessionEnvironment[], string)

Cria o objeto Environment no armazenamento de dados TCM

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

Parâmetros

environments: TestSessionEnvironment[]

Objeto Ambiente recebido.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<void>

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Para o sessionId fornecido, cria objetos de ambiente, configuração e máquina no armazenamento de dados 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

Devoluções

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

Devoluções

Promise<TestResultFailureType>

createNotification(TestSessionNotification[], string, number)

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

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

Parâmetros

notifications: TestSessionNotification[]

Notificação(ões) a adicionar para o sessionId especificado

project: string

ID do projeto ou nome do projeto

sessionId: number

ID da sessão para adicionar notificação

Devoluções

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

Devoluções

Promise<TestAttachmentReference>

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

Devoluções

Promise<TestAttachmentReference>

createTestResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number)

Regista metadados para um anexo de teste a nível de resultado cujo conteúdo já foi carregado para armazenamento de deduplicação pelo chamador. O pedido transporta apenas os metadados do anexo (id de duplicação, tamanho, nome do ficheiro, tipo, etc.) e nenhum byte de ficheiro.

function createTestResultAttachmentMetadata(attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel, project: string, runId: number, testCaseResultId: number): Promise<TestAttachmentReference>

Parâmetros

attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel

project: string

ID do projeto ou nome do projeto

runId: number

testCaseResultId: number

Devoluções

Promise<TestAttachmentReference>

createTestResultMachines(TestResultMachine[], string, number)

Cria máquinas de resultados de teste para o TestRunId fornecido

function createTestResultMachines(testResultMachines: TestResultMachine[], project: string, runId: number): Promise<void>

Parâmetros

testResultMachines: TestResultMachine[]

Lista de máquinas para resultados de teste na execução

project: string

ID do projeto ou nome do projeto

runId: number

ID do TestRun para adicionar máquinas para

Devoluções

Promise<void>

createTestRun(RunCreateModel, string)

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

Parâmetros

testRun: RunCreateModel

project: string

ID do projeto ou nome do projeto

Devoluções

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

Devoluções

Promise<TestAttachmentReference>

createTestRunAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number)

Regista metadados para um anexo de teste ao nível da execução cujo conteúdo já foi carregado para armazenamento deduplicado pelo chamador. O pedido transporta apenas os metadados do anexo (id de duplicação, tamanho, nome do ficheiro, tipo, etc.) e nenhum byte de ficheiro.

function createTestRunAttachmentMetadata(attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel, project: string, runId: number): Promise<TestAttachmentReference>

Parâmetros

attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel

project: string

ID do projeto ou nome do projeto

runId: number

Devoluções

Promise<TestAttachmentReference>

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 fluxo, nome do arquivo, comentário, attachmentType

project: string

ID do projeto ou nome do projeto

runId: number

RunId de teste

Devoluções

Promise<TestLogStoreAttachmentReference>

createTestSession(TestResultsSession, string)

Cria o objeto TestResultsSession no armazenamento de dados 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

Devoluções

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

Devoluções

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

Devoluções

Promise<TestAttachmentReference>

createTestSubResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number, number)

Regista metadados para um anexo de teste sub-nível de resultado cujo conteúdo já foi carregado para armazenamento de deduplicação pelo chamador. O pedido transporta apenas os metadados do anexo (id de duplicação, tamanho, nome do ficheiro, tipo, etc.) e nenhum byte de ficheiro.

function createTestSubResultAttachmentMetadata(attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel, project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachmentReference>

Parâmetros

attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel

project: string

ID do projeto ou nome do projeto

runId: number

testCaseResultId: number

testSubResultId: number

Devoluções

Promise<TestAttachmentReference>

deleteCustomFieldById(string, number)

Retorna detalhes do campo de teste personalizado para o testExtensionFieldId especificado.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

testExtensionFieldId: number

ID do campo de teste personalizado que deve ser excluído.

Devoluções

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

Devoluções

Promise<void>

deleteFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)

Eliminar IDs de referência de casos de teste instáveis por informação de branch e repositório

function deleteFlakyTestCaseRefIdsByBranch(project: string, repositoryId: string, branchInfo: BranchInfo): Promise<number>

Parâmetros

project: string

ID do projeto ou nome do projeto

repositoryId: string

Guid do repositório

branchInfo: BranchInfo

Informação de ramificação contendo nome e tipo Nota: Operações em ramificações protegidas como 'mestre' ou 'principal' não são suportadas.

Devoluções

Promise<number>

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

Devoluções

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

Devoluções

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

Devoluções

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

Devoluções

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

Nome do arquivo de anexo

Devoluções

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

Devoluções

Promise<void>

enhanceCoverage(string, string, number)

Ponto de entrada clicável no navegador para o link "Melhorar cobertura diferencial" apresentado nos comentários da cobertura de relações públicas. Despacha uma tarefa coverage_test_generation para o ADOAgenticService para o pull request dado e redireciona o utilizador de volta para a página de pull request.

function enhanceCoverage(project: string, repository: string, pullRequestId: number): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

repository: string

pullRequestId: number

Devoluções

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

Devoluções

Promise<SourceViewBuildCoverage[]>

generateTestPlanFromWorkItem(GenerateTestPlanFromWorkItemModel, string, number)

Gera um plano de teste manual a partir de um item de trabalho usando IA. Se o utilizador não tiver um token Copilot válido, devolve needsAuth=true com um authUrl em vez de entrar na fila do trabalho.

function generateTestPlanFromWorkItem(generateTestPlanFromWorkItemModel: GenerateTestPlanFromWorkItemModel, project: string, workItemId: number): Promise<boolean>

Parâmetros

generateTestPlanFromWorkItemModel: GenerateTestPlanFromWorkItemModel

project: string

ID do projeto ou nome do projeto

workItemId: number

Devoluções

Promise<boolean>

getAfdTcmEndpoint(string)

function getAfdTcmEndpoint(key: string): Promise<string>

Parâmetros

key: string

Devoluções

Promise<string>

getBranchesByFlakyTestCaseRefId(string, number)

Obter lista de ramificações onde um id de referência de caso de teste foi lascado

function getBranchesByFlakyTestCaseRefId(project: string, testCaseReferenceId: number): Promise<TestCaseFlakinessBranchInfo>

Parâmetros

project: string

ID do projeto ou nome do projeto

testCaseReferenceId: number

ID de referência do ensaio utilizado pelo resultado do ensaio

Devoluções

Promise<TestCaseFlakinessBranchInfo>

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

Devoluções

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

Devoluções

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10&deltaBuildId=9 Solicitação: build id e delta build id (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

Devoluções

Promise<CodeCoverageSummary>

getCoverageStatusBadge(string, string, string, string)

<p>Obtém o status de cobertura para a última compilação bem-sucedida de uma definição, opcionalmente com escopo para uma ramificação específica</p>

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

O ID ou nome da definição.

branchName: string

O nome da filial.

label: string

A String para substituir o texto padrão no lado esquerdo do selo.

Devoluções

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

Devoluções

Promise<TestResultFailureType[]>

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 pull

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<string>

getFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)

function getFlakyTestCaseRefIdsByBranch(project: string, repositoryId: string, branchInfo: BranchInfo): Promise<TestCaseFlakinessBranchInfo[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

repositoryId: string

branchInfo: BranchInfo

Devoluções

Promise<TestCaseFlakinessBranchInfo[]>

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

Devoluções

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

Devoluções

Promise<TestCaseResult[]>

getLatestTestResultsByTestCaseIds(TestCaseLatestResultsQuery, string)

Obtenha os resultados mais recentes para cada TestCaseID solicitado. Casos de teste que nunca foram executados (sem resultado numa execução não eliminada) são omitidos da resposta – o chamador trata a sua ausência como "nunca foi executado".

function getLatestTestResultsByTestCaseIds(query: TestCaseLatestResultsQuery, project: string): Promise<TestCaseLatestResult[]>

Parâmetros

query: TestCaseLatestResultsQuery

TestCaseLatestResultsQuery transportando os TestCaseIds para pesquisar.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<TestCaseLatestResult[]>

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

Devoluções

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

Devoluções

Promise<PagedList<FieldDetailsForTestResults>>

getSessionNotifications(string, number)

Recupera objetos TestResultsSession Notification no armazenamento de dados 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 obter notificações.

Devoluções

Promise<TestSessionNotification[]>

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

Obtém a lista de resultados cuja falha coincide com a 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 do teste

testResultId: number

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

testSubResultId: number

id do subresultado dentro de um resultado de teste

top: number

Número máximo de resultados a devolver

continuationToken: String

Cabeçalho para passar o continuationToken

Devoluções

Promise<TestCaseResult[]>

getTestAgentToken()

Devolve o token GitHub OAuth do utilizador atual com permissão para aceder às APIs do Copilot, bloqueado por uma feature flag.

function getTestAgentToken(): Promise<string>

Devoluções

Promise<string>

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

Devoluções

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

Devoluções

Promise<ArrayBuffer>

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

Obter lista de referência de anexos de compilação

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 da compilação para obter

type: TestLogType

tipo de anexo a obter

directoryPath: string

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

fileNamePrefix: string

prefixo do nome do 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 anexos de ensaio a devolver

continuationToken: String

Cabeçalho para passar o continuationToken

Devoluções

Promise<PagedList<TestLog>>

getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)

Obter Uri SAS de um anexo de compilação

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 da compilação para obter

type: TestLogType

Tipo de ficheiro

filePath: string

filePath para o qual sas uri é necessário

Devoluções

Promise<TestLogStoreEndpointDetails>

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

filePath: string

filePath para o qual sas uri é necessário

Devoluções

Promise<TestLogStoreEndpointDetails>

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 do teste cujo arquivo deve ser baixado

type: TestLogType

Tipo de ficheiro

filePath: string

filePath para o qual sas uri é necessário

Devoluções

Promise<TestLogStoreEndpointDetails>

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

Obter Uri SAS de um anexo de subresultados 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 o subresultado

subResultId: number

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

type: TestLogType

Tipo de ficheiro

filePath: string

filePath para o qual sas uri é necessário

Devoluções

Promise<TestLogStoreEndpointDetails>

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

Obtenha um resumo dos resultados dos testes.

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 construir Id.

stageName: string

Nome do palco. O comprimento máximo suportado para o nome é de 256 caracteres.

phaseName: string

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

jobName: string

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

metricNames: Metrics[]

groupByNode: boolean

Resumo do grupo para cada nó da herança pipleina

Devoluções

Promise<PipelineTestMetrics>

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

Devoluções

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

Devoluções

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

Devoluções

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

Devoluções

Promise<TestCaseResult>

getTestResultDetailsForBuild(string, number, string, string, string, string, boolean, boolean)

Obtenha um resumo dos resultados dos testes de uma build. Para obter o TestCaseResult completo, chame Results - Get.

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

Devoluções

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

Devoluções

Promise<TestResultsDetails>

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

Obter lista de referência de anexos de resultados 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 obter

directoryPath: string

caminho do diretório de anexos para obter

fileNamePrefix: string

prefixo do nome do arquivo para filtrar a lista de anexos

fetchMetaData: boolean

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

top: number

Numbe de anexos referência para retornar

continuationToken: String

Cabeçalho para passar o continuationToken

Devoluções

Promise<PagedList<TestLog>>

getTestResultMachines(string, number)

Obtém máquinas de resultado de teste para o TestRunId fornecido

function getTestResultMachines(project: string, runId: number): Promise<TestResultMachine[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

ID do TestRun para adicionar máquinas para

Devoluções

Promise<TestResultMachine[]>

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

Devoluções

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

Devoluções

Promise<PagedList<ShallowTestCaseResult>>

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

Obtenha uma lista de resultados.

function getTestResultsByPipeline(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, outcomes?: TestOutcome[], includeAllBuildRuns?: boolean, 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 construir Id.

stageName: string

Nome do palco. O comprimento máximo suportado para o nome é de 256 caracteres.

phaseName: string

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

jobName: string

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

outcomes: TestOutcome[]

Lista dos resultados

includeAllBuildRuns: boolean

Se deve incluir Test Runs de todas as execuções de compilação ou não.

top: number

Número máximo de resultados a devolver

continuationToken: String

Cabeçalho para passar o continuationToken

Devoluções

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsByPipelineMRX(string, number, string, string, string, TestOutcome[], boolean, number, String)

Obtém objetos TestCaseResult completos com detalhes 1MRX para o pipelineId fornecido

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

Parâmetros

project: string

ID do projeto ou nome do projeto

pipelineId: number

ID do pipeline. Isso é o mesmo que construir Id.

stageName: string

Nome do palco. O comprimento máximo suportado para o nome é de 256 caracteres.

phaseName: string

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

jobName: string

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

outcomes: TestOutcome[]

Lista dos resultados

includeAllBuildRuns: boolean

Se deve incluir Test Runs de todas as execuções de compilação ou não. É definido para false por padrão.

top: number

Número máximo de resultados a devolver. O padrão é 10000.

continuationToken: String

Cabeçalho para passar o continuationToken

Devoluções

Promise<PagedList<TestCaseResult>>

getTestResultsByQuery(TestResultsQuery, string)

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

Parâmetros

query: TestResultsQuery

project: string

ID do projeto ou nome do projeto

Devoluções

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

Devoluções

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

Devoluções

Promise<PagedList<ShallowTestCaseResult>>

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

settingsType: TestResultsSettingsType

Devoluções

Promise<TestResultsSettings>

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

Devoluções

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

Devoluções

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

Devoluções

Promise<TestAttachment[]>

getTestRunAttachmentUploadDetails(string, number)

Pré-voo para um carregamento de anexo de execução direto para o BlobStore: aplica permissão de publicação e devolve o domínio deduplicado para publicar. O agente chama isto antes de carregar quaisquer bytes.

function getTestRunAttachmentUploadDetails(project: string, runId: number): Promise<TestAttachmentUploadDetails>

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

Devoluções

Promise<TestAttachmentUploadDetails>

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

Devoluções

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

Devoluções

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

Devoluções

Promise<TestRunCoverage[]>

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

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

type: TestLogType

Tipo de anexos a obter

directoryPath: string

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

fileNamePrefix: string

prefixo do nome do 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 anexos de referência a devolver

continuationToken: String

Cabeçalho para passar o continuationToken

Devoluções

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

Nome do arquivo de anexo

Devoluções

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

Devoluções

Promise<TestLogStoreAttachment[]>

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

Nome do arquivo de anexo

Devoluções

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 corrida a obter.

Devoluções

Promise<TestMessageLogDetails[]>

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

Devoluções

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 obter Test Runs para.

Devoluções

Promise<number[]>

getTestRunStatistics(string, number)

Obtenha estatísticas de execução de teste , usadas quando queremos obter um 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 corrida a obter.

Devoluções

Promise<TestRunStatistic>

getTestRunSummaryByOutcome(string, number)

Obter resumo da execução de teste, usado quando queremos obter um 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 corrida a obter.

Devoluções

Promise<TestRunStatistic>

getTestSession(string, number)

Recupera o objeto de metadados TestResultsSession no armazenamento de dados TCM

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

Devoluções

Promise<TestResultsSession[]>

getTestSessionLayout(string, string)

Recupera o objeto TestResultsSession Layout no armazenamento de dados TCM

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

Parâmetros

project: string

ID do projeto ou nome do projeto

sessionId: string

Devoluções

Promise<any[]>

getTestSessionLayoutBySessionId(string, number)

Recupera o objeto TestResultsSession Layout no armazenamento de dados 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.

Devoluções

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

Devoluções

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

Devoluções

Promise<TestSettings>

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

Retorna um anexo de subresultado 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

Devoluções

Promise<ArrayBuffer>

getTestSubResultAttachments(string, number, number, number)

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

Devoluções

Promise<TestAttachment[]>

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

Retorna um anexo de subresultado 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

Devoluções

Promise<ArrayBuffer>

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

Obter lista de referência de anexos de subresultado 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 subresultado

subResultId: number

ID do subresultado do ensaio

type: TestLogType

Tipo de anexos a obter

directoryPath: string

caminho do diretório do anexo para obter

fileNamePrefix: string

prefixo do nome do ficheiro para filtrar a lista de anexos

fetchMetaData: boolean

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

top: number

Número de anexos de referência a devolver

continuationToken: String

Cabeçalho para passar o continuationToken

Devoluções

Promise<PagedList<TestLog>>

getTestTagsForBuild(string, number)

Obtenha todas as tags em uma compilação.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

ID de compilação

Devoluções

Promise<TestTag[]>

getTestTagsForRelease(string, number, number)

Obtenha todas as tags 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 liberação

Devoluções

Promise<TestTag[]>

getTestTagSummaryForBuild(string, number)

Obtenha todas as tags em uma compilação.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

ID de compilação

Devoluções

Promise<TestTagSummary>

getTestTagSummaryForRelease(string, number, number)

Obtenha todas as tags 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 liberação

Devoluções

Promise<TestTagSummary>

getTestWeightedScoreByTestRun(string, string, boolean, boolean)

Calcular a Pontuação Ponderada do Teste para uma dada lista separada de Comman de Ids de Corridas de Teste.

function getTestWeightedScoreByTestRun(project: string, runIds: string, includeAllOutcomes?: boolean, onlyFlakyResults?: boolean): Promise<TestCaseResult[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

runIds: string

Comman separou os IDs da corrida de teste. Máximo 100 suportados.

includeAllOutcomes: boolean

Inclua todos os resultados dos testes para o Cálculo do TWS. Por defeito, considera-se falso

onlyFlakyResults: boolean

Opção para devolver apenas resultados de testes inestables identificados como instáveis. Por defeito, o verdadeiro é passado

Devoluções

Promise<TestCaseResult[]>

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

Devoluções

Promise<TestResultDocument>

queryCustomFields(string, CustomTestFieldScope)

Retorna Lista de campos de teste personalizados para o escopo de campo de teste personalizado determinado.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

scopeFilter: CustomTestFieldScope

Escopo dos campos de teste personalizados que devem ser retornados.

Devoluções

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

Devoluções

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

Devoluções

Promise<AggregatedDataForResultTrend[]>

queryTestHistory(TestHistoryQuery, string)

Obter 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

Devoluções

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

Devoluções

Promise<TestToWorkItemLinks>

queryTestResultAttachmentsMetadata(string, number, number, string, string, number, boolean)

Devolve metadados para os anexos de teste suportados pelo BlobStore ao nível do resultado cujo nome de ficheiro começa com fileNamePrefix, ou para o único anexo identificado por attachmentId quando é fornecido.

function queryTestResultAttachmentsMetadata(project: string, runId: number, testCaseResultId: number, attachmentType?: string, fileNamePrefix?: string, attachmentId?: number, fetchMetaData?: boolean): Promise<BlobStoreTestAttachment[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

testCaseResultId: number

attachmentType: string

fileNamePrefix: string

attachmentId: number

fetchMetaData: boolean

Devoluções

Promise<BlobStoreTestAttachment[]>

queryTestResultHistory(ResultsFilter, string)

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

Parâmetros

filter: ResultsFilter

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<TestResultHistory>

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

TestCaseReference Ids do teste Resultado 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 incluir nos metadados dos resultados do teste. O padrão é Nenhum. Outros valores são FlakyIdentifiers.

Devoluções

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

Devoluções

Promise<TestResultSummary>

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

Obtenha um resumo dos resultados dos testes.

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 construir Id.

stageName: string

Nome do palco. O comprimento máximo suportado para o nome é de 256 caracteres.

phaseName: string

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

jobName: string

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

includeFailureDetails: boolean

Se true retorna informações de falha

Devoluções

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

Devoluções

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

Devoluções

Promise<TestResultSummary[]>

queryTestResultWorkItems(string, string, string, number, Date, number, number)

Consultar Itens de Trabalho de Resultado de Teste 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 tomar valores Microsoft.BugCategory ou todos (para obter todos os itens de trabalho)

automatedTestName: string

testCaseId: number

maxCompleteDate: Date

days: number

workItemCount: number

Devoluções

Promise<WorkItemReference[]>

queryTestRunAttachmentsMetadata(string, number, string, string, number, boolean)

Devolve metadados para os anexos de teste suportados pelo BlobStore ao nível da execução cujo nome de ficheiro começa com fileNamePrefix, ou para o único anexo identificado pelo attachmentId quando é fornecido. O agente utiliza isto para enumerar registos de teste BlobStore (dedup), que não estão presentes no contentor SAS clássico LogStore e, por isso, não podem ser listados diretamente pelo agente.

function queryTestRunAttachmentsMetadata(project: string, runId: number, attachmentType?: string, fileNamePrefix?: string, attachmentId?: number, fetchMetaData?: boolean): Promise<BlobStoreTestAttachment[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

attachmentType: string

fileNamePrefix: string

attachmentId: number

fetchMetaData: boolean

Devoluções

Promise<BlobStoreTestAttachment[]>

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

O teste de consulta é executado 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, sortOrder?: TestRunSortOrderType, 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 de execução a ser consultada (Obrigatório).

maxLastUpdatedDate: Date

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

state: TestRunState

Estado atual das Execuções a consultar.

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

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

buildDefIds: number[]

Build Definition Ids das execuções a serem consultadas, lista separada por vírgulas de ids válidas.

branchName: string

Nome da ramificação de origem das execuções a serem consultadas.

releaseIds: number[]

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

releaseDefIds: number[]

Ids de definição de liberaçã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[]

Ids de definição de ambiente de liberação 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 consultar. O limite é 100

sortOrder: TestRunSortOrderType

Ordene por LastUpdated para os testes.

continuationToken: string

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

Devoluções

Promise<PagedList<TestRun>>

queryTestSubResultAttachmentsMetadata(string, number, number, number, string, string, number, boolean)

Devolve metadados para os anexos de teste suportados por BlobStore ao nível de subresultado cujo nome de ficheiro começa com fileNamePrefix, ou para o anexo único identificado por attachmentId quando é fornecido.

function queryTestSubResultAttachmentsMetadata(project: string, runId: number, testCaseResultId: number, testSubResultId: number, attachmentType?: string, fileNamePrefix?: string, attachmentId?: number, fetchMetaData?: boolean): Promise<BlobStoreTestAttachment[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

runId: number

testCaseResultId: number

testSubResultId: number

attachmentType: string

fileNamePrefix: string

attachmentId: number

fetchMetaData: boolean

Devoluções

Promise<BlobStoreTestAttachment[]>

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

Devoluções

Promise<TestSummaryForWorkItem[]>

testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)

Criar e obter sas uri do contêiner de compilação

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

Id da compilação para obter

testLogStoreOperationType: TestLogStoreOperationType

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

Devoluções

Promise<TestLogStoreEndpointDetails>

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

Criar arquivo vazio para um resultado e Obter Sas uri 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 subresultado

subResultId: number

Id do subresultado do teste cujo arquivo sas uri é necessário

filePath: string

Caminho do arquivo dentro do subresultado para o qual o URI SAS é necessário

type: TestLogType

Tipo de ficheiro para transferência

Devoluções

Promise<TestLogStoreEndpointDetails>

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

Criar arquivo vazio para uma execução e Obter Sas uri 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

Devoluções

Promise<TestLogStoreEndpointDetails>

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

Obtenha todos os detalhes dos grupos disponíveis e, para esses grupos, obtenha resultados reprovados e abortados.

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 construir Id.

stageName: string

Nome do palco. O comprimento máximo suportado para o nome é de 256 caracteres.

phaseName: string

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

jobName: string

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

shouldIncludeFailedAndAbortedResults: boolean

Se verdadeiro, ele retornará Ids de resultados com falha e abortados para cada grupo de teste

queryGroupSummaryForInProgress: boolean

Se verdadeiro, ele também calculará o resumo para execuções do InProgress.

Devoluções

Promise<TestResultsDetails>

triggerTestAgent(TestAgentTriggerRequest, string)

function triggerTestAgent(request: TestAgentTriggerRequest, project: string): Promise<boolean>

Parâmetros

request: TestAgentTriggerRequest

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<boolean>

updateCodeCoverageSummary(string, number, CodeCoverageData)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Solicitação: Json do resumo da cobertura do 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

Devoluções

Promise<void>

updateCustomField(CustomTestFieldUpdateDefinition, string)

Retorna detalhes do campo de teste personalizado que é atualizado.

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

Parâmetros

updateCustomTestField: CustomTestFieldUpdateDefinition

Campo de teste personalizado que deve ser atualizado.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<CustomTestFieldDefinition>

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

Devoluções

Promise<TestResultsSettings>

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

Devoluções

Promise<TestCaseResult[]>

updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)

Atualizar propriedades de metadados de resultados de teste

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

Parâmetros

testResultMetaDataUpdateInput: TestResultMetaDataUpdateInput

Entrada de atualização TestResultMetaData TestResultMetaDataUpdateInput

project: string

ID do projeto ou nome do projeto

testCaseReferenceId: number

TestCaseReference ID do resultado do teste a ser atualizado.

Devoluções

Promise<TestResultMetaData>

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 propriedades MRX de resultados de teste e testResultId existente

project: string

ID do projeto ou nome do projeto

runId: number

RunId da execução do teste

Devoluções

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

Devoluções

Promise<TestRun>

updateTestRunsBySessionId(TestSessionTestRun, string, number)

Atualizações O teste é executado associado a uma sessão

function updateTestRunsBySessionId(testRunIds: TestSessionTestRun, project: string, sessionId: number): Promise<number[]>

Parâmetros

testRunIds: TestSessionTestRun

project: string

ID do projeto ou nome do projeto

sessionId: number

Id da sessão TestResults para atualizar Test Runs para.

Devoluções

Promise<number[]>

updateTestRunTags(TestTagsUpdateModel, string, number)

Atualizar tags de uma execução, tags 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

Devoluções

Promise<TestTag[]>

updateTestSession(TestResultsSession, string, number)

Atualiza o objeto de sessão de teste associado a um sessionId

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

Parâmetros

session: TestResultsSession

Atualizar objeto Session

project: string

ID do projeto ou nome do projeto

sessionId: number

Id da sessão TestResults para atualizar o objeto Test session.

Devoluções

Promise<number>

TestResultsRestClient class

Construtores

Propriedades

Métodos

Detalhes do Construtor

TestResultsRestClient(IVssRestClientOptions)

Parâmetros

Detalhes de Propriedade

RESOURCE_AREA_ID

Valor de Propriedade

Detalhes de Método

addCustomFields(CustomTestFieldDefinition[], string)

Parâmetros

Devoluções

addTestResultsToTestRun(TestCaseResult[], string, number)

Parâmetros

Devoluções

addTestResultsToTestRunSession(TestCaseResult[], string, number)

Parâmetros

Devoluções

addWorkItemToTestLinks(WorkItemToTestLinks, string)

Parâmetros

Devoluções

callbackTestAgent(TestAgentCallbackRequest, string)

Parâmetros

Devoluções

completeGitHubAuth(string, string)

Parâmetros

Devoluções

createAnalysis(TestSessionAnalysis[], string, number)

Parâmetros

Devoluções

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

Parâmetros

Devoluções

createEnvironment(TestSessionEnvironment[], string)

Parâmetros

Devoluções

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Parâmetros

Devoluções

createFailureType(TestResultFailureTypeRequestModel, string)

Parâmetros

Devoluções

createNotification(TestSessionNotification[], string, number)

Parâmetros

Devoluções

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

Parâmetros

Devoluções

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Parâmetros

Devoluções

createTestResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number)

Parâmetros

Devoluções

createTestResultMachines(TestResultMachine[], string, number)

Parâmetros

Devoluções

createTestRun(RunCreateModel, string)

Parâmetros

Devoluções

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Parâmetros

Devoluções

createTestRunAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number)

Parâmetros

Devoluções

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

Parâmetros

Devoluções

createTestSession(TestResultsSession, string)

Parâmetros

Devoluções

createTestSettings(TestSettings, string)

Parâmetros

Devoluções

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

Parâmetros

Devoluções