De Bueno a Excelente: Mejora las Pruebas con Cypress Contract Tests

Rate this content
Bookmark

Descubre el poder de Cypress Contract Tests, un enfoque de vanguardia que lleva tus pruebas a nuevas alturas. En esta presentación, exploraremos el concepto de pruebas de contrato y cómo aseguran una comunicación fluida entre microservicios. Luego, nos adentraremos en las capacidades revolucionarias de Cypress, mostrando su potencial inigualable para elevar tus prácticas de prueba de bueno a excelente. Únete a nosotros para obtener ideas, mejores prácticas y ejemplos del mundo real sobre cómo integrar Cypress Contract Tests en tus flujos de trabajo existentes y revolucionar tu estrategia de pruebas.

19 min
11 Dec, 2023

AI Generated Video Summary

Esta charla discute los desafíos de probar múltiples servicios en una arquitectura de microservicios e introduce el uso de Cypress y Pact para abordar estos desafíos. Explica cómo usar Cypress para escribir un contrato y generar y compartirlo con el proveedor. También se discuten el proceso de verificación y el flujo de trabajo de CI para el consumidor y el proveedor. La charla enfatiza la importancia de las pruebas de contrato para asegurar una comunicación fluida entre microservicios.

1. Introducción a Cypress y Kotra Test

Short description:

Hola, bienvenidos a mi presentación de buenas a excelentes pruebas LWA con Cypress, Kotra Test. Soy Petros Plakogiannis, líder de pruebas e ingeniero de automatización de pruebas en RAS Grecia. Comencemos con un simple ejemplo de API REST. Los microservicios son grandes proyectos de servidor que se desglosan en módulos o componentes más pequeños. El verdadero desafío es probar todos estos servicios juntos bajo un entorno de prueba específico como una prueba de API tradicional. Diferentes equipos pueden implementar cambios en diferentes servicios al mismo tiempo, por lo que el entorno debe tener una configuración adecuada y datos de prueba correctos.

Hola, bienvenidos a mi presentación de buenas a excelentes pruebas LWA con Cypress, Kotra Test. En primer lugar, es un honor para mí ser parte de TestJS Summit 2023, así que gracias por la invitación. Soy Petros Plakogiannis, tengo 15 años de experiencia en testing. Soy líder de testing e ingeniero de automation en RAS Grecia.

Solo tengo 20 minutos, así que intentaré darles tantos detalles como pueda sobre Cypress, Kotra Test. Pero primero lo primero, ¿por qué Kotra Test y qué es Kotra Test? Comencemos con un simple ejemplo de API REST. A la izquierda tenemos un cliente web que hace una llamada a la API REST para obtener algunos data. La API REST es el proveedor de data, toma data de la database y las envía de vuelta al cliente. Desde una perspectiva de testing, podemos crear pruebas de declaración de API y ejecutarlas contra un entorno de testing para verificar que el cliente obtiene los data correctos del proveedor, de la API.

¿Pero podemos aplicar esto en microservices? Los microservices son grandes proyectos de servidor que se desglosan en modules o componentes más pequeños. Diferentes equipos desarrollan y mantienen diferentes servicios, y cada servicio tiene su propia database, su propio código base, etc. El verdadero desafío es probar todos estos servicios juntos bajo un entorno de testing específico como una prueba de API tradicional. ¿Pero podemos hacer esto? Piénsalo. Diferentes equipos pueden implementar cambios en diferentes servicios al mismo tiempo, o piensa que un servicio puede estar inactivo debido a problemas de servidor, de entorno. Entonces, para probar todos estos servicios bajo un entorno específico, este entorno debe tener una configuración adecuada y datos de prueba correctos. Así que no es tan fácil.

2. Desafíos de probar múltiples servicios

Short description:

Si tienes cientos o miles de servicios, ¿puedes asegurarte de que cambiar algo en un servicio no afectará a los demás? Los desafíos surgen al tratar con múltiples servicios. Las pruebas unitarias solo validan la lógica interna y no pueden garantizar escenarios del mundo real. Las pruebas de Coda son una metodología para garantizar una comunicación adecuada entre los servicios. Captura las interacciones y las almacena en un contrato, que se utiliza para verificar los servicios. Los contratos del consumidor y del proveedor especifican expectativas y capacidades. Las pruebas de contrato implican escribir pruebas, hablar con un proveedor simulado, registrar las expectativas en el contrato y subirlo al intermediario para que el proveedor lo cumpla.

