La integració contínua (CI) és una pràctica de desenvolupament de programari que implica la fusió freqüent de canvis de codi en un repositori central, seguit de la realització automàtica de proves. En aquest tema, aprendrem com integrar Postman en un procés de CI per assegurar-nos que les nostres proves d'API es realitzen de manera automàtica cada vegada que es produeixen canvis en el codi.
Conceptes Clau
-
Integració Contínua (CI):
- Procés de combinar canvis de codi de diversos desenvolupadors en un projecte de programari de manera freqüent.
- Inclou l'execució automàtica de proves per detectar errors ràpidament.
-
Newman:
- Una eina de línia de comandes per executar col·leccions de Postman.
- Permet integrar les proves d'API en sistemes de CI com Jenkins, Travis CI, etc.
-
Sistemes de CI Populars:
- Jenkins
- Travis CI
- CircleCI
- GitLab CI/CD
Passos per Integrar Postman en un Procés de CI
- Exportar la Col·lecció de Postman
- Pas 1: Obre Postman i selecciona la col·lecció que vols exportar.
- Pas 2: Fes clic a "Exportar" i guarda el fitxer JSON de la col·lecció al teu sistema.
- Instal·lar Newman
- Pas 1: Assegura't de tenir Node.js instal·lat al teu sistema.
- Pas 2: Instal·la Newman utilitzant el següent comandament:
npm install -g newman
- Executar la Col·lecció amb Newman
- Pas 1: Utilitza el següent comandament per executar la col·lecció exportada:
newman run /path/to/your/collection.json
- Pas 2: Revisa els resultats de les proves a la consola.
- Configurar el Sistema de CI
- Pas 1: Tria un sistema de CI (per exemple, Jenkins).
- Pas 2: Crea un nou treball o pipeline.
- Pas 3: Afegeix un pas per executar el comandament de Newman:
newman run /path/to/your/collection.json
- Pas 4: Configura el treball perquè s'executi automàticament en cada canvi de codi.
Exemple de Configuració amb Jenkins
-
Instal·lar Jenkins:
- Descarrega i instal·la Jenkins al teu servidor o utilitza un servei d'allotjament de Jenkins.
-
Crear un Nou Treball:
- A la interfície de Jenkins, crea un nou treball de tipus "Freestyle project".
-
Configurar el Treball:
- Afegeix un pas de construcció per executar un script de shell.
- Inclou el comandament de Newman per executar la col·lecció.
-
Configurar Triggers:
- Configura el treball perquè s'executi automàticament en cada commit al repositori de codi.
Exercici Pràctic
Objectiu: Configurar un pipeline de CI que executi proves d'API amb Postman utilitzant Jenkins.
Passos:
- Exporta una col·lecció de Postman que contingui almenys tres sol·licituds d'API.
- Instal·la Newman i executa la col·lecció localment per assegurar-te que funciona correctament.
- Configura un servidor Jenkins i crea un nou treball per executar la col·lecció amb Newman.
- Configura el treball perquè s'executi automàticament en cada canvi de codi al teu repositori.
Solució:
- Assegura't que el treball de Jenkins està configurat correctament i que les proves s'executen sense errors.
- Revisa els logs de Jenkins per verificar que les proves s'han executat i han passat correctament.
Conclusió
Integrar Postman en un procés de CI permet assegurar que les proves d'API es realitzen de manera automàtica i consistent, millorant la qualitat del programari i reduint el temps de detecció d'errors. Amb l'ús de Newman i un sistema de CI com Jenkins, pots automatitzar completament les proves d'API i integrar-les en el teu flux de treball de desenvolupament.
Curs de Postman i Proves d'API
Mòdul 1: Introducció a les API i Postman
Mòdul 2: Proves Bàsiques d'API amb Postman
- Creació de la Teva Primera Sol·licitud
- Comprensió de la Sol·licitud i la Resposta
- Ús de les Col·leccions de Postman
- Variables d'Entorn a Postman
Mòdul 3: Tècniques Intermèdies de Proves d'API
- Enllaçar Sol·licituds
- Ús de Scripts de Postman
- Proves Basades en Dades amb Postman
- Proves d'APIs RESTful
Mòdul 4: Funcions Avançades de Postman
- Automatització de Proves amb Newman
- Integració Contínua amb Postman
- Servidors Simulats a Postman
- Tècniques Avançades de Scripting
Mòdul 5: Millors Pràctiques de Proves d'API
- Disseny de Casos de Prova Efectius
- Gestió de l'Autenticació
- Gestió d'Errors i Depuració
- Proves de Rendiment amb Postman