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 formador y consultor en Angular Architects. Esto significa que paso la mayor parte de mi tiempo con Angular.

Esta charla es sobre la regresión visual. Esto significa que vamos a crear 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 de Jest, pero mientras que las instantáneas se basan en cadenas de texto, la regresión visual utiliza imágenes reales.

Y como dije antes, estamos haciendo muchas masterclass, y cada vez que estoy introduciendo este tema, hay dos tipos diferentes de desarrolladores. El primer tipo dice, bien, 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. Donde se invierte mucho tiempo en un diseño muy atractivo.

La mayoría, sin embargo, dice, bien, estoy escribiendo aplicaciones de negocio o aplicaciones, y la mayor parte de mi tiempo la paso usando elementos de formulario. Estoy usando rejillas, y no las creo yo mismo. Ya utilizo un framework existente como Material Bootstrap o lo que sea. ¿Por qué tengo que preocuparme por la regresión visual? Si compartes esta opinión, entonces piensa qué sucede cuando entras en un sitio web y ves que los botones están sobrecargados, desbordados, o que el texto está desbordado o algo así. ¿Realmente confiarías en este sitio web? ¿Estarías realmente 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, primero, la primera impresión realmente cuenta. Y como es en las aplicaciones, la parte visual es siempre la primera impresión. Así que no subestimes eso, independientemente del tipo de aplicación que tengas.

Y así es como vamos a hacerlo. Te mostraré cómo hacer la regresión visual utilizando tres bibliotecas, frameworks diferentes. Empezaré con Puppeteer, luego Playwright, y luego Cypress. Empecemos. Bueno, aquí estamos. Esta es nuestra aplicación, y lo que queremos probar es esta tarjeta de vacaciones aquí. La primera acción es ya 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í, entonces la prueba lanzaría un error, aunque la tarjeta de vacaciones todavía se ve bien.

Y por eso, estamos usando Storybook. Storybook es una biblioteca que nos permite extraer componentes de nuestra aplicación y presentarlos o mostrarlos de manera aislada. Y esto es algo que ya he hecho. Así que esta es la instancia de Storybook. Puedo hacer clic a través de las diferentes variaciones, y eso es lo que voy a usar para la regresión visual.

Echemos un vistazo rápido a nuestro code, cómo se puede hacer esto. Así que Storybook requiere una configuración predeterminada. En mi caso, esto es Angular. Necesito definir todas las dependencias, y luego simplemente creo las llamadas historias, que son las diferentes variaciones. Y para eso estoy usando aquí, un método de fábrica escrito por mí mismo.

Así que empezaremos con Puppeteer. Puppeteer es una biblioteca que te permite controlar de forma remota un navegador basado en Chromium. Esto también te permite hacer capturas de pantalla, y eso es lo que vamos a combinar aquí con Jest. Ves aquí que ya tengo una configuración de Jest que tiene un preajuste de Jest Puppeteer. Así que todo ya está, o la mayoría de las cosas ya están configuradas por este preajuste. Y en nuestro paquete JSON tenemos estas dos dependencias importantes. La una es por supuesto Jest Puppeteer junto con Puppeteer en sí. Y la segunda es ImageSnapshot que es capaz de hacer la coincidencia de 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. Y una vez que esto está hecho, estoy creando una captura de pantalla de lo que veo o lo que ve Jest y luego simplemente llamo al comparador para que coincida con ImageSnapshot.

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

Así que lo siguiente ya es PlayWrite. Muy rápido aquí. ¿Qué requerimos para PlayWrite o qué es? PlayWrite es muy similar a Puppeteer. Puede ser visto como una reescritura hecha por Microsoft. Viene con su propia biblioteca de testing y también soporta regresión visual de serie. Así que vemos aquí la dependencia. Sólo hay un paquete. Tenemos una configuración aquí. Podemos definir múltiples navegadores. También vemos aquí WebKit. Así que esta es la prueba para Safari y luego tenemos la prueba real. Y como vemos aquí, se parece más o menos a lo que hemos visto antes con Jest. Ahora ejecutemos también la prueba aquí. A diferencia de Jest o Puppeteer, PlayWrite cuenta los casos en los que aún no tenemos una imagen de referencia como un fallo. Por eso vemos aquí todo rojo. Cuando lo ejecutamos la próxima vez, sólo fallará si hay una diferencia real. Y por supuesto, las imágenes también están ahí.

Solo necesito abrir este directorio y ves aquí que todo está ahí. Y ahora a Cypress. Cypress es un framework de extremo a extremo muy popular. ¿Qué requerimos? Cypress, por supuesto, pero también el plugin de Cypress para snapshots. Necesitamos agregar ese snapshot en nuestro directorio de soporte en el índice, simplemente impórtalo. También haz lo mismo en el directorio de plugins en sí. Lo ves aquí. Y 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 hacer coincidir el snapshot con él. Probémoslo. La prueba ahora está en ejecución. Vemos la captura de pantalla. Vemos que todo está bien. Verifiquemos el snapshot en sí. Es parte aquí del directorio de snapshots de imagen. No es sorpresa. Se ve muy familiar. Y eso es todo.

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