Bueno, si solo tienes dos servicios, quizás puedas hacerlo. ¿Pero qué pasa si tienes cientos o miles de servicios como Amazon o Netflix? ¿Puedes asegurarte de que si cambias algo en un servicio, no afectarás a los demás servicios? Entonces, aquí están los desafíos.

Y por supuesto, no podemos usar pruebas unitarias. Las pruebas unitarias solo validan la lógica interna de los servicios. Piensa en cómo podemos probar un detector de humo. Si presionamos el botón de alarma, podemos escuchar el sonido de la alarma. Esta es una prueba unitaria. Pero esto solo no garantiza que el detector de humo, la alarma, se activará en presencia de humo real. Y por supuesto, no podemos incendiar la casa para verificar esto. Entonces, ¿qué podemos hacer?

Volvamos a nuestro ejemplo. Podemos usar un productor de humo para verificar que el contacto entre el detector de humo y la condición diseñada para detectar el humo se mantiene. Mientras lees la definición de pruebas de Coda de Ian Robinson, el autor del libro de prácticas de descanso y el arquitecto principal en Amazon Web Services, te informaré que las pruebas de Coda son una metodología para garantizar que dos servicios pueden comunicarse adecuadamente y captura las interacciones que se intercambian entre estos dos servicios y las almacena en el contrato. Este contrato se puede utilizar para verificar estos dos servicios. Veamos la terminología. Consumidor. El consumidor es un servicio que consume data de un proveedor. El proveedor es un servicio que proporciona data a un consumidor. El contrato del consumidor es una colección de interacciones que describen cómo el consumidor espera que se comporte el proveedor. El contrato del proveedor especifica la capacidad del proveedor. Es como un documento OpenAPI. Un intermediario de Pact es un lugar de almacenamiento. Almacenamos los contratos. Almacenamos el Pact. ¿Cómo funcionan las pruebas de contrato? Entonces, el consumidor escribe una prueba basada en lo que espera que haga el proveedor. Habla con un proveedor simulado, no con un proveedor real. Habla con un proveedor simulado creado por un Pact. Veremos más tarde cómo. Las expectativas de la prueba se registran en el contrato. Y el contrato es subido por el consumidor al intermediario de Pact. El proveedor obtiene el contrato del intermediario de Pact y hace lo que el consumidor solicitó de acuerdo con el contrato.

3. Uso de Cypress para escribir un contrato

Short description:

Pact comprueba si el proveedor coincide con las expectativas registradas en el contrato. Cypress es un marco de pruebas de extremo a extremo basado en JavaScript con una rica API y características de depuración. Se da un ejemplo del mundo real utilizando la aplicación KeZer y la base de datos Euclid. La solicitud se simula utilizando el comando intercept de Cypress y los datos simulados se asignan a un alias. Los datos simulados se verifican en la prueba. El siguiente paso es convertir la simulación en un contrato utilizando el plugin Pact Cypress Adapter.

Pact luego verifica si el proveedor coincide con las expectativas registradas en el contrato por el consumidor. Si hay una coincidencia, entonces los dos servicios están en la misma página. Si hay una discrepancia, hay un problema y tenemos que averiguar por qué y resolverlo.

El papel de Cypress. Como puede que sepas, Cypress es un famoso marco de pruebas de extremo a extremo basado en JavaScript. Tiene muchas características, como una rica API, espera automatizada, recarga en tiempo real, depuración con viaje en el tiempo. Pero la verdadera pregunta es cómo se puede usar Cypress para escribir un contrato. Podemos convertir fácilmente un MOC de Cypress en un contrato de consumidor. ¿Cómo? Veamos un ejemplo del mundo real.

