TestPlanRestClient class

Odwołanie

Pakiet:: azure-devops-extension-api

Klasa podstawowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Extends: RestClientBase

Konstruktory

TestPlanRestClient(IVssRestClientOptions)

Metody

addTestCasesToSuite(SuiteTestCaseCreateUpdateParameters[], string, number, number)	Dodawanie przypadków testowych do zestawu z określonymi konfiguracjami
cloneTestCase(CloneTestCaseParams, string)
cloneTestPlan(CloneTestPlanParams, string, boolean)	Klonowanie planu testu
cloneTestSuite(CloneTestSuiteParams, string, boolean)	Klonowanie zestawu testów
createBulkTestSuites(TestSuiteCreateParams[], string, number, number)	Twórca zbiorczych zestawów testów opartych na wymaganiach.
createTestConfiguration(TestConfigurationCreateUpdateParameters, string)	Twórca konfiguracji testowej.
createTestPlan(TestPlanCreateParams, string)	Twórca plan testu.
createTestSuite(TestSuiteCreateParams, string, number)	Twórca zestawu testów.
createTestVariable(TestVariableCreateUpdateParameters, string)	Twórca zmiennej testowej.
deleteTestCase(string, number)	Usuwanie przypadku testowego.
deleteTestConfguration(string, number)	Usuń konfigurację testową według jego identyfikatora.
deleteTestPlan(string, number)	Usuń plan testu.
deleteTestSuite(string, number, number)	Usuń zestaw testów.
deleteTestVariable(string, number)	Usuń zmienną testową według jej identyfikatora.
exportTestCases(ExportTestCaseParams, string)	Eksportuje zestaw przypadków testowych z pakietu do pliku. Obecnie obsługiwane formaty: xlsx
getCloneInformation(string, number)	Uzyskiwanie informacji o klonowaniu.
getPoints(string, number, number, string, boolean, boolean)	Pobierz konkretny punkt testowy z zestawu.
getPointsList(string, number, number, string, string, string, boolean, boolean, boolean)	Pobieranie wszystkich punktów wewnątrz pakietu na podstawie niektórych filtrów
getSuiteCloneInformation(string, number)	Uzyskiwanie informacji o klonowaniu.
getSuiteEntries(string, number, SuiteEntryTypes)	Pobierz listę wpisów zestawu testów w zestawie testów.
getSuitesByTestCaseId(number)	Znajdź listę wszystkich zestawów testów, w których znajduje się dany przypadek testowy. Jest to przydatne, jeśli musisz dowiedzieć się, które zestawy testów korzystają z przypadku testowego, jeśli musisz wprowadzić zmiany w przypadku testowym.
getTestCase(string, number, number, string, string, boolean)	Pobierz konkretny przypadek testowy z pakietu.
getTestCaseCloneInformation(string, number)	Uzyskiwanie informacji o klonowaniu.
getTestCaseList(string, number, number, string, string, string, string, boolean, boolean, ExcludeFlags, boolean)	Funkcja Pobierz listę przypadków testowych zwraca te przypadki testowe, które mają wszystkie identyfikatory konfiguracji, jak wspomniano w opcjonalnym parametrze. Jeśli identyfikatory konfiguracji mają wartość null, zwracają wszystkie przypadki testowe
getTestConfigurationById(string, number)	Uzyskiwanie konfiguracji testowej
getTestConfigurations(string, string)	Pobierz listę konfiguracji testów.
getTestEntityCountByPlanId(string, number, string, UserFriendlyTestOutcome, string, string, string, TestEntityTypes)
getTestPlanById(string, number)	Uzyskaj plan testowy według identyfikatora.
getTestPlans(string, string, string, boolean, boolean)	Pobieranie listy planów testów
getTestSuiteById(string, number, number, SuiteExpand)	Uzyskaj pakiet testowy według identyfikatora pakietu.
getTestSuitesForPlan(string, number, SuiteExpand, string, boolean)	Uzyskaj zestawy testów dla planu.
getTestVariableById(string, number)	Pobierz zmienną testową według jego identyfikatora.
getTestVariables(string, string)	Pobierz listę zmiennych testowych.
removeTestCasesFromSuite(string, number, number, string)	Usuwa przypadki testowe z pakietu na podstawie podanej listy identyfikatorów przypadków testowych.
removeTestCasesListFromSuite(string, number, number, string)	Usuwa przypadki testowe z pakietu na podstawie podanej listy identyfikatorów przypadków testowych. Ten interfejs API może służyć do usuwania większej liczby przypadków testowych.
reorderSuiteEntries(SuiteEntryUpdateParams[], string, number)	Zmień kolejność wpisów zestawu testów w zestawie testów.
restoreDeletedTestPlan(TestPlanAndSuiteRestoreModel, string, number)	Przywracanie usuniętego planu testu
restoreDeletedTestSuite(TestPlanAndSuiteRestoreModel, string, number)	Przywracanie usuniętego zestawu testów
updateSuiteTestCases(SuiteTestCaseCreateUpdateParameters[], string, number, number)	Aktualizowanie konfiguracji dla przypadków testowych
updateTestConfiguration(TestConfigurationCreateUpdateParameters, string, number)	Zaktualizuj konfigurację testu według jego identyfikatora.
updateTestPlan(TestPlanUpdateParams, string, number)	Aktualizowanie planu testowego.
updateTestPoints(TestPointUpdateParams[], string, number, number, boolean, boolean)	Aktualizowanie punktów testowych. Służy do resetowania punktu testowego do aktywnego, aktualizowania wyniku punktu testowego lub aktualizowania testera punktu testowego
updateTestSuite(TestSuiteUpdateParams, string, number, number)	Aktualizowanie zestawu testów.
updateTestVariable(TestVariableCreateUpdateParameters, string, number)	Zaktualizuj zmienną testową według jego identyfikatora.

