Instalación y ejecución de Apidog CLI

Apidog CLI está diseñado para ejecutar escenarios de prueba de Apidog en la línea de comandos. Para comenzar a usar Apidog CLI, instale Node.js y, a continuación, Apidog CLI. Después podrá ejecutar sus escenarios de prueba.

Requisitos previos

Node.js v16 o posterior instalado en su sistema

npm (Node Package Manager) instalado

Una cuenta de Apidog con escenarios de prueba creados

Instalación de Apidog CLI

Apidog CLI está basado en Node.js. Para ejecutar Apidog CLI, instale Node.js antes de usarlo.

Apidog CLI requiere Node.js versión v16 o posterior.

Instale Apidog CLI desde npm de forma global en su sistema, lo que le permitirá ejecutarlo desde cualquier ubicación:

A continuación se muestran algunos comandos para comprobar si Apidog CLI se ha instalado correctamente.

Si se ha instalado correctamente, se imprimirá directamente el número de versión y la ruta de instalación después de ejecutar los comandos anteriores.

Salida de terminal que muestra la instalación correcta de Apidog CLI con números de versión y rutas

Actualización de Apidog CLI

Use el siguiente comando para actualizar Apidog CLI.

Ejecución de Apidog CLI

Para ejecutar escenarios de prueba con Apidog CLI, primero debe crear y organizar un escenario de prueba. Después, puede ejecutar el escenario de prueba desde la línea de comandos con Apidog CLI, igual que si lo ejecutara en la interfaz visual, y obtener un informe de prueba.

Apidog CLI admite dos formas de ejecución:

Ejecución con datos en línea: es adecuada para escenarios en vivo.

Ejecución con escenarios de prueba exportados: es adecuada para escenarios sin conexión.

Ejecutar datos en línea en tiempo real

En un escenario de prueba, cambie a la pestaña CI/CD.

Pestaña CI/CD en la interfaz de escenario de prueba de Apidog

Configure el entorno, los datos de prueba, las iteraciones, el retraso, etc.

En la sección del proveedor de CI/CD, seleccione "Command line".

Haga clic en el botón "Add access token" y, a continuación, en "Generate token".

Obtenga más información sobre el access token.

Haga clic en el comando para copiarlo.

Pegue y ejecute el comando en la línea de comandos. Obtendrá un informe de prueba en la línea de comandos.

En el paso 2, las configuraciones que establezca determinarán automáticamente las opciones y los valores utilizados en la CLI:

Entorno: se asigna a -e <environmentId>.

Datos de prueba: se asigna a -d <testDataId>.

Iteraciones: se asigna a -n <n>.

Retraso: se asigna a --delay-request <n>.

Variables de entorno/globales: si selecciona Export current value and use it, encontrará una opción de exportación a continuación para exportar los valores actuales de las variables de entorno/globales de su proyecto a un archivo. Esto afecta a --variables <path>. Deberá importar este archivo en el equipo que ejecute la CLI y especificar su ruta mediante --variables <path>. Obtenga más información aquí sobre las diferencias entre "Use initial value" y "Export current value and use it".

Si su escenario de prueba también utiliza configuraciones de conexión a base de datos almacenadas localmente, la interfaz del producto le guiará para exportar estas configuraciones a un archivo local, lo que afecta a --database-connection <path>. Después deberá importar este archivo exportado en el equipo que ejecute la CLI y especificar su ruta en --database-connection <path>.

Ejecutar datos exportados

Esta opción le permite ejecutar pruebas sin conexión localmente mediante archivos exportados.

En un escenario de prueba, cambie a la pestaña CI/CD.

Configure el entorno, los datos de prueba, las iteraciones, el retraso, etc.

En el proveedor de CI/CD, seleccione "Command line" y, a continuación, cambie a "Run exported data".

Opción Run exported data en la configuración de CI/CD

Exporte el escenario de prueba como un archivo JSON.

Copie el comando que se muestra a continuación.

Pegue y ejecute el comando en la línea de comandos. Obtendrá un informe de prueba de línea de comandos.

La configuración del paso 2 (por ejemplo, "Run Online Data") afectará automáticamente a las opciones y los valores utilizados en la CLI que aparece a continuación. Tenga en cuenta que, al ejecutar de esta manera, las variables de entorno/globales usan los valores del archivo exportado junto con el escenario de prueba. Obtenga más información aquí.

Informe de prueba de la CLI

Después de ejecutar la CLI, recibirá un informe de prueba de línea de comandos que incluye estadísticas de ejecución de los escenarios de prueba, así como validaciones y aserciones de las peticiones fallidas.

También puede encontrar el directorio /apidog-reports/ en la carpeta donde ejecutó la CLI. Este directorio contiene el informe de prueba de la CLI en formato HTML.

Opciones

Apidog CLI proporciona un amplio conjunto de opciones para personalizar la ejecución de una colección. Obtenga más información en Opciones de Apidog CLI.

Uso de Apidog CLI con CI/CD

Apidog CLI admite la integración con diversas herramientas de pipeline, como Jenkins, GitLab, GitHub Actions y más. Obtenga más información sobre la integración de CI/CD.

Instalación y ejecución de Apidog CLI

Requisitos previos#

Instalación de Apidog CLI#

Actualización de Apidog CLI#

Ejecución de Apidog CLI#

Ejecutar datos en línea en tiempo real#

Ejecutar datos exportados#

Informe de prueba de la CLI#

Opciones#

Uso de Apidog CLI con CI/CD#

Requisitos previos

Instalación de Apidog CLI

Actualización de Apidog CLI

Ejecución de Apidog CLI

Ejecutar datos en línea en tiempo real

Ejecutar datos exportados

Informe de prueba de la CLI

Opciones

Uso de Apidog CLI con CI/CD