Requisitos previos#
Jenkins instalado y en ejecución (se recomienda v2.0 o posterior)
Node.js v16 o posterior instalado en el host de Jenkins
Una cuenta de Apidog con escenarios de prueba creados
Acceso para generar tokens de acceso de Apidog
Instalar Jenkins#
Jenkins es una herramienta de compilación automatizada que ayuda a los desarrolladores a automatizar el proceso de compilación, las pruebas y el despliegue de aplicaciones durante el proceso de desarrollo de software. A continuación se indica cómo instalarlo en un sistema Linux:1.
Añada la clave pública GPG de Jenkins:
2.
Añada el origen de Jenkins a la lista de fuentes de software de APT:
3.
Actualice la lista de paquetes de APT:
5.
Inicie el servicio de Jenkins:
http://localhost:8080 o http://{your_public_IP}:8080 para acceder al panel de Jenkins. La consola proporciona una API web para que usted gestione y configure los servicios de Jenkins.Configurar el entorno de Node.js para Jenkins#
Antes de ejecutar Apidog CLI, debe asegurarse de que el número de versión de Node.js sea v16 o posterior, por lo que primero debe configurar las dependencias de NodeJS en el entorno de Jenkins.
1.
Abra la gestión de plugins de Jenkins, busque el plugin NodeJS, instálelo y reinícielo.
2.
Cree un nuevo NodeJS en la configuración global de herramientas, configure el número de versión (requiere v16 o posterior) y el nombre del paquete apidog-cli.
1.
Añadir la configuración en una pipeline visual (Freestyle Project)
2.
Integrar el código incrustado en la pipeline (Pipeline)
Ejecutar comandos de CLI#
Configurar la pipeline visualmente#
Abra Apidog y obtenga el comando de CLI desde la página de detalles de integración continua. Si su entorno de Jenkins tiene acceso a Internet, puede elegir usar el comando "Run online data in real time". Si no hay acceso a Internet disponible, primero debe exportar el archivo de datos JSON de CLI al entorno y luego ejecutarlo mediante la CLI.En la página de configuración del proyecto, localice la sección Build Environment, marque la opción "Provide Node & npm bin/ folder to PATH" y seleccione la versión de NodeJS (por ejemplo, nodejs18) que configuró en la sección Global Tool Configuration (Tools).Después de configurar el entorno de compilación, vaya a la sección Build Steps, haga clic en Add build step y seleccione Execute Shell (elija Execute Windows Batch Command si está utilizando un sistema Windows).Pegue el comando de Apidog CLI en el cuadro de entrada Command y guarde la configuración.Haga clic en Build Now en el proyecto para iniciar la ejecución.Puede comprobar el progreso y los resultados de la compilación en "Build History".Integrar código incrustado en la pipeline#
Vaya a la pestaña CI/CD y copie el fragmento de código incrustado; luego péguelo en su archivo de configuración de Jenkins.Simplemente pegue el código directamente en la configuración de la pipeline de Jenkins para incrustarlo en su flujo de trabajo de CI/CD existente.El nodejs18 mencionado aquí se refiere al alias de NodeJS establecido anteriormente; sustitúyalo por su alias real. Además, asegúrese de reemplazar la variable $APIDOG_ACCESS_TOKEN en el código por su Access Token real. Como alternativa, puede añadir una variable de entorno llamada APIDOG_ACCESS_TOKEN en Jenkins en Dashboard → Manage Jenkins → System y establecer su valor en su Access Token. Esto permite que la pipeline lea su Access Token durante la ejecución.Puede simplificar el código anterior eliminando el script para instalar Apidog CLI. De este modo, no es necesario reinstalar apidog-cli cada vez que se ejecuta una compilación, lo que reduce tanto el tiempo de compilación como el consumo de recursos. Esto es posible porque NodeJS y los paquetes globales de npm (es decir, apidog-cli) ya se han configurado previamente en Global Tool Configuration (Tools), lo que garantiza que las herramientas requeridas estén disponibles durante el proceso de compilación.Haga clic en Build Now en el proyecto para iniciar la ejecución.Especifique el nombre del informe generado ${JOB_NAME}_${BUILD_NUMBER} (variable integrada de Jenkins) en el comando. Use el plugin HTML Publisher para ver el informe.