Szczegóły konstruktora

TestPlanRestClient(IVssRestClientOptions)

new TestPlanRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

Szczegóły metody

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

Dodawanie przypadków testowych do zestawu z określonymi konfiguracjami

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

Parametry

suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[]

SuiteTestCaseCreateUpdateParameters, obiekt.

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testów, do którego mają zostać dodane przypadki testowe.

suiteId: number

Identyfikator zestawu testów, do którego mają zostać dodane przypadki testowe.

Zwraca

Promise<TestCase[]>

cloneTestCase(CloneTestCaseParams, string)

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

Parametry

cloneRequestBody: CloneTestCaseParams

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<CloneTestCaseOperationInformation>

cloneTestPlan(CloneTestPlanParams, string, boolean)

Klonowanie planu testu

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

Parametry

cloneRequestBody: CloneTestPlanParams

Szczegóły treści żądania klonowania planu TestPlanCloneRequest

project: string

Identyfikator projektu lub nazwa projektu

deepClone: boolean

Klonuje również wszystkie skojarzone przypadki testowe

Zwraca

Promise<CloneTestPlanOperationInformation>

cloneTestSuite(CloneTestSuiteParams, string, boolean)

Klonowanie zestawu testów

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

Parametry

cloneRequestBody: CloneTestSuiteParams

Szczegóły treści żądania klonowania pakietu TestSuiteCloneRequest

project: string

Identyfikator projektu lub nazwa projektu

deepClone: boolean

Klonuje również wszystkie skojarzone przypadki testowe

Zwraca

Promise<CloneTestSuiteOperationInformation>

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

Twórca zbiorczych zestawów testów opartych na wymaganiach.

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

Parametry

testSuiteCreateParams: TestSuiteCreateParams[]

Parametry tworzenia pakietu

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testów, w którym należy utworzyć zestawy oparte na wymaganiach.

parentSuiteId: number

Identyfikator pakietu nadrzędnego, w ramach którego zostaną utworzone pakiety oparte na wymaganiach

Zwraca

Promise<TestSuite[]>

createTestConfiguration(TestConfigurationCreateUpdateParameters, string)

Twórca konfiguracji testowej.

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

Parametry

testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters

TestConfigurationCreateUpdateParameters

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<TestConfiguration>

createTestPlan(TestPlanCreateParams, string)

Twórca plan testu.

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

Parametry

testPlanCreateParams: TestPlanCreateParams

Obiekt testPlanCreateParams. TestPlanCreateParams

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<TestPlan>

createTestSuite(TestSuiteCreateParams, string, number)

Twórca zestawu testów.

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

Parametry

testSuiteCreateParams: TestSuiteCreateParams

Parametry tworzenia pakietu

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testów, który zawiera pakiety.

Zwraca

Promise<TestSuite>

createTestVariable(TestVariableCreateUpdateParameters, string)

Twórca zmiennej testowej.

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

Parametry

testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters

TestVariableCreateUpdateParameters

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<TestVariable>

deleteTestCase(string, number)

