Compartilhar via


TestPlanRestClient class

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

Extends

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)

Clonar plano de teste

cloneTestSuite(CloneTestSuiteParams, string, boolean)

Clone o pacote de testes

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

Criar conjuntos de teste baseados em requisitos em massa.

createTestConfiguration(TestConfigurationCreateUpdateParameters, string)

Crie uma configuração de teste.

createTestPlan(TestPlanCreateParams, string)

Crie um plano de teste.

createTestPlanWithTestCases(TestPlanWithTestCasesCreateParams, string)

Crie um plano de teste com casos de teste enfileirando um trabalho.

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)

Excluir um plano de teste.

deleteTestSuite(string, number, number)

Excluir 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 com suporte no momento: xlsx

getCloneInformation(string, number)

Obter informações de clone.

getDeletedTestPlans(string, string)

Obter uma lista de planos de teste excluídos

getDeletedTestSuitesForPlan(string, number, SuiteExpand, string, boolean)

Obtenha conjuntos de testes excluídos para um plano de teste.

getDeletedTestSuitesForProject(string, SuiteExpand, string, boolean)

Obtenha suítes de teste excluídas em um projeto.

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)

Obter todos os pontos dentro de um pacote com base em alguns filtros

getSuiteCloneInformation(string, number)

Obter informações de clone.

getSuiteEntries(string, number, SuiteEntryTypes)

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

getSuitesByTestCaseId(number)

Localize a lista de todos os conjuntos de testes nos quais um determinado caso de teste está presente. Isso será útil se você precisar descobrir quais conjuntos de testes estão usando um caso de teste, quando precisar fazer alterações em um caso de teste.

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

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

getTestCaseCloneInformation(string, number)

Obter informações de clone.

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

Obter a Lista de Casos de Teste retorna os casos de teste que têm todas as IDs de configuração, conforme mencionado no parâmetro opcional. Se as IDs de configuração forem nulas, ela 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 pacote de testes por ID do pacote.

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

Obtenha pacotes de teste para o plano.

getTestVariableById(string, number)

Obtenha uma variável de teste por sua ID.

getTestVariables(string, string)

Obtenha uma lista de variáveis de teste.

removeTestCasesFromSuite(string, number, number, string)

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

removeTestCasesListFromSuite(string, number, number, string)

Remove casos de teste de um pacote 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)

Atualizar 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

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

Objeto SuiteTestCaseCreateUpdateParameters.

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.

Retornos

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

Retornos

cloneTestPlan(CloneTestPlanParams, string, boolean)

Clonar plano de teste

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

Parâmetros

cloneRequestBody
CloneTestPlanParams

Detalhes do corpo da solicitação de clone de plano TestPlanCloneRequest

project

string

ID do projeto ou nome do projeto

deepClone

boolean

Clona todos os casos de teste associados também

Retornos

cloneTestSuite(CloneTestSuiteParams, string, boolean)

Clone o pacote de testes

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

Parâmetros

cloneRequestBody
CloneTestSuiteParams

Detalhes do corpo da solicitação do clone do pacote TestSuiteCloneRequest

project

string

ID do projeto ou nome do projeto

deepClone

boolean

Clona todos os casos de teste associados também

Retornos

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

Criar conjuntos de teste 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 do pacote

project

string

ID do projeto ou nome do projeto

planId

number

ID do plano de teste em que os conjuntos baseados em requisitos precisam ser criados.

parentSuiteId

number

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

Retornos

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

Retornos

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

Retornos

Promise<TestPlan>

createTestPlanWithTestCases(TestPlanWithTestCasesCreateParams, string)

Crie um plano de teste com casos de teste enfileirando um trabalho.

function createTestPlanWithTestCases(creationParams: TestPlanWithTestCasesCreateParams, project: string): Promise<boolean>

Parâmetros

creationParams
TestPlanWithTestCasesCreateParams

Parâmetros para criar o plano de teste e os casos de teste.

project

string

ID do projeto ou nome do projeto

Retornos

Promise<boolean>

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

project

string

ID do projeto ou nome do projeto

planId

number

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

Retornos

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

Retornos

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.

Retornos

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.

Retornos

Promise<void>

deleteTestPlan(string, number)

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

Retornos

Promise<void>

deleteTestSuite(string, number, number)

Excluir 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 pacote.

suiteId

number

ID do conjunto de testes a ser excluído.

Retornos

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.

Retornos

Promise<void>

exportTestCases(ExportTestCaseParams, string)

Exporta um conjunto de casos de teste de um pacote para um arquivo. Formatos com suporte no momento: 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

Retornos

Promise<ArrayBuffer>

getCloneInformation(string, number)

Obter informações de clone.

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 enfileiramos uma operação de clone

Retornos

getDeletedTestPlans(string, string)

Obter uma lista de planos de teste excluídos

function getDeletedTestPlans(project: string, continuationToken?: string): Promise<PagedList<TestPlan>>

Parâmetros

project

string

ID do projeto ou nome do projeto

continuationToken

string

Se a lista de planos retornados não estiver concluída, 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.

Retornos

Promise<PagedList<TestPlan>>

getDeletedTestSuitesForPlan(string, number, SuiteExpand, string, boolean)

Obtenha conjuntos de testes excluídos para um plano de teste.

