API de JavaScript

Repeato permite ejecutar JavaScript mediante pasos de script. Las siguientes variables globales están disponibles mientras se ejecuta una prueba o un lote.

Para obtener documentación legible por máquinas, usa la referencia Markdown sin formato o las declaraciones de TypeScript. Consulta Recetas de JavaScript para ver ejemplos completos y ejecutables.

Globales

data

Tipo: object

Un objeto que puedes usar para compartir datos entre pasos.

data.scannedText

Tipo: string

La cadena escaneada por el último paso de comprobación de texto ejecutado.

workspaceDir

Tipo: string

El directorio del espacio de trabajo actual.

currentStepIndex

Tipo: number

El índice, basado en cero, del paso que se está ejecutando.

testDir

Tipo: string

El directorio de la prueba actual.

testRunDir

Tipo: string

El directorio de la ejecución de prueba actual.

axios

Tipo: AxiosInstance

El cliente HTTP Axios.

const response = await axios.get('https://example.com')

log()

Firma

log(message: object)

Registra un mensaje o un objeto.

sleep()

Firma

sleep(milliseconds: number): Promise<void>

Retrasa la ejecución durante el número de milisegundos indicado.

getResponse()

Firma

getResponse(host: string, path: string, headers?: object): Promise<string>

Envía una solicitud GET a un host.

sendPost()

Firma

sendPost(
  host: string,
  path: string,
  body: string | object,
  acceptHeader?: string,
  headers?: object,
): Promise<string>

Envía una solicitud POST.

showDialog()

Firma

showDialog({
  title,
  content,
  onConfirm,
  onClose,
}: {
  title: string
  content: string
  onConfirm?: () => void
  onClose?: () => void
}): { cancel: Function; confirm: Function }

Muestra un diálogo cuyo contenido admite Markdown, incluido texto con formato, enlaces e imágenes. Las devoluciones de llamada opcionales se ejecutan cuando ocurre la acción correspondiente. La instancia de diálogo devuelta se puede cerrar mediante cancel() o confirm().

batchRunner

Controla el lote de pruebas actual y proporciona hooks del ciclo de vida del lote.

batchRunner.testBatch

Tipo: TestBatch

El lote de pruebas actual.

batchRunner.currentExceptionHandlerIndex

Tipo: number

El índice del gestor de excepciones actual.

batchRunner.currentTestIndex

Tipo: number

El índice de la prueba actual.

batchRunner.batchRun

Tipo: BatchRun

La ejecución del lote actual. Usa log(batchRunner.batchRun) para inspeccionar todas las propiedades.

batchRunner.isPlaying

Tipo: boolean

Indica si el ejecutor de lotes está ejecutándose actualmente.

batchRunner.runMode

Tipo: string

El modo de ejecución actual.

batchRunner.stop()

stop(): Promise<void>

Detiene el ejecutor de lotes.

batchRunner.createBatchRunExport()

Firma

createBatchRunExport(): Promise<string>

Crea una exportación de la ejecución del lote actual en la carpeta batchRuns del espacio de trabajo y devuelve su ruta.

batchRunner.uploadReport()

Firma

uploadReport(dirPath: string): Promise<string>

Sube el informe ubicado en dirPath a la nube de Repeato y devuelve la URL del informe.

batchRunner.setTestBatchById()

Firma

batchRunner.setTestBatchById(batchId: string)

Establece el lote de pruebas para el ejecutor de lotes.

batchRunner.setRunMode()

Firma

batchRunner.setRunMode(mode: string)

Establece el modo de ejecución para todas las pruebas o solo para las pruebas fallidas.

batchRunner.setRunMode('AllTests')
batchRunner.setRunMode('OnlyFailed')

batchRunner.addOnBatchStart()

Firma

batchRunner.addOnBatchStart(key: string, callback: (batch: Batch) => void)

Registra una devolución de llamada que se ejecuta justo antes de que comience el lote.

batchRunner.addOnTestFail()

Firma

batchRunner.addOnTestFail(
  key: string,
  callback: (test: Test, testRun: TestRun, stepResult: StepResult) => void,
)

Registra una devolución de llamada que se ejecuta cuando falla una prueba.

batchRunner.addOnTestSuccess()

Firma

batchRunner.addOnTestSuccess(
  key: string,
  callback: (test: Test, testRun: TestRun) => void,
)

Registra una devolución de llamada que se ejecuta cuando una prueba finaliza correctamente.

batchRunner.addOnBatchCompleted()

Firma

batchRunner.addOnBatchCompleted(
  key: string,
  callback: (batchRun: BatchRun) => void,
)

Registra una devolución de llamada que se ejecuta cuando el lote finaliza, tanto si se completa correctamente como si falla.

batchRunner.removeOnBatchStart()

Firma

batchRunner.removeOnBatchStart(key: string)

Elimina una devolución de llamada registrada con addOnBatchStart().

batchRunner.removeOnTestFail()

Firma

batchRunner.removeOnTestFail(key: string)

Elimina una devolución de llamada registrada con addOnTestFail().

batchRunner.removeOnTestSuccess()

Firma

batchRunner.removeOnTestSuccess(key: string)

Elimina una devolución de llamada registrada con addOnTestSuccess().

batchRunner.removeOnBatchCompleted()

Firma

batchRunner.removeOnBatchCompleted(key: string)

Elimina una devolución de llamada registrada con addOnBatchCompleted().

batchRunner.testRunner

Tipo: TestRunner

Proporciona acceso a todos los testRunner propiedades y métodos. Usa log(batchRunner.testRunner) para inspeccionarlos.

testRunner

Controla la ejecución de la prueba actual y expone hooks del ciclo de vida de los pasos.