Usuwanie przypadku testowego.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

testCaseId: number

Identyfikator przypadku testowego do usunięcia.

Zwraca

Promise<void>

deleteTestConfguration(string, number)

Usuń konfigurację testową według jego identyfikatora.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

testConfiguartionId: number

Identyfikator konfiguracji testowej do usunięcia.

Zwraca

Promise<void>

deleteTestPlan(string, number)

Usuń plan testu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testowego, który ma zostać usunięty.

Zwraca

Promise<void>

deleteTestSuite(string, number, number)

Usuń zestaw testów.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testów, który zawiera pakiet.

suiteId: number

Identyfikator zestawu testów do usunięcia.

Zwraca

Promise<void>

deleteTestVariable(string, number)

Usuń zmienną testową według jej identyfikatora.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

testVariableId: number

Identyfikator zmiennej testowej do usunięcia.

Zwraca

Promise<void>

exportTestCases(ExportTestCaseParams, string)

Eksportuje zestaw przypadków testowych z pakietu do pliku. Obecnie obsługiwane formaty: xlsx

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

Parametry

exportTestCaseRequestBody: ExportTestCaseParams

Obiekt ExportTestCaseParams. ExportTestCaseParams

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ArrayBuffer>

getCloneInformation(string, number)

Uzyskiwanie informacji o klonowaniu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

cloneOperationId: number

Identyfikator operacji zwracany podczas kolejki operacji klonowania

Zwraca

Promise<CloneTestPlanOperationInformation>

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

Pobierz konkretny punkt testowy z zestawu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testów, dla którego są wymagane punkty testowe.

suiteId: number

Identyfikator zestawu testów, dla którego są wymagane punkty testowe.

pointId: string

Identyfikator punktu testowego do pobrania.

returnIdentityRef: boolean

W przypadku ustawienia wartości true zwraca pole AssignedTo w elemencie TestCaseReference jako obiekt IdentityRef.

includePointDetails: boolean

W przypadku ustawienia wartości false zostanie wyświetlony mniejszy ładunek zawierający tylko podstawowe informacje o obiekcie punktu testowego

Zwraca

Promise<TestPoint[]>

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

Pobieranie wszystkich punktów wewnątrz pakietu na podstawie niektórych filtrów

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testów, dla którego są wymagane punkty testowe.

suiteId: number

Identyfikator zestawu testów, dla którego są wymagane punkty testowe

testPointIds: string

Identyfikator punktów testowych do pobrania.

testCaseId: string

Uzyskiwanie punktów testowych dla określonych identyfikatorów przypadków testowych.

continuationToken: string

Jeśli zwracana lista punktów testowych nie zostanie ukończona, token kontynuacji do wykonania zapytania o następną partię punktów testowych zostanie uwzględniony w nagłówku odpowiedzi jako "x-ms-continuationtoken". Pomiń ten parametr, aby uzyskać pierwszą partię punktów testowych.

returnIdentityRef: boolean

W przypadku ustawienia wartości true zwraca pole AssignedTo w elemencie TestCaseReference jako obiekt IdentityRef.

includePointDetails: boolean

W przypadku ustawienia wartości false zostanie wyświetlony mniejszy ładunek zawierający tylko podstawowe informacje o obiekcie punktu testowego

isRecursive: boolean

W przypadku ustawienia wartości true punkty testowe będą również pobierane rekursywnie należące do zestawów podrzędnych.

Zwraca

Promise<PagedList<TestPoint>>

getSuiteCloneInformation(string, number)

Uzyskiwanie informacji o klonowaniu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

cloneOperationId: number

Identyfikator operacji zwracany podczas kolejki operacji klonowania

Zwraca

Promise<CloneTestSuiteOperationInformation>

getSuiteEntries(string, number, SuiteEntryTypes)

Pobierz listę wpisów zestawu testów w zestawie testów.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

suiteId: number

Identyfikator pakietu nadrzędnego.

suiteEntryType: SuiteEntryTypes

Zwraca

Promise<SuiteEntry[]>

getSuitesByTestCaseId(number)

Znajdź listę wszystkich zestawów testów, w których znajduje się dany przypadek testowy. Jest to przydatne, jeśli musisz dowiedzieć się, które zestawy testów korzystają z przypadku testowego, jeśli musisz wprowadzić zmiany w przypadku testowym.

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

Parametry

testCaseId: number

Identyfikator przypadku testowego, dla którego pakiety należy pobrać.

