En el desarrollo colaborativo de software, ejecutar manualmente las pruebas de API después de cada confirmación de código puede volverse rápidamente tedioso. ¿No sería mejor si estas pruebas pudieran ejecutarse automáticamente cada vez que se sube código nuevo?
La buena noticia es que esto es totalmente posible. La mayoría de los equipos ya utilizan plataformas CI/CD para gestionar las compilaciones y despliegues de código, y estas plataformas están diseñadas para escuchar los eventos de confirmación de Git. Cuando subes código, ejecutan automáticamente tareas predefinidas como compilar, empaquetar o desplegar.
Ejecutar pruebas de API automatizadas no es diferente. Apidog proporciona una herramienta CLI que te permite activar pruebas automatizadas con un solo comando. Al añadir este comando a tu pipeline de CI/CD, puedes asegurarte de que las pruebas se ejecuten automáticamente después de cada envío de código.
El proceso de configuración es sencillo. Lo principal es entender cómo funciona el mecanismo de activación y luego elegir el enfoque de integración adecuado según la plataforma que esté utilizando tu equipo.
¿Cómo funcionan los disparadores de pruebas automáticas? (Los principios)
El núcleo de todo el proceso es "Escucha de Eventos + Ejecución de Comandos".
Cuando subes código a un repositorio de Git, la plataforma CI/CD escucha este evento de Git y, de acuerdo con tu configuración preestablecida (como scripts de pipeline o archivos de configuración), ejecuta automáticamente el comando de prueba de Apidog.
Este principio se puede ilustrar de la siguiente manera:
Principalmente hay dos formas en que las plataformas CI/CD escuchan los eventos de Git:
El primero es el mecanismo de eventos incorporado de la plataforma. Por ejemplo, GitHub Actions se puede especificar directamente en el archivo de configuración: on: [push, pull_request]. Cuando subes código o creas un PR, la plataforma escucha automáticamente estos eventos de Git y comienza las pruebas.
El segundo es a través de Webhook, adecuado para escenarios como Jenkins donde se necesita comunicación entre plataformas. Tendrás que configurar manualmente una URL de activación.
Independientemente del método, el paso final siempre es el mismo: ejecutar el comando apidog run para iniciar la prueba automatizada.
Soluciones de Integración para Plataformas Populares
Si utilizas plataformas de alojamiento de código como GitHub o GitLab, activar las pruebas es especialmente sencillo. Estas plataformas tienen servicios CI/CD integrados (como GitHub Actions, GitLab CI) que pueden escuchar directamente los eventos de Git y ejecutar tareas. Puedes consultar estos documentos para empezar rápidamente:
Sin embargo, muchos equipos tienen configuraciones más complejas. Por ejemplo, el código está alojado en GitHub o GitLab, pero el pipeline de CI/CD se ejecuta en Jenkins. En este caso, GitHub/GitLab y Jenkins son dos sistemas independientes; el primero no puede activar directamente al segundo.
Para escenarios multiplataforma, los Webhooks son una solución simple y efectiva. Un Webhook funciona como un mecanismo de devolución de llamada: cuando ocurre un evento específico (como un push de Git) en GitHub, envía activamente una solicitud a una URL de Webhook predefinida para alertar a un sistema externo. Al ofrecer un endpoint de Webhook, Jenkins puede recibir estas notificaciones y activar automáticamente las tareas de prueba.
Veamos una configuración específica: el código está alojado en GitHub, pero el pipeline de pruebas se ejecuta en Jenkins.
Integración de GitHub + Jenkins para ejecutar pruebas automatizadas de Apidog
Si tu equipo almacena código en GitHub pero utiliza Jenkins para ejecutar tareas de compilación, así es como puedes configurarlo:
Paso 1: Configurar Jenkins y obtener la URL del Webhook
Primero, prepara la tarea de prueba en Jenkins. Sigue la documentación de Integrar con Jenkins para crear un proyecto, configurar el comando de compilación y asegurarte de que el comando CLI pueda ejecutarse correctamente.
A continuación, obtén la URL del Webhook de Jenkins. Esta URL actúa como un punto de entrada para que los sistemas externos llamen a Jenkins, y GitHub la usará para activar las tareas de prueba.
La forma más sencilla es instalar el plugin "Generic Webhook Trigger". Búscalo e instálalo en la página de gestión de plugins de Jenkins, luego reinicia Jenkins.
Luego ve a la página de configuración de tu proyecto y habilita este plugin. La dirección del Webhook será:
http://<your Jenkins server address>/generic-webhook-trigger/invoke`
Por seguridad, se recomienda establecer un Token personalizado, por lo que la dirección se convierte en:
http://<your Jenkins server address>/generic-webhook-trigger/invoke?token=<xxxxxx>Una vez que tengas esta URL, puedes configurar el Webhook en GitHub.
Paso 2: Configurar el Webhook de GitHub
Ve a tu "repositorio de GitHub → Settings → Webhooks", añade un nuevo Webhook, introduce la dirección del paso anterior, establece el tipo de contenido en application/json, selecciona push u otros eventos que quieras para activar la prueba, y guarda la configuración.
Después de la configuración, cada push de código activará automáticamente a Jenkins para ejecutar la tarea de prueba. Puedes subir algo de código para probarlo y verificar los registros de compilación de Jenkins y los resultados de las pruebas.
Paso 3: Verificar todo el proceso
Cuando subes código a GitHub, el Webhook configurado enviará una notificación a Jenkins. Jenkins recibirá la solicitud y comenzará la tarea de compilación automáticamente. Puedes ver los registros de ejecución de la prueba en la "Consola" del proyecto de Jenkins y ver el informe final de la prueba.
Configuración de Webhook para otras plataformas
Además de GitHub, otras plataformas de alojamiento de código también soportan Webhooks, como:
Los métodos de configuración son similares. La clave es entender el mecanismo de activación: una confirmación de Git genera un evento, que luego se utiliza para notificar a la plataforma CI/CD a través de la escucha de eventos o Webhook, lo que finalmente activa la ejecución automática del comando de prueba.
Para obtener más métodos de integración de plataformas CI/CD, consulta la sección de Integración CI/CD de la documentación oficial de Apidog.