Mi empresa tiene un cliente que se llama Agencia Química Europea y hemos construido una aplicación que se llama KeZer para generar un informe de seguridad química. Para generar el informe de seguridad química, obtenemos algunos datos a través de una API de otra aplicación que se llama Euclid. Euclid tiene algunas sustancias que necesitamos obtener para generar el informe. Euclid es algo así como una base de datos. Veamos una acción. Aquí está KeZer. Voy a iniciar sesión. Aquí está Euclid. Tengo dos sustancias, Bethustodianne y Eka substance demo. Y si hago clic en Importar Sustancias Euclid a través de Webservice e ingreso la URL de Euclid y hago clic en Buscar, puedo ver las dos sustancias que puedo importar en mi aplicación. Así que tengo y también si vas a Network, puedes ver la solicitud y la respuesta, ese es el archivo JSON con dos nombres químicos. Así que he simulado esta solicitud en mi prueba de extremo a extremo. ¿Cómo? Usando el comando intercept de Cypress y aquí están mis datos simulados. Una estación de muestra. Si vas a la estación de muestra, puedes ver mis datos simulados con dos nombres químicos test.jssummit1 y test.jssummit2. Y esta solicitud se asigna a un alias para referencia futura. Así que hago mi prueba aquí y aquí, estoy esperando la decepción y luego verifico que puedo ver el test.jssummit1 en mi tabla de datos. Así que vamos a ejecutar esta prueba en Cypress. Vale, así que tengo aquí que tengo, en lugar de Petros 2.1 y Nekasubscites demo, las dos subsites que tengo, mis datos simulados, test.jssummit1 y test.jssummit2. Así que quiero convertir esta simulación en un contrato, en un pacto. ¿Cómo puedo hacer esto? Hay un plugin que se llama Pact Cypress Adapter que voy a instalar.

4. Uso de Cypress para Generar y Compartir un Contrato

Short description:

Para instalar el plugin, ejecute npm install y configúrelo en CypressConfig.js, el listener y e2e.js. Use el comando setup-pact para configurar los nombres del consumidor y del proveedor. Reemplace el comando wait con use-pact wait para generar el contrato. El contrato es un archivo JSON que especifica los nombres del consumidor y del proveedor, las interacciones y los metadatos. Comparta el contrato con el proveedor utilizando un servidor de broker de pacto dedicado o la herramienta CLI de pacto. Siga las instrucciones para publicar el pacto con la versión del consumidor, la URL del broker y el token.

Bueno, entonces tienes que hacer npm install. Para instalar el plugin, ya lo he instalado en mi package.json. Aquí está el plugin, y ya he configurado el plugin en CypressConfig.js, el listener, y e2e.js, el comando de importación. Y voy a usar dos comandos, sólo dos comandos.

El primer comando es el setup-pact para configurar el nombre del consumidor y del proveedor. Así que voy a mi prueba y he usado el comando setup-pact. UIConsumer es mi consumidor, la aplicación de caso, y APIProvider es el proveedor, la aplicación EUCLID. Y luego voy a usar, en lugar del comando wait, voy a usar el comando use-pact wait. Que voy a esperar de nuevo por la intercepción, pero esta vez voy a generar el contrato. Así que vamos a ejecutar esta prueba.

Como puedes ver aquí, de nuevo tengo los datos simulados, testjs summit1 y testjs summit2, pero aquí en el archivo de prueba, he creado un contrato. Volvamos al proyecto, a la carpeta de pacto. Aquí está el contrato. Como puedes ver, es un archivo JSON que tengo el nombre del consumidor, el nombre del proveedor, una lista de interacciones que describen cómo el consumidor espera que se comporte el proveedor. Por ejemplo, necesito tener el estado 200, los nombres químicos, testjs summit1, testjs summit2, y algunos metadatos como la versión del adaptador de pacto Cypress, etc.

Ahora que he creado el contrato, tengo que compartir este archivo con un equipo de uklet que tienen un proveedor. Hay varias formas de compartir un contrato, pero por supuesto la mejor manera es tener un servidor de broker de pacto dedicado. Si tienes este servidor, puedes usar la herramienta CLI de pacto que ha sido creada por pacto, la herramienta CLI de pacto, para publicar y verificar pactos y broker de pacto directo. Veamos. Tengo un broker de pacto. Este es mi broker de pacto, motathen.packedflow.io. Aquí está la herramienta CLI de pacto. Para publicar y verificar pactos. Esa es una imagen de Docker. Puedes descargar una imagen de Docker. Tengo la imagen aquí ya en mi Docker desktop para Windows. Si sigues las instrucciones, puedes publicar el pacto. Aquí digo publicar. Doy la versión del consumidor, doy la URL base del broker, doy el token del broker que puedes encontrar si vas aquí, aquí, tokens de API. Así que voy a ejecutar este comando.

