Tests de snapshot y de golden files: cómo mantenerlos fiables

Qué es

Un test de snapshot (o de golden file) serializa una salida, por ejemplo un componente renderizado, una respuesta de API, la salida estándar de un comando o un archivo generado, y la compara con una referencia almacenada. En la primera ejecución se escribe la referencia; a partir de ahí, cualquier diferencia hace fallar el test. La documentación de Jest describe que toMatchSnapshot() escribe en un archivo .snap dentro de un directorio __snapshots__ junto al test, que los snapshots en línea (inline) se escriben de vuelta en el código fuente del test, que --updateSnapshot regenera las referencias tras un cambio intencionado y que, en CI, los snapshots nuevos no se escriben automáticamente sin ese indicador. insta, en Rust, sigue el mismo patrón con archivos .snap.new que se aceptan mediante cargo insta review, y ofrece enmascaramiento de datos (redactions) para los campos volátiles.

Por qué importa

Cuando la salida tiene muchos detalles, las aserciones escritas a mano comprueban unos pocos campos y pasan por alto el resto; un snapshot lo comprueba todo, a costa de no expresar ninguna intención. Convierte la pregunta «¿ha cambiado algo?» en una diferencia que un revisor puede leer, que es justo lo que hace falta para formatos de salida, mensajes de error y artefactos generados. Bien usados, los snapshots son tests de caracterización para formatos; mal usados, son un montón de diferencias aceptadas que nadie lee.

Cómo aplicarlo

• Haz snapshots de las salidas que son contratos: formas de respuesta, configuración generada, textos de ayuda, mensajes de error. Mantén cada snapshot corto y centrado; la documentación de Jest recomienda snapshots pequeños y nombres descriptivos para que un revisor pueda juzgar por el nombre si el contenido almacenado es correcto.
• Normaliza los datos volátiles antes de serializar: marcas de tiempo, identificadores generados, el orden de colecciones sin orden, rutas absolutas. Jest ofrece matchers de propiedades como expect.any(Date); insta ofrece enmascaramiento de datos (redactions).
• Revisa las diferencias de los snapshots en la pull request como si fueran código. La documentación de Jest advierte contra la costumbre de regenerar los snapshots cuando fallan las suites, en lugar de examinar la causa.
• Actualiza de forma selectiva, por patrón de nombre de test o de manera interactiva, en lugar de hacer una actualización generalizada tras un fallo no relacionado.
• Haz commit de los archivos de snapshot y configura CI para que falle si faltan o si están obsoletos.

Trampas

Un snapshot que cambia en cada pull request ha dejado de probar nada y acostumbra a la gente a aceptar a ciegas. Los snapshots de páginas enteras acoplan un test a componentes que no tienen relación con él. Un snapshot registra la salida actual, no la correcta: un error capturado en la primera ejecución queda aprobado hasta que alguien lee el archivo. La configuración regional, los finales de línea y el formato de los números de coma flotante hacen que los snapshots difieran entre máquinas. Un snapshot no sustituye a una aserción que exprese el requisito.