Files
orion/app/modules/dev_tools/definition.py
Samir Boulahtit d7a0ff8818 refactor: complete module-driven architecture migration
This commit completes the migration to a fully module-driven architecture:

## Models Migration
- Moved all domain models from models/database/ to their respective modules:
  - tenancy: User, Admin, Vendor, Company, Platform, VendorDomain, etc.
  - cms: MediaFile, VendorTheme
  - messaging: Email, VendorEmailSettings, VendorEmailTemplate
  - core: AdminMenuConfig
- models/database/ now only contains Base and TimestampMixin (infrastructure)

## Schemas Migration
- Moved all domain schemas from models/schema/ to their respective modules:
  - tenancy: company, vendor, admin, team, vendor_domain
  - cms: media, image, vendor_theme
  - messaging: email
- models/schema/ now only contains base.py and auth.py (infrastructure)

## Routes Migration
- Moved admin routes from app/api/v1/admin/ to modules:
  - menu_config.py -> core module
  - modules.py -> tenancy module
  - module_config.py -> tenancy module
- app/api/v1/admin/ now only aggregates auto-discovered module routes

## Menu System
- Implemented module-driven menu system with MenuDiscoveryService
- Extended FrontendType enum: PLATFORM, ADMIN, VENDOR, STOREFRONT
- Added MenuItemDefinition and MenuSectionDefinition dataclasses
- Each module now defines its own menu items in definition.py
- MenuService integrates with MenuDiscoveryService for template rendering

## Documentation
- Updated docs/architecture/models-structure.md
- Updated docs/architecture/menu-management.md
- Updated architecture validation rules for new exceptions

## Architecture Validation
- Updated MOD-019 rule to allow base.py in models/schema/
- Created core module exceptions.py and schemas/ directory
- All validation errors resolved (only warnings remain)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-01 21:02:56 +01:00

119 lines
4.3 KiB
Python

# app/modules/dev_tools/definition.py
"""
Dev-Tools module definition.
Defines the dev-tools module including its features, menu items,
route configurations, and task definitions.
Dev-Tools is an internal module providing:
- Code quality scanning (architecture, security, performance validators)
- Test execution and results management
- Component library browser
- Icon browser
"""
from app.modules.base import MenuItemDefinition, MenuSectionDefinition, ModuleDefinition
from app.modules.enums import FrontendType
# Dev-Tools module definition
# Note: API routes (code quality, tests) have been moved to monitoring module.
# This module retains models, services, and page routes only.
dev_tools_module = ModuleDefinition(
code="dev-tools",
name="Developer Tools",
description=(
"Internal development tools including code quality scanning, "
"test execution, component library, and icon browser."
),
version="1.0.0",
features=[
"component_library", # UI component browser
"icon_browser", # Icon library browser
"code_quality", # Code quality scanning
"architecture_validation", # Architecture validator
"security_validation", # Security validator
"performance_validation", # Performance validator
"test_runner", # Test execution
"violation_management", # Violation tracking and assignment
],
menu_items={
FrontendType.ADMIN: [
"components", # Component library page
"icons", # Icon browser page
"code-quality", # Code quality dashboard
"tests", # Test runner dashboard
],
FrontendType.VENDOR: [], # No vendor menu items - internal module
},
# New module-driven menu definitions
menus={
FrontendType.ADMIN: [
MenuSectionDefinition(
id="devTools",
label_key="dev_tools.menu.developer_tools",
icon="view-grid",
order=85,
is_super_admin_only=True,
items=[
MenuItemDefinition(
id="components",
label_key="dev_tools.menu.components",
icon="view-grid",
route="/admin/components",
order=10,
),
MenuItemDefinition(
id="icons",
label_key="dev_tools.menu.icons",
icon="photograph",
route="/admin/icons",
order=20,
),
],
),
],
},
is_core=False,
is_internal=True, # Internal module - admin-only, not customer-facing
# =========================================================================
# Self-Contained Module Configuration
# =========================================================================
is_self_contained=True,
services_path="app.modules.dev_tools.services",
models_path="app.modules.dev_tools.models",
schemas_path="app.modules.dev_tools.schemas",
exceptions_path="app.modules.dev_tools.exceptions",
tasks_path="app.modules.dev_tools.tasks",
# =========================================================================
# Scheduled Tasks
# =========================================================================
# Note: Code quality and test tasks are on-demand, not scheduled.
# If scheduled scans are desired, they can be added here:
# scheduled_tasks=[
# ScheduledTask(
# name="dev_tools.nightly_code_scan",
# task="app.modules.dev_tools.tasks.code_quality.execute_code_quality_scan",
# schedule="0 2 * * *", # Daily at 02:00
# options={"queue": "long_running"},
# ),
# ],
scheduled_tasks=[],
)
def get_dev_tools_module_with_routers() -> ModuleDefinition:
"""
Get dev-tools module definition.
Note: API routes have been moved to monitoring module.
This module has no routers to attach.
"""
# No routers - API routes are now in monitoring module
dev_tools_module.admin_router = None
dev_tools_module.vendor_router = None
return dev_tools_module
__all__ = ["dev_tools_module", "get_dev_tools_module_with_routers"]