5. Verificación del Contrato y Flujo de Trabajo CI

Short description:

El contrato se revisa y se examinan las interacciones PACT. El proveedor verifica el contrato ya sea utilizando un archivo local o extrayéndolo del broker PACT. Es necesario crear un webhook, lo cual se puede hacer a través de la herramienta CLI de PACT o la interfaz de usuario del broker PACT. El proceso de verificación implica publicar los resultados de nuevo en el broker. El flujo de trabajo CI del consumidor incluye la ejecución de pruebas de Cypress, la publicación del contrato en el broker PACT y la activación del flujo de trabajo CI del proveedor para verificar el contrato. Los codetests aseguran una comunicación fluida entre los microservicios, y los MOCs de Cypress pueden transformarse en contratos de consumidor de pacto utilizando el adaptador correcto y PackBroker.

Y el pacto se publicó con éxito en el broker. Volvamos y revisemos aquí el contrato. Este es el contrato, el PACT, ¿vale? Hace unos segundos. Si haces clic en ver interacciones PACT, podemos ver esta lista de direcciones que describen cómo el consumidor espera que se comporte el proveedor. Vale, con estado 200, test json a uno, test json dos, etcétera.

Ahora, los siguientes pasos son desde el lado del proveedor, desde la utilidad, que deberían verificar el contrato. ¿Cómo pueden hacer esto? La forma más sencilla es utilizar un archivo local, lo que significa que si no tienes un broker, entonces el consumidor escribe la prueba y copian el contrato a un sistema de archivos compartido. Pero si tienes un broker PACT, como hicimos en nuestro ejemplo, no extraes el archivo PACT del sistema de archivos, sino del broker utilizando una URL.

Así que creas un webhook. Para crear un webhook, puedes utilizar la herramienta CLI de PACT o la interfaz de usuario del broker PACT. Así que si uso la herramienta CLI de PACT, puedo ir aquí y crear una prueba, una prueba de muestra, compré la biblioteca, tengo el nombre del proveedor, la URL base del proveedor, la URL del broker PACT, y uso el método verify provider. Y digo publish verification results true. Verificar un contrato es la mitad de la historia. Deberías publicar los resultados de nuevo en el broker. Puedes usar el comando docker, verificar de nuevo el conjunto, tienes que decir dar el token del broker, los resultados de la verificación pública, etcétera. Así que si ejecutas esto, va a rechazar o verificar el contrato. Vale. Pero por supuesto, puedes usar la interfaz de usuario del broker PACT. Si vas a configuración, a los webhooks, puedes crear aquí un webhook. Eso va a ser activado por tu flujo de trabajo CI-CD. Y ya que dije flujo de trabajo CI-CD, voy a mostrarte un ejemplo de flujo de trabajo CI de consumidor. Así que aquí está el inicio, el checkout, luego la instalación, ejecutas la prueba del consumidor con Cypress, publicas el contrato, el archivo packed al broker PACT, luego el flujo de trabajo CI del proveedor es activado por un webhook para verificar el pacto, el contrato, y envía de vuelta los resultados con un nuevo webhook. Y entonces, puedo usar el, puedo usar el comando de despliegue del CLI de PACT que pregunta si podemos desplegar en un entorno particular. Así que, este sería un ejemplo de, de un flujo de trabajo CI de consumidor.

Así que, resumen. Los codetests aseguran una comunicación fluida entre los microservicios reduciendo el riesgo de errores y averías. Los MOCs de Cypress pueden transformarse en contratos de consumidor de pacto utilizando el adaptador correcto y por favor usa PackBroker para gestionar tus contratos y tu flujo de trabajo CI, CD. Espero que hayas encontrado útiles los Codetests de Cypress para tu viaje de software de bueno a excelente. Gracias.

