Samir Boulahtit
967f08e4ba
Add new validation rules MOD-020 to MOD-023 for module definition completeness and standardize permissions across all modules. Changes: - Add MOD-020: Module definitions must have required attributes - Add MOD-021: Modules with menus should have features - Add MOD-022: Feature modules should have permissions - Add MOD-023: Modules with routers should use get_*_with_routers pattern Module permissions added: - analytics: view, export, manage_dashboards - billing: view_tiers, manage_tiers, view_subscriptions, manage_subscriptions, view_invoices - cart: view, manage - checkout: view_settings, manage_settings - cms: view_pages, manage_pages, view_media, manage_media, manage_themes - loyalty: view_programs, manage_programs, view_rewards, manage_rewards - marketplace: view_integration, manage_integration, sync_products - messaging: view_messages, send_messages, manage_templates - payments: view_gateways, manage_gateways, view_transactions Module improvements: - Complete cart module with features and permissions - Complete checkout module with features and permissions - Add features to catalog module - Add version to cms module - Fix loyalty platform_router attachment - Add path definitions to payments module - Remove empty scheduled_tasks from dev_tools module Documentation: - Update module-system.md with new validation rules - Update architecture-rules.md with MOD-020 to MOD-023 Tests: - Add unit tests for module definition completeness - Add tests for permission structure validation Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
107 lines
3.8 KiB
Python
107 lines
3.8 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",
|
|
# Note: Code quality and test tasks are on-demand, not scheduled.
|
|
# If scheduled scans are desired, add ScheduledTask entries here.
|
|
)
|
|
|
|
|
|
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"]
|