Zwraca

Promise<TestSuite[]>

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

Pobierz konkretny przypadek testowy z pakietu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testów, dla którego są wymagane przypadki testowe.

suiteId: number

Identyfikator zestawu testów, dla którego są wymagane przypadki testowe.

testCaseId: string

Identyfikator przypadku testowego do pobrania.

witFields: string

Pobierz listę elementów witFields.

returnIdentityRef: boolean

W przypadku ustawienia wartości true zwraca wszystkie pola tożsamości, takie jak AssignedTo, ActivatedBy itp., jako obiekty IdentityRef. W przypadku ustawienia wartości false te pola są zwracane jako unikatowe nazwy w formacie ciągu. Jest to domyślnie wartość false.

Zwraca

Promise<TestCase[]>

getTestCaseCloneInformation(string, number)

Uzyskiwanie informacji o klonowaniu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

cloneOperationId: number

Identyfikator operacji zwracany podczas kolejki operacji klonowania

Zwraca

Promise<CloneTestCaseOperationInformation>

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

Funkcja Pobierz listę przypadków testowych zwraca te przypadki testowe, które mają wszystkie identyfikatory konfiguracji, jak wspomniano w opcjonalnym parametrze. Jeśli identyfikatory konfiguracji mają wartość null, zwracają wszystkie przypadki testowe

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testów, dla którego są wymagane przypadki testowe.

suiteId: number

Identyfikator zestawu testów, dla którego są wymagane przypadki testowe.

testIds: string

Identyfikatory przypadków testowych do pobrania.

configurationIds: string

Pobierz przypadki testowe zawierające wszystkie określone identyfikatory konfiguracji.

witFields: string

Pobierz listę elementów witFields.

continuationToken: string

Jeśli lista zwróconych przypadków testowych nie zostanie ukończona, token kontynuacji do wykonania zapytania w następnej partii przypadków testowych zostanie uwzględniony w nagłówku odpowiedzi jako "x-ms-continuationtoken". Pomiń ten parametr, aby uzyskać pierwszą partię przypadków testowych.

returnIdentityRef: boolean

Jeśli ustawiono wartość true, zwraca wszystkie pola tożsamości, takie jak AssignedTo, ActivatedBy itp., jako obiekty IdentityRef. W przypadku ustawienia wartości false te pola są zwracane jako unikatowe nazwy w formacie ciągu. Domyślnie jest to fałsz.

expand: boolean

Jeśli ustawiono wartość false, otrzyma mniejszy ładunek zawierający tylko podstawowe informacje o obiekcie przypadku testowego pakietu

excludeFlags: ExcludeFlags

Flaga wykluczania różnych wartości z ładunku. Aby na przykład usunąć przypisania punktów, wyklucz wyklucz = 1. Aby usunąć dodatkowe informacje (linki, plan testu, pakiet testowy) wyklucz = 2. Aby usunąć zarówno dodatkowe informacje, jak i przypisania punktów, należy wykluczyć = 3 (1 + 2).

isRecursive: boolean

Zwraca

Promise<PagedList<TestCase>>

getTestConfigurationById(string, number)

Uzyskiwanie konfiguracji testowej

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

testConfigurationId: number

Identyfikator konfiguracji testowej do pobrania.

Zwraca

Promise<TestConfiguration>

getTestConfigurations(string, string)

Pobierz listę konfiguracji testów.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

continuationToken: string

Jeśli lista zwróconych konfiguracji nie zostanie ukończona, token kontynuacji zapytania o następną partię konfiguracji znajduje się w nagłówku odpowiedzi jako "x-ms-continuationtoken". Pomiń ten parametr, aby uzyskać pierwszą partię konfiguracji testów.

Zwraca

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

planId: number

states: string

outcome: UserFriendlyTestOutcome

configurations: string

testers: string

assignedTo: string

entity: TestEntityTypes

Zwraca

Promise<TestEntityCount[]>

getTestPlanById(string, number)

Uzyskaj plan testowy według identyfikatora.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testowego do pobrania.

Zwraca

Promise<TestPlan>

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

Pobieranie listy planów testów

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

owner: string

Filtruj dla planu testowego według identyfikatora właściciela lub nazwy

continuationToken: string

Jeśli lista zwróconych planów nie zostanie ukończona, token kontynuacji zapytania o następną partię planów zostanie uwzględniony w nagłówku odpowiedzi jako "x-ms-continuationtoken". Pomiń ten parametr, aby uzyskać pierwszą partię planów testów.

