Files
knowledge-governance/internal/appconfig/config_test.go
T
姚章浩 b7f7e4f121
build / build (push) Successful in 1m1s
fix(deploy): 上线前校验 .env 键值形状(两行粘成一行的坏值不再能上线)
事故复盘(2026-10-14,测试实例 p1 整体不可用约 6 分钟):
- 我用 `rstrip("\n") + 新行` 往 `.env` 追加 `VERSION_HISTORY_LINK_ORIGIN`,而 `.env` 最后一行
  当时没有结尾换行 ⇒ 两行**粘成一行**:
  `VERSION_HISTORY_GITEA_BASE_URL=http://192.168.50.223:3000VERSION_HISTORY_LINK_ORIGIN=https://gitea.zheromiku.top`
- 配置校验按设计拒绝这个非法 origin ⇒ `cmd/api`/`cmd/worker` 启动即退出 ⇒ 容器 crash-loop
  (fail-closed 是对的,但代价是平台起不来)。

修复:
- `scripts/deploy-api-web.sh` 新增 **1a 步护栏**:上线前解析 `.env`,只要某行的值里又出现 `KEY=`
  (两行粘连)或键名不合法 ⇒ 打印 `ENV_VALUE_LOOKS_MERGED` 并**拒绝部署**(不动线上);
- `internal/appconfig` 在校验失败时补线索:值里含 `=` ⇒ 提示"`.env` 里两行可能粘成了一行";
- 回归用例 `TestLoadRejectsMergedVersionHistoryEnvValue`(粘行必拒 + 线索文案 + 合法值仍放行)。

验证:护栏对"粘行样例/键名非法"退出码 1、对"正常样例/当前真实 .env"退出码 0;Go 用例通过;
make verify 15/15。线上已修 `.env` 并重启 api+worker(healthy),重新同步后页面链接已全部走公网 origin。
2026-10-14 11:17:35 +08:00

