CHK-DGT-002 Verificación de Backend
v 6.0
Propósito
Esta checklist tiene como propósito el ser utilizada con el fin de garantizar la integridad en el proceso de desarrollo del proyecto LinkBridge, así como disminuir los defectos inyectados en la fase de desarrollo.
Notas introductorias
En la sección de "Criterios de Aceptación", se identifica con "CM" los criterios que pertenecen a Gestión de la Configuración y con "PPQA" los que pertenecen al Aseguramiento de la Calidad del Proceso y del Producto
Criterios de Aceptación
PPQA
Inconsistencia
- El desarrollo debe ser coherente con la información proporcionada durante el análisis y diseño de requerimientos. Debe mostrar cómo se abordará el problema y cómo se cumplirán los criterios de aceptación.
Organización de Archivos
- Los archivos están organizados en las carpetas correctas según su tipo y función dentro del proyecto, y se apegan al diagrama de paquetes backend
- No existen archivos obsoletos o sin utilizar
Uso de Funciones y Modularización
- Las implementaciones de interfaces y módulos están completas, claras y siguen los principios de diseño limpio
- El código se encuentra correctamente documentado según el EST-DGT-002 Estándar para comentarios de Código con Doxygen
Seguridad y Configuración
- No se revela información confidencial en el código, como claves API, URLs de bases de datos, etc
- Todas las claves secretas y configuraciones sensibles están en variables de entorno y no están codificadas directamente en el código fuente
- Todos los endpoints utilizados o implementados estén protegidos con autenticación adecuada, así como control de acceso basado en roles (RBAC)
Nomenclatura
- Los nombres de los archivos están apegados al EST-DGT-001 Estándar para nombres de Archivos de Código
- La estructura de los endpoints sigue el EST-DGT-003 Estructura de endpoints
- Nombres de funciones, variables y archivos están definidos en inglés
- En caso de realizar alguna modificación a la db, los nombres de tablas y/o campos agregados a la base de datos están en snake_case y son descriptivos
Manejo de errores
- El manejo de errores sigue el EST-DGT-004 Manejo de errores
Pruebas Unitarias
- Las nuevas funcionalidades o módulos están acompañados de pruebas unitarias
- Las pruebas unitarias pasan localmente
- Las pruebas unitarias pasan en Github Actions
Control de Cambios
| Versión | Cambio realizado | Análisis | Autor | Revisor(es) | Fecha de cambio |
|---|---|---|---|---|---|
| v 1.0 | Creación de la checklist | N/A | Sergio Garnica | Olimpia García | 18/04/2024 |
| v 2.0 | Agregar resumen de checklist | Para que se pueda entender mejor qué podemos lograr con este checklist, se agregó el resumen | Yuna Chung | Sergio Garnica | 22/04/2024 |
| v 3.0 | Refactorización de items y añadir enlaces | Algunos criterios de aceptación estaban muy ambiguos, entonces para que sea más fácil de revisar y verificar, los ítems se refactorizaron y se añadieron los enlaces | Daniel Hurtado | Yuna Chung | 22/04/2024 |
| v 3.1 | Cambio de nombre | N/A | Arturo Díaz | Ian Padrón | 30/04/2024 |
| v 4.0 | Refactorización de checklist | La checklist estaba deprecada y no se usaba por el equipo de desarrollo, se actualizó con el fin de fomentar su uso. | Arturo Díaz | Ian Padrón | 30/04/2024 |
| v 4.1 | Cambio a link relativo | Los links relativos avisan si se rompen | Ricardo Fernández | Sergio Garnica | 1/05/2024 |
| v 4.2 | Se agregó link a diagrama de paquetes backend | N/A | Arturo Díaz | Ian Padrón | 1/05/2024 |
| v 5.0 | Agregar áreas de proceso CM y PPQA | Se identificó para cada criterio de la checklist si pertenece a PPQA o a CM | Carlos Velasco | Sergio Garnica, Diego Perdomo | 14/05/2024 |
| v 6.0 | Criterio de Inconsistencia | Agregar criterio de Inconsistencia para aclarar cuándo existen inconsistencias en un requerimient entre fases | Sergio Garnica | Alejandra Cabrera | 23/05/2024 |