TestRestClient class
Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS
- Extends
Construtores
| Test |
Propriedades
| RESOURCE_AREA_ID |
Métodos
Detalhes do Construtor
TestRestClient(IVssRestClientOptions)
Detalhes de Propriedade
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValor de Propriedade
string
Detalhes de Método
addCustomFields(CustomTestFieldDefinition[], string)
function addCustomFields(newFields: CustomTestFieldDefinition[], project: string): Promise<CustomTestFieldDefinition[]>Parâmetros
- newFields
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<CustomTestFieldDefinition[]>
addTestCasesToSuite(string, number, number, string)
Adicione casos de teste ao conjunto de aplicações.
function addTestCasesToSuite(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- planId
-
number
ID do plano de teste que contém o conjunto de aplicações.
- suiteId
-
number
ID do conjunto de testes ao qual os casos de teste têm de ser adicionados.
- testCaseIds
-
string
IDs dos casos de teste a adicionar ao conjunto de aplicações. Os IDs são especificados em formato separado por vírgulas.
Devoluções
Promise<SuiteTestCase[]>
addTestResultsToTestRun(TestCaseResult[], string, number)
Adicionar resultados de teste a uma execução de teste.
function addTestResultsToTestRun(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>Parâmetros
- results
Lista de resultados de teste a adicionar.
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
Teste o ID de execução nos resultados do teste a adicionar.
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>
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)
Anexar um ficheiro ao resultado do passo de teste
function createTestIterationResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, iterationId: number, actionPath?: string): Promise<TestAttachmentReference>Parâmetros
- attachmentRequestModel
- TestAttachmentRequestModel
Detalhes do anexo TestAttachmentRequestModel
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução de teste que contém o resultado.
- testCaseResultId
-
number
ID do resultado do teste que contém a iteração
- iterationId
-
number
ID da iteração do resultado do teste.
- actionPath
-
string
Valor hexadecima do caminho de ação do resultado do teste.
Devoluções
Promise<TestAttachmentReference>
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)
Anexe um ficheiro a um resultado de teste.
function createTestResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number): Promise<TestAttachmentReference>Parâmetros
- attachmentRequestModel
- TestAttachmentRequestModel
Detalhes do anexo TestAttachmentRequestModel
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução de teste que contém o resultado.
- testCaseResultId
-
number
ID do resultado do teste em relação ao anexo que tem de ser carregado.
Devoluções
Promise<TestAttachmentReference>
createTestRun(RunCreateModel, string)
Criar nova execução de teste.
function createTestRun(testRun: RunCreateModel, project: string): Promise<TestRun>Parâmetros
- testRun
- RunCreateModel
Executar detalhes RunCreateModel
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<TestRun>
createTestRunAttachment(TestAttachmentRequestModel, string, number)
Anexar um ficheiro a uma execução de teste.
function createTestRunAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestAttachmentReference>Parâmetros
- attachmentRequestModel
- TestAttachmentRequestModel
Detalhes do anexo TestAttachmentRequestModel
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução do teste em relação ao anexo que tem de ser carregado.
Devoluções
Promise<TestAttachmentReference>
createTestSession(TestSession, TeamContext)
Criar uma sessão de teste
function createTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>Parâmetros
- testSession
- TestSession
Detalhes da sessão de teste para criação
- teamContext
- TeamContext
O contexto da equipa para a operação
Devoluções
Promise<TestSession>
createTestSettings(TestSettings, string)
function createTestSettings(testSettings: TestSettings, project: string): Promise<number>Parâmetros
- testSettings
- TestSettings
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<number>
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)
Anexar um ficheiro a um resultado de teste
function createTestSubResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachmentReference>Parâmetros
- attachmentRequestModel
- TestAttachmentRequestModel
Modelo de Pedido de Anexo.
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução de teste que contém o resultado.
- testCaseResultId
-
number
ID dos resultados do teste que contém sub result.
- testSubResultId
-
number
ID dos sub-resultados do teste em relação aos quais o anexo tem de ser carregado.
Devoluções
Promise<TestAttachmentReference>
deleteSharedParameter(string, number)
function deleteSharedParameter(project: string, sharedParameterId: number): Promise<void>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- sharedParameterId
-
number
Devoluções
Promise<void>
deleteSharedStep(string, number)
function deleteSharedStep(project: string, sharedStepId: number): Promise<void>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- sharedStepId
-
number
Devoluções
Promise<void>
deleteTestCase(string, number)
Eliminar um caso de teste.
function deleteTestCase(project: string, testCaseId: number): Promise<void>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- testCaseId
-
number
ID do caso de teste a eliminar.
Devoluções
Promise<void>
deleteTestMethodToWorkItemLink(string, string, number)
function deleteTestMethodToWorkItemLink(project: string, testName: string, workItemId: number): Promise<boolean>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- testName
-
string
- workItemId
-
number
Devoluções
Promise<boolean>
deleteTestRun(string, number)
Elimine um teste executado pelo respetivo ID.
function deleteTestRun(project: string, runId: number): Promise<void>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução a eliminar.
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>
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)
Obter dados de cobertura de código para uma compilação.
function getBuildCodeCoverage(project: string, buildId: number, flags: number): Promise<BuildCoverage[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- buildId
-
number
ID da compilação para a qual os dados de cobertura do código têm de ser obtidos.
- flags
-
number
O valor dos sinalizadores determina o nível de detalhes de cobertura do código a obter. As bandeiras são aditivas. Os Valores Esperados são 1 para Módulos, 2 para Funções, 4 para BlockData.
Devoluções
Promise<BuildCoverage[]>
getCodeCoverageSummary(string, number, number)
Obtenha o Resumo da Cobertura do Código para Compilação.
function getCodeCoverageSummary(project: string, buildId: number, deltaBuildId?: number): Promise<CodeCoverageSummary>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- buildId
-
number
ID da compilação para a qual os dados de cobertura do código têm de ser obtidos.
- deltaBuildId
-
number
ID da Compilação Delta (opcional)
Devoluções
Promise<CodeCoverageSummary>
getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)
function getLinkedWorkItemsByQuery(workItemQuery: LinkedWorkItemsQuery, project: string): Promise<LinkedWorkItemsQueryResult[]>Parâmetros
- workItemQuery
- LinkedWorkItemsQuery
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<LinkedWorkItemsQueryResult[]>
getPoint(string, number, number, number, string)
Obtenha um ponto de teste.
function getPoint(project: string, planId: number, suiteId: number, pointIds: number, witFields?: string): Promise<TestPoint>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- planId
-
number
ID do plano de teste.
- suiteId
-
number
ID do conjunto que contém o ponto.
- pointIds
-
number
ID do ponto de teste a obter.
- witFields
-
string
Lista separada por vírgulas de nomes de campos de itens de trabalho.
Devoluções
Promise<TestPoint>
getPoints(string, number, number, string, string, string, string, boolean, number, number)
Obtenha uma lista de pontos de teste.
function getPoints(project: string, planId: number, suiteId: number, witFields?: string, configurationId?: string, testCaseId?: string, testPointIds?: string, includePointDetails?: boolean, skip?: number, top?: number): Promise<TestPoint[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- planId
-
number
ID do plano de teste.
- suiteId
-
number
ID do conjunto que contém os pontos.
- witFields
-
string
Lista separada por vírgulas de nomes de campos de itens de trabalho.
- configurationId
-
string
Obtenha pontos de teste para uma configuração específica.
- testCaseId
-
string
Obtenha pontos de teste para um caso de teste específico, válido quando configurationId não está definido.
- testPointIds
-
string
Obtenha pontos de teste para uma lista separada por vírgulas de IDs de ponto de teste, válidos apenas quando configurationId e testCaseId não estiverem definidos.
- includePointDetails
-
boolean
Inclua todas as propriedades do ponto de teste.
- skip
-
number
Número de pontos de teste a ignorar.
- top
-
number
Número de pontos de teste a devolver.
Devoluções
Promise<TestPoint[]>
getPointsByQuery(TestPointsQuery, string, number, number)
Obtenha pontos de teste com a consulta.
function getPointsByQuery(query: TestPointsQuery, project: string, skip?: number, top?: number): Promise<TestPointsQuery>Parâmetros
- query
- TestPointsQuery
TestPointsQuery para obter pontos de teste.
- project
-
string
ID do Projeto ou nome do projeto
- skip
-
number
Número de pontos de teste a ignorar.
- top
-
number
Número de pontos de teste a devolver.
Devoluções
Promise<TestPointsQuery>
getResultGroupsByBuild(string, number, string, string[], string)
function getResultGroupsByBuild(project: string, buildId: number, publishContext: string, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- buildId
-
number
- publishContext
-
string
- fields
-
string[]
- continuationToken
-
string
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>>
getResultRetentionSettings(string)
Obter definições de retenção de resultados de teste
function getResultRetentionSettings(project: string): Promise<ResultRetentionSettings>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<ResultRetentionSettings>
getTestCaseById(string, number, number, number)
Obtenha um caso de teste específico num conjunto de testes com o ID do caso de teste.
function getTestCaseById(project: string, planId: number, suiteId: number, testCaseIds: number): Promise<SuiteTestCase>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- planId
-
number
ID do plano de teste que contém os conjuntos de aplicações.
- suiteId
-
number
ID do conjunto que contém o caso de teste.
- testCaseIds
-
number
ID do caso de teste a obter.
Devoluções
Promise<SuiteTestCase>
getTestCases(string, number, number)
Obtenha todos os casos de teste num conjunto de aplicações.
function getTestCases(project: string, planId: number, suiteId: number): Promise<SuiteTestCase[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- planId
-
number
ID do plano de teste que contém os conjuntos de aplicações.
- suiteId
-
number
ID da suite para obter.
Devoluções
Promise<SuiteTestCase[]>
getTestIteration(string, number, number, number, boolean)
Obter iteração para um resultado
function getTestIteration(project: string, runId: number, testCaseResultId: number, iterationId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução de teste que contém o resultado.
- testCaseResultId
-
number
ID do resultado do teste que contém as iterações.
- iterationId
-
number
ID da Iteração dos resultados do teste.
- includeActionResults
-
boolean
Inclua detalhes de resultados para cada ação executada na iteração de teste. ActionResults refere-se ao resultado (pass/fail) dos passos de teste que são executados como parte de um teste manual em execução. Incluindo o sinalizador ActionResults obtém o resultado dos passos de teste na secção actionResults e parâmetros de teste na secção parâmetros para cada iteração de teste.
Devoluções
Promise<TestIterationDetailsModel>
getTestIterations(string, number, number, boolean)
Obter iterações para um resultado
function getTestIterations(project: string, runId: number, testCaseResultId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução de teste que contém o resultado.
- testCaseResultId
-
number
ID do resultado do teste que contém as iterações.
- includeActionResults
-
boolean
Inclua detalhes de resultados para cada ação executada na iteração de teste. ActionResults refere-se ao resultado (pass/fail) dos passos de teste que são executados como parte de um teste manual em execução. Incluindo o sinalizador ActionResults obtém o resultado dos passos de teste na secção actionResults e parâmetros de teste na secção parâmetros para cada iteração de teste.
Devoluções
Promise<TestIterationDetailsModel[]>
getTestResultAttachmentContent(string, number, number, number)
Transfira um anexo de resultado de teste pelo respetivo ID.
function getTestResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução de teste que contém testCaseResultId.
- testCaseResultId
-
number
ID do resultado do teste cujo anexo tem de ser transferido.
- attachmentId
-
number
ID do anexo do resultado do teste a transferir.
Devoluções
Promise<ArrayBuffer>
getTestResultAttachments(string, number, number)
Obter a lista de referência de anexos de resultados de teste.
function getTestResultAttachments(project: string, runId: number, testCaseResultId: number): Promise<TestAttachment[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução de teste que contém o resultado.
- testCaseResultId
-
number
ID do resultado do teste.
Devoluções
Promise<TestAttachment[]>
getTestResultAttachmentZip(string, number, number, number)
Transfira um anexo de resultado de teste pelo respetivo ID.
function getTestResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução de teste que contém testCaseResultId.
- testCaseResultId
-
number
ID do resultado do teste cujo anexo tem de ser transferido.
- attachmentId
-
number
ID do anexo do resultado do teste a transferir.
Devoluções
Promise<ArrayBuffer>
getTestResultById(string, number, number, ResultDetails)
Obtenha um resultado de teste para uma execução de teste.
function getTestResultById(project: string, runId: number, testCaseResultId: number, detailsToInclude?: ResultDetails): Promise<TestCaseResult>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
Testar o ID de execução de um resultado de teste a obter.
- testCaseResultId
-
number
ID do resultado do teste.
- detailsToInclude
- ResultDetails
Detalhes a incluir com os resultados do teste. A predefinição é Nenhuma. Outros valores são Iterações, WorkItems e SubResults.
Devoluções
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
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>
getTestResults(string, number, ResultDetails, number, number, TestOutcome[])
Obter resultados de teste para uma execução de teste.
function getTestResults(project: string, runId: number, detailsToInclude?: ResultDetails, skip?: number, top?: number, outcomes?: TestOutcome[]): Promise<TestCaseResult[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
Testar o ID de execução dos resultados do teste a obter.
- detailsToInclude
- ResultDetails
Detalhes a incluir com os resultados do teste. A predefinição é Nenhuma. Outros valores são Iterações e WorkItems.
- skip
-
number
Número de resultados de teste a ignorar do início.
- top
-
number
Número de resultados do teste a devolver. O máximo é 1000 quando detailsToInclude é Nenhum e 200 de outra forma.
- outcomes
Lista separada por vírgulas dos resultados do teste para filtrar os resultados dos testes.
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
- top
-
number
- continuationToken
-
string
Devoluções
Promise<PagedList<ShallowTestCaseResult>>
getTestResultsByQuery(TestResultsQuery, string)
Esta API devolverá resultados por IDs com campos especificados/tendência para um método de teste automatizado específico. Ainda estamos a melhorar esta API e ainda não finalizámos a assinatura e o contrato adequados.
function getTestResultsByQuery(query: TestResultsQuery, project: string): Promise<TestResultsQuery>Parâmetros
- query
- TestResultsQuery
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<TestResultsQuery>
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
function getTestResultsByRelease(project: string, releaseId: number, releaseEnvid?: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- releaseId
-
number
- releaseEnvid
-
number
- publishContext
-
string
- outcomes
- top
-
number
- continuationToken
-
string
Devoluções
Promise<PagedList<ShallowTestCaseResult>>
getTestRunAttachmentContent(string, number, number)
Transfira um anexo de execução de teste pelo respetivo ID.
function getTestRunAttachmentContent(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução de teste cujo anexo tem de ser transferido.
- attachmentId
-
number
ID do anexo de execução de teste a transferir.
Devoluções
Promise<ArrayBuffer>
getTestRunAttachments(string, number)
Obter a lista de referência de anexos da execução de testes.
function getTestRunAttachments(project: string, runId: number): Promise<TestAttachment[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução do teste.
Devoluções
Promise<TestAttachment[]>
getTestRunAttachmentZip(string, number, number)
Transfira um anexo de execução de teste pelo respetivo ID.
function getTestRunAttachmentZip(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução de teste cujo anexo tem de ser transferido.
- attachmentId
-
number
ID do anexo de execução de teste a transferir.
Devoluções
Promise<ArrayBuffer>
getTestRunById(string, number, boolean)
Obtenha um teste executado pelo respetivo ID.
function getTestRunById(project: string, runId: number, includeDetails?: boolean): Promise<TestRun>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução a obter.
- includeDetails
-
boolean
O valor predefinido é verdadeiro. Inclui detalhes como estatísticas de execução, versão, compilação, ambiente de teste, estado pós-processo e muito mais.
Devoluções
Promise<TestRun>
getTestRunCodeCoverage(string, number, number)
Obter dados de cobertura do código para uma execução de teste
function getTestRunCodeCoverage(project: string, runId: number, flags: number): Promise<TestRunCoverage[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução de teste para a qual os dados de cobertura do código têm de ser obtidos.
- flags
-
number
O valor dos sinalizadores determina o nível de detalhes de cobertura do código a obter. As bandeiras são aditivas. Os Valores Esperados são 1 para Módulos, 2 para Funções, 4 para BlockData.
Devoluções
Promise<TestRunCoverage[]>
getTestRunLogs(string, number)
Obter registos de mensagens de execução de teste
function getTestRunLogs(project: string, runId: number): Promise<TestMessageLogDetails[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução a obter.
Devoluções
Promise<TestMessageLogDetails[]>
getTestRuns(string, string, string, string, number, boolean, boolean, number, number)
Obtenha uma lista de execuções de testes.
function getTestRuns(project: string, buildUri?: string, owner?: string, tmiRunId?: string, planId?: number, includeRunDetails?: boolean, automated?: boolean, skip?: number, top?: number): Promise<TestRun[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- buildUri
-
string
URI da compilação que a execução utilizou.
- owner
-
string
ID de fundação da equipa do proprietário das execuções.
- tmiRunId
-
string
- planId
-
number
ID do plano de teste do qual as execuções fazem parte.
- includeRunDetails
-
boolean
Se for verdadeiro, inclua todas as propriedades das execuções.
- automated
-
boolean
Se for verdadeiro, apenas devolve execuções automatizadas.
- skip
-
number
Número de execuções de teste a ignorar.
- top
-
number
Número de execuções de teste a devolver.
Devoluções
Promise<TestRun[]>
getTestRunStatistics(string, number)
Obtenha estatísticas de execução de testes , utilizadas quando queremos obter o resumo de um resultado executado por.
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 obter.
Devoluções
Promise<TestRunStatistic>
getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)
Obter uma lista de sessões de teste
function getTestSessions(teamContext: TeamContext, period?: number, allSessions?: boolean, includeAllProperties?: boolean, source?: TestSessionSource, includeOnlyCompletedSessions?: boolean): Promise<TestSession[]>Parâmetros
- teamContext
- TeamContext
O contexto da equipa para a operação
- period
-
number
Período em dias a partir de agora, para o qual as sessões de teste são obtidas.
- allSessions
-
boolean
Se for falso, devolve sessões de teste para o utilizador atual. Caso contrário, devolve sessões de teste para todos os utilizadores
- includeAllProperties
-
boolean
Se for verdadeiro, devolve todas as propriedades das sessões de teste. Caso contrário, devolve a versão magra.
- source
- TestSessionSource
Origem da sessão de teste.
- includeOnlyCompletedSessions
-
boolean
Se for verdadeiro, devolve sessões de teste no estado concluído. Caso contrário, devolve sessões de teste para todos os estados
Devoluções
Promise<TestSession[]>
getTestSettingsById(string, number)
function getTestSettingsById(project: string, testSettingsId: number): Promise<TestSettings>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- testSettingsId
-
number
Devoluções
Promise<TestSettings>
getTestSubResultAttachmentContent(string, number, number, number, number)
Transferir um anexo de sub result de teste
function getTestSubResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução de teste que contém o resultado.
- testCaseResultId
-
number
ID dos resultados do teste que contém sub result.
- attachmentId
-
number
ID do anexo do resultado do teste a transferir
- testSubResultId
-
number
ID do subconjunto de teste cujo anexo tem de ser transferido
Devoluções
Promise<ArrayBuffer>
getTestSubResultAttachments(string, number, number, number)
Obter lista de anexos de subconsultores de teste
function getTestSubResultAttachments(project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachment[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução de teste que contém o resultado.
- testCaseResultId
-
number
ID dos resultados do teste que contém sub result.
- testSubResultId
-
number
ID do subconjunto de teste cujo anexo tem de ser transferido
Devoluções
Promise<TestAttachment[]>
getTestSubResultAttachmentZip(string, number, number, number, number)
Transferir um anexo de sub result de teste
function getTestSubResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução de teste que contém o resultado.
- testCaseResultId
-
number
ID dos resultados do teste que contém sub result.
- attachmentId
-
number
ID do anexo do resultado do teste a transferir
- testSubResultId
-
number
ID do subconjunto de teste cujo anexo tem de ser transferido
Devoluções
Promise<ArrayBuffer>
publishTestResultDocument(TestResultDocument, string, number)
function publishTestResultDocument(document: TestResultDocument, project: string, runId: number): Promise<TestResultDocument>Parâmetros
- document
- TestResultDocument
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
Devoluções
Promise<TestResultDocument>
queryCustomFields(string, CustomTestFieldScope)
function queryCustomFields(project: string, scopeFilter: CustomTestFieldScope): Promise<CustomTestFieldDefinition[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- scopeFilter
- CustomTestFieldScope
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 o histórico de um método de teste com 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>
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)
Obter lista de detalhes de metadados de resultados de teste para testcasereferenceId correspondente
function queryTestResultsMetaData(testReferenceIds: string[], project: string): Promise<TestResultMetaData[]>Parâmetros
- testReferenceIds
-
string[]
TestCaseReference Ids do resultado de teste a consultar, lista separada por vírgulas de IDs válidos (n.º limite de IDs 200).
- project
-
string
ID do Projeto ou nome do projeto
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>
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
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<TestResultSummary[]>
queryTestResultWorkItems(string, string, string, number, Date, number, number)
function queryTestResultWorkItems(project: string, workItemCategory: string, automatedTestName?: string, testCaseId?: number, maxCompleteDate?: Date, days?: number, workItemCount?: number): Promise<WorkItemReference[]>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- workItemCategory
-
string
- automatedTestName
-
string
- testCaseId
-
number
- maxCompleteDate
-
Date
- days
-
number
- workItemCount
-
number
Devoluções
Promise<WorkItemReference[]>
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, string)
Execuções de Testes de Consulta baseadas 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 consultar (Obrigatório).
- maxLastUpdatedDate
-
Date
Data Máxima da Última Modificação da execução a consultar (Obrigatório, a diferença entre a data mínima e a máxima pode ser no máximo de 7 dias).
- state
- TestRunState
Estado atual das Execuções a consultar.
- planIds
-
number[]
Planeie os IDs das Execuções a consultar, lista separada por vírgulas de IDs válidos (limite n.º de IDs 10).
- isAutomated
-
boolean
Tipo de automatização das Execuções a consultar.
- publishContext
- TestRunPublishContext
PublishContext das Execuções a consultar.
- buildIds
-
number[]
Criar IDs das Execuções a consultar, lista separada por vírgulas de IDs válidos (não limite de IDs 10).
- buildDefIds
-
number[]
Criar IDs de Definição das Execuções a consultar, lista separada por vírgulas de IDs válidos (n.º limite de IDs 10).
- branchName
-
string
Nome do Ramo de Origem das Execuções a consultar.
- releaseIds
-
number[]
IDs de versão das Execuções a consultar, lista separada por vírgulas de IDs válidos (n.º limite de IDs 10).
- releaseDefIds
-
number[]
IDs de Definição de Versão das Execuções a consultar, lista separada por vírgulas de IDs válidos (n.º limite de IDs 10).
- releaseEnvIds
-
number[]
IDs do Ambiente de Versão das Execuções a consultar, lista separada por vírgulas de IDs válidos (não limite de IDs 10).
- releaseEnvDefIds
-
number[]
IDs de Definição do Ambiente de Versão das Execuções a consultar, lista separada por vírgulas de IDs válidos (n.º limite de IDs 10).
- runTitle
-
string
Execute o Título das Execuções a consultar.
- top
-
number
Número de execuções a consultar. O limite é 100
- continuationToken
-
string
continuationToken recebido do lote anterior ou nulo para o primeiro lote. Não é suposto ser criado (ou alterado, se recebido do último lote) pelo utilizador.
Devoluções
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[]>
removeTestCasesFromSuiteUrl(string, number, number, string)
Os pontos de teste associados aos casos de teste são removidos do conjunto de testes. O item de trabalho do caso de teste não é eliminado do sistema. Veja o recurso de casos de teste para eliminar um caso de teste permanentemente.
function removeTestCasesFromSuiteUrl(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<void>Parâmetros
- project
-
string
ID do Projeto ou nome do projeto
- planId
-
number
ID do plano de teste que contém o conjunto de aplicações.
- suiteId
-
number
ID da suite para obter.
- testCaseIds
-
string
IDs dos casos de teste a remover do conjunto de aplicações.
Devoluções
Promise<void>
updateCodeCoverageSummary(CodeCoverageData, string, number)
http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Request: Json of code coverage summary
function updateCodeCoverageSummary(coverageData: CodeCoverageData, project: string, buildId: number): Promise<void>Parâmetros
- coverageData
- CodeCoverageData
- project
-
string
ID do Projeto ou nome do projeto
- buildId
-
number
Devoluções
Promise<void>
updateResultRetentionSettings(ResultRetentionSettings, string)
Atualizar as definições de retenção de resultados do teste
function updateResultRetentionSettings(retentionSettings: ResultRetentionSettings, project: string): Promise<ResultRetentionSettings>Parâmetros
- retentionSettings
- ResultRetentionSettings
Detalhes das definições de retenção de resultados de teste a serem atualizados
- project
-
string
ID do Projeto ou nome do projeto
Devoluções
Promise<ResultRetentionSettings>
updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)
Atualizações as propriedades da associação de casos de teste num conjunto de aplicações.
function updateSuiteTestCases(suiteTestCaseUpdateModel: SuiteTestCaseUpdateModel, project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>Parâmetros
- suiteTestCaseUpdateModel
- SuiteTestCaseUpdateModel
Modelo para a updation das propriedades da associação do conjunto de casos de teste.
- project
-
string
ID do Projeto ou nome do projeto
- planId
-
number
ID do plano de teste que contém o conjunto de aplicações.
- suiteId
-
number
ID do conjunto de testes ao qual os casos de teste têm de ser adicionados.
- testCaseIds
-
string
IDs dos casos de teste a adicionar ao conjunto de aplicações. Os IDs são especificados em formato separado por vírgulas.
Devoluções
Promise<SuiteTestCase[]>
updateTestPoints(PointUpdateModel, string, number, number, string)
Atualizar pontos de teste.
function updateTestPoints(pointUpdateModel: PointUpdateModel, project: string, planId: number, suiteId: number, pointIds: string): Promise<TestPoint[]>Parâmetros
- pointUpdateModel
- PointUpdateModel
Dados a atualizar.
- project
-
string
ID do Projeto ou nome do projeto
- planId
-
number
ID do plano de teste.
- suiteId
-
number
ID do conjunto que contém os pontos.
- pointIds
-
string
ID do ponto de teste a obter. Utilize uma lista separada por vírgulas de IDs para atualizar vários pontos de teste.
Devoluções
Promise<TestPoint[]>
updateTestResults(TestCaseResult[], string, number)
O teste de atualização resulta numa execução de teste.
function updateTestResults(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>Parâmetros
- results
Lista de resultados do teste a atualizar.
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID de execução de teste cujos resultados de teste serão atualizados.
Devoluções
Promise<TestCaseResult[]>
updateTestRun(RunUpdateModel, string, number)
Teste de atualização executado pelo respetivo ID.
function updateTestRun(runUpdateModel: RunUpdateModel, project: string, runId: number): Promise<TestRun>Parâmetros
- runUpdateModel
- RunUpdateModel
Executar detalhes RunUpdateModel
- project
-
string
ID do Projeto ou nome do projeto
- runId
-
number
ID da execução a atualizar.
Devoluções
Promise<TestRun>
updateTestSession(TestSession, TeamContext)
Atualizar uma sessão de teste
function updateTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>Parâmetros
- testSession
- TestSession
Detalhes da sessão de teste para atualização
- teamContext
- TeamContext
O contexto da equipa para a operação
Devoluções
Promise<TestSession>
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários