TestPlanRestClient class

Referência

Pacote:: azure-devops-extension-api

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

Extends: RestClientBase

Construtores

TestPlanRestClient(IVssRestClientOptions)

Métodos

addTestCasesToSuite(SuiteTestCaseCreateUpdateParameters[], string, number, number)	Adicionar casos de teste a um pacote com configurações especificadas
cloneTestCase(CloneTestCaseParams, string)
cloneTestPlan(CloneTestPlanParams, string, boolean)	Plano de teste de clonagem
cloneTestSuite(CloneTestSuiteParams, string, boolean)	Conjunto de testes de clonagem
createBulkTestSuites(TestSuiteCreateParams[], string, number, number)	Crie conjuntos de testes baseados em requisitos em massa.
createTestConfiguration(TestConfigurationCreateUpdateParameters, string)	Crie uma configuração de teste.
createTestPlan(TestPlanCreateParams, string)	Crie um plano de teste.
createTestSuite(TestSuiteCreateParams, string, number)	Crie um conjunto de testes.
createTestVariable(TestVariableCreateUpdateParameters, string)	Crie uma variável de teste.
deleteTestCase(string, number)	Exclua um caso de teste.
deleteTestConfguration(string, number)	Exclua uma configuração de teste por sua ID.
deleteTestPlan(string, number)	Exclua um plano de teste.
deleteTestSuite(string, number, number)	Exclua o conjunto de testes.
deleteTestVariable(string, number)	Exclua uma variável de teste por sua ID.
exportTestCases(ExportTestCaseParams, string)	Exporta um conjunto de casos de teste de um pacote para um arquivo. Formatos atualmente suportados: xlsx
getCloneInformation(string, number)	Obtenha informações sobre clones.
getPoints(string, number, number, string, boolean, boolean)	Obtenha um ponto de teste específico de um pacote.
getPointsList(string, number, number, string, string, string, boolean, boolean, boolean)	Obtenha todos os pontos dentro de uma suíte com base em alguns filtros
getSuiteCloneInformation(string, number)	Obtenha informações sobre clones.
getSuiteEntries(string, number, SuiteEntryTypes)	Obtenha uma lista de entradas do conjunto de testes no conjunto de testes.
getSuitesByTestCaseId(number)	Encontre a lista de todos os conjuntos de testes em que um determinado caso de teste está presente. Isso é útil se você precisar descobrir quais suítes de teste estão usando um caso de teste, quando você precisa fazer alterações em um caso de teste.
getTestCase(string, number, number, string, string, boolean)	Obtenha um caso de teste específico de um pacote.
getTestCaseCloneInformation(string, number)	Obtenha informações sobre clones.
getTestCaseList(string, number, number, string, string, string, string, boolean, boolean, ExcludeFlags, boolean)	Obter Lista de casos de teste retornar os casos de teste que têm todas as ids de configuração conforme mencionado no parâmetro opcional. Se o Ids de configuração for nulo, ele retornará todos os casos de teste
getTestConfigurationById(string, number)	Obter uma configuração de teste
getTestConfigurations(string, string)	Obtenha uma lista de configurações de teste.
getTestEntityCountByPlanId(string, number, string, UserFriendlyTestOutcome, string, string, string, TestEntityTypes)
getTestPlanById(string, number)	Obtenha um plano de teste por Id.
getTestPlans(string, string, string, boolean, boolean)	Obter uma lista de planos de teste
getTestSuiteById(string, number, number, SuiteExpand)	Obtenha o conjunto de testes por ID da suíte.
getTestSuitesForPlan(string, number, SuiteExpand, string, boolean)	Obtenha suítes de teste para o plano.
getTestVariableById(string, number)	Obtenha uma variável de teste pelo seu ID.
getTestVariables(string, string)	Obtenha uma lista de variáveis de teste.
removeTestCasesFromSuite(string, number, number, string)	Remove casos de teste de um conjunto com base na lista de IDs de caso de teste fornecidas.
removeTestCasesListFromSuite(string, number, number, string)	Remove casos de teste de um conjunto com base na lista de IDs de caso de teste fornecidas. Essa API pode ser usada para remover um número maior de casos de teste.
reorderSuiteEntries(SuiteEntryUpdateParams[], string, number)	Reordene as entradas do conjunto de testes no conjunto de testes.
restoreDeletedTestPlan(TestPlanAndSuiteRestoreModel, string, number)	Restaura o plano de teste excluído
restoreDeletedTestSuite(TestPlanAndSuiteRestoreModel, string, number)	Restaura o conjunto de testes excluído
updateSuiteTestCases(SuiteTestCaseCreateUpdateParameters[], string, number, number)	Atualizar as configurações para casos de teste
updateTestConfiguration(TestConfigurationCreateUpdateParameters, string, number)	Atualize uma configuração de teste por sua ID.
updateTestPlan(TestPlanUpdateParams, string, number)	Atualize um plano de teste.
updateTestPoints(TestPointUpdateParams[], string, number, number, boolean, boolean)	Atualizar pontos de teste. Isso é usado para redefinir o ponto de teste para ativo, atualizar o resultado de um ponto de teste ou atualizar o testador de um ponto de teste
updateTestSuite(TestSuiteUpdateParams, string, number, number)	Atualize o conjunto de testes.
updateTestVariable(TestVariableCreateUpdateParameters, string, number)	Atualize uma variável de teste por sua ID.

