Pruebas de Regresión Visual con Puppeteer, Playwright y Cypress

Rate this content
Bookmark

Las pruebas de regresión visual verifican componentes mediante la comparación de capturas de pantalla. Mostraré cómo hacerlo en tres bibliotecas/frameworks diferentes. Además, utilizaré Storybook para extraer los componentes de tu SPA elegida.

9 min
19 Nov, 2021

Video Summary and Transcription

Hola, soy Rainer Haneckamp, un entrenador y consultor en Angular Architects. En esta charla, exploraremos las pruebas de regresión visual utilizando herramientas como Puppeteer, Playwright y Cypress. Aprenderemos cómo utilizar Storybook y Puppeteer con Jest para las pruebas de regresión visual. También veremos cómo Jest y Playwright pueden utilizarse juntos para las pruebas de regresión visual. Por último, descubriremos cómo utilizar Cypress para las pruebas de regresión visual. ¡Gracias por ver!

Available in English

1. Introducción a las pruebas de regresión visual

Short description:

Hola, soy Rainer Haneckamp, un entrenador y consultor en Angular Architects. En esta charla, exploraremos la regresión visual, que implica crear capturas de pantalla y compararlas con imágenes de referencia. La regresión visual es crucial para todo tipo de aplicaciones, ya que afecta la primera impresión. Demostraré cómo usar Puppeteer, Playwright y Cypress.

Hola, y muchas gracias por unirse a mi charla. Mi nombre es Rainer Haneckamp. Soy de Austria y soy un entrenador y consultor en Angular Architects. Esto significa que paso la mayor parte de mi tiempo con Angular.

Esta charla trata sobre la regresión visual. Esto significa que crearemos automáticamente capturas de pantalla de nuestra aplicación, de nuestros componentes, y las compararemos con imágenes de referencia existentes. Esto es muy similar a lo que encontramos con las instantáneas, pero mientras que las instantáneas se basan en cadenas de texto, la regresión visual utiliza imágenes reales.

Y como dije antes, hacemos muchos talleres, y cada vez que introduzco este tema, hay dos tipos diferentes de desarrolladores. El primer tipo dice: `Bueno, eso es genial. Siempre quise ver cómo funciona esto. Esto es exactamente lo que necesitaba. Y es muy probable que estén trabajando en bibliotecas de UI o que tengan aplicaciones. Se invierte mucho tiempo en un diseño muy atractivo`.

