Feat/multi format audit report export

.github/workflows/ci.yml

@@ -12,36 +12,29 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Set up repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v5
         with:
           # Should be consistent with go.mod
           go-version: '1.19.6'
 
       - name: Lint
-        uses: golangci/golangci-lint-action@v2
+        uses: golangci/golangci-lint-action@v6
         with:
-          # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
           version: v1.45.2
-
-          # If set to true then the action will use pre-installed Go
-          skip-go-installation: true
-
-          # Optional: golangci-lint command line arguments. 
-          # The config file has lower priority than command-line options.
           args: --config=.golangci.yml
 
   test:
     name: test
     runs-on: ubuntu-latest
     steps:
       - name: Set up repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v5
         with:
           # Should be consistent with go.mod
           go-version: '1.19.6'

sqle/api/controller/v1/report_data_builder.go

@@ -0,0 +1,265 @@
+package v1
+
+import (
+	"context"
+	"fmt"
+	"sort"
+	"strings"
+	"time"
+
+	"github.com/actiontech/sqle/sqle/locale"
+	"github.com/actiontech/sqle/sqle/model"
+	"github.com/actiontech/sqle/sqle/server"
+	"github.com/actiontech/sqle/sqle/server/auditreport"
+)
+
+// BuildAuditReportData 从 Task 和数据库查询构建报告数据。
+// 该函数放在 controller 层；报告数据模型在 server/auditreport。utils 被 model 引用，
+// 若 utils 反向引用 model 会产生循环依赖。
+func BuildAuditReportData(task *model.Task, s *model.Storage, noDuplicate bool, ctx context.Context) (*auditreport.AuditReportData, error) {
+	// 1. 获取 SQL 列表
+	data := map[string]interface{}{
+		"task_id":      fmt.Sprintf("%d", task.ID),
+		"no_duplicate": noDuplicate,
+	}
+
+	taskSQLsDetail, _, err := s.GetTaskSQLsByReq(data)
+	if err != nil {
+		return nil, fmt.Errorf("get task SQLs failed: %w", err)
+	}
+
+	// 2. 获取回滚 SQL 映射
+	rollbackSqlMap, err := server.BackupService{}.GetRollbackSqlsMap(task.ID)
+	if err != nil {
+		return nil, fmt.Errorf("get rollback SQLs failed: %w", err)
+	}
+
+	// 3. 构建 SQL 列表和统计数据（等级：固定顺序 normal/notice/warn/error，其余等级单独统计）
+	var levelCounts [4]int
+	extrasLevel := make(map[string]int)
+	ruleHits := make(map[string]int)
+	n := len(taskSQLsDetail)
+	sqlList := make([]auditreport.AuditSQLItem, 0, n)
+	problemSQLs := make([]auditreport.AuditSQLItem, 0, n)
+
+	for _, td := range taskSQLsDetail {
+		// 构造临时 ExecuteSQL 对象以复用状态描述方法
+		tempSQL := &model.ExecuteSQL{
+			AuditResults: td.AuditResults,
+			AuditStatus:  td.AuditStatus,
+		}
+		tempSQL.ExecStatus = td.ExecStatus
+
+		// 提取规则名称和审核建议
+		ruleName, suggestion := extractRuleInfo(td.AuditResults, ctx)
+
+		item := auditreport.AuditSQLItem{
+			Number:      td.Number,
+			SQL:         td.ExecSQL,
+			AuditLevel:  td.AuditLevel,
+			AuditStatus: tempSQL.GetAuditStatusDesc(ctx),
+			AuditResult: tempSQL.GetAuditResultDesc(ctx),
+			ExecStatus:  tempSQL.GetExecStatusDesc(ctx),
+			ExecResult:  td.ExecResult,
+			RollbackSQL: strings.Join(rollbackSqlMap[td.Id], "\n"),
+			Description: td.Description,
+			RuleName:    ruleName,
+			Suggestion:  suggestion,
+		}
+		sqlList = append(sqlList, item)
+
+		// 统计等级分布
+		level := td.AuditLevel
+		if level == "" {
+			level = "normal"
+		}
+		switch level {
+		case "normal":
+			levelCounts[0]++
+		case "notice":
+			levelCounts[1]++
+		case "warn":
+			levelCounts[2]++
+		case "error":
+			levelCounts[3]++
+		default:
+			extrasLevel[level]++
+		}
+
+		// 区分问题 SQL（AuditLevel 不是 normal 且不为空）
+		if level != "normal" {
+			problemSQLs = append(problemSQLs, item)
+		}
+
+		// 统计规则命中
+		for _, ar := range td.AuditResults {
+			if ar.RuleName != "" {
+				ruleHits[ar.RuleName]++
+			}
+		}
+	}
+
+	// 4. 构建国际化标签（当前使用 locale 包提供的 i18n 标签）
+	labels := buildReportLabels(ctx)
+
+	now := time.Now()
+	auditTime := now.Format("2006-01-02 15:04:05")
+	if task.CreatedAt.Year() > 1 {
+		auditTime = task.CreatedAt.Format("2006-01-02 15:04:05")
+	}
+
+	instanceName := task.InstanceName()
+	if instanceName == "" {
+		instanceName = "unknown"
+	}
+
+	return &auditreport.AuditReportData{
+		TaskID:       uint64(task.ID),
+		Title:        locale.Bundle.LocalizeMsgByCtx(ctx, locale.ReportLabelTitle),
+		InstanceName: instanceName,
+		Schema:       task.Schema,
+		GeneratedAt:  now,
+		Lang:         locale.Bundle.GetLangTagFromCtx(ctx).String(),
+		LogoBase64:   "",
+		Summary: auditreport.AuditSummary{
+			AuditTime:    auditTime,
+			InstanceName: instanceName,
+			Schema:       task.Schema,
+			TotalSQL:     len(sqlList),
+			PassRate:     task.PassRate * 100,
+			Score:        task.Score,
+			AuditLevel:   task.AuditLevel,
+		},
+		Statistics: auditreport.AuditStatistics{
+			LevelDistribution: formatLevelDistribution(levelCounts, extrasLevel),
+			RuleHits:          toRuleHits(ruleHits),
+		},
+		SQLList:     sqlList,
+		ProblemSQLs: problemSQLs,
+		Labels:      labels,
+	}, nil
+}
+
+// extractRuleInfo 从审核结果中提取规则名称和审核建议。
+// 如果有多条规则命中，使用逗号分隔拼接。
+func extractRuleInfo(auditResults model.AuditResults, ctx context.Context) (ruleName string, suggestion string) {
+	if len(auditResults) == 0 {
+		return "", ""
+	}
+
+	lang := locale.Bundle.GetLangTagFromCtx(ctx)
+	var ruleNames []string
+	var suggestions []string
+
+	for _, ar := range auditResults {
+		if ar.RuleName != "" {
+			ruleNames = append(ruleNames, ar.RuleName)
+		}
+		msg := ar.GetAuditMsgByLangTag(lang)
+		if msg != "" {
+			suggestions = append(suggestions, msg)
+		}
+	}
+
+	return strings.Join(ruleNames, ", "), strings.Join(suggestions, "; ")
+}
+
+// formatLevelDistribution 将各等级计数转为 LevelCount 切片：先按固定顺序输出非零的标准等级，
+// 再按名字排序输出其余等级。
+func formatLevelDistribution(counts [4]int, extras map[string]int) []auditreport.LevelCount {
+	names := []string{"normal", "notice", "warn", "error"}
+	out := make([]auditreport.LevelCount, 0, 4+len(extras))
+	for i, name := range names {
+		if counts[i] > 0 {
+			out = append(out, auditreport.LevelCount{Level: name, Count: counts[i]})
+		}
+	}
+	if len(extras) == 0 {
+		return out
+	}
+	keys := make([]string, 0, len(extras))
+	for k := range extras {
+		keys = append(keys, k)
+	}
+	sort.Strings(keys)
+	for _, k := range keys {
+		out = append(out, auditreport.LevelCount{Level: k, Count: extras[k]})
+	}
+	return out
+}
+
+// toLevelCounts 将等级分布 map 转为 LevelCount 切片（供测试与 map 输入场景）。
+func toLevelCounts(dist map[string]int) []auditreport.LevelCount {
+	if len(dist) == 0 {
+		return []auditreport.LevelCount{}
+	}
+	var counts [4]int
+	extras := make(map[string]int)
+	for level, c := range dist {
+		switch level {
+		case "normal":
+			counts[0] += c
+		case "notice":
+			counts[1] += c
+		case "warn":
+			counts[2] += c
+		case "error":
+			counts[3] += c
+		default:
+			extras[level] += c
+		}
+	}
+	return formatLevelDistribution(counts, extras)
+}
+
+// toRuleHits 将规则命中 map 转换为按命中次数降序排列的 RuleHit 切片。
+func toRuleHits(hits map[string]int) []auditreport.RuleHit {
+	if len(hits) == 0 {
+		return []auditreport.RuleHit{}
+	}
+
+	result := make([]auditreport.RuleHit, 0, len(hits))
+	for name, count := range hits {
+		result = append(result, auditreport.RuleHit{
+			RuleName: name,
+			HitCount: count,
+		})
+	}
+
+	sort.Slice(result, func(i, j int) bool {
+		return result[i].HitCount > result[j].HitCount
+	})
+
+	return result
+}
+
+// buildReportLabels 构建报告中使用的国际化标签。
+// 当前版本使用 locale 包已有的国际化消息和硬编码中文标签，
+// 后续阶段 8 将接入 go-i18n 框架实现完整国际化。
+func buildReportLabels(ctx context.Context) auditreport.ReportLabels {
+	return auditreport.ReportLabels{
+		AuditSummary:      locale.Bundle.LocalizeMsgByCtx(ctx, locale.ReportLabelAuditSummary),
+		ResultStatistics:  locale.Bundle.LocalizeMsgByCtx(ctx, locale.ReportLabelResultStatistics),
+		ProblemSQLList:    locale.Bundle.LocalizeMsgByCtx(ctx, locale.ReportLabelProblemSQLList),
+		RuleHitStatistics: locale.Bundle.LocalizeMsgByCtx(ctx, locale.ReportLabelRuleHitStatistics),
+		AuditTime:         locale.Bundle.LocalizeMsgByCtx(ctx, locale.ReportLabelAuditTime),
+		DataSource:        locale.Bundle.LocalizeMsgByCtx(ctx, locale.ReportLabelDataSource),
+		Schema:            locale.Bundle.LocalizeMsgByCtx(ctx, locale.ReportLabelSchema),
+		TotalSQL:          locale.Bundle.LocalizeMsgByCtx(ctx, locale.ReportLabelTotalSQL),
+		PassRate:          locale.Bundle.LocalizeMsgByCtx(ctx, locale.ReportLabelPassRate),
+		Score:             locale.Bundle.LocalizeMsgByCtx(ctx, locale.ReportLabelScore),
+		AuditLevel:        locale.Bundle.LocalizeMsgByCtx(ctx, locale.ReportLabelAuditLevel),
+		Number:            locale.Bundle.LocalizeMsgByCtx(ctx, locale.TaskSQLReportIndex),
+		SQL:               locale.Bundle.LocalizeMsgByCtx(ctx, locale.TaskSQLReportSQL),
+		AuditStatus:       locale.Bundle.LocalizeMsgByCtx(ctx, locale.TaskSQLReportAuditStatus),
+		AuditResult:       locale.Bundle.LocalizeMsgByCtx(ctx, locale.TaskSQLReportAuditResult),
+		ExecStatus:        locale.Bundle.LocalizeMsgByCtx(ctx, locale.TaskSQLReportExecStatus),
+		ExecResult:        locale.Bundle.LocalizeMsgByCtx(ctx, locale.TaskSQLReportExecResult),
+		RollbackSQL:       locale.Bundle.LocalizeMsgByCtx(ctx, locale.TaskSQLReportRollbackSQL),
+		RuleName:          locale.Bundle.LocalizeMsgByCtx(ctx, locale.ReportLabelRuleName),
+		Description:       locale.Bundle.LocalizeMsgByCtx(ctx, locale.TaskSQLReportDescription),
+		Suggestion:        locale.Bundle.LocalizeMsgByCtx(ctx, locale.ReportLabelSuggestion),
+		Count:             locale.Bundle.LocalizeMsgByCtx(ctx, locale.ReportLabelCount),
+		HitCount:          locale.Bundle.LocalizeMsgByCtx(ctx, locale.ReportLabelHitCount),
+	}
+}