Detalhes do Construtor

TestPlanRestClient(IVssRestClientOptions)

new TestPlanRestClient(options: IVssRestClientOptions)

Parâmetros

options: IVssRestClientOptions

Detalhes de Método

addTestCasesToSuite(SuiteTestCaseCreateUpdateParameters[], string, number, number)

Adicionar casos de teste a um pacote com configurações especificadas

function addTestCasesToSuite(suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[], project: string, planId: number, suiteId: number): Promise<TestCase[]>

Parâmetros

suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[]

SuiteTestCaseCreateUpdateParameters objeto.

project: string

ID do projeto ou nome do projeto

planId: number

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

suiteId: number

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

Devoluções

Promise<TestCase[]>

cloneTestCase(CloneTestCaseParams, string)

function cloneTestCase(cloneRequestBody: CloneTestCaseParams, project: string): Promise<CloneTestCaseOperationInformation>

Parâmetros

cloneRequestBody: CloneTestCaseParams

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<CloneTestCaseOperationInformation>

cloneTestPlan(CloneTestPlanParams, string, boolean)

Plano de teste de clonagem

function cloneTestPlan(cloneRequestBody: CloneTestPlanParams, project: string, deepClone?: boolean): Promise<CloneTestPlanOperationInformation>

Parâmetros

cloneRequestBody: CloneTestPlanParams

Planejar solicitação de clone Detalhes do corpo TestPlanCloneRequest

project: string

ID do projeto ou nome do projeto

deepClone: boolean

Clones todos os casos de teste associados também

Devoluções

Promise<CloneTestPlanOperationInformation>

cloneTestSuite(CloneTestSuiteParams, string, boolean)

Conjunto de testes de clonagem

function cloneTestSuite(cloneRequestBody: CloneTestSuiteParams, project: string, deepClone?: boolean): Promise<CloneTestSuiteOperationInformation>

Parâmetros

cloneRequestBody: CloneTestSuiteParams

Suite Clone Request Body detail TestSuiteCloneRequest

project: string

ID do projeto ou nome do projeto

deepClone: boolean

Clones todos os casos de teste associados também

Devoluções

Promise<CloneTestSuiteOperationInformation>

createBulkTestSuites(TestSuiteCreateParams[], string, number, number)

Crie conjuntos de testes baseados em requisitos em massa.

function createBulkTestSuites(testSuiteCreateParams: TestSuiteCreateParams[], project: string, planId: number, parentSuiteId: number): Promise<TestSuite[]>

