TestRestClient class
Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS
- Extends
Constructores
| Test |
Propiedades
| RESOURCE_AREA_ID |
Métodos
Detalles del constructor
TestRestClient(IVssRestClientOptions)
Detalles de las propiedades
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValor de propiedad
string
Detalles del método
addCustomFields(CustomTestFieldDefinition[], string)
function addCustomFields(newFields: CustomTestFieldDefinition[], project: string): Promise<CustomTestFieldDefinition[]>Parámetros
- newFields
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<CustomTestFieldDefinition[]>
addTestCasesToSuite(string, number, number, string)
Agregue casos de prueba al conjunto de aplicaciones.
function addTestCasesToSuite(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- planId
-
number
Identificador del plan de prueba que contiene el conjunto de aplicaciones.
- suiteId
-
number
Identificador del conjunto de pruebas al que se deben agregar los casos de prueba.
- testCaseIds
-
string
Identificadores de los casos de prueba que se van a agregar al conjunto de aplicaciones. Los identificadores se especifican en formato separado por comas.
Devoluciones
Promise<SuiteTestCase[]>
addTestResultsToTestRun(TestCaseResult[], string, number)
Agregue resultados de pruebas a una ejecución de pruebas.
function addTestResultsToTestRun(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>Parámetros
- results
Lista de resultados de pruebas que se van a agregar.
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de ejecución de prueba en el que se van a agregar los resultados de la prueba.
Devoluciones
Promise<TestCaseResult[]>
addWorkItemToTestLinks(WorkItemToTestLinks, string)
function addWorkItemToTestLinks(workItemToTestLinks: WorkItemToTestLinks, project: string): Promise<WorkItemToTestLinks>Parámetros
- workItemToTestLinks
- WorkItemToTestLinks
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<WorkItemToTestLinks>
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)
Adjuntar un archivo para probar el resultado del paso
function createTestIterationResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, iterationId: number, actionPath?: string): Promise<TestAttachmentReference>Parámetros
- attachmentRequestModel
- TestAttachmentRequestModel
Detalles de datos adjuntos TestAttachmentRequestModel
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución de prueba que contiene el resultado.
- testCaseResultId
-
number
Identificador del resultado de la prueba que contiene la iteración
- iterationId
-
number
Identificador de la iteración del resultado de la prueba.
- actionPath
-
string
Valor hexadecimal de la ruta de acción del resultado de la prueba.
Devoluciones
Promise<TestAttachmentReference>
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)
Adjunte un archivo a un resultado de prueba.
function createTestResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number): Promise<TestAttachmentReference>Parámetros
- attachmentRequestModel
- TestAttachmentRequestModel
Detalles de datos adjuntos TestAttachmentRequestModel
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución de prueba que contiene el resultado.
- testCaseResultId
-
number
Identificador del resultado de la prueba en el que se deben cargar los datos adjuntos.
Devoluciones
Promise<TestAttachmentReference>
createTestRun(RunCreateModel, string)
Cree una nueva ejecución de prueba.
function createTestRun(testRun: RunCreateModel, project: string): Promise<TestRun>Parámetros
- testRun
- RunCreateModel
Detalles de ejecución RunCreateModel
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<TestRun>
createTestRunAttachment(TestAttachmentRequestModel, string, number)
Adjunte un archivo a una ejecución de prueba.
function createTestRunAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestAttachmentReference>Parámetros
- attachmentRequestModel
- TestAttachmentRequestModel
Detalles de datos adjuntos TestAttachmentRequestModel
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución de prueba en la que se deben cargar los datos adjuntos.
Devoluciones
Promise<TestAttachmentReference>
createTestSession(TestSession, TeamContext)
Creación de una sesión de prueba
function createTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>Parámetros
- testSession
- TestSession
Detalles de la sesión de prueba para la creación
- teamContext
- TeamContext
Contexto del equipo para la operación
Devoluciones
Promise<TestSession>
createTestSettings(TestSettings, string)
function createTestSettings(testSettings: TestSettings, project: string): Promise<number>Parámetros
- testSettings
- TestSettings
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<number>
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)
Adjuntar un archivo a un resultado de prueba
function createTestSubResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachmentReference>Parámetros
- attachmentRequestModel
- TestAttachmentRequestModel
Modelo de solicitud de datos adjuntos.
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución de prueba que contiene el resultado.
- testCaseResultId
-
number
Identificador de los resultados de la prueba que contiene el sub result.
- testSubResultId
-
number
Identificador de los sub resultados de prueba con los que se deben cargar los datos adjuntos.
Devoluciones
Promise<TestAttachmentReference>
deleteSharedParameter(string, number)
function deleteSharedParameter(project: string, sharedParameterId: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- sharedParameterId
-
number
Devoluciones
Promise<void>
deleteSharedStep(string, number)
function deleteSharedStep(project: string, sharedStepId: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- sharedStepId
-
number
Devoluciones
Promise<void>
deleteTestCase(string, number)
Elimine un caso de prueba.
function deleteTestCase(project: string, testCaseId: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- testCaseId
-
number
Identificador del caso de prueba que se va a eliminar.
Devoluciones
Promise<void>
deleteTestMethodToWorkItemLink(string, string, number)
function deleteTestMethodToWorkItemLink(project: string, testName: string, workItemId: number): Promise<boolean>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- testName
-
string
- workItemId
-
number
Devoluciones
Promise<boolean>
deleteTestRun(string, number)
Elimine una prueba ejecutada por su identificador.
function deleteTestRun(project: string, runId: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución que se va a eliminar.
Devoluciones
Promise<void>
deleteTestSettings(string, number)
function deleteTestSettings(project: string, testSettingsId: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- testSettingsId
-
number
Devoluciones
Promise<void>
getBugsLinkedToTestResult(string, number, number)
function getBugsLinkedToTestResult(project: string, runId: number, testCaseResultId: number): Promise<WorkItemReference[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
- testCaseResultId
-
number
Devoluciones
Promise<WorkItemReference[]>
getBuildCodeCoverage(string, number, number)
Obtener datos de cobertura de código para una compilación.
function getBuildCodeCoverage(project: string, buildId: number, flags: number): Promise<BuildCoverage[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- buildId
-
number
Identificador de la compilación para la que se deben capturar los datos de cobertura de código.
- flags
-
number
El valor de las marcas determina el nivel de detalles de cobertura de código que se van a capturar. Las marcas son aditivos. Los valores esperados son 1 para los módulos, 2 para Functions, 4 para BlockData.
Devoluciones
Promise<BuildCoverage[]>
getCodeCoverageSummary(string, number, number)
Obtenga el resumen de cobertura de código para la compilación.
function getCodeCoverageSummary(project: string, buildId: number, deltaBuildId?: number): Promise<CodeCoverageSummary>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- buildId
-
number
Identificador de la compilación para la que se deben capturar los datos de cobertura de código.
- deltaBuildId
-
number
Id. de compilación delta (opcional)
Devoluciones
Promise<CodeCoverageSummary>
getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)
function getLinkedWorkItemsByQuery(workItemQuery: LinkedWorkItemsQuery, project: string): Promise<LinkedWorkItemsQueryResult[]>Parámetros
- workItemQuery
- LinkedWorkItemsQuery
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<LinkedWorkItemsQueryResult[]>
getPoint(string, number, number, number, string)
Obtener un punto de prueba.
function getPoint(project: string, planId: number, suiteId: number, pointIds: number, witFields?: string): Promise<TestPoint>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- planId
-
number
Identificador del plan de prueba.
- suiteId
-
number
Identificador del conjunto que contiene el punto.
- pointIds
-
number
Identificador del punto de prueba que se va a obtener.
- witFields
-
string
Lista separada por comas de nombres de campo de elemento de trabajo.
Devoluciones
Promise<TestPoint>
getPoints(string, number, number, string, string, string, string, boolean, number, number)
Obtenga una lista de puntos de prueba.
function getPoints(project: string, planId: number, suiteId: number, witFields?: string, configurationId?: string, testCaseId?: string, testPointIds?: string, includePointDetails?: boolean, skip?: number, top?: number): Promise<TestPoint[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- planId
-
number
Identificador del plan de prueba.
- suiteId
-
number
Identificador del conjunto que contiene los puntos.
- witFields
-
string
Lista separada por comas de nombres de campo de elemento de trabajo.
- configurationId
-
string
Obtener puntos de prueba para una configuración específica.
- testCaseId
-
string
Obtiene puntos de prueba para un caso de prueba específico, válido cuando no se establece configurationId.
- testPointIds
-
string
Obtenga puntos de prueba para la lista separada por comas de identificadores de punto de prueba, válido solo cuando configurationId y testCaseId no estén establecidos.
- includePointDetails
-
boolean
Incluya todas las propiedades del punto de prueba.
- skip
-
number
Número de puntos de prueba que se van a omitir.
- top
-
number
Número de puntos de prueba que se van a devolver.
Devoluciones
Promise<TestPoint[]>
getPointsByQuery(TestPointsQuery, string, number, number)
Obtenga puntos de prueba mediante la consulta.
function getPointsByQuery(query: TestPointsQuery, project: string, skip?: number, top?: number): Promise<TestPointsQuery>Parámetros
- query
- TestPointsQuery
TestPointsQuery para obtener puntos de prueba.
- project
-
string
Id. de proyecto o nombre del proyecto
- skip
-
number
Número de puntos de prueba que se van a omitir.
- top
-
number
Número de puntos de prueba que se van a devolver.
Devoluciones
Promise<TestPointsQuery>
getResultGroupsByBuild(string, number, string, string[], string)
function getResultGroupsByBuild(project: string, buildId: number, publishContext: string, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- buildId
-
number
- publishContext
-
string
- fields
-
string[]
- continuationToken
-
string
Devoluciones
Promise<PagedList<FieldDetailsForTestResults>>
getResultGroupsByRelease(string, number, string, number, string[], string)
function getResultGroupsByRelease(project: string, releaseId: number, publishContext: string, releaseEnvId?: number, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
- publishContext
-
string
- releaseEnvId
-
number
- fields
-
string[]
- continuationToken
-
string
Devoluciones
Promise<PagedList<FieldDetailsForTestResults>>
getResultRetentionSettings(string)
Obtención de la configuración de retención de resultados de prueba
function getResultRetentionSettings(project: string): Promise<ResultRetentionSettings>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<ResultRetentionSettings>
getTestCaseById(string, number, number, number)
Obtenga un caso de prueba específico en un conjunto de pruebas con el identificador de caso de prueba.
function getTestCaseById(project: string, planId: number, suiteId: number, testCaseIds: number): Promise<SuiteTestCase>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- planId
-
number
Identificador del plan de prueba que contiene los conjuntos.
- suiteId
-
number
Identificador del conjunto que contiene el caso de prueba.
- testCaseIds
-
number
Identificador del caso de prueba que se va a obtener.
Devoluciones
Promise<SuiteTestCase>
getTestCases(string, number, number)
Obtenga todos los casos de prueba de un conjunto de aplicaciones.
function getTestCases(project: string, planId: number, suiteId: number): Promise<SuiteTestCase[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- planId
-
number
Identificador del plan de prueba que contiene los conjuntos.
- suiteId
-
number
Identificador del conjunto que se va a obtener.
Devoluciones
Promise<SuiteTestCase[]>
getTestIteration(string, number, number, number, boolean)
Obtención de la iteración de un resultado
function getTestIteration(project: string, runId: number, testCaseResultId: number, iterationId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución de prueba que contiene el resultado.
- testCaseResultId
-
number
Identificador del resultado de la prueba que contiene las iteraciones.
- iterationId
-
number
Id. de los resultados de la prueba Iteración.
- includeActionResults
-
boolean
Incluya los detalles del resultado de cada acción realizada en la iteración de prueba. ActionResults hace referencia al resultado (paso o error) de los pasos de prueba que se ejecutan como parte de una ejecución de una prueba manual. La inclusión de la marca ActionResults obtiene el resultado de los pasos de prueba en la sección actionResults y los parámetros de prueba de la sección de parámetros para cada iteración de prueba.
Devoluciones
Promise<TestIterationDetailsModel>
getTestIterations(string, number, number, boolean)
Obtención de iteraciones para un resultado
function getTestIterations(project: string, runId: number, testCaseResultId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución de prueba que contiene el resultado.
- testCaseResultId
-
number
Identificador del resultado de la prueba que contiene las iteraciones.
- includeActionResults
-
boolean
Incluya los detalles del resultado de cada acción realizada en la iteración de prueba. ActionResults hace referencia al resultado (paso o error) de los pasos de prueba que se ejecutan como parte de una ejecución de una prueba manual. La inclusión de la marca ActionResults obtiene el resultado de los pasos de prueba en la sección actionResults y los parámetros de prueba de la sección de parámetros para cada iteración de prueba.
Devoluciones
Promise<TestIterationDetailsModel[]>
getTestResultAttachmentContent(string, number, number, number)
Descargue los datos adjuntos de un resultado de prueba por su identificador.
function getTestResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución de prueba que contiene testCaseResultId.
- testCaseResultId
-
number
Identificador del resultado de la prueba cuyos datos adjuntos se deben descargar.
- attachmentId
-
number
Identificador de los datos adjuntos del resultado de la prueba que se van a descargar.
Devoluciones
Promise<ArrayBuffer>
getTestResultAttachments(string, number, number)
Obtiene la lista de datos adjuntos de resultados de prueba.
function getTestResultAttachments(project: string, runId: number, testCaseResultId: number): Promise<TestAttachment[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución de prueba que contiene el resultado.
- testCaseResultId
-
number
Identificador del resultado de la prueba.
Devoluciones
Promise<TestAttachment[]>
getTestResultAttachmentZip(string, number, number, number)
Descargue los datos adjuntos de un resultado de prueba por su identificador.
function getTestResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución de prueba que contiene testCaseResultId.
- testCaseResultId
-
number
Identificador del resultado de la prueba cuyos datos adjuntos se deben descargar.
- attachmentId
-
number
Identificador de los datos adjuntos del resultado de la prueba que se van a descargar.
Devoluciones
Promise<ArrayBuffer>
getTestResultById(string, number, number, ResultDetails)
Obtenga un resultado de prueba para una ejecución de prueba.
function getTestResultById(project: string, runId: number, testCaseResultId: number, detailsToInclude?: ResultDetails): Promise<TestCaseResult>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de ejecución de prueba de un resultado de prueba que se va a capturar.
- testCaseResultId
-
number
Id. de resultado de la prueba.
- detailsToInclude
- ResultDetails
Detalles que se van a incluir con los resultados de la prueba. El valor predeterminado es Ninguno. Otros valores son Iteraciones, WorkItems y SubResults.
Devoluciones
Promise<TestCaseResult>
getTestResultDetailsForBuild(string, number, string, string, string, string, boolean, boolean)
function getTestResultDetailsForBuild(project: string, buildId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- buildId
-
number
- publishContext
-
string
- groupBy
-
string
- filter
-
string
- orderby
-
string
- shouldIncludeResults
-
boolean
- queryRunSummaryForInProgress
-
boolean
Devoluciones
Promise<TestResultsDetails>
getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)
function getTestResultDetailsForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
- releaseEnvId
-
number
- publishContext
-
string
- groupBy
-
string
- filter
-
string
- orderby
-
string
- shouldIncludeResults
-
boolean
- queryRunSummaryForInProgress
-
boolean
Devoluciones
Promise<TestResultsDetails>
getTestResults(string, number, ResultDetails, number, number, TestOutcome[])
Obtiene los resultados de las pruebas para una ejecución de prueba.
function getTestResults(project: string, runId: number, detailsToInclude?: ResultDetails, skip?: number, top?: number, outcomes?: TestOutcome[]): Promise<TestCaseResult[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de ejecución de prueba de los resultados de la prueba que se van a capturar.
- detailsToInclude
- ResultDetails
Detalles que se van a incluir con los resultados de la prueba. El valor predeterminado es Ninguno. Otros valores son Iteraciones y WorkItems.
- skip
-
number
Número de resultados de pruebas que se van a omitir desde el principio.
- top
-
number
Número de resultados de pruebas que se van a devolver. El máximo es 1000 cuando detailsToInclude es None y 200 en caso contrario.
- outcomes
Lista separada por comas de resultados de pruebas para filtrar los resultados de las pruebas.
Devoluciones
Promise<TestCaseResult[]>
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
function getTestResultsByBuild(project: string, buildId: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- buildId
-
number
- publishContext
-
string
- outcomes
- top
-
number
- continuationToken
-
string
Devoluciones
Promise<PagedList<ShallowTestCaseResult>>
getTestResultsByQuery(TestResultsQuery, string)
Esta API devolverá resultados por ids con campos especificados o tendencias para un método de prueba automatizado determinado. Todavía estamos mejorando esta API y no hemos finalizado la firma y el contrato adecuados.
function getTestResultsByQuery(query: TestResultsQuery, project: string): Promise<TestResultsQuery>Parámetros
- query
- TestResultsQuery
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<TestResultsQuery>
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
function getTestResultsByRelease(project: string, releaseId: number, releaseEnvid?: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
- releaseEnvid
-
number
- publishContext
-
string
- outcomes
- top
-
number
- continuationToken
-
string
Devoluciones
Promise<PagedList<ShallowTestCaseResult>>
getTestRunAttachmentContent(string, number, number)
Descargue los datos adjuntos de una ejecución de prueba por su identificador.
function getTestRunAttachmentContent(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución de prueba cuyos datos adjuntos se deben descargar.
- attachmentId
-
number
Identificador de los datos adjuntos de la ejecución de pruebas que se van a descargar.
Devoluciones
Promise<ArrayBuffer>
getTestRunAttachments(string, number)
Obtenga la lista de referencias de datos adjuntos de ejecución de pruebas.
function getTestRunAttachments(project: string, runId: number): Promise<TestAttachment[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución de pruebas.
Devoluciones
Promise<TestAttachment[]>
getTestRunAttachmentZip(string, number, number)
Descargue los datos adjuntos de una ejecución de prueba por su identificador.
function getTestRunAttachmentZip(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución de prueba cuyos datos adjuntos se deben descargar.
- attachmentId
-
number
Identificador de los datos adjuntos de la ejecución de pruebas que se van a descargar.
Devoluciones
Promise<ArrayBuffer>
getTestRunById(string, number, boolean)
Obtenga una prueba ejecutada por su identificador.
function getTestRunById(project: string, runId: number, includeDetails?: boolean): Promise<TestRun>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución que se va a obtener.
- includeDetails
-
boolean
El valor predeterminado es true. Incluye detalles como las estadísticas de ejecución, la versión, la compilación, el entorno de prueba, el estado posterior al proceso, etc.
Devoluciones
Promise<TestRun>
getTestRunCodeCoverage(string, number, number)
Obtención de datos de cobertura de código para una ejecución de prueba
function getTestRunCodeCoverage(project: string, runId: number, flags: number): Promise<TestRunCoverage[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución de prueba para la que se deben capturar los datos de cobertura de código.
- flags
-
number
El valor de las marcas determina el nivel de detalles de cobertura de código que se van a capturar. Las marcas son aditivos. Los valores esperados son 1 para los módulos, 2 para Functions, 4 para BlockData.
Devoluciones
Promise<TestRunCoverage[]>
getTestRunLogs(string, number)
Obtención de registros de mensajes de ejecución de prueba
function getTestRunLogs(project: string, runId: number): Promise<TestMessageLogDetails[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución que se va a obtener.
Devoluciones
Promise<TestMessageLogDetails[]>
getTestRuns(string, string, string, string, number, boolean, boolean, number, number)
Obtenga una lista de ejecuciones de pruebas.
function getTestRuns(project: string, buildUri?: string, owner?: string, tmiRunId?: string, planId?: number, includeRunDetails?: boolean, automated?: boolean, skip?: number, top?: number): Promise<TestRun[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- buildUri
-
string
URI de la compilación que se ejecuta.
- owner
-
string
Identificador de base del equipo del propietario de las ejecuciones.
- tmiRunId
-
string
- planId
-
number
Identificador del plan de prueba del que forman parte las ejecuciones.
- includeRunDetails
-
boolean
Si es true, incluya todas las propiedades de las ejecuciones.
- automated
-
boolean
Si es true, solo devuelve ejecuciones automatizadas.
- skip
-
number
Número de ejecuciones de pruebas que se van a omitir.
- top
-
number
Número de ejecuciones de pruebas que se van a devolver.
Devoluciones
Promise<TestRun[]>
getTestRunStatistics(string, number)
Obtiene las estadísticas de ejecución de pruebas , que se usan cuando queremos obtener un resumen de una ejecución por resultado.
function getTestRunStatistics(project: string, runId: number): Promise<TestRunStatistic>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución que se va a obtener.
Devoluciones
Promise<TestRunStatistic>
getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)
Obtener una lista de sesiones de prueba
function getTestSessions(teamContext: TeamContext, period?: number, allSessions?: boolean, includeAllProperties?: boolean, source?: TestSessionSource, includeOnlyCompletedSessions?: boolean): Promise<TestSession[]>Parámetros
- teamContext
- TeamContext
Contexto del equipo para la operación
- period
-
number
Período en días a partir de ahora, para el que se capturan las sesiones de prueba.
- allSessions
-
boolean
Si es false, devuelve sesiones de prueba para el usuario actual. De lo contrario, devuelve sesiones de prueba para todos los usuarios.
- includeAllProperties
-
boolean
Si es true, devuelve todas las propiedades de las sesiones de prueba. De lo contrario, devuelve la versión skinny.
- source
- TestSessionSource
Origen de la sesión de prueba.
- includeOnlyCompletedSessions
-
boolean
Si es true, devuelve sesiones de prueba en estado completado. De lo contrario, devuelve sesiones de prueba para todos los estados.
Devoluciones
Promise<TestSession[]>
getTestSettingsById(string, number)
function getTestSettingsById(project: string, testSettingsId: number): Promise<TestSettings>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- testSettingsId
-
number
Devoluciones
Promise<TestSettings>
getTestSubResultAttachmentContent(string, number, number, number, number)
Descarga de datos adjuntos de sub result de prueba
function getTestSubResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución de prueba que contiene el resultado.
- testCaseResultId
-
number
Identificador de los resultados de la prueba que contiene el sub result.
- attachmentId
-
number
Identificador de los datos adjuntos del resultado de la prueba que se van a descargar
- testSubResultId
-
number
Id. del resultado secundario de prueba cuyos datos adjuntos se deben descargar
Devoluciones
Promise<ArrayBuffer>
getTestSubResultAttachments(string, number, number, number)
Obtener la lista de datos adjuntos de sub result de prueba
function getTestSubResultAttachments(project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachment[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución de prueba que contiene el resultado.
- testCaseResultId
-
number
Identificador de los resultados de la prueba que contiene el sub result.
- testSubResultId
-
number
Id. del resultado secundario de prueba cuyos datos adjuntos se deben descargar
Devoluciones
Promise<TestAttachment[]>
getTestSubResultAttachmentZip(string, number, number, number, number)
Descarga de datos adjuntos de sub result de prueba
function getTestSubResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución de prueba que contiene el resultado.
- testCaseResultId
-
number
Identificador de los resultados de la prueba que contiene el sub result.
- attachmentId
-
number
Identificador de los datos adjuntos del resultado de la prueba que se van a descargar
- testSubResultId
-
number
Id. del resultado secundario de prueba cuyos datos adjuntos se deben descargar
Devoluciones
Promise<ArrayBuffer>
processSuitesForStaging(StagedSuitesRequestModel, string, number)
Procesa una colección de conjuntos de pruebas y devuelve un modelo de respuesta que contiene detalles del conjunto y del caso de prueba.
function processSuitesForStaging(request: StagedSuitesRequestModel, project: string, workItemId: number): Promise<StagedSuitesResponseModel>Parámetros
- request
- StagedSuitesRequestModel
El modelo de solicitud que contiene los conjuntos de pruebas que se van a procesar. No puede ser nulo.
- project
-
string
Id. de proyecto o nombre del proyecto
- workItemId
-
number
Devoluciones
Promise<StagedSuitesResponseModel>
publishTestResultDocument(TestResultDocument, string, number)
function publishTestResultDocument(document: TestResultDocument, project: string, runId: number): Promise<TestResultDocument>Parámetros
- document
- TestResultDocument
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Devoluciones
Promise<TestResultDocument>
queryCustomFields(string, CustomTestFieldScope)
function queryCustomFields(project: string, scopeFilter: CustomTestFieldScope): Promise<CustomTestFieldDefinition[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- scopeFilter
- CustomTestFieldScope
Devoluciones
Promise<CustomTestFieldDefinition[]>
queryResultTrendForBuild(TestResultTrendFilter, string)
function queryResultTrendForBuild(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>Parámetros
- filter
- TestResultTrendFilter
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<AggregatedDataForResultTrend[]>
queryResultTrendForRelease(TestResultTrendFilter, string)
function queryResultTrendForRelease(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>Parámetros
- filter
- TestResultTrendFilter
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<AggregatedDataForResultTrend[]>
queryTestHistory(TestHistoryQuery, string)
Obtención del historial de un método de prueba mediante TestHistoryQuery
function queryTestHistory(filter: TestHistoryQuery, project: string): Promise<TestHistoryQuery>Parámetros
- filter
- TestHistoryQuery
TestHistoryQuery para obtener el historial
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<TestHistoryQuery>
queryTestMethodLinkedWorkItems(string, string)
function queryTestMethodLinkedWorkItems(project: string, testName: string): Promise<TestToWorkItemLinks>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- testName
-
string
Devoluciones
Promise<TestToWorkItemLinks>
queryTestResultHistory(ResultsFilter, string)
function queryTestResultHistory(filter: ResultsFilter, project: string): Promise<TestResultHistory>Parámetros
- filter
- ResultsFilter
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<TestResultHistory>
queryTestResultsMetaData(string[], string)
Obtener la lista de detalles de metadatos de resultados de prueba para testcasereferenceId correspondiente
function queryTestResultsMetaData(testReferenceIds: string[], project: string): Promise<TestResultMetaData[]>Parámetros
- testReferenceIds
-
string[]
TestCaseReference Ids del resultado de la prueba que se va a consultar, lista separada por comas de identificadores válidos (límite no. de ids 200).
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<TestResultMetaData[]>
queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)
function queryTestResultsReportForBuild(project: string, buildId: number, publishContext?: string, includeFailureDetails?: boolean, buildToCompare?: BuildReference): Promise<TestResultSummary>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- buildId
-
number
- publishContext
-
string
- includeFailureDetails
-
boolean
- buildToCompare
- BuildReference
Devoluciones
Promise<TestResultSummary>
queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
function queryTestResultsReportForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, includeFailureDetails?: boolean, releaseToCompare?: ReleaseReference): Promise<TestResultSummary>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- releaseId
-
number
- releaseEnvId
-
number
- publishContext
-
string
- includeFailureDetails
-
boolean
- releaseToCompare
- ReleaseReference
Devoluciones
Promise<TestResultSummary>
queryTestResultsSummaryForReleases(ReleaseReference[], string)
function queryTestResultsSummaryForReleases(releases: ReleaseReference[], project: string): Promise<TestResultSummary[]>Parámetros
- releases
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<TestResultSummary[]>
queryTestResultWorkItems(string, string, string, number, Date, number, number)
function queryTestResultWorkItems(project: string, workItemCategory: string, automatedTestName?: string, testCaseId?: number, maxCompleteDate?: Date, days?: number, workItemCount?: number): Promise<WorkItemReference[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- workItemCategory
-
string
- automatedTestName
-
string
- testCaseId
-
number
- maxCompleteDate
-
Date
- days
-
number
- workItemCount
-
number
Devoluciones
Promise<WorkItemReference[]>
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, string)
Ejecuciones de pruebas de consulta basadas en filtros. Los campos obligatorios son minLastUpdatedDate y maxLastUpdatedDate.
function queryTestRuns(project: string, minLastUpdatedDate: Date, maxLastUpdatedDate: Date, state?: TestRunState, planIds?: number[], isAutomated?: boolean, publishContext?: TestRunPublishContext, buildIds?: number[], buildDefIds?: number[], branchName?: string, releaseIds?: number[], releaseDefIds?: number[], releaseEnvIds?: number[], releaseEnvDefIds?: number[], runTitle?: string, top?: number, continuationToken?: string): Promise<PagedList<TestRun>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- minLastUpdatedDate
-
Date
Fecha mínima de última modificación de la ejecución que se va a consultar (obligatorio).
- maxLastUpdatedDate
-
Date
La fecha máxima de última modificación de la ejecución que se va a consultar (obligatoria, la diferencia entre la fecha mínima y máxima puede ser de más de 7 días).
- state
- TestRunState
Estado actual de las ejecuciones que se van a consultar.
- planIds
-
number[]
Identificadores de plan de las ejecuciones que se van a consultar, lista separada por comas de identificadores válidos (límite no. de ids 10).
- isAutomated
-
boolean
Tipo de automatización de las ejecuciones que se van a consultar.
- publishContext
- TestRunPublishContext
PublishContext de las ejecuciones que se van a consultar.
- buildIds
-
number[]
Identificadores de compilación de las ejecuciones que se van a consultar, lista separada por comas de identificadores válidos (límite no. de ids 10).
- buildDefIds
-
number[]
Identificadores de definición de compilación de las ejecuciones que se van a consultar, lista separada por comas de identificadores válidos (límite no. de ids 10).
- branchName
-
string
Nombre de rama de origen de las ejecuciones que se van a consultar.
- releaseIds
-
number[]
Identificadores de versión de las ejecuciones que se van a consultar, lista separada por comas de identificadores válidos (límite no. de ids 10).
- releaseDefIds
-
number[]
Identificadores de definición de versión de las ejecuciones que se van a consultar, lista separada por comas de identificadores válidos (límite no. de ids 10).
- releaseEnvIds
-
number[]
Identificadores de entorno de versión de las ejecuciones que se van a consultar, lista separada por comas de identificadores válidos (límite no. de ids 10).
- releaseEnvDefIds
-
number[]
Identificadores de definición del entorno de versión de las ejecuciones que se van a consultar, lista separada por comas de identificadores válidos (límite no. de ids 10).
- runTitle
-
string
Ejecute Título de las ejecuciones que se van a consultar.
- top
-
number
Número de ejecuciones que se van a consultar. El límite es 100
- continuationToken
-
string
continuationToken recibido del lote anterior o null para el primer lote. No se supone que el usuario cree (o modifique, si lo recibe del último lote).
Devoluciones
queryTestSummaryByRequirement(TestResultsContext, string, number[])
function queryTestSummaryByRequirement(resultsContext: TestResultsContext, project: string, workItemIds?: number[]): Promise<TestSummaryForWorkItem[]>Parámetros
- resultsContext
- TestResultsContext
- project
-
string
Id. de proyecto o nombre del proyecto
- workItemIds
-
number[]
Devoluciones
Promise<TestSummaryForWorkItem[]>
removeTestCasesFromSuiteUrl(string, number, number, string)
Los puntos de prueba asociados a los casos de prueba se quitan del conjunto de pruebas. El elemento de trabajo del caso de prueba no se elimina del sistema. Consulte el recurso de casos de prueba para eliminar un caso de prueba de forma permanente.
function removeTestCasesFromSuiteUrl(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- planId
-
number
Identificador del plan de prueba que contiene el conjunto de aplicaciones.
- suiteId
-
number
Identificador del conjunto que se va a obtener.
- testCaseIds
-
string
Identificadores de los casos de prueba que se van a quitar del conjunto de aplicaciones.
Devoluciones
Promise<void>
updateCodeCoverageSummary(CodeCoverageData, string, number)
http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Solicitud: Json de resumen de cobertura de código
function updateCodeCoverageSummary(coverageData: CodeCoverageData, project: string, buildId: number): Promise<void>Parámetros
- coverageData
- CodeCoverageData
- project
-
string
Id. de proyecto o nombre del proyecto
- buildId
-
number
Devoluciones
Promise<void>
updateResultRetentionSettings(ResultRetentionSettings, string)
Actualización de la configuración de retención de resultados de prueba
function updateResultRetentionSettings(retentionSettings: ResultRetentionSettings, project: string): Promise<ResultRetentionSettings>Parámetros
- retentionSettings
- ResultRetentionSettings
Detalles de la configuración de retención de resultados de prueba que se van a actualizar
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<ResultRetentionSettings>
updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)
Actualiza las propiedades de la asociación de casos de prueba en un conjunto de aplicaciones.
function updateSuiteTestCases(suiteTestCaseUpdateModel: SuiteTestCaseUpdateModel, project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>Parámetros
- suiteTestCaseUpdateModel
- SuiteTestCaseUpdateModel
Modelo para la actualización de las propiedades de la asociación del conjunto de casos de prueba.
- project
-
string
Id. de proyecto o nombre del proyecto
- planId
-
number
Identificador del plan de prueba que contiene el conjunto de aplicaciones.
- suiteId
-
number
Identificador del conjunto de pruebas al que se deben agregar los casos de prueba.
- testCaseIds
-
string
Identificadores de los casos de prueba que se van a agregar al conjunto de aplicaciones. Los identificadores se especifican en formato separado por comas.
Devoluciones
Promise<SuiteTestCase[]>
updateTestPoints(PointUpdateModel, string, number, number, string)
Actualice los puntos de prueba.
function updateTestPoints(pointUpdateModel: PointUpdateModel, project: string, planId: number, suiteId: number, pointIds: string): Promise<TestPoint[]>Parámetros
- pointUpdateModel
- PointUpdateModel
Datos que se van a actualizar.
- project
-
string
Id. de proyecto o nombre del proyecto
- planId
-
number
Identificador del plan de prueba.
- suiteId
-
number
Identificador del conjunto que contiene los puntos.
- pointIds
-
string
Identificador del punto de prueba que se va a obtener. Use una lista separada por comas de identificadores para actualizar varios puntos de prueba.
Devoluciones
Promise<TestPoint[]>
updateTestResults(TestCaseResult[], string, number)
Actualizar los resultados de la prueba en una ejecución de prueba.
function updateTestResults(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>Parámetros
- results
Lista de resultados de pruebas que se van a actualizar.
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de ejecución de pruebas cuyos resultados de prueba se van a actualizar.
Devoluciones
Promise<TestCaseResult[]>
updateTestRun(RunUpdateModel, string, number)
Actualice la prueba ejecutada por su identificador.
function updateTestRun(runUpdateModel: RunUpdateModel, project: string, runId: number): Promise<TestRun>Parámetros
- runUpdateModel
- RunUpdateModel
Detalles de ejecución RunUpdateModel
- project
-
string
Id. de proyecto o nombre del proyecto
- runId
-
number
Identificador de la ejecución que se va a actualizar.
Devoluciones
Promise<TestRun>
updateTestSession(TestSession, TeamContext)
Actualización de una sesión de prueba
function updateTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>Parámetros
- testSession
- TestSession
Detalles de la sesión de prueba para la actualización
- teamContext
- TeamContext
Contexto del equipo para la operación
Devoluciones
Promise<TestSession>