FastAPI: un buzón de prueba que no se repite

La estabilidad en las pruebas de software es crucial, especialmente cuando se trata de enviar correos electrónicos de verificación. Este tema es relevante ahora más que nunca, ya que las pruebas automatizadas son una parte esencial del desarrollo moderno.

El Problema de Reutilizar Buzones de Prueba

Cuando realizamos pruebas que envían correos electrónicos, un problema común es la reutilización de buzones de prueba. Esto puede llevar a que un test pase una vez y falle en la siguiente ejecución. Algunos de los problemas que surgen son:

• Mensajes antiguos: Un correo de una prueba anterior puede interferir con una nueva, haciendo que el test falle inesperadamente.
• Confusión en entornos de integración continua (CI): Si varios procesos intentan acceder al mismo buzón al mismo tiempo, pueden surgir conflictos.
• Reintentos problemáticos: Si un enlace de verificación caduca o no se consume correctamente, un reintento podría utilizar el mismo enlace, afectando la validez de la prueba.

Solución Propuesta

Para resolver estos problemas, se sugiere tratar cada correo de prueba como un recurso temporal. Esto significa crear un buzón único para cada ejecución de prueba. Para implementar esta estrategia, se deben definir tres valores por corrida:

1. run_id: Un identificador para el trabajo de CI o la ejecución local.
2. mailbox_id: Un identificador para el buzón creado para esa corrida.
3. expected_token: Un token que relaciona el enlace recibido con el usuario que se está probando.

Este enfoque asegura que los mensajes de una ejecución no interfieran con otras, mejorando la estabilidad y confiabilidad de las pruebas.

Implementación en FastAPI

Para implementar esta estrategia en FastAPI, podemos crear un endpoint que genere un buzón de correo único para cada prueba. A continuación, se muestra un ejemplo de cómo hacerlo:

from dataclasses import dataclass
from uuid import uuid4
from fastapi import FastAPI

app = FastAPI()

dataclass(frozen=True)
class Mailbox:
    address: str
    mailbox_id: str


def create_test_mailbox(run_id: str) -> Mailbox:
    mailbox_id = f"{run_id}-{uuid4().hex[:8]}"
    return Mailbox(
        address=f"{mailbox_id}@test.invalid",
        mailbox_id=mailbox_id,
    )

@app.post("/test-users")
def create_test_user(run_id: str):
    mailbox = create_test_mailbox(run_id)
    token = uuid4().hex  # Guarda mailbox.mailbox_id y token junto al usuario creado.
    return {
        "email": mailbox.address,
        "mailbox_id": mailbox.mailbox_id,
        "verification_token": token,
    }

En este código, cada vez que se crea un usuario de prueba, se genera un buzón único. Esto garantiza que las pruebas sean independientes y más fáciles de diagnosticar.

Mejores Prácticas para Pruebas

Además de crear buzones temporales, hay algunas mejores prácticas que se deben seguir:

• Aislar pruebas: Cada ejecución debe tener su propio buzón, evitando interferencias.
• Definir un timeout: Esto ayuda a gestionar cuánto tiempo esperar por un correo antes de considerar que no llegó.
• Limpiar después de las pruebas: Asegúrate de eliminar el buzón o marcarlo como cerrado al final de cada prueba, incluso si falla.

Conclusión

Crear un buzón de prueba aislado no soluciona todos los problemas de autenticación, pero establece una clara frontera entre las ejecuciones. FastAPI puede manejar el endpoint mientras que un adaptador de pruebas gestiona el buzón y la lectura del mensaje. Con un run_id, tokens, timeouts y limpieza, cada ejecución sabe qué creó y qué debe consumir. Esto resulta en menos ruido en CI y señales más útiles cuando algo falla.

Merits

• Aislamiento de pruebas.
• Facilidad de diagnóstico.
• Mejora en la estabilidad de las pruebas.

Demerits

• Puede requerir más trabajo inicial para implementar.
• Necesita una buena gestión de los recursos temporales.

Caution

Este artículo es educativo. Los valores de ejemplo deben ser reemplazados por datos reales en su implementación. Asegúrate de verificar cualquier afirmación contra la fuente original antes de confiar en ella.

Frequently asked questions

• ¿Qué es FastAPI? — FastAPI es un framework moderno y rápido para construir APIs con Python.
• ¿Por qué es importante el aislamiento en las pruebas? — Aislar las pruebas evita interferencias y resultados inconsistentes, mejorando la fiabilidad.
• ¿Cómo se implementa un buzón temporal en FastAPI? — Se puede crear un endpoint que genere un buzón único para cada ejecución de prueba.
• ¿Qué es un run_id? — Es un identificador único que ayuda a distinguir entre diferentes ejecuciones de pruebas.
• ¿Qué problemas causa la reutilización de buzones de prueba? — Puede causar fallos intermitentes, confusión en entornos CI y problemas con reintentos.
• ¿Qué es un mailbox_id? — Es un identificador que asocia un buzón específico con una ejecución de prueba.