Parâmetros

testSuiteCreateParams: TestSuiteCreateParams[]

Parâmetros para a criação de pacotes

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de teste onde os pacotes baseados em requisitos precisam ser criados.

parentSuiteId: number

ID do pacote pai sob o qual os pacotes baseados em requisitos serão criados

Devoluções

Promise<TestSuite[]>

createTestConfiguration(TestConfigurationCreateUpdateParameters, string)

Crie uma configuração de teste.

function createTestConfiguration(testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters, project: string): Promise<TestConfiguration>

Parâmetros

testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters

TestConfigurationCreateUpdateParameters

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<TestConfiguration>

createTestPlan(TestPlanCreateParams, string)

Crie um plano de teste.

function createTestPlan(testPlanCreateParams: TestPlanCreateParams, project: string): Promise<TestPlan>

Parâmetros

testPlanCreateParams: TestPlanCreateParams

Um objeto testPlanCreateParams. TestPlanCreateParams

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<TestPlan>

createTestSuite(TestSuiteCreateParams, string, number)

Crie um conjunto de testes.

function createTestSuite(testSuiteCreateParams: TestSuiteCreateParams, project: string, planId: number): Promise<TestSuite>

Parâmetros

testSuiteCreateParams: TestSuiteCreateParams

Parâmetros para a criação de pacotes

project: string

ID do projeto ou nome do projeto

planId: number

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

Devoluções

Promise<TestSuite>

createTestVariable(TestVariableCreateUpdateParameters, string)

Crie uma variável de teste.

function createTestVariable(testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters, project: string): Promise<TestVariable>

Parâmetros

testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters

TestVariableCreateUpdateParameters

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<TestVariable>

deleteTestCase(string, number)

Exclua um caso de teste.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

testCaseId: number

Id do caso de teste a ser excluído.

Devoluções

Promise<void>

deleteTestConfguration(string, number)

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

function deleteTestConfguration(project: string, testConfiguartionId: number): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

testConfiguartionId: number

ID da configuração de teste a ser excluída.

Devoluções

Promise<void>

deleteTestPlan(string, number)

Exclua um plano de teste.

function deleteTestPlan(project: string, planId: number): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de teste a ser excluído.

Devoluções

Promise<void>

deleteTestSuite(string, number, number)

Exclua o conjunto de testes.

function deleteTestSuite(project: string, planId: number, suiteId: number): 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.

suiteId: number

ID do conjunto de testes a ser excluído.

Devoluções

Promise<void>

deleteTestVariable(string, number)

Exclua uma variável de teste por sua ID.

function deleteTestVariable(project: string, testVariableId: number): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

testVariableId: number

ID da variável de teste a ser excluída.

Devoluções

Promise<void>

exportTestCases(ExportTestCaseParams, string)

Exporta um conjunto de casos de teste de um pacote para um arquivo. Formatos atualmente suportados: xlsx

function exportTestCases(exportTestCaseRequestBody: ExportTestCaseParams, project: string): Promise<ArrayBuffer>

Parâmetros

exportTestCaseRequestBody: ExportTestCaseParams

Um objeto ExportTestCaseParams. ExportTestCaseParams

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<ArrayBuffer>

getCloneInformation(string, number)

Obtenha informações sobre clones.

function getCloneInformation(project: string, cloneOperationId: number): Promise<CloneTestPlanOperationInformation>

Parâmetros

project: string

ID do projeto ou nome do projeto

cloneOperationId: number

ID da operação retornada quando colocamos em fila uma operação de clone

Devoluções

Promise<CloneTestPlanOperationInformation>

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

Obtenha um ponto de teste específico de um pacote.