function getDeletedTestSuitesForPlan(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 os pacotes são solicitados.

expand
SuiteExpand

Inclua os detalhes de conjuntos filhos e testadores.

continuationToken

string

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

asTreeView

boolean

Se os pacotes retornados devem estar em uma estrutura de árvore.

Retornos

Promise<PagedList<TestSuite>>

getDeletedTestSuitesForProject(string, SuiteExpand, string, boolean)

Obtenha suítes de teste excluídas em um projeto.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

expand
SuiteExpand

Inclua os detalhes de conjuntos filhos e testadores.

continuationToken

string

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

asTreeView

boolean

Se os pacotes retornados devem estar em uma estrutura de árvore.

Retornos

Promise<PagedList<TestSuite>>

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 teste para o qual os pontos de teste são solicitados.

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, retornará o campo AssignedTo em TestCaseReference como objeto IdentityRef.

includePointDetails

boolean

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

Retornos

Promise<TestPoint[]>

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

Obter todos os pontos dentro de um pacote 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 teste para o qual os pontos de teste são solicitados.

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íficas.

continuationToken

string

Se a lista de pontos de teste retornado não estiver concluída, 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 esse parâmetro para obter o primeiro lote de pontos de teste.

returnIdentityRef

boolean

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

includePointDetails

boolean

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

isRecursive

boolean

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

Retornos

Promise<PagedList<TestPoint>>

getSuiteCloneInformation(string, number)

Obter informações de clone.

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 enfileiramos uma operação de clone

Retornos

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 do pacote pai.

suiteEntryType
SuiteEntryTypes

Retornos

Promise<SuiteEntry[]>

getSuitesByTestCaseId(number)

Localize a lista de todos os conjuntos de testes nos quais um determinado caso de teste está presente. Isso será útil se você precisar descobrir quais conjuntos de testes estão usando um caso de teste, quando precisar 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 os pacotes precisam ser buscados.

Retornos

Promise<TestSuite[]>

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

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

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

witFields

string

Obtenha a lista de witFields.

returnIdentityRef

boolean

Se definido como true, retornará 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.

Retornos

Promise<TestCase[]>

getTestCaseCloneInformation(string, number)

Obter informações de clone.

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 enfileiramos uma operação de clone

Retornos

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

Obter a Lista de Casos de Teste retorna os casos de teste que têm todas as IDs de configuração, conforme mencionado no parâmetro opcional. Se as IDs de configuração forem nulas, ela 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 buscadas.

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 for concluída, um token de continuação para consultar o próximo lote de casos de teste será incluído no cabeçalho de resposta como "x-ms-continuationtoken". Omita esse parâmetro para obter o primeiro lote de casos de teste.

returnIdentityRef

boolean

Se definido como true, retornará 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.

expand

boolean

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

excludeFlags
ExcludeFlags

Sinalizar para excluir vários valores do conteúdo. Por exemplo, para remover atribuições de ponto, passe exclusão = 1. Para remover informações extras (links, plano de teste, conjunto de testes) passe exclusão = 2. Para remover informações extras e atribuições de ponto, passe exclusão = 3 (1 + 2).

isRecursive

boolean

Retornos

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

Retornos

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 concluída, 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.

Retornos

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

configurations

string

testers

string

assignedTo

string

Retornos

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 ser obtido.

Retornos

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 concluída, 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

Obter apenas os planos ativos

Retornos

Promise<PagedList<TestPlan>>

getTestSuiteById(string, number, number, SuiteExpand)

Obtenha o pacote de testes por ID do pacote.

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 do pacote a ser obtido.

expand
SuiteExpand

Incluir os detalhes dos conjuntos filhos e testadores

Retornos

Promise<TestSuite>

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

Obtenha pacotes 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 os pacotes são solicitados.

expand
SuiteExpand

Inclua os detalhes de conjuntos filhos e testadores.

continuationToken

string

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

asTreeView

boolean

Se os pacotes retornados devem estar em uma estrutura de árvore.

Retornos

Promise<PagedList<TestSuite>>

getTestVariableById(string, number)

Obtenha uma variável de teste por sua 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 obtido.

Retornos

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 retornadas não estiver concluída, 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.

Retornos

removeTestCasesFromSuite(string, number, number, string)

Remove casos de teste de um pacote 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 removidas.

Retornos

Promise<void>

removeTestCasesListFromSuite(string, number, number, string)

Remove casos de teste de um pacote 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 serem removidas.

Retornos

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 a ser reordenado.

project

string

ID do projeto ou nome do projeto

suiteId

number

ID do conjunto de testes pai.

Retornos

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 a ser restaurado

Retornos

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

Retornos

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.

Retornos

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.

Retornos

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.

Retornos

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 teste para o qual os pontos de teste são solicitados.

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 menor contendo apenas detalhes básicos sobre o objeto do ponto de teste

returnIdentityRef

boolean

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

Retornos

Promise<TestPoint[]>

updateTestSuite(TestSuiteUpdateParams, string, number, number)

Atualizar o conjunto de testes.

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

Parâmetros

testSuiteUpdateParams
TestSuiteUpdateParams

Parâmetros para updation 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.

Retornos

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.

Retornos

Promise<TestVariable>