Check out more articles and videos

We constantly think of articles and videos that might spark Git people interest / skill us up or help building a stellar career

TestJS Summit 2021TestJS Summit 2021
33 min
Network Requests with Cypress
Whether you're testing your UI or API, Cypress gives you all the tools needed to work with and manage network requests. This intermediate-level task demonstrates how to use the cy.request and cy.intercept commands to execute, spy on, and stub network requests while testing your application in the browser. Learn how the commands work as well as use cases for each, including best practices for testing and mocking your network requests.
TestJS Summit 2021TestJS Summit 2021
38 min
Testing Pyramid Makes Little Sense, What We Can Use Instead
Featured Video
The testing pyramid - the canonical shape of tests that defined what types of tests we need to write to make sure the app works - is ... obsolete. In this presentation, Roman Sandler and Gleb Bahmutov argue what the testing shape works better for today's web applications.
TestJS Summit 2022TestJS Summit 2022
27 min
Full-Circle Testing With Cypress
Cypress has taken the world by storm by brining an easy to use tool for end to end testing. It’s capabilities have proven to be be useful for creating stable tests for frontend applications. But end to end testing is just a small part of testing efforts. What about your API? What about your components? Well, in my talk I would like to show you how we can start with end-to-end tests, go deeper with component testing and then move up to testing our API, circ
TestJS Summit 2021TestJS Summit 2021
31 min
Test Effective Development
Developers want to sleep tight knowing they didn't break production. Companies want to be efficient in order to meet their customer needs faster and to gain competitive advantage sooner. We ALL want to be cost effective... or shall I say... TEST EFFECTIVE!But how do we do that?Are the "unit" and "integration" terminology serves us right?Or is it time for a change? When should we use either strategy to maximize our "test effectiveness"?In this talk I'll show you a brand new way to think about cost effective testing with new strategies and new testing terms!It’s time to go DEEPER!
TestJS Summit 2023TestJS Summit 2023
21 min
Everyone Can Easily Write Tests
Let’s take a look at how Playwright can help you get your end to end tests written with tools like Codegen that generate tests on user interaction. Let’s explore UI mode for a better developer experience and then go over some tips to make sure you don’t have flakey tests. Then let’s talk about how to get your tests up and running on CI, debugging on CI and scaling using shards.

Workshops on related topic

