TestRestClient class
Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS
- Rozszerzenie
Konstruktory
| Test |
Właściwości
| RESOURCE_AREA_ID |
Metody
Szczegóły konstruktora
TestRestClient(IVssRestClientOptions)
Szczegóły właściwości
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string
Wartość właściwości
string
Szczegóły metody
addCustomFields(CustomTestFieldDefinition[], string)
function addCustomFields(newFields: CustomTestFieldDefinition[], project: string): Promise<CustomTestFieldDefinition[]>
Parametry
- newFields
- project
-
string
Identyfikator projektu lub nazwa projektu
Zwraca
Promise<CustomTestFieldDefinition[]>
addTestCasesToSuite(string, number, number, string)
Dodaj przypadki testowe do pakietu.
function addTestCasesToSuite(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- planId
-
number
Identyfikator planu testu, który zawiera zestaw.
- suiteId
-
number
Identyfikator zestawu testów, do którego należy dodać przypadki testowe.
- testCaseIds
-
string
Identyfikatory przypadków testowych, które mają zostać dodane do pakietu. Identyfikatory są podawane w formacie oddzielonym przecinkami.
Zwraca
Promise<SuiteTestCase[]>
addTestResultsToTestRun(TestCaseResult[], string, number)
Dodawanie wyników testu do przebiegu testu.
function addTestResultsToTestRun(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>
Parametry
- results
Lista wyników testów do dodania.
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testu, do którego należy dodać wyniki testu.
Zwraca
Promise<TestCaseResult[]>
addWorkItemToTestLinks(WorkItemToTestLinks, string)
function addWorkItemToTestLinks(workItemToTestLinks: WorkItemToTestLinks, project: string): Promise<WorkItemToTestLinks>
Parametry
- workItemToTestLinks
- WorkItemToTestLinks
- project
-
string
Identyfikator projektu lub nazwa projektu
Zwraca
Promise<WorkItemToTestLinks>
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)
Dołączanie pliku do wyniku kroku testu
function createTestIterationResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, iterationId: number, actionPath?: string): Promise<TestAttachmentReference>
Parametry
- attachmentRequestModel
- TestAttachmentRequestModel
Szczegóły załącznika: TestAttachmentRequestModel
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testu, który zawiera wynik.
- testCaseResultId
-
number
Identyfikator wyniku testu, który zawiera iterację
- iterationId
-
number
Identyfikator iteracji wyniku testu.
- actionPath
-
string
Wartość szesnastkowa ścieżki działania wyniku testu.
Zwraca
Promise<TestAttachmentReference>
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)
Dołącz plik do wyniku testu.
function createTestResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number): Promise<TestAttachmentReference>
Parametry
- attachmentRequestModel
- TestAttachmentRequestModel
Szczegóły załącznika: TestAttachmentRequestModel
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testu, który zawiera wynik.
- testCaseResultId
-
number
Identyfikator wyniku testu, na podstawie którego należy przesłać załącznik.
Zwraca
Promise<TestAttachmentReference>
createTestRun(RunCreateModel, string)
Utwórz nowy przebieg testu.
function createTestRun(testRun: RunCreateModel, project: string): Promise<TestRun>
Parametry
- testRun
- RunCreateModel
Szczegóły uruchomienia RunCreateModel
- project
-
string
Identyfikator projektu lub nazwa projektu
Zwraca
Promise<TestRun>
createTestRunAttachment(TestAttachmentRequestModel, string, number)
Dołączanie pliku do przebiegu testu.
function createTestRunAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestAttachmentReference>
Parametry
- attachmentRequestModel
- TestAttachmentRequestModel
Szczegóły załącznika: TestAttachmentRequestModel
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testu, względem którego należy przekazać załącznik.
Zwraca
Promise<TestAttachmentReference>
createTestSession(TestSession, TeamContext)
Tworzenie sesji testowej
function createTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>
Parametry
- testSession
- TestSession
Szczegóły sesji testowej do utworzenia
- teamContext
- TeamContext
Kontekst zespołu dla operacji
Zwraca
Promise<TestSession>
createTestSettings(TestSettings, string)
function createTestSettings(testSettings: TestSettings, project: string): Promise<number>
Parametry
- testSettings
- TestSettings
- project
-
string
Identyfikator projektu lub nazwa projektu
Zwraca
Promise<number>
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)
Dołączanie pliku do wyniku testu
function createTestSubResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachmentReference>
Parametry
- attachmentRequestModel
- TestAttachmentRequestModel
Model żądania załącznika.
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testu, który zawiera wynik.
- testCaseResultId
-
number
Identyfikator wyników testu, który zawiera wynik cząstkowy.
- testSubResultId
-
number
Identyfikator wyników podwyników testu, do których należy przesłać załącznik.
Zwraca
Promise<TestAttachmentReference>
deleteSharedParameter(string, number)
function deleteSharedParameter(project: string, sharedParameterId: number): Promise<void>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- sharedParameterId
-
number
Zwraca
Promise<void>
deleteSharedStep(string, number)
function deleteSharedStep(project: string, sharedStepId: number): Promise<void>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- sharedStepId
-
number
Zwraca
Promise<void>
deleteTestCase(string, number)
Usuń przypadek testowy.
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>
deleteTestMethodToWorkItemLink(string, string, number)
function deleteTestMethodToWorkItemLink(project: string, testName: string, workItemId: number): Promise<boolean>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- testName
-
string
- workItemId
-
number
Zwraca
Promise<boolean>
deleteTestRun(string, number)
Usuń test uruchomiony według jego identyfikatora.
function deleteTestRun(project: string, runId: number): Promise<void>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu do usunięcia.
Zwraca
Promise<void>
deleteTestSettings(string, number)
function deleteTestSettings(project: string, testSettingsId: number): Promise<void>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- testSettingsId
-
number
Zwraca
Promise<void>
getBugsLinkedToTestResult(string, number, number)
function getBugsLinkedToTestResult(project: string, runId: number, testCaseResultId: number): Promise<WorkItemReference[]>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
- testCaseResultId
-
number
Zwraca
Promise<WorkItemReference[]>
getBuildCodeCoverage(string, number, number)
Pobierz dane pokrycia kodu dla kompilacji.
function getBuildCodeCoverage(project: string, buildId: number, flags: number): Promise<BuildCoverage[]>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- buildId
-
number
Identyfikator kompilacji, dla której należy pobrać dane pokrycia kodu.
- flags
-
number
Wartość flag określa poziom szczegółów pokrycia kodu, które mają zostać pobrane. Flagi są addytywne. Oczekiwane wartości to 1 dla modułów, 2 dla funkcji, 4 dla BlockData.
Zwraca
Promise<BuildCoverage[]>
getCodeCoverageSummary(string, number, number)
Pobierz podsumowanie pokrycia kodu dla kompilacji.
function getCodeCoverageSummary(project: string, buildId: number, deltaBuildId?: number): Promise<CodeCoverageSummary>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- buildId
-
number
Identyfikator kompilacji, dla której należy pobrać dane pokrycia kodu.
- deltaBuildId
-
number
Identyfikator kompilacji różnicowej (opcjonalnie)
Zwraca
Promise<CodeCoverageSummary>
getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)
function getLinkedWorkItemsByQuery(workItemQuery: LinkedWorkItemsQuery, project: string): Promise<LinkedWorkItemsQueryResult[]>
Parametry
- workItemQuery
- LinkedWorkItemsQuery
- project
-
string
Identyfikator projektu lub nazwa projektu
Zwraca
Promise<LinkedWorkItemsQueryResult[]>
getPoint(string, number, number, number, string)
Zdobądź punkt testowy.
function getPoint(project: string, planId: number, suiteId: number, pointIds: number, witFields?: string): Promise<TestPoint>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- planId
-
number
Identyfikator planu testów.
- suiteId
-
number
Identyfikator pakietu, w którym znajduje się punkt.
- pointIds
-
number
Identyfikator punktu testowego do pobrania.
- witFields
-
string
Rozdzielona przecinkami lista nazw pól elementów roboczych.
Zwraca
Promise<TestPoint>
getPoints(string, number, number, string, string, string, string, boolean, number, number)
Pobierz listę punktów testowych.
function getPoints(project: string, planId: number, suiteId: number, witFields?: string, configurationId?: string, testCaseId?: string, testPointIds?: string, includePointDetails?: boolean, skip?: number, top?: number): Promise<TestPoint[]>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- planId
-
number
Identyfikator planu testów.
- suiteId
-
number
Identyfikator pakietu, który zawiera punkty.
- witFields
-
string
Rozdzielona przecinkami lista nazw pól elementów roboczych.
- configurationId
-
string
Pobierz punkty testowe dla określonej konfiguracji.
- testCaseId
-
string
Pobierz punkty testowe dla określonego przypadku testowego, ważne, gdy identyfikator configurationId nie jest ustawiony.
- testPointIds
-
string
Pobierz punkty testowe dla rozdzielanej przecinkami listy identyfikatorów punktów testowych, prawidłowej tylko wtedy, gdy configurationId i testCaseId nie są ustawione.
- includePointDetails
-
boolean
Uwzględnij wszystkie właściwości punktu testowego.
- skip
-
number
Liczba punktów testowych do pominięcia.
- top
-
number
Liczba punktów testowych do zwrócenia.
Zwraca
Promise<TestPoint[]>
getPointsByQuery(TestPointsQuery, string, number, number)
Pobierz punkty testowe za pomocą zapytania.
function getPointsByQuery(query: TestPointsQuery, project: string, skip?: number, top?: number): Promise<TestPointsQuery>
Parametry
- query
- TestPointsQuery
TestPointsQuery, aby uzyskać punkty testowe.
- project
-
string
Identyfikator projektu lub nazwa projektu
- skip
-
number
Liczba punktów testowych do pominięcia.
- top
-
number
Liczba punktów testowych do zwrócenia.
Zwraca
Promise<TestPointsQuery>
getResultGroupsByBuild(string, number, string, string[], string)
function getResultGroupsByBuild(project: string, buildId: number, publishContext: string, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- buildId
-
number
- publishContext
-
string
- fields
-
string[]
- continuationToken
-
string
Zwraca
Promise<PagedList<FieldDetailsForTestResults>>
getResultGroupsByRelease(string, number, string, number, string[], string)
function getResultGroupsByRelease(project: string, releaseId: number, publishContext: string, releaseEnvId?: number, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- releaseId
-
number
- publishContext
-
string
- releaseEnvId
-
number
- fields
-
string[]
- continuationToken
-
string
Zwraca
Promise<PagedList<FieldDetailsForTestResults>>
getResultRetentionSettings(string)
Pobieranie ustawień przechowywania wyników testów
function getResultRetentionSettings(project: string): Promise<ResultRetentionSettings>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
Zwraca
Promise<ResultRetentionSettings>
getTestCaseById(string, number, number, number)
Pobierz konkretny przypadek testowy w zestawie testów z identyfikatorem przypadku testowego.
function getTestCaseById(project: string, planId: number, suiteId: number, testCaseIds: number): Promise<SuiteTestCase>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- planId
-
number
Identyfikator planu testu, który zawiera zestawy.
- suiteId
-
number
Identyfikator zestawu zawierającego przypadek testowy.
- testCaseIds
-
number
Identyfikator przypadku testowego do pobrania.
Zwraca
Promise<SuiteTestCase>
getTestCases(string, number, number)
Pobierz wszystkie przypadki testowe w pakiecie.
function getTestCases(project: string, planId: number, suiteId: number): Promise<SuiteTestCase[]>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- planId
-
number
Identyfikator planu testu, który zawiera zestawy.
- suiteId
-
number
Identyfikator apartamentu do pobrania.
Zwraca
Promise<SuiteTestCase[]>
getTestIteration(string, number, number, number, boolean)
Pobieranie iteracji dla wyniku
function getTestIteration(project: string, runId: number, testCaseResultId: number, iterationId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testu, który zawiera wynik.
- testCaseResultId
-
number
Identyfikator wyniku testu, który zawiera iteracje.
- iterationId
-
number
Identyfikator iteracji wyników testu.
- includeActionResults
-
boolean
Uwzględnij szczegóły wyniku dla każdej akcji wykonanej w iteracji testu. ActionResults odnoszą się do wyniku (zaliczenie/niepowodzenie) kroków testu, które są wykonywane w ramach uruchamiania testu ręcznego. Dołączenie flagi ActionResults powoduje pobranie wyniku kroków testu w sekcji actionResults i parametrów testu w sekcji parameters dla każdej iteracji testu.
Zwraca
Promise<TestIterationDetailsModel>
getTestIterations(string, number, number, boolean)
Pobieranie iteracji dla wyniku
function getTestIterations(project: string, runId: number, testCaseResultId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel[]>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testu, który zawiera wynik.
- testCaseResultId
-
number
Identyfikator wyniku testu, który zawiera iteracje.
- includeActionResults
-
boolean
Uwzględnij szczegóły wyniku dla każdej akcji wykonanej w iteracji testu. ActionResults odnoszą się do wyniku (zaliczenie/niepowodzenie) kroków testu, które są wykonywane w ramach uruchamiania testu ręcznego. Dołączenie flagi ActionResults powoduje pobranie wyniku kroków testu w sekcji actionResults i parametrów testu w sekcji parameters dla każdej iteracji testu.
Zwraca
Promise<TestIterationDetailsModel[]>
getTestResultAttachmentContent(string, number, number, number)
Pobierz załącznik z wynikiem testu według jego identyfikatora.
function getTestResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testu, który zawiera element testCaseResultId.
- testCaseResultId
-
number
Identyfikator wyniku testu, z którego należy pobrać załącznik.
- attachmentId
-
number
Identyfikator załącznika z wynikiem testu do pobrania.
Zwraca
Promise<ArrayBuffer>
getTestResultAttachments(string, number, number)
Pobierz listę odwołań do załączników z wynikami testów.
function getTestResultAttachments(project: string, runId: number, testCaseResultId: number): Promise<TestAttachment[]>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testu, który zawiera wynik.
- testCaseResultId
-
number
Identyfikator wyniku testu.
Zwraca
Promise<TestAttachment[]>
getTestResultAttachmentZip(string, number, number, number)
Pobierz załącznik z wynikiem testu według jego identyfikatora.
function getTestResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testu, który zawiera element testCaseResultId.
- testCaseResultId
-
number
Identyfikator wyniku testu, z którego należy pobrać załącznik.
- attachmentId
-
number
Identyfikator załącznika z wynikiem testu do pobrania.
Zwraca
Promise<ArrayBuffer>
getTestResultById(string, number, number, ResultDetails)
Uzyskaj wynik testu dla przebiegu testu.
function getTestResultById(project: string, runId: number, testCaseResultId: number, detailsToInclude?: ResultDetails): Promise<TestCaseResult>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testu wyniku testu do pobrania.
- testCaseResultId
-
number
Identyfikator wyniku testu.
- detailsToInclude
- ResultDetails
Szczegóły, które należy dołączyć do wyników testu. Wartość domyślna to Brak. Inne wartości to Iteracje, WorkItems i SubResults.
Zwraca
Promise<TestCaseResult>
getTestResultDetailsForBuild(string, number, string, string, string, string, boolean, boolean)
function getTestResultDetailsForBuild(project: string, buildId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- buildId
-
number
- publishContext
-
string
- groupBy
-
string
- filter
-
string
- orderby
-
string
- shouldIncludeResults
-
boolean
- queryRunSummaryForInProgress
-
boolean
Zwraca
Promise<TestResultsDetails>
getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)
function getTestResultDetailsForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- releaseId
-
number
- releaseEnvId
-
number
- publishContext
-
string
- groupBy
-
string
- filter
-
string
- orderby
-
string
- shouldIncludeResults
-
boolean
- queryRunSummaryForInProgress
-
boolean
Zwraca
Promise<TestResultsDetails>
getTestResults(string, number, ResultDetails, number, number, TestOutcome[])
Pobieranie wyników testu dla przebiegu testu.
function getTestResults(project: string, runId: number, detailsToInclude?: ResultDetails, skip?: number, top?: number, outcomes?: TestOutcome[]): Promise<TestCaseResult[]>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator uruchomienia testowego wyników testu do pobrania.
- detailsToInclude
- ResultDetails
Szczegóły, które należy dołączyć do wyników testu. Wartość domyślna to Brak. Inne wartości to Iteracje i WorkItems.
- skip
-
number
Liczba wyników testów, które należy pominąć od początku.
- top
-
number
Liczba wyników testu do zwrócenia. Maksymalna wartość to 1000, gdy detailsToInclude ma wartość None, a w przeciwnym razie 200.
- outcomes
Lista wyników testu rozdzielona przecinkami w celu filtrowania wyników testu.
Zwraca
Promise<TestCaseResult[]>
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
function getTestResultsByBuild(project: string, buildId: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- buildId
-
number
- publishContext
-
string
- outcomes
- top
-
number
- continuationToken
-
string
Zwraca
Promise<PagedList<ShallowTestCaseResult>>
getTestResultsByQuery(TestResultsQuery, string)
Ten interfejs API zwróci wyniki według identyfikatorów z określonymi polami/trendem dla określonej metody testu automatycznego. Wciąż ulepszamy ten interfejs API i nie sfinalizowaliśmy jeszcze prawidłowego podpisu i umowy.
function getTestResultsByQuery(query: TestResultsQuery, project: string): Promise<TestResultsQuery>
Parametry
- query
- TestResultsQuery
- project
-
string
Identyfikator projektu lub nazwa projektu
Zwraca
Promise<TestResultsQuery>
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
function getTestResultsByRelease(project: string, releaseId: number, releaseEnvid?: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- releaseId
-
number
- releaseEnvid
-
number
- publishContext
-
string
- outcomes
- top
-
number
- continuationToken
-
string
Zwraca
Promise<PagedList<ShallowTestCaseResult>>
getTestRunAttachmentContent(string, number, number)
Pobierz załącznik przebiegu testu według jego identyfikatora.
function getTestRunAttachmentContent(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testowego, którego załącznik należy pobrać.
- attachmentId
-
number
Identyfikator załącznika do uruchomienia testu, który ma zostać pobrany.
Zwraca
Promise<ArrayBuffer>
getTestRunAttachments(string, number)
Pobierz listę odwołań do załączników przebiegu testu.
function getTestRunAttachments(project: string, runId: number): Promise<TestAttachment[]>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testowego.
Zwraca
Promise<TestAttachment[]>
getTestRunAttachmentZip(string, number, number)
Pobierz załącznik przebiegu testu według jego identyfikatora.
function getTestRunAttachmentZip(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testowego, którego załącznik należy pobrać.
- attachmentId
-
number
Identyfikator załącznika do uruchomienia testu, który ma zostać pobrany.
Zwraca
Promise<ArrayBuffer>
getTestRunById(string, number, boolean)
Pobierz test uruchamiany według jego identyfikatora.
function getTestRunById(project: string, runId: number, includeDetails?: boolean): Promise<TestRun>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu do pobrania.
- includeDetails
-
boolean
Domyślna wartość to "true". Zawiera szczegółowe informacje, takie jak statystyki uruchamiania, wydanie, kompilacja, środowisko testowe, stan procesu końcowego i inne.
Zwraca
Promise<TestRun>
getTestRunCodeCoverage(string, number, number)
Pobieranie danych pokrycia kodu dla przebiegu testu
function getTestRunCodeCoverage(project: string, runId: number, flags: number): Promise<TestRunCoverage[]>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testu, dla którego należy pobrać dane pokrycia kodu.
- flags
-
number
Wartość flag określa poziom szczegółów pokrycia kodu, które mają zostać pobrane. Flagi są addytywne. Oczekiwane wartości to 1 dla modułów, 2 dla funkcji, 4 dla BlockData.
Zwraca
Promise<TestRunCoverage[]>
getTestRunLogs(string, number)
Pobieranie dzienników komunikatów przebiegu testowego
function getTestRunLogs(project: string, runId: number): Promise<TestMessageLogDetails[]>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu do pobrania.
Zwraca
Promise<TestMessageLogDetails[]>
getTestRuns(string, string, string, string, number, boolean, boolean, number, number)
Pobierz listę przebiegów testowych.
function getTestRuns(project: string, buildUri?: string, owner?: string, tmiRunId?: string, planId?: number, includeRunDetails?: boolean, automated?: boolean, skip?: number, top?: number): Promise<TestRun[]>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- buildUri
-
string
Identyfikator URI kompilacji używanej przez przebiegi.
- owner
-
string
Identyfikator fundacji zespołu właściciela przebiegów.
- tmiRunId
-
string
- planId
-
number
Identyfikator planu testu, którego częścią są przebiegi.
- includeRunDetails
-
boolean
Jeśli wartość true, uwzględnij wszystkie właściwości przebiegów.
- automated
-
boolean
Jeśli ma wartość true, zwraca tylko przebiegi automatyczne.
- skip
-
number
Liczba przebiegów testowych do pominięcia.
- top
-
number
Liczba przebiegów testowych do zwrócenia.
Zwraca
Promise<TestRun[]>
getTestRunStatistics(string, number)
Pobierz statystyki przebiegów testowych , używane, gdy chcemy uzyskać podsumowanie przebiegu według wyniku.
function getTestRunStatistics(project: string, runId: number): Promise<TestRunStatistic>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu do pobrania.
Zwraca
Promise<TestRunStatistic>
getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)
Pobierz listę sesji testowych
function getTestSessions(teamContext: TeamContext, period?: number, allSessions?: boolean, includeAllProperties?: boolean, source?: TestSessionSource, includeOnlyCompletedSessions?: boolean): Promise<TestSession[]>
Parametry
- teamContext
- TeamContext
Kontekst zespołu dla operacji
- period
-
number
Okres w dniach od teraz, dla którego pobierane są sesje testowe.
- allSessions
-
boolean
W przypadku wartości false zwraca sesje testowe dla bieżącego użytkownika. W przeciwnym razie zwraca sesje testowe dla wszystkich użytkowników
- includeAllProperties
-
boolean
Jeśli true, zwraca wszystkie właściwości sesji testowych. W przeciwnym razie zwraca chudą wersję.
- source
- TestSessionSource
Źródło sesji testowej.
- includeOnlyCompletedSessions
-
boolean
Jeśli true, zwraca sesje testowe w stanie ukończonym. W przeciwnym razie zwraca sesje testowe dla wszystkich stanów
Zwraca
Promise<TestSession[]>
getTestSettingsById(string, number)
function getTestSettingsById(project: string, testSettingsId: number): Promise<TestSettings>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- testSettingsId
-
number
Zwraca
Promise<TestSettings>
getTestSubResultAttachmentContent(string, number, number, number, number)
Pobierz załącznik z wynikiem cząstkowym testu
function getTestSubResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testu, który zawiera wynik.
- testCaseResultId
-
number
Identyfikator wyników testu, który zawiera wynik cząstkowy.
- attachmentId
-
number
Identyfikator załącznika z wynikiem testu do pobrania
- testSubResultId
-
number
Identyfikator wyniku cząstkowego testu, z którego należy pobrać załącznik
Zwraca
Promise<ArrayBuffer>
getTestSubResultAttachments(string, number, number, number)
Pobierz listę załączników z wynikami podrzędnymi testu
function getTestSubResultAttachments(project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachment[]>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testu, który zawiera wynik.
- testCaseResultId
-
number
Identyfikator wyników testu, który zawiera wynik cząstkowy.
- testSubResultId
-
number
Identyfikator wyniku cząstkowego testu, z którego należy pobrać załącznik
Zwraca
Promise<TestAttachment[]>
getTestSubResultAttachmentZip(string, number, number, number, number)
Pobierz załącznik z wynikiem cząstkowym testu
function getTestSubResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testu, który zawiera wynik.
- testCaseResultId
-
number
Identyfikator wyników testu, który zawiera wynik cząstkowy.
- attachmentId
-
number
Identyfikator załącznika z wynikiem testu do pobrania
- testSubResultId
-
number
Identyfikator wyniku cząstkowego testu, z którego należy pobrać załącznik
Zwraca
Promise<ArrayBuffer>
processSuitesForStaging(StagedSuitesRequestModel, string, number)
Przetwarza kolekcję zestawów testów i zwraca model odpowiedzi zawierający szczegóły zestawu i przypadku testowego.
function processSuitesForStaging(request: StagedSuitesRequestModel, project: string, workItemId: number): Promise<StagedSuitesResponseModel>
Parametry
- request
- StagedSuitesRequestModel
Model żądania zawierający zestawy testów, które mają zostać przetworzone. Nie może mieć wartości null.
- project
-
string
Identyfikator projektu lub nazwa projektu
- workItemId
-
number
Zwraca
Promise<StagedSuitesResponseModel>
publishTestResultDocument(TestResultDocument, string, number)
function publishTestResultDocument(document: TestResultDocument, project: string, runId: number): Promise<TestResultDocument>
Parametry
- document
- TestResultDocument
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Zwraca
Promise<TestResultDocument>
queryCustomFields(string, CustomTestFieldScope)
function queryCustomFields(project: string, scopeFilter: CustomTestFieldScope): Promise<CustomTestFieldDefinition[]>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- scopeFilter
- CustomTestFieldScope
Zwraca
Promise<CustomTestFieldDefinition[]>
queryResultTrendForBuild(TestResultTrendFilter, string)
function queryResultTrendForBuild(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>
Parametry
- filter
- TestResultTrendFilter
- project
-
string
Identyfikator projektu lub nazwa projektu
Zwraca
Promise<AggregatedDataForResultTrend[]>
queryResultTrendForRelease(TestResultTrendFilter, string)
function queryResultTrendForRelease(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>
Parametry
- filter
- TestResultTrendFilter
- project
-
string
Identyfikator projektu lub nazwa projektu
Zwraca
Promise<AggregatedDataForResultTrend[]>
queryTestHistory(TestHistoryQuery, string)
Pobieranie historii metody testowej przy użyciu TestHistoryQuery
function queryTestHistory(filter: TestHistoryQuery, project: string): Promise<TestHistoryQuery>
Parametry
- filter
- TestHistoryQuery
TestHistoryQuery, aby uzyskać historię
- project
-
string
Identyfikator projektu lub nazwa projektu
Zwraca
Promise<TestHistoryQuery>
queryTestMethodLinkedWorkItems(string, string)
function queryTestMethodLinkedWorkItems(project: string, testName: string): Promise<TestToWorkItemLinks>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- testName
-
string
Zwraca
Promise<TestToWorkItemLinks>
queryTestResultHistory(ResultsFilter, string)
function queryTestResultHistory(filter: ResultsFilter, project: string): Promise<TestResultHistory>
Parametry
- filter
- ResultsFilter
- project
-
string
Identyfikator projektu lub nazwa projektu
Zwraca
Promise<TestResultHistory>
queryTestResultsMetaData(string[], string)
Pobieranie listy szczegółów metadanych wyniku testu dla odpowiedniego testcasereferenceId
function queryTestResultsMetaData(testReferenceIds: string[], project: string): Promise<TestResultMetaData[]>
Parametry
- testReferenceIds
-
string[]
TestCaseReference Identyfikatory wyniku testu, który ma zostać zapytany, oddzielona przecinkami lista prawidłowych identyfikatorów (limit liczby identyfikatorów 200).
- project
-
string
Identyfikator projektu lub nazwa projektu
Zwraca
Promise<TestResultMetaData[]>
queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)
function queryTestResultsReportForBuild(project: string, buildId: number, publishContext?: string, includeFailureDetails?: boolean, buildToCompare?: BuildReference): Promise<TestResultSummary>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- buildId
-
number
- publishContext
-
string
- includeFailureDetails
-
boolean
- buildToCompare
- BuildReference
Zwraca
Promise<TestResultSummary>
queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
function queryTestResultsReportForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, includeFailureDetails?: boolean, releaseToCompare?: ReleaseReference): Promise<TestResultSummary>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- releaseId
-
number
- releaseEnvId
-
number
- publishContext
-
string
- includeFailureDetails
-
boolean
- releaseToCompare
- ReleaseReference
Zwraca
Promise<TestResultSummary>
queryTestResultsSummaryForReleases(ReleaseReference[], string)
function queryTestResultsSummaryForReleases(releases: ReleaseReference[], project: string): Promise<TestResultSummary[]>
Parametry
- releases
- project
-
string
Identyfikator projektu lub nazwa projektu
Zwraca
Promise<TestResultSummary[]>
queryTestResultWorkItems(string, string, string, number, Date, number, number)
function queryTestResultWorkItems(project: string, workItemCategory: string, automatedTestName?: string, testCaseId?: number, maxCompleteDate?: Date, days?: number, workItemCount?: number): Promise<WorkItemReference[]>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- workItemCategory
-
string
- automatedTestName
-
string
- testCaseId
-
number
- maxCompleteDate
-
Date
- days
-
number
- workItemCount
-
number
Zwraca
Promise<WorkItemReference[]>
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, string)
Wykonywanie zapytań testowych na podstawie filtrów. Pola obowiązkowe to minLastUpdatedDate i maxLastUpdatedDate.
function queryTestRuns(project: string, minLastUpdatedDate: Date, maxLastUpdatedDate: Date, state?: TestRunState, planIds?: number[], isAutomated?: boolean, publishContext?: TestRunPublishContext, buildIds?: number[], buildDefIds?: number[], branchName?: string, releaseIds?: number[], releaseDefIds?: number[], releaseEnvIds?: number[], releaseEnvDefIds?: number[], runTitle?: string, top?: number, continuationToken?: string): Promise<PagedList<TestRun>>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- minLastUpdatedDate
-
Date
Minimalna data ostatniej modyfikacji uruchomienia, które ma zostać odpytane (obowiązkowe).
- maxLastUpdatedDate
-
Date
Maksymalna data ostatniej modyfikacji uruchomienia do odpytywania (obowiązkowe, różnica między datą minimalną a maksymalną może wynosić co najwyżej 7 dni).
- state
- TestRunState
Bieżący stan przebiegów, które mają być odpytywane.
- planIds
-
number[]
Identyfikatory planu przebiegów, które mają być odpytywane, oddzielona przecinkami lista prawidłowych identyfikatorów (limit liczby identyfikatorów 10).
- isAutomated
-
boolean
Typ automatyzacji przebiegów, które mają być odpytywane.
- publishContext
- TestRunPublishContext
PublishContext przebiegów, które mają być odpytywane.
- buildIds
-
number[]
Identyfikatory kompilacji przebiegów, które mają być odpytywane, rozdzielana przecinkami lista prawidłowych identyfikatorów (limit liczby identyfikatorów 10).
- buildDefIds
-
number[]
Identyfikatory definicji kompilacji przebiegów, które mają być odpytywane, rozdzielane przecinkami lista prawidłowych identyfikatorów (limit liczby identyfikatorów 10).
- branchName
-
string
Nazwa gałęzi źródłowej przebiegów, które mają być odpytywane.
- releaseIds
-
number[]
Identyfikatory wydania przebiegów, które mają być odpytywane, oddzielona przecinkami lista prawidłowych identyfikatorów (limit liczby identyfikatorów 10).
- releaseDefIds
-
number[]
Identyfikatory definicji wydania przebiegów, które mają być odpytywane, oddzielona przecinkami lista prawidłowych identyfikatorów (limit liczby identyfikatorów 10).
- releaseEnvIds
-
number[]
Identyfikatory środowiska wydania przebiegów, które mają być odpytywane, rozdzielana przecinkami lista prawidłowych identyfikatorów (limit liczby identyfikatorów 10).
- releaseEnvDefIds
-
number[]
Identyfikatory definicji środowiska wydania przebiegów, które mają być odpytywane, oddzielona przecinkami lista prawidłowych identyfikatorów (limit liczby identyfikatorów 10).
- runTitle
-
string
Tytuł uruchomienia przebiegów, które mają być przedmiotem zapytania.
- top
-
number
Liczba przebiegów do odpytywania. Limit wynosi 100
- continuationToken
-
string
continuationToken odebrany z poprzedniej partii lub null dla pierwszej partii. Nie powinien być tworzony (ani zmieniany, jeśli został otrzymany z ostatniej partii) przez użytkownika.
Zwraca
queryTestSummaryByRequirement(TestResultsContext, string, number[])
function queryTestSummaryByRequirement(resultsContext: TestResultsContext, project: string, workItemIds?: number[]): Promise<TestSummaryForWorkItem[]>
Parametry
- resultsContext
- TestResultsContext
- project
-
string
Identyfikator projektu lub nazwa projektu
- workItemIds
-
number[]
Zwraca
Promise<TestSummaryForWorkItem[]>
removeTestCasesFromSuiteUrl(string, number, number, string)
Punkty testowe skojarzone z przypadkami testowymi są usuwane z zestawu testów. Element roboczy przypadku testowego nie jest usuwany z systemu. Zobacz zasób przypadków testowych, aby trwale usunąć przypadek testowy.
function removeTestCasesFromSuiteUrl(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<void>
Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- planId
-
number
Identyfikator planu testu, który zawiera zestaw.
- suiteId
-
number
Identyfikator apartamentu do pobrania.
- testCaseIds
-
string
Identyfikatory przypadków testowych do usunięcia z pakietu.
Zwraca
Promise<void>
updateCodeCoverageSummary(CodeCoverageData, string, number)
http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Żądanie: Json podsumowania pokrycia kodu
function updateCodeCoverageSummary(coverageData: CodeCoverageData, project: string, buildId: number): Promise<void>
Parametry
- coverageData
- CodeCoverageData
- project
-
string
Identyfikator projektu lub nazwa projektu
- buildId
-
number
Zwraca
Promise<void>
updateResultRetentionSettings(ResultRetentionSettings, string)
Aktualizowanie ustawień przechowywania wyników testu
function updateResultRetentionSettings(retentionSettings: ResultRetentionSettings, project: string): Promise<ResultRetentionSettings>
Parametry
- retentionSettings
- ResultRetentionSettings
Szczegóły ustawień przechowywania wyników testu, które mają zostać zaktualizowane
- project
-
string
Identyfikator projektu lub nazwa projektu
Zwraca
Promise<ResultRetentionSettings>
updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)
Aktualizuje właściwości skojarzenia przypadku testowego w pakiecie.
function updateSuiteTestCases(suiteTestCaseUpdateModel: SuiteTestCaseUpdateModel, project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>
Parametry
- suiteTestCaseUpdateModel
- SuiteTestCaseUpdateModel
Model do aktualizacji właściwości skojarzenia zestawu przypadków testowych.
- project
-
string
Identyfikator projektu lub nazwa projektu
- planId
-
number
Identyfikator planu testu, który zawiera zestaw.
- suiteId
-
number
Identyfikator zestawu testów, do którego należy dodać przypadki testowe.
- testCaseIds
-
string
Identyfikatory przypadków testowych, które mają zostać dodane do pakietu. Identyfikatory są podawane w formacie oddzielonym przecinkami.
Zwraca
Promise<SuiteTestCase[]>
updateTestPoints(PointUpdateModel, string, number, number, string)
Zaktualizuj punkty testowe.
function updateTestPoints(pointUpdateModel: PointUpdateModel, project: string, planId: number, suiteId: number, pointIds: string): Promise<TestPoint[]>
Parametry
- pointUpdateModel
- PointUpdateModel
Dane do zaktualizowania.
- project
-
string
Identyfikator projektu lub nazwa projektu
- planId
-
number
Identyfikator planu testów.
- suiteId
-
number
Identyfikator pakietu, który zawiera punkty.
- pointIds
-
string
Identyfikator punktu testowego do pobrania. Użyj listy identyfikatorów rozdzielonych przecinkami, aby zaktualizować wiele punktów testowych.
Zwraca
Promise<TestPoint[]>
updateTestResults(TestCaseResult[], string, number)
Aktualizowanie wyników testu w przebiegu testu.
function updateTestResults(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>
Parametry
- results
Lista wyników testów do aktualizacji.
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu testu, którego wyniki testu mają zostać zaktualizowane.
Zwraca
Promise<TestCaseResult[]>
updateTestRun(RunUpdateModel, string, number)
Zaktualizuj test uruchamiany według jego identyfikatora.
function updateTestRun(runUpdateModel: RunUpdateModel, project: string, runId: number): Promise<TestRun>
Parametry
- runUpdateModel
- RunUpdateModel
Szczegóły uruchamiania RunUpdateModel
- project
-
string
Identyfikator projektu lub nazwa projektu
- runId
-
number
Identyfikator przebiegu do zaktualizowania.
Zwraca
Promise<TestRun>
updateTestSession(TestSession, TeamContext)
Aktualizowanie sesji testowej
function updateTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>
Parametry
- testSession
- TestSession
Szczegóły sesji testowej do aktualizacji
- teamContext
- TeamContext
Kontekst zespołu dla operacji
Zwraca
Promise<TestSession>