DEV Community

SAUL JOSE ALVARADO URBANO
SAUL JOSE ALVARADO URBANO

Posted on

De la concepción al despliegue: Automatización de pruebas de API REST con Newman, CI/CD en GitHub Actions y Render

🚀 ¿Cómo asegurar la estabilidad de un servicio web antes de que llegue a producción?

En esta publicación expongo el desarrollo y aseguramiento de calidad de una API REST orientada a la Gestión de Tareas Académicas. El proyecto conecta un backend en Node.js y Express con un circuito de pruebas en Postman y Newman, orquestado automáticamente mediante GitHub Actions y publicado de forma continua en Render, alcanzando un balance de 21 peticiones ejecutadas y 21 aserciones aprobadas sin fallos.
video: https://www.youtube.com/watch?v=juJPeWzo_NE

📌 1. Introducción

En el ecosistema del desarrollo de software moderno, el aseguramiento de la calidad (QA) tiene el mismo peso estratégico que la codificación de las funcionalidades. Un servicio puede responder adecuadamente en el equipo del programador y, sin embargo, romperse tras incorporar nuevas características o al exponerse a la infraestructura de producción.
Las pruebas automáticas sobre interfaces de programación (API Testing) son indispensables para inspeccionar códigos de estado HTTP, verificar la estructura de las cargas útiles en JSON y anticipar defectos antes de impactar a los consumidores del servicio.
En el marco del curso de Calidad de Software, diseñé una solución completa que abarca desde la creación del servicio hasta su validación y despliegue desatendido en la nube.

Tecnologías que integran la solución

  • Node.js & Express: Construcción de las rutas y lógica del servicio REST.
  • Postman: Estructuración y diseño interactivo de las colecciones de prueba.
  • Newman: Ejecución de las pruebas desde la consola de comandos.
  • Git & GitHub: Control de versiones distribuido y repositorio público.
  • GitHub Actions: Automatización de flujos de integración continua.
  • Render: Plataforma en la nube para el alojamiento productivo del servicio. ## 🎯 2. Metas del proyecto ### Objetivo general Diseñar e implementar un ciclo automatizado de pruebas funcionales para una API REST, enlazándolo con flujos de integración y entrega continua (CI/CD) en la nube. ### Objetivos específicos
  • Programar un servicio REST funcional con Node.js y Express.
  • Soportar las cuatro operaciones CRUD para la administración de tareas.
  • Construir una suite de aserciones automatizadas mediante Postman.
  • Integrar Newman como ejecutor de pruebas en línea de comandos.
  • Definir un workflow en GitHub Actions que dispare las pruebas ante cada cambio en el repositorio.
  • Habilitar el despliegue automático en Render condicionado al éxito del pipeline de CI.
  • Comprobar la respuesta del servicio en un entorno público mediante HTTPS. ## 🛠️ 3. Catálogo tecnológico | Herramienta | Rol en la arquitectura | |---|---| | Node.js | Entorno de ejecución en servidor para JavaScript | | Express | Framework para estructurar las rutas y middlewares REST | | Postman | Diseño de solicitudes HTTP y definición de aserciones | | Newman | Ejecutor CLI para correr colecciones de Postman de forma automatizada | | GitHub | Plataforma para el versionado y resguardo del código fuente | | GitHub Actions | Motor de CI/CD para ejecutar las pruebas en contenedores | | Render | Plataforma PaaS encargada del alojamiento y despliegue del servicio | ### ¿Por qué utilizar Newman? Newman desacopla las pruebas de Postman de su entorno gráfico de escritorio, permitiendo ejecutarlas directamente desde una terminal o un agente de integración continua. Gracias a esto, cada nuevo push o pull request puede validar de manera idéntica y repetible todo el comportamiento del backend. ## 🏗️ 4. Arquitectura de la solución La arquitectura se fundamenta en un modelo cliente-servidor bajo principios REST, donde las solicitudes HTTP desencadenan respuestas estandarizadas en formato JSON. Esta arquitectura se complementa con un pipeline de CI/CD encargado de actuar como filtro de calidad previo a la publicación. ### Flujo del proceso CI/CD
  • Desarrollo y cambios: Se programa en Node.js y se envía el código mediante Git push.
  • Activación de GitHub Actions: El flujo de CI descarga las dependencias e inicia el servidor.
  • Ejecución con Newman: Se ejecutan las 21 aserciones de la colección de Postman.
  • Comprobación de calidad:
    • Si las pruebas fallan: el pipeline se detiene en rojo y Render no despliega.
    • Si las pruebas pasan: el pipeline concluye en verde y autoriza el despliegue.
  • Publicación en Render: La nueva versión queda accesible públicamente vía HTTPS. Este esquema previene que modificaciones rotas o con regresiones funcionales se publiquen en el servidor productivo. ## 💻 5. Desarrollo de la API REST La API REST implementada gestiona recursos correspondientes a tareas académicas mediante operaciones HTTP bien definidas. ### Endpoints principales del servicio | Método | Endpoint | Acción realizada | |---|---|---| | GET | / | Presentación del mensaje de inicio | | GET | /health | Diagnóstico de disponibilidad del servidor | | GET | /api/tareas | Consulta de la colección completa de tareas | | GET | /api/tareas/:id | Búsqueda y obtención de una tarea específica | | POST | /api/tareas | Creación y registro de una nueva tarea | | PATCH | /api/tareas/:id | Modificación parcial de una tarea existente | | DELETE | /api/tareas/:id | Remoción definitiva de un registro | ### Manejo de códigos de estado HTTP La API devuelve códigos de respuesta precisos para facilitar la evaluación automática de resultados:
  • 200 OK: Petición procesada exitosamente.
  • 201 Created: Registro creado y persistido con éxito.
  • 400 Bad Request: Carga útil con formato incorrecto o datos faltantes.
  • 404 Not Found: Identificador o ruta inexistente.
  • 500 Internal Server Error: Fallo inesperado en el servidor. ### Acceso al repositorio El código y las configuraciones del proyecto están disponibles para inspección pública:
  • Código fuente: Repositorio en GitHub ## 🧪 6. Suite de pruebas con Postman y Newman Una vez concluido el backend, se formalizó una batería exhaustiva de aserciones dentro de una colección de Postman para auditar cada punto de acceso. ### 6.1. Alcance de las pruebas diseñadas Los casos de prueba evalúan tanto flujos exitosos como escenarios de error:
  • Respuesta correcta de la raíz y del endpoint /health.
  • Lectura, creación, modificación parcial y borrado de tareas.
  • Validación de que los identificadores eliminados respondan posteriormente con 404.
  • Verificación del comportamiento del servidor ante peticiones con campos obligatorios vacíos.
  • Inspección estricta de encabezados Content-Type: application/json. ### 6.2. Ejemplos de aserciones programadas En Postman se escriben pruebas en JavaScript mediante el objeto global pm:
