topfans/backend/pkg/queue/consts/consts_test.go

package consts

import (
	"os"
	"path/filepath"
	"runtime"
	"strings"
	"testing"
)

// TestQueueNames_HaveExpectedValues 锁死字面量值 — 改名 = 丢消息(regression guard)。
func TestQueueNames_HaveExpectedValues(t *testing.T) {
	if QueueGallery != "gallery" {
		t.Fatalf("QueueGallery changed to %q — 改名会丢消息!", QueueGallery)
	}
	if QueueDefault != "default" {
		t.Fatalf("QueueDefault changed to %q — 改名会丢消息!", QueueDefault)
	}
}

// TestServiceFilesUseConstants 验证 galleryService / taskService 已用 consts 引用字面量,
// 不再硬编码 "gallery"/"default"。此测试是字面量集中化的回归保护。
//
// 允许保留字面量的位置:
//   - consts.go 本文件(定义)
//   - 注释 / doc 字符串
//   - pkg/mq/asynq 的默认值("default" 作为 asynq client 端的语义保留)
func TestServiceFilesUseConstants(t *testing.T) {
	// 项目根 = 后端目录
	_, thisFile, _, _ := runtime.Caller(0)
	root := filepath.Dir(filepath.Dir(filepath.Dir(filepath.Dir(thisFile))))
	// thisFile = .../pkg/queue/consts/consts_test.go
	// 走 4 层: consts -> queue -> pkg -> backend

	targets := []string{
		filepath.Join(root, "services", "galleryService", "main.go"),
		filepath.Join(root, "services", "galleryService", "mq", "producer.go"),
		filepath.Join(root, "services", "galleryService", "mq", "consumer.go"),
		filepath.Join(root, "services", "taskService", "main.go"),
		filepath.Join(root, "services", "taskService", "mq", "consumer.go"),
	}

	for _, p := range targets {
		body, err := os.ReadFile(p)
		if err != nil {
			t.Fatalf("read %s: %v", p, err)
		}
		text := string(body)
		// 抽掉所有 // / /* */ 注释,再扫字面量
		stripped := stripComments(text)
		// 找 `Queue: "gallery"` / `Queue: "default"` / `Queues: map[...]string{...}` 等
		// 实际只关心:
		//   - "gallery" 出现在 Queue 上下文字面量位置(Queue: "gallery" 或 "gallery": N)
		//   - "default" 同上
		assertNoQueueLiteral(t, p, stripped, `"gallery"`, "QueueGallery")
		assertNoQueueLiteral(t, p, stripped, `"default"`, "QueueDefault")
	}
}

func assertNoQueueLiteral(t *testing.T, file, body, literal, constName string) {
	t.Helper()
	// 行号定位以便排查
	for i, line := range rangeLines(body) {
		// 跳过 consts 导入行(import 块里就是 consts. 引用,不算字面量)
		// 但我们看的是 stripped 文本,import 也还在;不影响,只看 Queue/Queues 上下文
		if !strings.Contains(line, literal) {
			continue
		}
		// 判定: 此行是否在 Queue: / Queues: 上下文里
		isQueueContext := strings.Contains(line, "Queue:") ||
			strings.Contains(line, "Queues:") ||
			strings.Contains(line, "Queue =") ||
			strings.Contains(line, `Queues =`)
		if isQueueContext {
			t.Errorf("%s:%d 仍硬编码 %s — 应改为 consts.%s\n  line: %s",
				file, i+1, literal, constName, strings.TrimSpace(line))
		}
	}
}

// stripComments 删掉 // / /* */ 注释。简化版:用 // 拆行处理 // 注释,/ *...* / 整段删。
func stripComments(s string) string {
	var b strings.Builder
	// 先删 /* ... */
	for {
		start := strings.Index(s, "/*")
		if start < 0 {
			break
		}
		end := strings.Index(s[start:], "*/")
		if end < 0 {
			s = s[:start]
			break
		}
		s = s[:start] + s[start+end+2:]
	}
	// 再按行删 // 注释
	for _, line := range strings.Split(s, "\n") {
		if i := strings.Index(line, "//"); i >= 0 {
			line = line[:i]
		}
		b.WriteString(line)
		b.WriteByte('\n')
	}
	return b.String()
}

// rangeLines 把字符串按行返回(不分配 index/element 配对,只给测试用)。
func rangeLines(s string) []string { return strings.Split(s, "\n") }