La mayoría, sin embargo, dice: `Bueno, estoy escribiendo aplicaciones empresariales o aplicaciones, y la mayor parte de mi tiempo estoy usando elementos de formulario. Estoy usando cuadrículas, y no los creo yo mismo. Ya uso un framework existente como Material Bootstrap o cualquier otro. ¿Por qué tengo que preocuparme por la regresión visual? Si compartes esta opinión, solo piensa qué sucede cuando ingresas a un sitio web y ves que los botones están sobrecargados, desbordados o que el texto se desborda o algo así. ¿Realmente confiarías en este sitio web? ¿Realmente estarías dispuesto a pagar por algunos de sus servicios? Muy probablemente no. ¿Por qué? Porque la primera impresión ya fue muy mala. Y como en todas partes de la vida, la primera impresión realmente cuenta. Y como sucede en las aplicaciones, la parte visual siempre es la primera impresión. Así que no subestimes eso, sin importar qué tipo de aplicación tengas.

Y así es como lo vamos a hacer. Te mostraré cómo hacer la regresión visual usando tres bibliotecas diferentes, frameworks. Comenzaré con Puppeteer, luego Playwright y luego Cypress. Empecemos. De acuerdo, aquí estamos. Esta es nuestra aplicación y lo que queremos probar es esta tarjeta de vacaciones aquí. La primera acción es que no creamos una captura de pantalla de esta URL, porque también contiene el menú lateral aquí en el lado izquierdo, el encabezado. Y si algo cambia allí, la prueba arrojaría un error, aunque la tarjeta de vacaciones todavía se vea bien.

2. Usando Storybook y Puppeteer con Jest

Short description:

Utilizamos Storybook para extraer componentes y mostrarlos de forma aislada. Puppeteer permite el control remoto de un navegador basado en Chromium para tomar capturas de pantalla, combinado con Jest. La configuración preestablecida de Jest Puppeteer configura la mayoría de las cosas, y tenemos dos dependencias importantes: Jest Puppeteer e ImageSnapshot.

Y debido a eso, estamos utilizando Storybook. Storybook es una biblioteca que nos permite extraer componentes de nuestra aplicación y mostrarlos de forma aislada. Y esto es algo que ya he hecho antes. Esta es la instancia de Storybook. Puedo hacer clic en las diferentes variaciones, y eso es lo que voy a usar para la regresión visual.

Echemos un vistazo rápido a nuestro código, cómo se puede hacer esto. Entonces, Storybook requiere una configuración predeterminada. En mi caso, esto es Angular. Necesito definir todas las dependencias y luego simplemente creo los llamados `stories`, que son las diferentes variaciones. Y para eso, aquí utilizo un método de fábrica que he escrito yo mismo.

Comenzaremos con Puppeteer. Puppeteer es una biblioteca que te permite controlar de forma remota un navegador basado en Chromium. Esto también te permite tomar capturas de pantalla, y eso es lo que vamos a combinar aquí con Jest. Aquí puedes ver que ya tengo una configuración de Jest que tiene un preset de Jest Puppeteer. Entonces, la mayoría de las cosas ya están configuradas por este preset. Y en nuestro package JSON tenemos estas dos dependencias importantes. Una es, por supuesto, Jest Puppeteer junto con Puppeteer en sí. Y la segunda es ImageSnapshot, que es capaz de comparar las dos imágenes. Y eso es todo lo que necesitamos hacer, excepto escribir la prueba.

3. Pruebas de regresión visual con Jest y PlayWrite

Short description:

He preparado una prueba parametrizada utilizando el objeto de página global para abrir una URL y navegar a mi instancia de Storybook. Tomo capturas de pantalla y las comparo utilizando el comparador ImageSnapshot. Al ejecutar la prueba, Jest crea nuevas capturas de pantalla si no existen. Al cambiar el CSS, podemos comparar las capturas de pantalla de referencia y actuales para identificar diferencias. PlayWrite es similar a Puppeteer y viene con su propia biblioteca de pruebas. Admite pruebas de regresión visual y permite la configuración para varios navegadores. PlayWrite considera los casos sin una imagen de referencia como fallas, mientras que las ejecuciones posteriores solo fallan si hay diferencias reales.

Ya he preparado la prueba aquí. Así es como se vería. Esta es una prueba parametrizada porque estoy probando todas las variaciones que tengo. Estoy utilizando el objeto de página global para abrir una URL, navegar a mi instancia de Storybook. Una vez hecho esto, creo una captura de pantalla de lo que veo o lo que Jest ve y luego simplemente llamo al comparador para comparar ImageSnapshot.

Ejecutemos la prueba y veremos que como aún no hay capturas de pantalla, Jest las crea nuevas y las encontramos aquí en este directorio ImageSnapshot. Si lo abrimos, veremos las capturas de pantalla. Ahora intentemos cambiar algo y verificar cómo se ve. Estoy en mi CSS de mi tarjeta de vacaciones y lo estoy cambiando de negrita a normal. Veremos si nuestra prueba nos muestra la diferencia ahora. Vemos que muchas pruebas fallaron. Verifiquemos cómo podemos ver esto. Encontramos en los ImageSnapshots un subdirectorio adicional, un div de salida, que nos muestra a la izquierda la referencia, a la derecha la actual y en el medio vemos la diferencia.

Entonces, lo siguiente es PlayWrite. Muy rápido aquí. ¿Qué necesitamos para PlayWrite o qué es? PlayWrite es muy similar a Puppeteer. Se puede ver como una reescritura realizada por Microsoft. Viene con su propia biblioteca de pruebas y también admite pruebas de regresión visual de forma predeterminada. Aquí vemos la dependencia. Solo hay un paquete. Tenemos una configuración aquí. Podemos definir varios navegadores. También vemos aquí WebKit. Esta es la prueba para Safari y luego tenemos la prueba real. Y como vemos aquí, se ve más o menos muy similar a lo que hemos visto antes con Jest. Ahora ejecutemos la prueba aquí también. A diferencia de Jest o Puppeteer, PlayWrite cuenta los casos en los que aún no tenemos una imagen de referencia como una falla. Por eso vemos todo en rojo. Cuando lo ejecutemos la próxima vez, solo fallará si hay una diferencia real. Y, por supuesto, las imágenes también están ahí.

4. Usando Cypress para Pruebas de Regresión Visual

Short description:

Para usar Cypress para pruebas de regresión visual, agrega el complemento de Cypress para capturas de pantalla, actualiza la configuración de CypressJSON y ejecuta la prueba. Abre el directorio, importa la captura de pantalla en los directorios de soporte y complementos, abre la instancia de Storybook, compara la captura de pantalla con el documento y verifica el directorio de capturas de pantalla para ver el resultado. Gracias por ver y mantente atento para la sesión de preguntas y respuestas.

Solo necesitas abrir este directorio y verás que todo está ahí. Y ahora, a Cypress. Cypress es un framework muy popular de extremo a extremo. ¿Qué necesitamos? Por supuesto, Cypress, pero también el complemento de Cypress para capturas de pantalla. Necesitamos agregar esa captura de pantalla en nuestro directorio de soporte en el índice, simplemente importarla. También haz lo mismo en el directorio de complementos en sí. Lo ves aquí. También quieres actualizar el propio CypressJSON. Allí necesitas agregar la configuración.

¿Qué queda? Bueno, ejecutar la prueba, por supuesto. ¿Cómo se ve? Estamos abriendo la instancia de Storybook. Luego decimos, bueno, tengo el documento y quiero comparar la captura de pantalla con él. Probémoslo. La prueba se está ejecutando ahora. Vemos la captura de pantalla. Vemos que todo está bien. Verifiquemos la captura de pantalla en sí. Es parte del directorio de capturas de pantalla. Sin sorpresas. Se ve muy familiar. Y eso es todo.

Espero que mi charla haya sido útil. Muchas gracias, por supuesto, por ver. Mi código fuente también está disponible. Se publicará después y ya estoy deseando la sesión de preguntas y respuestas. Nos vemos entonces. Adiós.

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
Top Content
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
Top Content
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
Top Content
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
Top Content
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
Top Content
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.