includePlanDetails: boolean

Pobieranie wszystkich właściwości planu testu

filterActivePlans: boolean

Pobieranie tylko aktywnych planów

Zwraca

Promise<PagedList<TestPlan>>

getTestSuiteById(string, number, number, SuiteExpand)

Uzyskaj pakiet testowy według identyfikatora pakietu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testowego, który zawiera zestawy.

suiteId: number

Identyfikator pakietu do pobrania.

expand: SuiteExpand

Dołącz szczegóły zestawów dla dzieci i testerów

Zwraca

Promise<TestSuite>

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

Uzyskaj zestawy testów dla planu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testowego, dla którego są wymagane zestawy.

expand: SuiteExpand

Dołącz szczegóły zestawów dla dzieci i testerów.

continuationToken: string

Jeśli zwracana lista zestawów nie zostanie ukończona, token kontynuacji do wykonania zapytania o następną partię zestawów zostanie uwzględniony w nagłówku odpowiedzi jako "x-ms-continuationtoken". Pomiń ten parametr, aby uzyskać pierwszą partię zestawów testów.

asTreeView: boolean

Jeśli zwrócone pakiety powinny znajdować się w strukturze drzewa.

Zwraca

Promise<PagedList<TestSuite>>

getTestVariableById(string, number)

Pobierz zmienną testową według jego identyfikatora.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

testVariableId: number

Identyfikator zmiennej testowej do pobrania.

Zwraca

Promise<TestVariable>

getTestVariables(string, string)

Pobierz listę zmiennych testowych.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

continuationToken: string

Jeśli lista zwracanych zmiennych nie zostanie ukończona, token kontynuacji do wykonania zapytania o następną partię zmiennych znajduje się w nagłówku odpowiedzi jako "x-ms-continuationtoken". Pomiń ten parametr, aby uzyskać pierwszą partię zmiennych testowych.

Zwraca

Promise<PagedList<TestVariable>>

removeTestCasesFromSuite(string, number, number, string)

Usuwa przypadki testowe z pakietu na podstawie podanej listy identyfikatorów przypadków testowych.