React Summit 2023React Summit 2023
151 min
Designing Effective Tests With React Testing Library
Featured Workshop
React Testing Library is a great framework for React component tests because there are a lot of questions it answers for you, so you don’t need to worry about those questions. But that doesn’t mean testing is easy. There are still a lot of questions you have to figure out for yourself: How many component tests should you write vs end-to-end tests or lower-level unit tests? How can you test a certain line of code that is tricky to test? And what in the world are you supposed to do about that persistent act() warning?
In this three-hour workshop we’ll introduce React Testing Library along with a mental model for how to think about designing your component tests. This mental model will help you see how to test each bit of logic, whether or not to mock dependencies, and will help improve the design of your components. You’ll walk away with the tools, techniques, and principles you need to implement low-cost, high-value component tests.
Table of contents- The different kinds of React application tests, and where component tests fit in- A mental model for thinking about the inputs and outputs of the components you test- Options for selecting DOM elements to verify and interact with them- The value of mocks and why they shouldn’t be avoided- The challenges with asynchrony in RTL tests and how to handle them
Prerequisites- Familiarity with building applications with React- Basic experience writing automated tests with Jest or another unit testing framework- You do not need any experience with React Testing Library- Machine setup: Node LTS, Yarn
TestJS Summit 2022TestJS Summit 2022
146 min
How to Start With Cypress
Featured WorkshopFree
The web has evolved. Finally, testing has also. Cypress is a modern testing tool that answers the testing needs of modern web applications. It has been gaining a lot of traction in the last couple of years, gaining worldwide popularity. If you have been waiting to learn Cypress, wait no more! Filip Hric will guide you through the first steps on how to start using Cypress and set up a project on your own. The good news is, learning Cypress is incredibly easy. You'll write your first test in no time, and then you'll discover how to write a full end-to-end test for a modern web application. You'll learn the core concepts like retry-ability. Discover how to work and interact with your application and learn how to combine API and UI tests. Throughout this whole workshop, we will write code and do practical exercises. You will leave with a hands-on experience that you can translate to your own project.
React Summit 2022React Summit 2022
117 min
Detox 101: How to write stable end-to-end tests for your React Native application
WorkshopFree
Compared to unit testing, end-to-end testing aims to interact with your application just like a real user. And as we all know it can be pretty challenging. Especially when we talk about Mobile applications.
Tests rely on many conditions and are considered to be slow and flaky. On the other hand - end-to-end tests can give the greatest confidence that your app is working. And if done right - can become an amazing tool for boosting developer velocity.
Detox is a gray-box end-to-end testing framework for mobile apps. Developed by Wix to solve the problem of slowness and flakiness and used by React Native itself as its E2E testing tool.
Join me on this workshop to learn how to make your mobile end-to-end tests with Detox rock.
Prerequisites- iOS/Android: MacOS Catalina or newer- Android only: Linux- Install before the workshop
TestJS Summit 2023TestJS Summit 2023
48 min
API Testing with Postman Workshop
WorkshopFree
In the ever-evolving landscape of software development, ensuring the reliability and functionality of APIs has become paramount. "API Testing with Postman" is a comprehensive workshop designed to equip participants with the knowledge and skills needed to excel in API testing using Postman, a powerful tool widely adopted by professionals in the field. This workshop delves into the fundamentals of API testing, progresses to advanced testing techniques, and explores automation, performance testing, and multi-protocol support, providing attendees with a holistic understanding of API testing with Postman.
1. Welcome to Postman- Explaining the Postman User Interface (UI)2. Workspace and Collections Collaboration- Understanding Workspaces and their role in collaboration- Exploring the concept of Collections for organizing and executing API requests3. Introduction to API Testing- Covering the basics of API testing and its significance4. Variable Management- Managing environment, global, and collection variables- Utilizing scripting snippets for dynamic data5. Building Testing Workflows- Creating effective testing workflows for comprehensive testing- Utilizing the Collection Runner for test execution- Introduction to Postbot for automated testing6. Advanced Testing- Contract Testing for ensuring API contracts- Using Mock Servers for effective testing- Maximizing productivity with Collection/Workspace templates- Integration Testing and Regression Testing strategies7. Automation with Postman- Leveraging the Postman CLI for automation- Scheduled Runs for regular testing- Integrating Postman into CI/CD pipelines8. Performance Testing- Demonstrating performance testing capabilities (showing the desktop client)- Synchronizing tests with VS Code for streamlined development9. Exploring Advanced Features - Working with Multiple Protocols: GraphQL, gRPC, and more
Join us for this workshop to unlock the full potential of Postman for API testing, streamline your testing processes, and enhance the quality and reliability of your software. Whether you're a beginner or an experienced tester, this workshop will equip you with the skills needed to excel in API testing with Postman.
TestJS Summit - January, 2021TestJS Summit - January, 2021
173 min
Testing Web Applications Using Cypress
WorkshopFree
This workshop will teach you the basics of writing useful end-to-end tests using Cypress Test Runner.
We will cover writing tests, covering every application feature, structuring tests, intercepting network requests, and setting up the backend data.
Anyone who knows JavaScript programming language and has NPM installed would be able to follow along.
TestJS Summit 2023TestJS Summit 2023
148 min
Best Practices for Writing and Debugging Cypress Tests
Workshop
You probably know the story. You’ve created a couple of tests, and since you are using Cypress, you’ve done this pretty quickly. Seems like nothing is stopping you, but then – failed test. It wasn’t the app, wasn’t an error, the test was… flaky? Well yes. Test design is important no matter what tool you will use, Cypress included. The good news is that Cypress has a couple of tools behind its belt that can help you out. Join me on my workshop, where I’ll guide you away from the valley of anti-patterns into the fields of evergreen, stable tests. We’ll talk about common mistakes when writing your test as well as debug and unveil underlying problems. All with the goal of avoiding flakiness, and designing stable test.