Pruebas de Regresión Visual con 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.

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.

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í.

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.