Referencia del código¶
Clases, métodos y propiedades generados con mkdocstrings a partir de los docstrings y las anotaciones del código de app/. Solo se documenta Python; el frontend (JavaScript) no está incluido.
| Módulo | Descripción |
|---|---|
app.api.analysis |
Analizar una tabla: perfila una tabla de la base objetivo con una conexión guardada y propone reglas; después guarda las elegidas |
app.api.connections |
Endpoints REST para la gestión de Perfiles de Conexión Oracle (sin persistencia de contraseñas). |
app.api.demo |
Escenario de demostración: crea los casos y suites de ejemplo en un proyecto y, si se pide, los ejecuta de principio a fin. |
app.api.excel |
Endpoints de la integración con Excel (.xlsx). Ver app/services/excel_io.py para las reglas y la seguridad. |
app.api.executions |
Router de Ejecución de Pruebas SQL desacoplado utilizando el Servicio Centralizado de Ejecución. |
app.api.history |
Endpoints REST para la consulta del Historial de Ejecuciones. |
app.api.projects |
Endpoints REST para la gestión de Proyectos. |
app.api.rules |
Asistente de reglas: catálogo de reglas comunes y generación del SELECT correspondiente. No se conecta a Oracle ni guarda nada. |
app.api.suites |
Endpoints REST para las Suites de Pruebas. |
app.api.test_cases |
Endpoints REST para la gestión de Casos de Prueba SQL. |
app.api.usage |
Dashboard de utilización: métricas de uso calculadas a partir de datos persistidos. |
app.api.users |
Ingreso, solicitud de cuenta y administración de usuarios. |
app.cli |
CLI del Framework de pruebas SQL: ejecutar casos y suites desde la terminal o desde un flujo de CI y obtener un |
app.core.database |
|
app.core.logs |
Registro (logs) de la aplicación: una línea por evento, a la salida estándar (Docker la recoge con docker logs). |
app.engine.executor |
Módulo de ejecución SQL para el Framework de Pruebas. |
app.engine.validator |
Módulo de validación para el Framework de Pruebas. |
app.main |
|
app.models.connection |
Modelo de base de datos para Perfiles de Conexión Oracle (sin columna de contraseña). |
app.models.history |
Modelo de base de datos para registrar la trazabilidad completa de las ejecuciones. |
app.models.project |
Modelo de base de datos para Proyectos. |
app.models.schemas |
|
app.models.suite |
Modelo de base de datos para las Suites de Pruebas. |
app.models.test_case |
Modelo de base de datos para Casos de Prueba SQL. |
app.models.usage |
Eventos de uso del producto que no son ejecuciones (p. ej. importar o exportar Excel). |
app.models.user |
Usuarios de la aplicación (base interna SQLite). |
app.security.acceso |
Dependencias de FastAPI para el control de acceso por usuario y rol. |
app.security.auth |
Seguridad del acceso: contraseñas, sesiones y límites de intentos. |
app.security.sql_policy |
Módulo de políticas SQL para el Framework de Pruebas. |
app.security.target_policy |
Política de destinos para las conexiones Oracle de la aplicación. |
app.services.analisis_tabla |
Analizar una tabla: lee la estructura de una tabla Oracle y cómo están hoy sus datos, y propone reglas de calidad listas para |
app.services.comparacion |
Comparar con la ejecución anterior: para cada caso, qué resultado tuvo la vez anterior y si ahora empeoró («nuevo fallo») o se |
app.services.demo_scenario |
Escenario de demostración: reglas de calidad de datos sobre la tabla FRAMEWORK_TEST_ITEMS. |
app.services.excel_io |
Integración con Excel: plantilla, importación y exportación de casos, y exportación de resultados (.xlsx). |
app.services.execution_service |
Servicio centralizado de ejecución y validación de pruebas SQL. |
app.services.project_service |
Servicio para inicializar y gestionar proyectos en la base de datos interna. |
app.services.reporte_corrida |
Reporte de una corrida: página HTML autónoma (sin JavaScript ni recursos externos) con el resultado de cada caso, la comparación |
app.services.rule_templates |
Asistente de reglas: convierte una regla en lenguaje común («ninguna fila con la columna X vacía») en la consulta SELECT, el tipo |
app.services.usage_service |
Métricas de uso del producto, calculadas SOLO con datos persistidos en la base interna: |
app.services.validacion_auto |
Validación automática: la persona escribe la consulta y lo que espera, y la aplicación decide cómo compararlo. |