pm.test("El código de respuesta debe ser 200", function () {
  pm.response.to.have.status(200);
});
pm.test("El formato de respuesta debe ser JSON", function () {
  pm.response.to.be.json;
});
Enter fullscreen mode Exit fullscreen mode

6.3. Ejecución desatendida mediante Newman

Desde la terminal, Newman procesa la colección exportada en JSON:

newman run coleccion-postman.json
Enter fullscreen mode Exit fullscreen mode

Para generar reportes estructurados que puedan ser auditados por herramientas de integración continua:

newman run coleccion-postman.json --reporters cli,junit --reporter-junit-export reporte.xml
Enter fullscreen mode Exit fullscreen mode

6.4. Balance final de las pruebas

Indicador evaluado Métrica obtenida
Peticiones HTTP ejecutadas 21
Total de aserciones evaluadas 21
Aserciones aprobadas con éxito 21
Aserciones con fallo 0
Resultado final 100% Exitoso

⚙️ 7. Integración continua en GitHub Actions

La automatización de las pruebas se configuró mediante un flujo de trabajo declarado en .github/workflows/.

Etapas del pipeline de CI

  1. Configuración del entorno: Despliegue de un runner con Ubuntu y Node.js.
  2. Instalación de dependencias: Descarga de librerías mediante npm install.
  3. Arranque del servicio: Inicialización en segundo plano de la API.
  4. Ejecución con Newman: Ejecución de la colección contra el servidor local.
  5. Dictamen de calidad: El flujo finaliza en verde únicamente si las 21 aserciones son aprobadas. La última ejecución registrada finalizó con éxito:
  6. Registro de ejecución: Workflow verificado en GitHub Actions ## ☁️ 8. Despliegue automático en Render La publicación se realizó en la plataforma Render utilizando su modalidad de Web Service gratuita. ### Despliegue condicionado (After CI Checks Pass) Para evitar que se publique código no validado, Render se configuró para vigilar los estados de GitHub Actions. Si las pruebas de Newman no concluyen con éxito, Render descarta el evento y mantiene la versión anterior intacta. ### Acceso a la API en producción
  7. Servicio web en vivo: API de Tareas Académicas
  8. Endpoint de verificación: Endpoint de salud (/health) Tras el despliegue, la suite de Newman se ejecutó apuntando a la dirección HTTPS de Render, confirmando que las 21 aserciones se aprobaron de forma idéntica en el entorno en la nube. ## 📊 9. Resultados y consideraciones técnicas ### Beneficios demostrados
  9. Repetibilidad garantizada: Cualquier miembro del equipo puede reproducir exactamente las mismas 21 comprobaciones con un solo comando.
  10. Detección oportuna de fallos: Los errores se detectan en el pull request antes de afectar a los usuarios finales.
  11. Trazabilidad histórica: Cada commit queda formalmente asociado al resultado de sus pruebas en GitHub.
  12. Cero costo de infraestructura: Todo el flujo opera dentro de los planes gratuitos de GitHub y Render. ### Consideraciones del entorno Al utilizar persistencia en memoria y el plan gratuito de Render:
  13. Los registros se reinician si el contenedor se apaga tras períodos de inactividad.
  14. La primera petición tras un periodo de inactividad puede tardar unos segundos mientras el contenedor se reactiva.
  15. Para un producto comercial, se recomendaría complementar este esquema con bases de datos persistentes y pruebas de carga. ## 🏆 10. Conclusiones
  16. Eficacia del API Testing: Validar los contratos de datos y los códigos HTTP mediante Postman y Newman ofrece una barrera de seguridad sólida sin requerir una interfaz gráfica de usuario.
  17. Automatización indispensable: Integrar Newman con GitHub Actions transforma una tarea manual y propensa a olvidos en una política de calidad automática y constante.
  18. Entrega continua real: Condicionar los despliegues en Render al visto bueno del pipeline de CI materializa los principios esenciales de DevOps en un proyecto académico accesible y funcional. ## 📚 11. Referencias
  19. Documentación oficial de Express
  20. Guía de uso de GitHub Actions
  21. Documentación del CLI de Newman
  22. Guía de despliegue en Render

Top comments (0)