Ejemplo Adaptador Colecciones de Postman

English

Descripción

¿Qué es y para qué sirve Postman? Postman es una aplicación para hacer solicitudes HTTP. Es una plataforma que permite y hace más sencilla la creación y el uso de APIs. Es una herramienta usada principalmente para el lanzamiento y testing de APIs del tipo REST. Es muy útil para programar porque da la posibilidad de hacer pruebas y comprobar el correcto funcionamiento de los proyectos que realizan los desarrolladores web. Tiene más funcionalidades como por ejemplo el monitoreo, documentación y modelado de pruebas automáticas. 

¿Qué son las solicitudes HTTP? Son mensajes enviados por el cliente al servidor para iniciar una acción específica. Tienen una estructura específica y se caracterizan por un método (o verbo) que permite distinguir el tipo de acción requerida: GET, HEAD, POST, PUT, DELETE, PATCH, OPTIONS.

¿Qué son las respuestas HTTP? Las respuestas HTTP son mensajes enviados por el servidor en respuesta a una solicitud enviada por el cliente. Tienen una estructura específica y se caracterizan por el código de respuesta (status code) que permite comprender si la solicitud fue exitosa o no y viene representado por números de tres cifras, entre 100 y 599. La prima indica a qué clase pertenece el status code:

• 1xx (informativo) - la solicitud ha sido recibida, elaboración en curso
• 2xx (éxito) - la solicitud ha sido recibida, extendida y aceptada con éxito
• 3xx (redireccionamiento) - se deben tomar medidas adicionales para completar la solicitud
• 4xx (error del cliente) - la solicitud contiene una sintaxis incorrecta o no se puede cumplir
• 5xx (error del servidor) - el servidor no pudo cumplir con una solicitud aparentemente válida

¿Qué es una API?

API (interfaz de programación de aplicaciones) es un software que permite que dos aplicaciones se comuniquen entre sí. Nunca están en la superficie de una web o aplicación, por lo tanto, no son visibles, son circuitos internos que sólo los desarrolladores ven y conectan para hacer funcionar una herramienta.

¿Qué es una colección de Postman?

Postman nos ofrece la posibilidad de guardar y agrupar conjuntos de solicitudes, lo que se denomina “Collections”, es decir simples carpetas en distintos niveles que organizarán nuestras peticiones HTTP.

Con el Adaptador de Colecciones de Postman creado en TAST podremos ejecutar una colección que previamente hemos exportado de la Aplicación Postman y hemos guardado en Local. Nos devolverá toda la información: response headers y body; request headers y body.

Enunciado del ejercicio

En este ejemplo vamos a ejecutar una colección exportada de Postman con diferentes llamadas o peticiones. Comprobaremos que estas peticiones se han realizado correctamente y obtendremos los resultados.

Mandar una colección de Postman a nuestro microservicio de Postman, y obtener la información deseada y respuesta de esta. No se requiere ninguna información en el proceso de inicialización del adaptador. Será cuando empecemos a usar las PF’s, cuando le facilitemos toda la información necesaria.

Resolución del caso de prueba

Hemos diseñado este caso de prueba utilizando dos Adaptadores: el Adaptador de Objeto de Usuario y el Adaptador Postman.

En este caso concreto las funciones que vamos a necesitar son únicamente las del Adaptador Postman.

• executePostmanCollection: ejecuta un fichero que contenga una colección de Postman en un microservicio y devuelve una variable TastRowValues que tiene información sobre el resultado. Requiere el path local del fichero en el que esté la colección de Postman, y opcionalmente, el path local de un fichero de entorno.

Ruta donde guardamos la colección y el entorno:

• getResponseBody: permite al usuario obtener el body de la respuesta recibida de una petición específica, de una colección que se haya ejecutado previamente con el adaptador. Para identificar la petición de la que quieres recuperar el body de la respuesta, esta función necesita el nombre de la petición como un parámetro.

• getResponseStatusCode: permite al usuario obtener el status code HTTP, recibido como una respuesta a una petición específica, de una colección ejecutada anteriormente con el adaptador. El nombre de la petición debe ser especificado como un parámetro para poder obtener el status code de dicha petición.

Ejecución del Test Set

Para ejecutar este caso de prueba, abrimos el Cliente de TAST, lo buscamos y lanzamos la ejecución. Cuando terminamos de ejecutar este caso de prueba, vemos si se ha ejecutado correctamente. Nos aparecerá la casilla de Status marcada en verde. 

 

Captura de resultados

A continuación abrimos el icono de la derecha (marcado con una flecha roja) y tenemos como resultado la carpeta de evidencias, donde se almacena tanto el log de la ejecución, como todas las capturas de pantalla, archivos, etc... si hemos marcado la casilla «Evidencias» en la configuración general del diagrama.

Log de la ejecución   

El resultado ha sido 200 y lo vemos en la siguiente imagen:

A la hora de devolvernos los resultados TAST devuelve un documento Word, detallando los pasos que hemos dado, los resultados obtenidos de cada paso, los enlaces al diagrama y al conjunto de pruebas, si hemos pulsado en la pestaña de Resultados, descargar documento de evidencias: 

Descargar documento de evidencias

Archivos necesarios para ejecutar el caso

Para poder ejecutar ese caso de prueba necesitamos estos dos archivos: colección y entorno y la ruta donde están guardados.

• C:\test\Petstore.postman_collection.json
• C:\test\PetStoreEnv.postman_environment.json

 

Compartimos a continuación el enlace a un vídeo con otro ejemplo muy similar: en este ejemplo vamos a ejecutar una colección exportada de Postman con diferentes llamadas o peticiones. Comprobaremos que estas peticiones se han realizado correctamente y obtendremos los resultados en una hoja Excel.  https://www.youtube.com/watch?v=Z6V-U5WEjeM