function removeTestCasesFromSuite(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<void>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testowego, z którego mają zostać usunięte przypadki testowe.

suiteId: number

Identyfikator zestawu testów, z którego mają zostać usunięte przypadki testowe.

testCaseIds: string

Identyfikatory przypadków testowych do usunięcia.

Zwraca

Promise<void>

removeTestCasesListFromSuite(string, number, number, string)

Usuwa przypadki testowe z pakietu na podstawie podanej listy identyfikatorów przypadków testowych. Ten interfejs API może służyć do usuwania większej liczby przypadków testowych.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testowego, z którego mają zostać usunięte przypadki testowe.

suiteId: number

Identyfikator zestawu testów, z którego mają zostać usunięte przypadki testowe.

testIds: string

Ciąg rozdzielony przecinkami identyfikatorów przypadków testowych do usunięcia.

Zwraca

Promise<void>

reorderSuiteEntries(SuiteEntryUpdateParams[], string, number)

Zmień kolejność wpisów zestawu testów w zestawie testów.

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

Parametry

suiteEntries: SuiteEntryUpdateParams[]

Lista elementów SuiteEntry do zmiany kolejności.

project: string

Identyfikator projektu lub nazwa projektu

suiteId: number

Identyfikator nadrzędnego zestawu testów.

Zwraca

Promise<SuiteEntry[]>

restoreDeletedTestPlan(TestPlanAndSuiteRestoreModel, string, number)

Przywracanie usuniętego planu testu

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

Parametry

restoreModel: TestPlanAndSuiteRestoreModel

Model zawierający informacje o przywracaniu

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testowego do przywrócenia

Zwraca

Promise<void>

restoreDeletedTestSuite(TestPlanAndSuiteRestoreModel, string, number)

Przywracanie usuniętego zestawu testów

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

Parametry

payload: TestPlanAndSuiteRestoreModel

Model zawierający informacje o przywracaniu

project: string

Identyfikator projektu lub nazwa projektu

suiteId: number

Identyfikator zestawu testów do przywrócenia

Zwraca

Promise<void>

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

Aktualizowanie konfiguracji dla przypadków testowych

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

Parametry

suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[]

Obiekt SuiteTestCaseCreateUpdateParameters.

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testowego, do którego mają zostać zaktualizowane przypadki testowe.

suiteId: number

Identyfikator zestawu testów, do którego mają zostać zaktualizowane przypadki testowe.

Zwraca

Promise<TestCase[]>

updateTestConfiguration(TestConfigurationCreateUpdateParameters, string, number)

Zaktualizuj konfigurację testu według jego identyfikatora.

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

Parametry

testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters

TestConfigurationUtwórzUpdateParameters

project: string

Identyfikator projektu lub nazwa projektu

testConfiguartionId: number

Identyfikator konfiguracji testowej do zaktualizowania.

Zwraca

Promise<TestConfiguration>

updateTestPlan(TestPlanUpdateParams, string, number)

Aktualizowanie planu testowego.

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

Parametry

testPlanUpdateParams: TestPlanUpdateParams

Obiekt testPlanUpdateParams. TestPlanUpdateParams

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testowego, który ma zostać zaktualizowany.

Zwraca

Promise<TestPlan>

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

Aktualizowanie punktów testowych. Służy do resetowania punktu testowego do aktywnego, aktualizowania wyniku punktu testowego lub aktualizowania testera punktu testowego

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

Parametry

testPointUpdateParams: TestPointUpdateParams[]

Obiekt TestPointUpdateParams.

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testu, dla którego są wymagane punkty testowe.

suiteId: number

Identyfikator zestawu testów, dla którego są wymagane punkty testowe.

includePointDetails: boolean

Jeśli ustawiono wartość false, otrzyma mniejszy ładunek zawierający tylko podstawowe szczegóły dotyczące obiektu punktu testowego

returnIdentityRef: boolean

Jeśli ustawiono wartość true, zwraca pole AssignedTo w elemencie TestCaseReference jako obiekt IdentityRef.

Zwraca

Promise<TestPoint[]>

updateTestSuite(TestSuiteUpdateParams, string, number, number)

Aktualizowanie zestawu testów.

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

Parametry

testSuiteUpdateParams: TestSuiteUpdateParams

Parametry pakietu updation

project: string

Identyfikator projektu lub nazwa projektu

planId: number

Identyfikator planu testowego, który zawiera zestawy.

suiteId: number

Identyfikator pakietu nadrzędnego.

Zwraca

Promise<TestSuite>

updateTestVariable(TestVariableCreateUpdateParameters, string, number)

Zaktualizuj zmienną testową według jego identyfikatora.

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

Parametry

testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters

TestVariableCreateUpdateParameters

project: string

Identyfikator projektu lub nazwa projektu

testVariableId: number

Identyfikator zmiennej testowej do zaktualizowania.

Zwraca

Promise<TestVariable>

Udostępnij za pośrednictwem

TestPlanRestClient class

Konstruktory

Metody

Szczegóły konstruktora

TestPlanRestClient(IVssRestClientOptions)

Parametry

Szczegóły metody

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

Parametry

Zwraca

cloneTestCase(CloneTestCaseParams, string)

Parametry

Zwraca

cloneTestPlan(CloneTestPlanParams, string, boolean)

Parametry

Zwraca

cloneTestSuite(CloneTestSuiteParams, string, boolean)

Parametry

Zwraca

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

Parametry

Zwraca

createTestConfiguration(TestConfigurationCreateUpdateParameters, string)

Parametry

Zwraca

createTestPlan(TestPlanCreateParams, string)

Parametry

Zwraca

createTestSuite(TestSuiteCreateParams, string, number)

Parametry

Zwraca

createTestVariable(TestVariableCreateUpdateParameters, string)

Parametry

Zwraca

deleteTestCase(string, number)

Parametry

Zwraca

deleteTestConfguration(string, number)

Parametry

Zwraca

deleteTestPlan(string, number)

Parametry

Zwraca

deleteTestSuite(string, number, number)

Parametry

Zwraca

deleteTestVariable(string, number)

Parametry

Zwraca

exportTestCases(ExportTestCaseParams, string)

Parametry

Zwraca

getCloneInformation(string, number)

Parametry

Zwraca

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

Parametry

Zwraca

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

Parametry

Zwraca

getSuiteCloneInformation(string, number)

Parametry

Zwraca

getSuiteEntries(string, number, SuiteEntryTypes)

Parametry

Zwraca

getSuitesByTestCaseId(number)

Parametry

Zwraca

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

Parametry

Zwraca

getTestCaseCloneInformation(string, number)

Parametry

Zwraca

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

Parametry

Zwraca