Backoffice is up and running.
+ + """ - return { - "name": "NeuroBank Backoffice Dashboard", - "version": "1.0.0", - "description": "Enterprise-grade banking administration panel", - "features": [ - "Real-time metrics dashboard", - "Transaction management", - "User administration", - "Financial reporting", - "Interactive charts", - "Protected admin panels", - "Responsive design", - ], - "endpoints": { - "dashboard": "/backoffice/", - "metrics_api": "/backoffice/api/metrics", - "transactions_api": "/backoffice/api/transactions", - "health_api": "/backoffice/api/system-health", - "admin_panels": [ - "/backoffice/admin/transactions", - "/backoffice/admin/users", - "/backoffice/admin/reports", - ], - }, - "tech_stack": [ - "FastAPI", - "Jinja2 Templates", - "Bootstrap 5 for UI", - "Real-time data updates", - ], - } diff --git a/app/config.py b/app/config.py index a55ba43..0b11742 100644 --- a/app/config.py +++ b/app/config.py @@ -1,115 +1,53 @@ +""" +Application configuration and settings. + +This module provides a centralized configuration management system using Pydantic. +It MUST NOT import FastAPI, routers, or app.main to avoid circular dependencies. +""" + import os -import sys from functools import lru_cache -from typing import List, Optional +from typing import List -from pydantic import Field from pydantic_settings import BaseSettings -class BaseAppSettings(BaseSettings): - model_config = {"extra": "ignore"} - - cors_origins: list[str] = Field(default_factory=list) - - # Añade estos si quieres que existan: - secret_key: str | None = None - workers: int | None = 1 - ci: bool | None = False - github_actions: bool | None = False - - otel_exporter_otlp_endpoint: str | None = None - otel_service_name: str | None = "neurobank-fastapi" - otel_python_logging_auto_instrumentation_enabled: bool | None = False +class Settings(BaseSettings): + """Application settings loaded from environment variables.""" - -class Settings(BaseAppSettings): # type: ignore - """Configuración de la aplicación optimizada para Railway""" - - # API Configuration - api_key: Optional[str] = os.getenv("API_KEY") + # Application app_name: str = "NeuroBank FastAPI Toolkit" app_version: str = "1.0.0" + environment: str = "development" + debug: bool = False - # Server Configuration - host: str = "0.0.0.0" # nosec B104 - port: int = int(os.getenv("PORT", 8000)) - - # Environment Configuration - environment: str = os.getenv( - "ENVIRONMENT", "development" - ) # Default to development, not production - debug: bool = os.getenv("DEBUG", "false").lower() == "true" - - # CORS Configuration - usando el dominio privado de Railway - cors_origins: List[str] = [] + # Security + api_key: str = "" + secret_key: str = "" - # AWS Configuration - aws_region: str = os.getenv("AWS_REGION", "eu-west-1") + # CORS + cors_origins: List[str] = ["*"] - # Logging Configuration - log_level: str = os.getenv( - "LOG_LEVEL", "INFO" if os.getenv("ENVIRONMENT") == "production" else "DEBUG" - ) - - # Railway Specific Variables (todas disponibles) - railway_project_id: str = os.getenv("RAILWAY_PROJECT_ID", "") - railway_environment_id: str = os.getenv("RAILWAY_ENVIRONMENT_ID", "") - railway_service_id: str = os.getenv("RAILWAY_SERVICE_ID", "") - railway_project_name: str = os.getenv("RAILWAY_PROJECT_NAME", "") - railway_environment_name: str = os.getenv("RAILWAY_ENVIRONMENT_NAME", "") - railway_service_name: str = os.getenv("RAILWAY_SERVICE_NAME", "") - railway_private_domain: str = os.getenv("RAILWAY_PRIVATE_DOMAIN", "") - - def _get_cors_origins(self) -> List[str]: - """Configura CORS origins usando variables de Railway""" - # Si hay CORS_ORIGINS configurado manualmente, usarlo - if os.getenv("CORS_ORIGINS"): - return os.getenv("CORS_ORIGINS").split(",") - - # Si no, construir automáticamente desde Railway - origins = ["https://*.railway.app"] - - # Añadir dominio privado de Railway si existe - if os.getenv("RAILWAY_PRIVATE_DOMAIN"): - origins.append(f"https://{os.getenv('RAILWAY_PRIVATE_DOMAIN')}") - - return origins + # Logging + log_level: str = "INFO" class Config: env_file = ".env" case_sensitive = False + extra = "ignore" # Ignore extra environment variables - def __init__(self, **kwargs): - super().__init__(**kwargs) - # Configurar CORS origins después de la inicialización - self.cors_origins = self._get_cors_origins() - - # Detectar si estamos en modo test de manera más robusta - is_testing = ( - bool(os.getenv("PYTEST_CURRENT_TEST")) - or "pytest" in str(os.getenv("_", "")) - or "pytest" in " ".join(sys.argv) - or any("test" in arg for arg in sys.argv) - or os.getenv("CI") == "true" # GitHub Actions, GitLab CI, etc. - or os.getenv("GITHUB_ACTIONS") == "true" # Específico de GitHub Actions - or self.environment - in ["testing", "development", "dev"] # Entornos explícitos - ) - - # En modo test o CI, asegurar que tenemos una API key - if is_testing and not self.api_key: - self.api_key = "test_secure_key_for_testing_only_not_production" - print( - f"🔧 Auto-configured API_KEY for testing environment (CI={os.getenv('CI')}, GITHUB_ACTIONS={os.getenv('GITHUB_ACTIONS')}, ENVIRONMENT={self.environment})" - ) - - # Validación de configuración crítica solo en producción real (no testing) - if self.environment == "production" and not is_testing and not self.api_key: - raise ValueError("API_KEY environment variable is required in production") + @property + def is_production(self) -> bool: + """Check if running in production environment.""" + return self.environment.lower() == "production" @lru_cache() def get_settings() -> Settings: - """Obtiene la configuración de la aplicación (cached)""" + """ + Get cached settings instance. + + Uses lru_cache to ensure settings are loaded once and reused. + This avoids repeated environment variable reads. + """ return Settings() diff --git a/app/main.py b/app/main.py index 2754b99..8aae500 100644 --- a/app/main.py +++ b/app/main.py @@ -1,253 +1,131 @@ -import datetime +""" +Main FastAPI application module. + +This is the ONLY place where: +- FastAPI app instance is created +- Lifespan is defined +- Routers are wired +- Middleware is configured + +Dependencies flow: main.py -> config.py, routers (NEVER the reverse) +""" + import logging -import os +from contextlib import asynccontextmanager +from typing import Dict from fastapi import FastAPI from fastapi.middleware.cors import CORSMiddleware from fastapi.responses import JSONResponse -from .backoffice import router as backoffice_router -from .routers import operator -from .utils.logging import setup_logging - -# Configuración constantes -APP_NAME = "NeuroBank FastAPI Toolkit" -APP_VERSION = "1.0.0" -APP_DESCRIPTION = """ -## 🏦 NeuroBank FastAPI Toolkit - -**Professional banking operations API** with enterprise-grade features and **admin backoffice dashboard**: - -### 🚀 Key Features -- **Banking Operations**: Comprehensive account management and transactions -- **Admin Dashboard**: Visual backoffice panel at `/backoffice/` with real-time metrics -- **Security First**: API key authentication and request validation -- **Production Ready**: AWS serverless deployment with monitoring -- **High Performance**: Async operations with optimized response times - -### 🎨 Backoffice Dashboard -- **Real-time Metrics**: Live transaction monitoring and system health -- **Interactive Charts**: Chart.js visualizations for business intelligence -- **Transaction Management**: Advanced filtering and administration tools -- **Responsive Design**: Bootstrap 5 with professional banking UI -- **Protected Admin Panels**: Secure administrative access - -### 🛠️ Technical Stack -- **FastAPI**: Modern, fast web framework for building APIs -- **Jinja2**: Template engine for dynamic HTML generation -- **Bootstrap 5**: Professional UI framework with responsive design -- **Chart.js**: Interactive data visualizations -- **Pydantic**: Data validation using Python type annotations -- **AWS Lambda**: Serverless compute platform -- **CloudWatch**: Monitoring and logging - -### 📚 API Documentation -- **Swagger UI**: Available at `/docs` (interactive documentation) -- **ReDoc**: Available at `/redoc` (alternative documentation) -- **Admin Dashboard**: Available at `/backoffice/` (visual interface) - -### 🔐 Authentication -All endpoints require a valid API key in the `X-API-Key` header. - -### 📊 Health Monitoring -- Health check endpoint at `/health` -- Comprehensive logging with structured JSON format -- CloudWatch integration for production monitoring - ---- -*Built with ❤️ for modern banking infrastructure* -""" +from app.backoffice.router import router as backoffice_router +from app.routers import operator +from app.utils.logging import setup_logging + + +@asynccontextmanager +async def lifespan(app: FastAPI): + """ + Application lifespan manager. + + Configures logging on startup and ensures clean shutdown. + Settings are imported lazily inside the function to avoid circular imports. + """ + # Lazy import to avoid circular dependency + from app.config import get_settings + + settings = get_settings() + + # Startup + try: + setup_logging() # NO arguments - CodeQL requirement + logging.info("Logging configured successfully") + logging.info(f"Starting {settings.app_name} v{settings.app_version}") + logging.info(f"Environment: {settings.environment}") + except Exception as exc: + logging.basicConfig(level=logging.INFO) + logging.error("Failed to configure logging, using basic config", exc_info=exc) -# Configurar logging -setup_logging() -logger = logging.getLogger(__name__) + yield -# Crear la aplicación FastAPI con documentación mejorada + # Shutdown + logging.info("Application shutdown completed") + + +# Lazy settings access +from app.config import get_settings + +settings = get_settings() + +# Create FastAPI app app = FastAPI( - title=APP_NAME, - description=APP_DESCRIPTION, - version=APP_VERSION, + title=settings.app_name, + version=settings.app_version, + debug=settings.debug, + lifespan=lifespan, docs_url="/docs", redoc_url="/redoc", - contact={ - "name": "NeuroBank Development Team", - "email": "dev@neurobank.com", - }, - license_info={ - "name": "MIT License", - "url": "https://opensource.org/licenses/MIT", - }, - servers=[ - {"url": "https://api.neurobank.com", "description": "Production server"}, - {"url": "https://staging-api.neurobank.com", "description": "Staging server"}, - {"url": "http://localhost:8000", "description": "Development server"}, - ], ) -# Configurar CORS - usando configuración de Railway -from .config import get_settings - -settings = get_settings() - +# Configure CORS middleware app.add_middleware( CORSMiddleware, allow_origins=settings.cors_origins, allow_credentials=True, - allow_methods=["GET", "POST", "PUT", "DELETE"], + allow_methods=["*"], allow_headers=["*"], ) -# Incluir routers -app.include_router(operator.router, prefix="/api", tags=["api"]) -app.include_router(backoffice_router.router, tags=["backoffice"]) +# Include routers +app.include_router(operator.router, prefix="/api", tags=["API"]) +app.include_router(backoffice_router) -# Health check endpoint -@app.get( - "/health", - summary="🏥 Health Check", - description="Comprehensive health check endpoint for monitoring service status", - response_description="Service health status with detailed information", - tags=["Health & Monitoring"], - responses={ - 200: { - "description": "Service is healthy and operational", - "content": { - "application/json": { - "example": { - "status": "healthy", - "service": "NeuroBank FastAPI Toolkit", - "version": "1.0.0", - "timestamp": "2025-07-20T15:30:45.123456Z", - "environment": "production", - "uptime_seconds": 3600, - } - } - }, - } - }, -) -async def health_check(): - """ - **Endpoint de verificación de salud del sistema** - - Retorna información detallada sobre: - - ✅ Estado del servicio - - 📊 Versión actual - - ⏰ Timestamp de respuesta - - 🌍 Entorno de ejecución - - ⏱️ Tiempo de actividad - - **Casos de uso:** - - Monitoreo automatizado (Kubernetes, Docker, AWS) - - Load balancers health checks - - Verificación de deployments - - Debugging y troubleshooting - """ - import datetime - import os - - return JSONResponse( - status_code=200, - content={ - "status": "healthy", - "service": APP_NAME, - "version": APP_VERSION, - "timestamp": f"{datetime.datetime.now(datetime.timezone.utc).isoformat()}", - "environment": os.getenv("ENVIRONMENT", "production"), - "railway": { - "project_name": os.getenv("RAILWAY_PROJECT_NAME", "unknown"), - "project_id": os.getenv("RAILWAY_PROJECT_ID", "unknown"), - "service_name": os.getenv("RAILWAY_SERVICE_NAME", "unknown"), - "environment_name": os.getenv("RAILWAY_ENVIRONMENT_NAME", "unknown"), - "private_domain": os.getenv("RAILWAY_PRIVATE_DOMAIN", "unknown"), - }, - "uptime_seconds": "N/A", # Se puede implementar con un contador global - }, - ) - - -# Root endpoint @app.get( "/", - summary="🏠 API Root", - description="Welcome endpoint with API information and navigation links", - response_description="API overview with quick navigation", - tags=["Information"], - responses={ - 200: { - "description": "API information and navigation links", - "content": { - "application/json": { - "example": { - "message": "Welcome to NeuroBank FastAPI Toolkit", - "version": "1.0.0", - "status": "operational", - "documentation": {"swagger_ui": "/docs", "redoc": "/redoc"}, - "endpoints": { - "health_check": "/health", - "operator_operations": "/operator", - }, - "features": [ - "🏦 Banking Operations", - "🔐 API Key Authentication", - "📊 Real-time Monitoring", - "☁️ AWS Serverless Ready", - ], - } - } - }, - } - }, + summary="API Root", + response_description="API metadata and useful links", ) -async def root(): - """ - **Endpoint de bienvenida de la API** - - Proporciona información general sobre la API incluyendo: - - 📋 Información básica del servicio - - 🔗 Enlaces de navegación rápida - - 📚 Acceso a documentación - - ⚡ Estado operacional - - 🎯 Características principales - - **Útil para:** - - Verificación rápida de conectividad - - Descubrimiento de endpoints principales - - Validación de versión de API - - Navegación inicial para desarrolladores - """ +async def root() -> Dict[str, object]: + """Root endpoint with API information.""" return { - "message": f"Welcome to {APP_NAME}", - "version": APP_VERSION, + "message": f"Welcome to {settings.app_name}", + "version": settings.app_version, "status": "operational", - "documentation": {"swagger_ui": "/docs", "redoc": "/redoc"}, - "endpoints": {"health_check": "/health", "operator_operations": "/operator"}, + "documentation": { + "swagger_ui": "/docs", + "redoc": "/redoc", + }, + "endpoints": { + "health_check": "/health", + "operator_operations": "/api", + "backoffice": "/backoffice", + }, "features": [ "🏦 Banking Operations", "🔐 API Key Authentication", - "📊 Real-time Monitoring", - "☁️ AWS Serverless Ready", + "📊 Admin Backoffice Dashboard", + "☁️ Cloud & Serverless Ready", ], } -if __name__ == "__main__": - import uvicorn - import uvloop - - # Use uvloop for better performance - uvloop.install() - - port = int(os.getenv("PORT", 8000)) - workers = int(os.getenv("WORKERS", 1)) # Single worker for Railway +@app.get( + "/health", + summary="Health check", + response_description="Service health status", +) +async def health_check() -> JSONResponse: + """Health check endpoint.""" + from datetime import datetime, timezone - uvicorn.run( - "app.main:app", - host="0.0.0.0", # nosec B104, - port=port, - workers=workers, - loop="uvloop", - access_log=True, - timeout_keep_alive=120, + return JSONResponse( + status_code=200, + content={ + "status": "healthy", + "service": settings.app_name, + "version": settings.app_version, + "environment": settings.environment, + "timestamp": datetime.now(timezone.utc).isoformat(), + }, ) diff --git a/app/tests/conftest.py b/app/tests/conftest.py new file mode 100644 index 0000000..0164553 --- /dev/null +++ b/app/tests/conftest.py @@ -0,0 +1,25 @@ +""" +Pytest configuration and fixtures. + +This file sets up test environment variables for local testing. +In CI, variables are set via GitHub Actions workflow. +""" + +import os + + +def pytest_configure(config): + """Configure pytest with test environment variables.""" + # Set test environment variables if not already set (for local testing) + test_env = { + "API_KEY": "test-api-key-12345678", + "SECRET_KEY": "test-secret-key-87654321", + "CORS_ORIGINS": '["*"]', + "ENVIRONMENT": "testing", + "DEBUG": "false", + "LOG_LEVEL": "INFO", + } + + for key, value in test_env.items(): + if key not in os.environ: + os.environ[key] = value diff --git a/app/utils/logging.py b/app/utils/logging.py index d624327..086e915 100644 --- a/app/utils/logging.py +++ b/app/utils/logging.py @@ -1,33 +1,57 @@ +""" +Logging configuration module. + +This module configures structured JSON logging for the application. +It reads configuration internally to avoid circular dependencies. +""" + import logging +import os import sys from pythonjsonlogger import jsonlogger def setup_logging(): - """Configura el sistema de logging para la aplicación""" + """ + Configure application logging system with NO parameters. + + Reads configuration from environment variables internally to avoid + circular import dependencies with app.config module. - # Crear formateador JSON + This function MUST be called with zero arguments to satisfy CodeQL + and maintain architectural boundaries. + """ + # Read log level from environment, default to INFO + log_level = os.getenv("LOG_LEVEL", "INFO").upper() + + # Validate log level + numeric_level = getattr(logging, log_level, logging.INFO) + + # Create JSON formatter formatter = jsonlogger.JsonFormatter( fmt="%(asctime)s %(name)s %(levelname)s %(message)s" ) - # Configurar handler para stdout + # Configure handler for stdout handler = logging.StreamHandler(sys.stdout) handler.setFormatter(formatter) - # Configurar logger raíz + # Configure root logger root_logger = logging.getLogger() - root_logger.setLevel(logging.INFO) + root_logger.setLevel(numeric_level) + + # Clear existing handlers to avoid duplicates + root_logger.handlers.clear() root_logger.addHandler(handler) - # Configurar logger específico para uvicorn + # Configure uvicorn logger uvicorn_logger = logging.getLogger("uvicorn") - uvicorn_logger.setLevel(logging.INFO) + uvicorn_logger.setLevel(numeric_level) return root_logger def get_logger(name: str) -> logging.Logger: - """Obtiene un logger configurado para el módulo especificado""" + """Get a configured logger for the specified module.""" return logging.getLogger(name) diff --git a/config.py b/config.py deleted file mode 100644 index 95e9bae..0000000 --- a/config.py +++ /dev/null @@ -1,22 +0,0 @@ -from pydantic import field_validator - -class Settings(BaseSettings): # type: ignore - model_config = SettingsConfigDict( # type: ignore - env_file=".env", - extra="ignore" - ) - - # ... - - @classmethod - def settings_customise_sources( - cls, settings_cls, init_settings, env_settings, dotenv_settings, file_secret_settings - ): - import os - - # Cuando pytest está corriendo, ignoramos por completo .env real - if os.getenv("PYTEST_CURRENT_TEST"): - return (init_settings, env_settings) # NO dotenv_settings - - # Flujo normal para prod/dev - return (init_settings, env_settings, dotenv_settings, file_secret_settings) diff --git a/pyproject.toml b/pyproject.toml index e69de29..7c1569c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -0,0 +1,5 @@ +[tool.isort] +profile = "black" +line_length = 88 +known_first_party = ["app"] +combine_as_imports = true diff --git a/requirements-dev.txt b/requirements-dev.txt index b4da1e4..f7b59e4 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -2,13 +2,13 @@ # Estas dependencias son solo para desarrollo, testing y CI/CD # Testing Framework -pytest==8.2.0 +pytest==8.4.2 pytest-asyncio==0.23.6 pytest-cov==5.0.0 pytest-mock==3.14.0 pytest-xdist==3.6.0 # Para tests paralelos pytest-timeout==2.3.1 # Timeout para tests -pytest-env==1.2.0 # Variables de entorno para tests +pytest-env==0.8.2 # Variables de entorno para tests # HTTP Testing httpx==0.27.0