testRunner.currentTest

Tipo: Test

La prueba actual. Usa log(testRunner.currentTest) para inspeccionar todas las propiedades.

testRunner.currentTestRun

Tipo: TestRun

La ejecución de prueba actual. Usa log(testRunner.currentTestRun) para inspeccionar todas las propiedades.

testRunner.lastStepResult

Tipo: StepResult

El resultado del paso ejecutado anteriormente. Usa log(testRunner.lastStepResult) para inspeccionar todas las propiedades.

testRunner.currentStepIndex

Tipo: number

El índice de base cero del paso actual.

testRunner.setNextStepId()

Firma

testRunner.setNextStepId(id: string)

Establece el siguiente paso que se ejecutará mediante su ID.

testRunner.setNextStepId('AH23D6')

testRunner.setNextStepIndex()

Firma

testRunner.setNextStepIndex(index: number)

Establece el siguiente paso que se ejecutará mediante su índice de base cero.

testRunner.goBackBy()

Firma

testRunner.goBackBy(stepCount: number)

Retrocede stepCount pasos y continúa la ejecución desde allí.

testRunner.addOnScreenshotSaved()

Firma

testRunner.addOnScreenshotSaved(
  key: string,
  listener: (stepResult: StepResult, screenshotPath: string) => void,
)

Registra un listener que se ejecuta en cuanto se guarda una captura de pantalla.

testRunner.addOnStepCompleted()

Firma

testRunner.addOnStepCompleted(
  key: string,
  callback: (stepResult: StepResult) => void,
)

Registra un callback que se ejecuta cada vez que se completa un paso.

testRunner.removeOnScreenshotSaved()

Firma

testRunner.removeOnScreenshotSaved(key: string)

Elimina un listener registrado con addOnScreenshotSaved().

testRunner.removeOnStepCompleted()

Firma

testRunner.removeOnStepCompleted(key: string)

Elimina una devolución de llamada registrada con addOnStepCompleted().

testRunner.setScaleInvariantMatchingEnabled()

Firma

testRunner.setScaleInvariantMatchingEnabled(enabled: boolean)

Activa o desactiva la coincidencia invariante a la escala. Está activada de forma predeterminada.

deviceConnector

Proporciona información sobre el dispositivo conectado actualmente y le envía comandos.

deviceConnector.selectedDeviceData

Tipo: DeviceData

Todos los datos relacionados con el dispositivo conectado actualmente. Usa log(deviceConnector.selectedDeviceData) para inspeccionarla.

deviceConnector.sendString()

Firma

sendString(value: string): Promise<void>

Envía una cadena al dispositivo. La aplicación bajo prueba debe tener un campo de entrada enfocado para recibir los datos.

deviceConnector.clearText()

clearText(): Promise<void>

Borra el campo de entrada seleccionado actualmente.

deviceConnector.sendClick()

Firma

sendClick(xPercentage: number, yPercentage: number): Promise<void>

Envía un evento táctil al dispositivo. Las coordenadas van de 0 a 1; sendClick(0.5, 0.5) toca el centro de la pantalla.

deviceConnector.sendDown()

Firma

sendDown(xPercentage: number, yPercentage: number): Promise<void>

Envía un evento de pulsación táctil. Cada sendDown() necesita un sendUp(); combínalo con sendMove() para simular un gesto de arrastre.

deviceConnector.sendMove()

Firma

sendMove(xPercentage: number, yPercentage: number): Promise<void>

Envía un evento de movimiento. Usa sendDown() primero y finaliza el arrastre con sendUp().

deviceConnector.sendUp()

Firma

sendUp(xPercentage: number, yPercentage: number): Promise<void>

Envía un evento de liberación táctil.

deviceConnector.sendAdbCommand()

Firma

sendAdbCommand(command: string): Promise<string>

Envía un comando de Android Debug Bridge (ADB).

deviceConnector.addOnDeviceLog()

Firma

deviceConnector.addOnDeviceLog(
  listenerName: string,
  callback: (log: string) => void,
)

Registra un callback que se ejecuta para cada línea de registro enviada por la aplicación bajo prueba.

deviceConnector.sendIdbCommand()

Firma

sendIdbCommand(command: string): Promise<string>

Envía un comando de iOS Development Bridge (IDB).

await deviceConnector.sendIdbCommand('list-targets')

deviceConnector.takeScreenshot()

Firma

takeScreenshot(filepath: string): Promise<void>

Toma una captura de pantalla y la guarda en filepath.

deviceConnector.setClipboard()

Firma

setClipboard(content: string): Promise<void>

Establece el portapapeles del dispositivo con una cadena.

deviceConnector.getClipboard()

getClipboard(): Promise<string>

Obtiene el contenido del portapapeles del dispositivo.

deviceConnector.vision()

Firma

vision(
  prompt: string,
  region: { x: number; y: number; width: number; height: number } | undefined,
): Promise<string>

Envía un prompt y una captura de pantalla de la pantalla actual del dispositivo al módulo de visión. Pasa una región para limitar la captura a una parte de la pantalla.

audioTools

Proporciona conversión de texto a voz, reproducción de audio y grabación de audio.

audioTools.say()

Firma

audioTools.say(text: string)

Convierte el texto indicado en audio.

audioTools.playAudio()

Firma

playAudio(url: string): Promise<number>

Reproduce audio desde la URL indicada.

audioTools.stopAudio()

audioTools.stopAudio()

Detiene el audio que se está reproduciendo.

audioTools.recordAudio()

Firma

recordAudio(duration: number): Promise<string>

Graba audio durante la duración indicada en milisegundos y devuelve la URL de la grabación temporal.