325 lines
14 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
package appconfig
import (
"strings"
"testing"
"time"
)
func TestLoadUsesSafeDefaults(t *testing.T) {
values := map[string]string{"DATABASE_URL": "postgres://example"}
config, err := Load(func(key string) string { return values[key] })
if err != nil {
t.Fatalf("Load() error = %v", err)
}
if config.AppAddr != ":8080" || config.WorkerID != "worker-1" {
t.Fatalf("address/worker defaults = %#v", config)
}
if config.PollInterval != time.Second || config.LeaseDuration != 30*time.Second || config.RetryDelay != 5*time.Second {
t.Fatalf("duration defaults = %#v", config)
}
if config.ReleaseWorkerEnabled {
t.Fatal("release worker must be disabled by default")
}
if config.ReleaseConfigFile != "" {
t.Fatalf("release config default = %q", config.ReleaseConfigFile)
}
if config.ProductionReleaseRequestsEnabled {
t.Fatal("production release requests must be disabled by default")
}
if config.TestWeKnoraEnabled {
t.Fatal("test WeKnora must be disabled by default")
}
if config.PPScanEnabled {
t.Fatal("PP source scan must be disabled by default")
}
if config.PPScanAllowedRoot != "" || config.PPScanLedgerPath != "" || config.PPScanManifestPath != "" {
t.Fatalf("PP scan paths must be empty by default: %#v", config)
}
if config.TestWeKnoraAllowDockerHTTP {
t.Fatal("test WeKnora Docker HTTP must be disabled by default")
}
if config.TestWeKnoraAPIKeyFile != "/run/secrets/test_weknora_api_key" {
t.Fatalf("test API key file = %q", config.TestWeKnoraAPIKeyFile)
}
if config.GovernanceSpoolRoot != "/var/lib/governance/spool" {
t.Fatalf("spool root = %q", config.GovernanceSpoolRoot)
}
if config.TestWeKnoraHTTPTimeout != 60*time.Second || config.TestWeKnoraPollInitial != 10*time.Second || config.TestWeKnoraPollMax != time.Minute || config.TestWeKnoraStalledAfter != 30*time.Minute {
t.Fatalf("test WeKnora timing defaults = %#v", config)
}
if config.TestWeKnoraMaxUploadBytes != 50*1024*1024 || config.TestAcceptancePolicyVersion != "structural-v1" {
t.Fatalf("test WeKnora safety defaults = %#v", config)
}
}
func TestLoadRequiresDatabaseURL(t *testing.T) {
if _, err := Load(func(string) string { return "" }); err == nil {
t.Fatal("Load() error = nil, want missing DATABASE_URL error")
}
}
func TestLoadParsesProductionReleaseRequestGate(t *testing.T) {
values := map[string]string{
"DATABASE_URL": "postgres://example",
"PRODUCTION_RELEASE_REQUESTS_ENABLED": "true",
"PRODUCTION_BACKUP_RESTORE_VERIFIED": "true",
"PRODUCTION_RELEASE_AUTHORIZER_REF": "release-owner",
"PRODUCTION_RELEASE_AUTH_TOKEN_FILE": "/run/secrets/production_release_auth_token",
}
config, err := Load(func(key string) string { return values[key] })
if err != nil || !config.ProductionReleaseRequestsEnabled || !config.ProductionBackupRestoreVerified || config.ProductionReleaseAuthorizerRef != "release-owner" || config.ProductionReleaseAuthTokenFile != "/run/secrets/production_release_auth_token" {
t.Fatalf("config=%#v error=%v", config, err)
}
values["PRODUCTION_RELEASE_REQUESTS_ENABLED"] = "not-a-bool"
if _, err := Load(func(key string) string { return values[key] }); err == nil {
t.Fatal("invalid production release request gate must be rejected")
}
values["PRODUCTION_RELEASE_REQUESTS_ENABLED"] = "true"
values["PRODUCTION_BACKUP_RESTORE_VERIFIED"] = "not-a-bool"
if _, err := Load(func(key string) string { return values[key] }); err == nil {
t.Fatal("invalid production backup restore gate must be rejected")
}
}
func TestLoadRequiresProductionReleaseAuthorizationConfigWhenGateEnabled(t *testing.T) {
base := map[string]string{
"DATABASE_URL": "postgres://example",
"PRODUCTION_RELEASE_REQUESTS_ENABLED": "true",
"PRODUCTION_RELEASE_AUTHORIZER_REF": "release-owner",
"PRODUCTION_RELEASE_AUTH_TOKEN_FILE": "/run/secrets/production_release_auth_token",
}
for _, missing := range []string{"PRODUCTION_RELEASE_AUTHORIZER_REF", "PRODUCTION_RELEASE_AUTH_TOKEN_FILE"} {
values := make(map[string]string, len(base))
for key, value := range base {
values[key] = value
}
delete(values, missing)
if _, err := Load(func(key string) string { return values[key] }); err == nil {
t.Fatalf("missing %s accepted", missing)
}
}
base["PRODUCTION_RELEASE_AUTH_TOKEN_FILE"] = "relative/token"
if _, err := Load(func(key string) string { return base[key] }); err == nil {
t.Fatal("relative production release token file accepted")
}
}
func TestLoadRequiresReleaseConfigFileWhenReleaseWorkerEnabled(t *testing.T) {
if _, err := Load(func(key string) string {
values := map[string]string{"DATABASE_URL": "postgres://example", "RELEASE_WORKER_ENABLED": "true"}
return values[key]
}); err == nil {
t.Fatal("enabled release worker without config file accepted")
}
config, err := Load(func(key string) string {
values := map[string]string{"DATABASE_URL": "postgres://example", "RELEASE_WORKER_ENABLED": "true", "RELEASE_CONFIG_FILE": "/run/secrets/release-config"}
return values[key]
})
if err != nil || config.ReleaseConfigFile != "/run/secrets/release-config" {
t.Fatalf("config=%#v err=%v", config, err)
}
}
func TestLoadRequiresAllPPScanPathsWhenEnabled(t *testing.T) {
base := map[string]string{
"DATABASE_URL": "postgres://example",
"PP_SCAN_ENABLED": "true",
"PP_SCAN_ALLOWED_ROOT": "/source",
"PP_SCAN_LEDGER_PATH": "/source/state.jsonl",
"PP_SCAN_MANIFEST_PATH": "/source/manifest.json",
}
for _, missing := range []string{"PP_SCAN_ALLOWED_ROOT", "PP_SCAN_LEDGER_PATH", "PP_SCAN_MANIFEST_PATH"} {
values := make(map[string]string, len(base))
for key, value := range base {
values[key] = value
}
delete(values, missing)
if _, err := Load(func(key string) string { return values[key] }); err == nil {
t.Fatalf("Load() error = nil, want missing %s rejected", missing)
}
}
}
func TestLoadRequiresTestWeKnoraEndpointAndKBWhenEnabled(t *testing.T) {
base := map[string]string{
"DATABASE_URL": "postgres://example",
"TEST_WEKNORA_ENABLED": "true",
}
for _, key := range []string{"TEST_WEKNORA_BASE_URL", "TEST_WEKNORA_KB_ID"} {
values := make(map[string]string, len(base)+1)
for name, value := range base {
values[name] = value
}
if key == "TEST_WEKNORA_BASE_URL" {
values["TEST_WEKNORA_KB_ID"] = "kb-test"
} else {
values["TEST_WEKNORA_BASE_URL"] = "https://weknora.test.example"
}
if _, err := Load(func(name string) string { return values[name] }); err == nil {
t.Fatalf("Load() error = nil, want missing %s error", key)
}
}
}
func TestLoadParsesTestWeKnoraSettings(t *testing.T) {
values := map[string]string{
"DATABASE_URL": "postgres://example",
"TEST_WEKNORA_ENABLED": "true",
"TEST_WEKNORA_ALLOW_DOCKER_HTTP": "true",
"TEST_WEKNORA_BASE_URL": "https://weknora.test.example",
"TEST_WEKNORA_KB_ID": "kb-test",
"TEST_WEKNORA_API_KEY_FILE": "/run/secrets/custom_key",
"GOVERNANCE_SPOOL_ROOT": "/srv/spool",
"TEST_WEKNORA_HTTP_TIMEOUT": "45s",
"TEST_WEKNORA_POLL_INITIAL": "5s",
"TEST_WEKNORA_POLL_MAX": "20s",
"TEST_WEKNORA_STALLED_AFTER": "15m",
"TEST_WEKNORA_MAX_UPLOAD_BYTES": "1048576",
"TEST_ACCEPTANCE_POLICY_VERSION": "structural-v2",
}
config, err := Load(func(name string) string { return values[name] })
if err != nil {
t.Fatalf("Load() error = %v", err)
}
if !config.TestWeKnoraEnabled || !config.TestWeKnoraAllowDockerHTTP || config.TestWeKnoraBaseURL != values["TEST_WEKNORA_BASE_URL"] || config.TestWeKnoraKBID != "kb-test" {
t.Fatalf("test WeKnora identity = %#v", config)
}
if config.TestWeKnoraAPIKeyFile != "/run/secrets/custom_key" || config.GovernanceSpoolRoot != "/srv/spool" {
t.Fatalf("test WeKnora file settings = %#v", config)
}
if config.TestWeKnoraHTTPTimeout != 45*time.Second || config.TestWeKnoraPollInitial != 5*time.Second || config.TestWeKnoraPollMax != 20*time.Second || config.TestWeKnoraStalledAfter != 15*time.Minute {
t.Fatalf("test WeKnora timing settings = %#v", config)
}
if config.TestWeKnoraMaxUploadBytes != 1048576 || config.TestAcceptancePolicyVersion != "structural-v2" {
t.Fatalf("test WeKnora safety settings = %#v", config)
}
}
func TestLoadRejectsUnsafeTestWeKnoraSettings(t *testing.T) {
tests := []struct {
name string
key string
value string
}{
{name: "poll max before initial", key: "TEST_WEKNORA_POLL_MAX", value: "5s"},
{name: "stalled before poll max", key: "TEST_WEKNORA_STALLED_AFTER", value: "30s"},
{name: "upload limit above 50 MiB", key: "TEST_WEKNORA_MAX_UPLOAD_BYTES", value: "52428801"},
{name: "empty policy", key: "TEST_ACCEPTANCE_POLICY_VERSION", value: " "},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
values := map[string]string{
"DATABASE_URL": "postgres://example",
"TEST_WEKNORA_ENABLED": "true",
"TEST_WEKNORA_BASE_URL": "https://weknora.test.example",
"TEST_WEKNORA_KB_ID": "kb-test",
"TEST_WEKNORA_POLL_INITIAL": "10s",
"TEST_WEKNORA_POLL_MAX": "60s",
"TEST_WEKNORA_STALLED_AFTER": "30m",
"TEST_ACCEPTANCE_POLICY_VERSION": "structural-v1",
}
values[tt.key] = tt.value
if _, err := Load(func(name string) string { return values[name] }); err == nil {
t.Fatalf("Load() error = nil, want unsafe %s rejected", tt.key)
}
})
}
}
func TestLoadRequiresBothCatalogRoutingKnowledgeBases(t *testing.T) {
values := map[string]string{
"DATABASE_URL": "postgres://example",
"TEST_INTERNAL_WEKNORA_KB_ID": "kb-internal",
"TEST_EXTERNAL_WEKNORA_KB_ID": "kb-external",
}
config, err := Load(func(key string) string { return values[key] })
if err != nil || config.InternalRoutingKnowledgeBaseID != "kb-internal" || config.ExternalRoutingKnowledgeBaseID != "kb-external" {
t.Fatalf("config=%#v err=%v", config, err)
}
delete(values, "TEST_EXTERNAL_WEKNORA_KB_ID")
if _, err = Load(func(key string) string { return values[key] }); err == nil {
t.Fatal("one-sided routing target must fail closed")
}
}
// TestProductionWeKnoraEndpointIsConfigurableAndFailsClosed freezes the
// production WeKnora configuration contract: the address is operator-supplied
// (never hardcoded), validation rejects anything that could smuggle secrets, and
// an unset address is an explicit "not configured" state instead of a guess.
func TestProductionWeKnoraEndpointIsConfigurableAndFailsClosed(t *testing.T) {
load := func(extra map[string]string) (Config, error) {
values := map[string]string{"DATABASE_URL": "postgres://example"}
for key, value := range extra {
values[key] = value
}
return Load(func(key string) string { return values[key] })
}
config, err := load(map[string]string{
"PRODUCTION_WEKNORA_BASE_URL": "https://weknora.prod.example/",
"PRODUCTION_WEKNORA_API_KEY_FILE": "/run/secrets/production_weknora_api_key",
"PRODUCTION_WEKNORA_ALLOW_DOCKER_HTTP": "true",
})
if err != nil {
t.Fatalf("valid production endpoint rejected: %v", err)
}
if config.ProductionWeKnoraBaseURL != "https://weknora.prod.example/" || !config.ProductionWeKnoraAllowDockerHTTP {
t.Fatalf("production endpoint = %#v", config)
}
if config.ProductionWeKnoraAPIKeyFile != "/run/secrets/production_weknora_api_key" {
t.Fatalf("production key file = %q", config.ProductionWeKnoraAPIKeyFile)
}
for _, invalid := range []map[string]string{
{"PRODUCTION_WEKNORA_BASE_URL": "ftp://weknora.example"},
{"PRODUCTION_WEKNORA_BASE_URL": "weknora.example"},
{"PRODUCTION_WEKNORA_BASE_URL": "https://user:pass@weknora.example"},
{"PRODUCTION_WEKNORA_BASE_URL": "https://weknora.example/?token=secret"},
{"PRODUCTION_WEKNORA_BASE_URL": "https://weknora.example/#frag"},
{"PRODUCTION_WEKNORA_API_KEY_FILE": "/run/secrets/production_weknora_api_key"},
{"PRODUCTION_WEKNORA_BASE_URL": "https://weknora.example", "PRODUCTION_WEKNORA_API_KEY_FILE": "relative/key"},
{"PRODUCTION_WEKNORA_ALLOW_DOCKER_HTTP": "yes"},
} {
if _, err := load(invalid); err == nil {
t.Fatalf("invalid production endpoint accepted: %#v", invalid)
}
}
unset, err := load(nil)
if err != nil {
t.Fatal(err)
}
if unset.ProductionWeKnoraBaseURL != "" || unset.ProductionWeKnoraAPIKeyFile != "" || unset.ProductionWeKnoraAllowDockerHTTP {
t.Fatalf("production endpoint must default to unconfigured: %#v", unset)
}
}
// 回归用例(2026-10-14 线上事故):`.env` 两行粘成一行时,base URL 会变成
// "http://host:3000VERSION_HISTORY_LINK_ORIGIN=…" —— 必须被拒,并给出线索文案,
// 而不是让 api/worker 带着坏值崩溃重启(或者更糟:静默按坏值跑起来)。
func TestLoadRejectsMergedVersionHistoryEnvValue(t *testing.T) {
values := map[string]string{
"DATABASE_URL": "postgres://example",
"VERSION_HISTORY_GITEA_BASE_URL": "http://192.168.50.223:3000VERSION_HISTORY_LINK_ORIGIN=https://gitea.example",
}
_, err := Load(func(key string) string { return values[key] })
if err == nil {
t.Fatal("粘在一起的值必须被拒绝")
}
if !strings.Contains(err.Error(), "粘成了一行") {
t.Fatalf("错误里应给出线索(.env 粘行):%v", err)
}
// 正常值仍然放行,且链接 origin 可为空(退回抓取 origin)
good := map[string]string{
"DATABASE_URL": "postgres://example",
"VERSION_HISTORY_GITEA_BASE_URL": "http://192.168.50.223:3000",
"VERSION_HISTORY_LINK_ORIGIN": "https://gitea.example",
}
config, err := Load(func(key string) string { return good[key] })
if err != nil {
t.Fatalf("合法配置不该被拒:%v", err)
}
if config.VersionHistoryLinkOrigin != "https://gitea.example" || len(config.VersionHistoryAllowedOrigins) != 1 {
t.Fatalf("配置解析不对:%+v", config)
}
}