function getPoints(project: string, planId: number, suiteId: number, pointId: string, returnIdentityRef?: boolean, includePointDetails?: boolean): Promise<TestPoint[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de ensaio para o qual são solicitados pontos de ensaio.

suiteId: number

ID do conjunto de testes para o qual os pontos de teste são solicitados.

pointId: string

ID do ponto de teste a ser buscado.

returnIdentityRef: boolean

Se definido como true, retorna o campo AssignedTo em TestCaseReference como objeto IdentityRef.

includePointDetails: boolean

Se definido como false, obterá uma carga útil menor contendo apenas detalhes básicos sobre o objeto de ponto de teste

Devoluções

Promise<TestPoint[]>

getPointsList(string, number, number, string, string, string, boolean, boolean, boolean)

Obtenha todos os pontos dentro de uma suíte com base em alguns filtros

function getPointsList(project: string, planId: number, suiteId: number, testPointIds?: string, testCaseId?: string, continuationToken?: string, returnIdentityRef?: boolean, includePointDetails?: boolean, isRecursive?: boolean): Promise<PagedList<TestPoint>>

Parâmetros

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de ensaio para o qual são solicitados pontos de ensaio.

suiteId: number

ID do conjunto de testes para o qual os pontos de teste são solicitados

testPointIds: string

ID dos pontos de teste a serem buscados.

testCaseId: string

Obtenha pontos de teste para IDs de caso de teste específicos.

continuationToken: string

Se a lista de pontos de teste retornados não estiver completa, um token de continuação para consultar o próximo lote de pontos de teste será incluído no cabeçalho de resposta como "x-ms-continuationtoken". Omita este parâmetro para obter o primeiro lote de pontos de teste.

returnIdentityRef: boolean

Se definido como true, retorna o campo AssignedTo em TestCaseReference como objeto IdentityRef.

includePointDetails: boolean

Se definido como false, obterá uma carga útil menor contendo apenas detalhes básicos sobre o objeto de ponto de teste

isRecursive: boolean

Se definido como true, também buscará pontos de teste pertencentes a suítes filho recursivamente.

Devoluções

Promise<PagedList<TestPoint>>

getSuiteCloneInformation(string, number)

Obtenha informações sobre clones.

function getSuiteCloneInformation(project: string, cloneOperationId: number): Promise<CloneTestSuiteOperationInformation>

Parâmetros

project: string

ID do projeto ou nome do projeto

cloneOperationId: number

ID da operação retornada quando colocamos em fila uma operação de clone

Devoluções

Promise<CloneTestSuiteOperationInformation>

getSuiteEntries(string, number, SuiteEntryTypes)

Obtenha uma lista de entradas do conjunto de testes no conjunto de testes.

function getSuiteEntries(project: string, suiteId: number, suiteEntryType?: SuiteEntryTypes): Promise<SuiteEntry[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

suiteId: number

Id da suíte pai.

suiteEntryType: SuiteEntryTypes

Devoluções

Promise<SuiteEntry[]>

getSuitesByTestCaseId(number)

Encontre a lista de todos os conjuntos de testes em que um determinado caso de teste está presente. Isso é útil se você precisar descobrir quais suítes de teste estão usando um caso de teste, quando você precisa fazer alterações em um caso de teste.

function getSuitesByTestCaseId(testCaseId: number): Promise<TestSuite[]>

Parâmetros

testCaseId: number

ID do caso de teste para o qual as suítes precisam ser buscadas.

Devoluções

Promise<TestSuite[]>

getTestCase(string, number, number, string, string, boolean)

Obtenha um caso de teste específico de um pacote.

function getTestCase(project: string, planId: number, suiteId: number, testCaseId: string, witFields?: string, returnIdentityRef?: boolean): Promise<TestCase[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de teste para o qual os casos de teste são solicitados.

suiteId: number

ID do conjunto de testes para o qual os casos de teste são solicitados.

testCaseId: string

Id do caso de teste a ser buscado.

witFields: string

Obtenha a lista de witFields.

returnIdentityRef: boolean

Se definido como true, retorna todos os campos de identidade, como AssignedTo, ActivatedBy etc., como objetos IdentityRef. Se definido como false, esses campos serão retornados como nomes exclusivos no formato de cadeia de caracteres. Isso é falso por padrão.

Devoluções

Promise<TestCase[]>

getTestCaseCloneInformation(string, number)

Obtenha informações sobre clones.

function getTestCaseCloneInformation(project: string, cloneOperationId: number): Promise<CloneTestCaseOperationInformation>

Parâmetros

project: string

ID do projeto ou nome do projeto

cloneOperationId: number

ID da operação retornada quando colocamos em fila uma operação de clone

Devoluções

Promise<CloneTestCaseOperationInformation>

getTestCaseList(string, number, number, string, string, string, string, boolean, boolean, ExcludeFlags, boolean)

Obter Lista de casos de teste retornar os casos de teste que têm todas as ids de configuração conforme mencionado no parâmetro opcional. Se o Ids de configuração for nulo, ele retornará todos os casos de teste

function getTestCaseList(project: string, planId: number, suiteId: number, testIds?: string, configurationIds?: string, witFields?: string, continuationToken?: string, returnIdentityRef?: boolean, expand?: boolean, excludeFlags?: ExcludeFlags, isRecursive?: boolean): Promise<PagedList<TestCase>>

Parâmetros

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de teste para o qual os casos de teste são solicitados.

suiteId: number

ID do conjunto de testes para o qual os casos de teste são solicitados.

testIds: string

Ids de caso de teste a serem buscados.

configurationIds: string

Buscar casos de teste que contém todas as ids de configuração especificadas.

witFields: string

Obtenha a lista de witFields.

continuationToken: string

Se a lista de casos de teste retornados não estiver completa, um token de continuação para consultar o próximo lote de casos de teste será incluído no cabeçalho da resposta como "x-ms-continuationtoken". Omita esse parâmetro para obter o primeiro lote de casos de teste.

returnIdentityRef: boolean

expand: boolean

Se definido como false, obterá uma carga útil menor contendo apenas detalhes básicos sobre o objeto de caso de teste do conjunto

excludeFlags: ExcludeFlags

Sinalizador para excluir vários valores da carga útil. Por exemplo, para remover atribuições de pontos, passe excluir = 1. Para remover informações extras (links, plano de teste, conjunto de testes) passe excluir = 2. Para remover informações extras e atribuições de pontos, passe excluir = 3 (1 + 2).

isRecursive: boolean

Devoluções

Promise<PagedList<TestCase>>

getTestConfigurationById(string, number)

Obter uma configuração de teste

function getTestConfigurationById(project: string, testConfigurationId: number): Promise<TestConfiguration>

Parâmetros

project: string

ID do projeto ou nome do projeto

testConfigurationId: number

ID da configuração de teste a ser obtida.

Devoluções

Promise<TestConfiguration>

getTestConfigurations(string, string)

Obtenha uma lista de configurações de teste.

function getTestConfigurations(project: string, continuationToken?: string): Promise<PagedList<TestConfiguration>>

Parâmetros

project: string

ID do projeto ou nome do projeto

continuationToken: string

Se a lista de configurações retornadas não estiver completa, um token de continuação para consultar o próximo lote de configurações será incluído no cabeçalho de resposta como "x-ms-continuationtoken". Omita esse parâmetro para obter o primeiro lote de configurações de teste.

Devoluções

Promise<PagedList<TestConfiguration>>

getTestEntityCountByPlanId(string, number, string, UserFriendlyTestOutcome, string, string, string, TestEntityTypes)

function getTestEntityCountByPlanId(project: string, planId: number, states?: string, outcome?: UserFriendlyTestOutcome, configurations?: string, testers?: string, assignedTo?: string, entity?: TestEntityTypes): Promise<TestEntityCount[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

planId: number

states: string

outcome: UserFriendlyTestOutcome

configurations: string

testers: string

assignedTo: string

entity: TestEntityTypes

Devoluções

Promise<TestEntityCount[]>

getTestPlanById(string, number)

Obtenha um plano de teste por Id.

function getTestPlanById(project: string, planId: number): Promise<TestPlan>

Parâmetros

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de teste a obter.

Devoluções

Promise<TestPlan>

getTestPlans(string, string, string, boolean, boolean)

Obter uma lista de planos de teste

function getTestPlans(project: string, owner?: string, continuationToken?: string, includePlanDetails?: boolean, filterActivePlans?: boolean): Promise<PagedList<TestPlan>>

Parâmetros

project: string

ID do projeto ou nome do projeto

owner: string

Filtrar o plano de teste por ID ou nome do proprietário

continuationToken: string

Se a lista de planos retornados não estiver completa, um token de continuação para consultar o próximo lote de planos será incluído no cabeçalho de resposta como "x-ms-continuationtoken". Omita esse parâmetro para obter o primeiro lote de planos de teste.

includePlanDetails: boolean

Obter todas as propriedades do plano de teste

filterActivePlans: boolean

Obtenha apenas os planos ativos

Devoluções

Promise<PagedList<TestPlan>>

getTestSuiteById(string, number, number, SuiteExpand)

Obtenha o conjunto de testes por ID da suíte.

function getTestSuiteById(project: string, planId: number, suiteId: number, expand?: SuiteExpand): Promise<TestSuite>

Parâmetros

project: string

ID do projeto ou nome do projeto

planId: number

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

suiteId: number

ID da suíte a ser obtida.

expand: SuiteExpand

Inclua as suítes infantis e os detalhes dos testadores

Devoluções

Promise<TestSuite>

getTestSuitesForPlan(string, number, SuiteExpand, string, boolean)

Obtenha suítes de teste para o plano.

function getTestSuitesForPlan(project: string, planId: number, expand?: SuiteExpand, continuationToken?: string, asTreeView?: boolean): Promise<PagedList<TestSuite>>

Parâmetros

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de teste para o qual as suítes são solicitadas.

expand: SuiteExpand

Inclua as suítes infantis e os detalhes dos testadores.

continuationToken: string

Se a lista de suítes retornada não estiver completa, um token de continuação para consultar o próximo lote de suítes será incluído no cabeçalho de resposta como "x-ms-continuationtoken". Omita esse parâmetro para obter o primeiro lote de conjuntos de testes.

asTreeView: boolean

Se as suítes retornadas devem estar em uma estrutura de árvore.

Devoluções

Promise<PagedList<TestSuite>>

getTestVariableById(string, number)

Obtenha uma variável de teste pelo seu ID.

function getTestVariableById(project: string, testVariableId: number): Promise<TestVariable>

Parâmetros

project: string

ID do projeto ou nome do projeto

testVariableId: number

ID da variável de teste a ser obtida.

Devoluções

Promise<TestVariable>

getTestVariables(string, string)

Obtenha uma lista de variáveis de teste.

function getTestVariables(project: string, continuationToken?: string): Promise<PagedList<TestVariable>>

Parâmetros

project: string

ID do projeto ou nome do projeto

continuationToken: string

Se a lista de variáveis retornada não estiver completa, um token de continuação para consultar o próximo lote de variáveis será incluído no cabeçalho de resposta como "x-ms-continuationtoken". Omita esse parâmetro para obter o primeiro lote de variáveis de teste.

Devoluções

Promise<PagedList<TestVariable>>

removeTestCasesFromSuite(string, number, number, string)

Remove casos de teste de um conjunto com base na lista de IDs de caso de teste fornecidas.

function removeTestCasesFromSuite(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 do qual os casos de teste devem ser removidos.

suiteId: number

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

testCaseIds: string

Ids de caso de teste a serem removidos.

Devoluções

Promise<void>

removeTestCasesListFromSuite(string, number, number, string)

Remove casos de teste de um conjunto com base na lista de IDs de caso de teste fornecidas. Essa API pode ser usada para remover um número maior de casos de teste.

function removeTestCasesListFromSuite(project: string, planId: number, suiteId: number, testIds: string): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de teste do qual os casos de teste devem ser removidos.

suiteId: number

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

testIds: string

Cadeia de caracteres separada por vírgulas de IDs de caso de teste a ser removida.

Devoluções

Promise<void>

reorderSuiteEntries(SuiteEntryUpdateParams[], string, number)

Reordene as entradas do conjunto de testes no conjunto de testes.

function reorderSuiteEntries(suiteEntries: SuiteEntryUpdateParams[], project: string, suiteId: number): Promise<SuiteEntry[]>

Parâmetros

suiteEntries: SuiteEntryUpdateParams[]

Lista de SuiteEntry para reordenar.

project: string

ID do projeto ou nome do projeto

suiteId: number

Id do conjunto de testes pai.

Devoluções

Promise<SuiteEntry[]>

restoreDeletedTestPlan(TestPlanAndSuiteRestoreModel, string, number)

Restaura o plano de teste excluído

function restoreDeletedTestPlan(restoreModel: TestPlanAndSuiteRestoreModel, project: string, planId: number): Promise<void>

Parâmetros

restoreModel: TestPlanAndSuiteRestoreModel

O modelo que contém as informações de restauração

project: string

ID do projeto ou nome do projeto

planId: number

A ID do plano de teste para restaurar

Devoluções

Promise<void>

restoreDeletedTestSuite(TestPlanAndSuiteRestoreModel, string, number)

Restaura o conjunto de testes excluído

function restoreDeletedTestSuite(payload: TestPlanAndSuiteRestoreModel, project: string, suiteId: number): Promise<void>

Parâmetros

payload: TestPlanAndSuiteRestoreModel

O modelo que contém as informações de restauração

project: string

ID do projeto ou nome do projeto

suiteId: number

A ID do conjunto de testes a ser restaurado

Devoluções

Promise<void>

updateSuiteTestCases(SuiteTestCaseCreateUpdateParameters[], string, number, number)

Atualizar as configurações para casos de teste

function updateSuiteTestCases(suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[], project: string, planId: number, suiteId: number): Promise<TestCase[]>

Parâmetros

suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[]

Um objeto SuiteTestCaseCreateUpdateParameters.

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de teste para o qual os casos de teste devem ser atualizados.

suiteId: number

ID do conjunto de testes para o qual os casos de teste devem ser atualizados.

Devoluções

Promise<TestCase[]>

updateTestConfiguration(TestConfigurationCreateUpdateParameters, string, number)

Atualize uma configuração de teste por sua ID.

function updateTestConfiguration(testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters, project: string, testConfiguartionId: number): Promise<TestConfiguration>

Parâmetros

testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters

TestConfigurationCreateUpdateParameters

project: string

ID do projeto ou nome do projeto

testConfiguartionId: number

ID da configuração de teste a ser atualizada.

Devoluções

Promise<TestConfiguration>

updateTestPlan(TestPlanUpdateParams, string, number)

Atualize um plano de teste.

function updateTestPlan(testPlanUpdateParams: TestPlanUpdateParams, project: string, planId: number): Promise<TestPlan>

Parâmetros

testPlanUpdateParams: TestPlanUpdateParams

Um objeto testPlanUpdateParams. TestPlanUpdateParams

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de teste a ser atualizado.

Devoluções

Promise<TestPlan>

updateTestPoints(TestPointUpdateParams[], string, number, number, boolean, boolean)

Atualizar pontos de teste. Isso é usado para redefinir o ponto de teste para ativo, atualizar o resultado de um ponto de teste ou atualizar o testador de um ponto de teste

function updateTestPoints(testPointUpdateParams: TestPointUpdateParams[], project: string, planId: number, suiteId: number, includePointDetails?: boolean, returnIdentityRef?: boolean): Promise<TestPoint[]>

Parâmetros

testPointUpdateParams: TestPointUpdateParams[]

Um objeto TestPointUpdateParams.

project: string

ID do projeto ou nome do projeto

planId: number

ID do plano de ensaio para o qual são solicitados pontos de ensaio.

suiteId: number

ID do conjunto de testes para o qual os pontos de teste são solicitados.

includePointDetails: boolean

Se definido como false, obterá uma carga útil menor contendo apenas detalhes básicos sobre o objeto de ponto de teste

returnIdentityRef: boolean

Se definido como true, retorna o campo AssignedTo em TestCaseReference como objeto IdentityRef.

Devoluções

Promise<TestPoint[]>

updateTestSuite(TestSuiteUpdateParams, string, number, number)

Atualize o conjunto de testes.

function updateTestSuite(testSuiteUpdateParams: TestSuiteUpdateParams, project: string, planId: number, suiteId: number): Promise<TestSuite>

Parâmetros

testSuiteUpdateParams: TestSuiteUpdateParams

Parâmetros para atualização do pacote

project: string

ID do projeto ou nome do projeto

planId: number

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

suiteId: number

ID do pacote pai.

Devoluções

Promise<TestSuite>

updateTestVariable(TestVariableCreateUpdateParameters, string, number)

Atualize uma variável de teste por sua ID.

function updateTestVariable(testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters, project: string, testVariableId: number): Promise<TestVariable>

Parâmetros

testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters

TestVariableCreateUpdateParameters

project: string

ID do projeto ou nome do projeto

testVariableId: number

ID da variável de teste a ser atualizada.

Devoluções

Promise<TestVariable>

Partilhar via

TestPlanRestClient class

Construtores

Métodos

Detalhes do Construtor

TestPlanRestClient(IVssRestClientOptions)

Parâmetros

Detalhes de Método

addTestCasesToSuite(SuiteTestCaseCreateUpdateParameters[], string, number, number)

Parâmetros

Devoluções

cloneTestCase(CloneTestCaseParams, string)

Parâmetros

Devoluções

cloneTestPlan(CloneTestPlanParams, string, boolean)

Parâmetros

Devoluções

cloneTestSuite(CloneTestSuiteParams, string, boolean)

Parâmetros

Devoluções

createBulkTestSuites(TestSuiteCreateParams[], string, number, number)

Parâmetros

Devoluções

createTestConfiguration(TestConfigurationCreateUpdateParameters, string)

Parâmetros

Devoluções

createTestPlan(TestPlanCreateParams, string)

Parâmetros

Devoluções

createTestSuite(TestSuiteCreateParams, string, number)

Parâmetros

Devoluções

createTestVariable(TestVariableCreateUpdateParameters, string)

Parâmetros

Devoluções

deleteTestCase(string, number)

Parâmetros

Devoluções

deleteTestConfguration(string, number)

Parâmetros

Devoluções

deleteTestPlan(string, number)

Parâmetros

Devoluções

deleteTestSuite(string, number, number)

Parâmetros

Devoluções

deleteTestVariable(string, number)

Parâmetros

Devoluções

exportTestCases(ExportTestCaseParams, string)

Parâmetros

Devoluções

getCloneInformation(string, number)

Parâmetros

Devoluções

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

Parâmetros

Devoluções

getPointsList(string, number, number, string, string, string, boolean, boolean, boolean)

Parâmetros

Devoluções

getSuiteCloneInformation(string, number)

Parâmetros

Devoluções

getSuiteEntries(string, number, SuiteEntryTypes)

Parâmetros

Devoluções

getSuitesByTestCaseId(number)

Parâmetros

Devoluções

getTestCase(string, number, number, string, string, boolean)

Parâmetros

Devoluções

getTestCaseCloneInformation(string, number)

Parâmetros

Devoluções

getTestCaseList(string, number, number, string, string, string, string, boolean, boolean, ExcludeFlags, boolean)

Parâmetros

Devoluções