#!/usr/bin/env bash # Copyright 2026 Arctel.net # SPDX-License-Identifier: Apache-2.0 # # check_cordis_architecture.sh # 验证代码库是否严格遵循 Cordis 插件化架构规约与设计规范。 set -euo pipefail ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" BACKEND_DIR="${ROOT_DIR}/backend" MODULE=$(cd "${BACKEND_DIR}" && go list -m 2>/dev/null || echo "Wavelet") RED='\033[0;31m' GREEN='\033[0;32m' YELLOW='\033[1;33m' BLUE='\033[0;34m' BOLD='\033[1m' NC='\033[0m' # No Color ERRORS=0 log_check() { echo -e "${BLUE}==>${NC} ${BOLD}$1${NC}" } log_pass() { echo -e " ${GREEN}✓${NC} $1" } log_fail() { echo -e " ${RED}✗ [FAIL]${NC} $1" >&2 ERRORS=$((ERRORS + 1)) } log_warn() { echo -e " ${YELLOW}! [WARN]${NC} $1" } # 确保 ripgrep 可用 if ! command -v rg >/dev/null 2>&1; then echo -e "${RED}error: rg (ripgrep) is required to run architecture checks.${NC}" >&2 exit 1 fi echo -e "${BOLD}═══════════════════════════════════════════════════════════════${NC}" echo -e "${BOLD} Cordis Architecture & Spatiotemporal Composability Linter ${NC}" echo -e "${BOLD}═══════════════════════════════════════════════════════════════${NC}" # ============================================================================== # 1. 微内核绝对隔离 (Core Micro-Kernel Isolation) # ============================================================================== log_check "1. 检查微内核 (backend/core/) 纯洁度..." # 1.1 禁止直接依赖重型 Web/ORM/Worker 框架 CORE_FRAMEWORK_IMPORTS=$(rg -n '"github.com/gin-gonic/gin"|"gorm.io/gorm"|"github.com/hibiken/asynq"|"github.com/robfig/cron' \ "${BACKEND_DIR}/core/" --glob '*.go' -g '!*contracts*' -g '!*_test.go' || true) if [ -n "${CORE_FRAMEWORK_IMPORTS}" ]; then log_fail "backend/core/ 严禁导入具体 Web/ORM/Worker 运行时框架 (gin, gorm, asynq, cron):" echo "${CORE_FRAMEWORK_IMPORTS}" >&2 else log_pass "backend/core/ 无重型框架依赖" fi # 1.2 core/ 禁止导入任何插件 CORE_PLUGIN_IMPORTS=$(rg -n "\"${MODULE}/plugins/|\"${MODULE}/downstream/" \ "${BACKEND_DIR}/core/" --glob '*.go' -g '!*_test.go' || true) if [ -n "${CORE_PLUGIN_IMPORTS}" ]; then log_fail "backend/core/ 严禁直接依赖具体插件 (plugins/ 或 downstream/):" echo "${CORE_PLUGIN_IMPORTS}" >&2 else log_pass "backend/core/ 零插件反向依赖" fi # ============================================================================== # 2. 服务契约纯洁度 (Contracts Cleanliness) # ============================================================================== log_check "2. 检查契约层 (backend/core/contracts/) 抽象纯洁度..." CONTRACTS_PLUGIN_IMPORTS=$(rg -n "\"${MODULE}/plugins/|\"${MODULE}/downstream/|\"github.com/gin-gonic/gin\"|\"github.com/hibiken/asynq\"" \ "${BACKEND_DIR}/core/contracts/" --glob '*.go' || true) if [ -n "${CONTRACTS_PLUGIN_IMPORTS}" ]; then log_fail "backend/core/contracts/ 必须保持纯 Interface/DTO,严禁导入插件或 Web/Worker 框架依赖:" echo "${CONTRACTS_PLUGIN_IMPORTS}" >&2 else log_pass "backend/core/contracts/ 纯抽象无侵入" fi # ============================================================================== # 3. 基础包纯洁度 (backend/pkg/ Purity) # ============================================================================== log_check "3. 检查基础库 (backend/pkg/) 纯洁度..." # 3.1 pkg/ 严禁导入 plugins/ PKG_PLUGIN_IMPORTS=$(rg -n "\"${MODULE}/plugins/" \ "${BACKEND_DIR}/pkg/" --glob '*.go' -g '!*testhelper*' -g '!*_test.go' || true) if [ -n "${PKG_PLUGIN_IMPORTS}" ]; then log_fail "backend/pkg/ 严禁导入任何上层 plugins/:" echo "${PKG_PLUGIN_IMPORTS}" >&2 else log_pass "backend/pkg/ 零插件依赖" fi # 3.2 pkg/util/ 严禁导入 ORM / Session 框架 UTIL_FRAMEWORK_IMPORTS=$(rg -n '"gorm.io/gorm"|"github.com/gorilla/sessions"' \ "${BACKEND_DIR}/pkg/util/" --glob '*.go' -g '!*_test.go' || true) if [ -n "${UTIL_FRAMEWORK_IMPORTS}" ]; then log_fail "backend/pkg/util/ 必须保持纯粹,禁止导入 gorm、sessions 等数据库/会话框架包:" echo "${UTIL_FRAMEWORK_IMPORTS}" >&2 else log_pass "backend/pkg/util/ 保持纯净无状态" fi # ============================================================================== # 4. 插件间隔离与单一所有者防线 (Plugin-to-Plugin Isolation & Single Owner Principle) # ============================================================================== log_check "4. 检查插件间隔离性 (禁止跨域直接 import)..." # 4.1 Domain 插件之间严禁相互 import DOMAIN_CROSS_IMPORTS="" for d in "${BACKEND_DIR}"/plugins/domain/*/; do [ -d "$d" ] || continue name=$(basename "$d") imports=$(rg -n "\"${MODULE}/plugins/domain/" "${BACKEND_DIR}/plugins/domain/${name}" \ -g '*.go' -g '!*_test.go' 2>/dev/null | rg -v "backend/plugins/domain/${name}/" || true) if [ -n "$imports" ]; then DOMAIN_CROSS_IMPORTS="${DOMAIN_CROSS_IMPORTS}\n[domain/${name} -> other domain]:\n${imports}\n" fi done if [ -n "${DOMAIN_CROSS_IMPORTS}" ]; then log_fail "发现跨 Domain 插件直接依赖(必须通过 core/contracts 接口或 EventBus 解耦):" echo -e "${DOMAIN_CROSS_IMPORTS}" >&2 else log_pass "Domain 插件间 100% 解耦,无跨域直连 import" fi # 4.2 Driver 插件严禁导入 Domain 插件 DRIVER_DOMAIN_IMPORTS=$(rg -n "\"${MODULE}/plugins/domain/" \ "${BACKEND_DIR}/plugins/drivers/" --glob '*.go' -g '!*_test.go' || true) if [ -n "${DRIVER_DOMAIN_IMPORTS}" ]; then log_fail "Driver 驱动插件严禁直接依赖具体业务 domain 插件:" echo "${DRIVER_DOMAIN_IMPORTS}" >&2 else log_pass "Driver 驱动插件独立无业务污染" fi # ============================================================================== # 5. 数据库规范与 GORM AutoMigrate 禁令 (Database Migration & ORM Rules) # ============================================================================== log_check "5. 检查数据库操作与 AutoMigrate 禁令..." AUTOMIGRATE_CALLS=$(rg -n '\.AutoMigrate\(' "${BACKEND_DIR}" \ --glob '*.go' -g '!*_test.go' -g '!*testhelper*' || true) if [ -n "${AUTOMIGRATE_CALLS}" ]; then log_fail "严禁在生产代码中使用 GORM AutoMigrate(必须使用插件自包含 Goose SQL 迁移):" echo "${AUTOMIGRATE_CALLS}" >&2 else log_pass "零 GORM AutoMigrate,100% Goose SQL 迁移管理" fi # ============================================================================== # 6. 并发安全规范 (Goroutine Concurrency Safety) # ============================================================================== log_check "6. 检查并发安全规范 (禁止生产代码中使用裸 go func())..." BARE_GO_ROUTINES=$(rg -n '\bgo func\(' "${BACKEND_DIR}" \ --glob '*.go' -g '!*_test.go' -g '!goroutine.go' -g '!events.go' || true) if [ -n "${BARE_GO_ROUTINES}" ]; then log_fail "生产代码严禁使用裸 'go func()',必须使用 'util.Go' 确保 panic 恢复与调用栈追踪:" echo "${BARE_GO_ROUTINES}" >&2 else log_pass "并发调用统一使用 util.Go 具备 panic 恢复能力" fi # ============================================================================== # 总结与判定 # ============================================================================== echo -e "${BOLD}═══════════════════════════════════════════════════════════════${NC}" if [ ${ERRORS} -eq 0 ]; then echo -e "${GREEN}${BOLD}✓ 所有 Cordis 架构合规性检查全部通过 (0 Violations)!${NC}" exit 0 else echo -e "${RED}${BOLD}✗ 发现 ${ERRORS} 项 Cordis 架构规约违背,请根据上述提示修复!${NC}" >&2 exit 1 fi