mirror of
https://github.com/Rain-kl/OpenFlare.git
synced 2026-09-29 14:06:36 +08:00
7d71f1e4e1
- New internal/repository/logstore abstraction: exported domain interfaces (AccessLogStore/ObservabilityStore/UserAccessLogStore/StatusStore), config-driven provider (Active/Build/Migrating/SetConfigReader), GORM implementation for PostgreSQL/SQLite (incl. hourly rollups computed in real time, migration listers, PG partition maintenance), and a ClickHouse wrapper preserving the native batch path; repository facade delegates to logstore; import-lint test enforces apps never import analyticsrepo. - ClickHouse is now optional: the log DB is either the main DB (postgres when database.enabled, else sqlite) or clickhouse; boot validation + first-run seed; log_database / log_db_migration are protected keys. - New user task 切换日志数据库 (of_log_db_switch): freeze log writes, drain batch writers, copy all 6 raw log tables by id (preserving IDs) with target-partition pre-creation for PG, flip log_database on success, clear the freeze flag on failure. - Per-store retention (log_retention_days_*) with expiry cleanup folded into the daily system_cleanup task; legacy database_auto_cleanup_* and of_database_auto_cleanup decommissioned. - goose migrations: 6 log tables in PG (2 monthly-partitioned) + SQLite, retention config seeds, schedule cleanup; GET /api/v1/admin/status/log-database endpoint; frontend retention settings, switch-task UI and status badge; changelog and docs updated. docs(plan): log database decoupling implementation plan docs(design): log database decoupling design (ClickHouse optional)
312 lines
9.8 KiB
Go
312 lines
9.8 KiB
Go
// Copyright 2026 Arctel.net
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package waf
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/Rain-kl/Wavelet/internal/repository"
|
|
"github.com/Rain-kl/Wavelet/internal/testhelper"
|
|
|
|
db "github.com/Rain-kl/Wavelet/internal/infra/persistence"
|
|
"github.com/Rain-kl/Wavelet/internal/model"
|
|
"github.com/glebarez/sqlite"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"gorm.io/gorm"
|
|
)
|
|
|
|
func setupIPGroupSyncTestDB(t *testing.T) func() {
|
|
t.Helper()
|
|
|
|
sqliteDB, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{
|
|
DisableForeignKeyConstraintWhenMigrating: true,
|
|
})
|
|
require.NoError(t, err)
|
|
require.NoError(t, sqliteDB.AutoMigrate(
|
|
&model.OpenFlareWAFRuleGroup{},
|
|
&model.OpenFlareWAFIPGroup{},
|
|
))
|
|
|
|
db.SetDB(sqliteDB)
|
|
testhelper.SetupLogStoresForTest(t)
|
|
return func() {
|
|
db.SetDB(nil)
|
|
}
|
|
}
|
|
|
|
func TestParseIPGroupSubscriptionParsers(t *testing.T) {
|
|
textItems, err := parseIPGroupSubscription([]byte("# comment\n203.0.113.10\n\n198.51.100.0/24\n"), "text", "")
|
|
require.NoError(t, err)
|
|
require.Len(t, textItems, 2)
|
|
assert.Equal(t, "198.51.100.0/24", textItems[0])
|
|
assert.Equal(t, "203.0.113.10", textItems[1])
|
|
|
|
jsonItems, err := parseIPGroupSubscription([]byte(`{"data":{"items":[{"ip":"203.0.113.11"},{"ip":"203.0.113.12"}]}}`), "json", "data.items[].ip")
|
|
require.NoError(t, err)
|
|
require.Len(t, jsonItems, 2)
|
|
assert.Equal(t, "203.0.113.11", jsonItems[0])
|
|
assert.Equal(t, "203.0.113.12", jsonItems[1])
|
|
}
|
|
|
|
func TestSyncIPGroupDownloadsSubscription(t *testing.T) {
|
|
cleanup := setupIPGroupSyncTestDB(t)
|
|
defer cleanup()
|
|
ctx := context.Background()
|
|
|
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte("203.0.113.20\n"))
|
|
}))
|
|
defer server.Close()
|
|
|
|
group, err := CreateIPGroup(ctx, IPGroupInput{
|
|
Name: "subscription",
|
|
Type: wafIPGroupTypeSubscription,
|
|
Enabled: true,
|
|
SubscriptionURL: server.URL,
|
|
SubscriptionFormat: wafIPGroupSubscriptionFormatText,
|
|
SyncIntervalMinutes: 10,
|
|
})
|
|
require.NoError(t, err)
|
|
|
|
result, err := SyncIPGroup(ctx, group.ID)
|
|
require.NoError(t, err)
|
|
require.Equal(t, 1, result.IPCount)
|
|
assert.Equal(t, "203.0.113.20", result.Group.IPList[0])
|
|
assert.Equal(t, "success", result.Status)
|
|
}
|
|
|
|
func TestSyncIPGroupAutomaticExprRules(t *testing.T) {
|
|
cleanup := setupIPGroupSyncTestDB(t)
|
|
defer cleanup()
|
|
ctx := context.Background()
|
|
|
|
now := time.Now().UTC()
|
|
seedWAFAccessLogs(t, ctx, now, "203.0.113.10", "app.example.com", 101, 81)
|
|
seedWAFAccessLogs(t, ctx, now, "203.0.113.11", "198.51.100.10", 60, 0)
|
|
seedWAFAccessLogs(t, ctx, now, "203.0.113.12", "app.example.com", 120, 10)
|
|
|
|
group, err := CreateIPGroup(ctx, IPGroupInput{
|
|
Name: "auto blacklist",
|
|
Type: wafIPGroupTypeAutomatic,
|
|
Enabled: true,
|
|
AutoConfig: json.RawMessage(`{
|
|
"lookback": "60m",
|
|
"rules": [
|
|
{"name":"单 IP 404 高频扫描","expr":"request_count > 100 && StatusRatio(404) >= 0.8"},
|
|
{"name":"单 IP 直连访问异常","expr":"ip_host_count > 50 && ip_host_ratio > 0.5"}
|
|
]
|
|
}`),
|
|
})
|
|
require.NoError(t, err)
|
|
|
|
result, err := SyncIPGroup(ctx, group.ID)
|
|
require.NoError(t, err)
|
|
require.Equal(t, 2, result.IPCount)
|
|
|
|
want := map[string]bool{"203.0.113.10": true, "203.0.113.11": true}
|
|
for _, item := range result.Group.IPList {
|
|
assert.True(t, want[item], "unexpected matched IP %s", item)
|
|
delete(want, item)
|
|
}
|
|
assert.Empty(t, want)
|
|
}
|
|
|
|
func TestTestIPGroupAutoConfigReturnsMatchedIPs(t *testing.T) {
|
|
cleanup := setupIPGroupSyncTestDB(t)
|
|
defer cleanup()
|
|
ctx := context.Background()
|
|
|
|
now := time.Now().UTC()
|
|
seedWAFAccessLogs(t, ctx, now, "203.0.113.10", "app.example.com", 101, 81)
|
|
seedWAFAccessLogs(t, ctx, now, "203.0.113.11", "198.51.100.10", 60, 0)
|
|
seedWAFAccessLogs(t, ctx, now, "203.0.113.12", "app.example.com", 120, 10)
|
|
|
|
result, err := TestIPGroupAutoConfig(ctx, IPGroupAutoTestInput{
|
|
AutoConfig: json.RawMessage(`{
|
|
"lookback": "1h",
|
|
"rules": [
|
|
{"name":"单 IP 404 高频扫描","expr":"request_count > 100 && StatusRatio(404) >= 0.8"},
|
|
{"name":"单 IP 直连访问异常","expr":"ip_host_count > 50 && ip_host_ratio > 0.5"}
|
|
]
|
|
}`),
|
|
})
|
|
require.NoError(t, err)
|
|
assert.Equal(t, 2, result.MatchedCount)
|
|
assert.Equal(t, 2, result.RuleCount)
|
|
assert.Equal(t, "1h", result.Lookback)
|
|
|
|
want := map[string]bool{"203.0.113.10": true, "203.0.113.11": true}
|
|
for _, item := range result.MatchedIPs {
|
|
assert.True(t, want[item], "unexpected matched IP %s", item)
|
|
delete(want, item)
|
|
}
|
|
assert.Empty(t, want)
|
|
}
|
|
|
|
func TestListDueOpenFlareWAFIPGroups(t *testing.T) {
|
|
cleanup := setupIPGroupSyncTestDB(t)
|
|
defer cleanup()
|
|
ctx := context.Background()
|
|
|
|
past := time.Now().UTC().Add(-time.Hour)
|
|
future := time.Now().UTC().Add(time.Hour)
|
|
|
|
dueAuto := &model.OpenFlareWAFIPGroup{
|
|
Name: "due auto", Type: wafIPGroupTypeAutomatic, Enabled: true,
|
|
IPList: "[]", AutoConfig: "{}", ExtIPs: "[]", NextSyncAt: &past,
|
|
}
|
|
require.NoError(t, repository.CreateOpenFlareWAFIPGroup(ctx, dueAuto))
|
|
|
|
futureAuto := &model.OpenFlareWAFIPGroup{
|
|
Name: "future auto", Type: wafIPGroupTypeAutomatic, Enabled: true,
|
|
IPList: "[]", AutoConfig: "{}", ExtIPs: "[]", NextSyncAt: &future,
|
|
}
|
|
require.NoError(t, repository.CreateOpenFlareWAFIPGroup(ctx, futureAuto))
|
|
|
|
dueSub := &model.OpenFlareWAFIPGroup{
|
|
Name: "due sub", Type: wafIPGroupTypeSubscription, Enabled: true,
|
|
IPList: "[]", AutoConfig: "{}", ExtIPs: "[]",
|
|
SubscriptionURL: "https://example.com/list", NextSyncAt: &past,
|
|
}
|
|
require.NoError(t, repository.CreateOpenFlareWAFIPGroup(ctx, dueSub))
|
|
|
|
manual := &model.OpenFlareWAFIPGroup{
|
|
Name: "manual", Type: wafIPGroupTypeManual, Enabled: true,
|
|
IPList: "[]", AutoConfig: "{}", ExtIPs: "[]", NextSyncAt: &past,
|
|
}
|
|
require.NoError(t, repository.CreateOpenFlareWAFIPGroup(ctx, manual))
|
|
|
|
groups, err := repository.ListDueOpenFlareWAFIPGroups(ctx, time.Now().UTC())
|
|
require.NoError(t, err)
|
|
require.Len(t, groups, 2)
|
|
ids := []uint{groups[0].ID, groups[1].ID}
|
|
assert.Contains(t, ids, dueAuto.ID)
|
|
assert.Contains(t, ids, dueSub.ID)
|
|
}
|
|
|
|
func seedWAFAccessLogs(t *testing.T, ctx context.Context, loggedAt time.Time, remoteAddr string, host string, total int, notFound int) {
|
|
t.Helper()
|
|
records := make([]*model.OpenFlareAccessLog, 0, total)
|
|
for i := 0; i < total; i++ {
|
|
statusCode := http.StatusOK
|
|
if i < notFound {
|
|
statusCode = http.StatusNotFound
|
|
}
|
|
records = append(records, &model.OpenFlareAccessLog{
|
|
NodeID: "node-waf-auto",
|
|
LoggedAt: loggedAt.Add(-time.Duration(i%30) * time.Second),
|
|
RemoteAddr: remoteAddr,
|
|
Host: host,
|
|
Path: "/probe",
|
|
StatusCode: statusCode,
|
|
})
|
|
}
|
|
require.NoError(t, repository.InsertOpenFlareAccessLogsBatch(ctx, records))
|
|
}
|
|
|
|
func TestParseIPGroupAutoConfigLookback(t *testing.T) {
|
|
cases := []struct {
|
|
name string
|
|
raw string
|
|
want string
|
|
wantDur time.Duration
|
|
wantErr bool
|
|
}{
|
|
{name: "duration 60m", raw: `{"lookback":"60m","rules":[]}`, want: "1h", wantDur: time.Hour},
|
|
{name: "duration 1h", raw: `{"lookback":"1h","rules":[]}`, want: "1h", wantDur: time.Hour},
|
|
{name: "duration 30m", raw: `{"lookback":"30m","rules":[]}`, want: "30m", wantDur: 30 * time.Minute},
|
|
{name: "duration 1m no min floor", raw: `{"lookback":"1m","rules":[]}`, want: "1m", wantDur: time.Minute},
|
|
{name: "legacy minutes", raw: `{"lookback_minutes":45,"rules":[]}`, want: "45m", wantDur: 45 * time.Minute},
|
|
{name: "default empty", raw: `{"rules":[]}`, want: "1h", wantDur: time.Hour},
|
|
{name: "invalid", raw: `{"lookback":"abc","rules":[]}`, wantErr: true},
|
|
{name: "zero lookback uses default", raw: `{"lookback":"","rules":[]}`, want: "1h", wantDur: time.Hour},
|
|
}
|
|
for _, tc := range cases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
cfg, err := parseIPGroupAutoConfig(json.RawMessage(tc.raw))
|
|
if tc.wantErr {
|
|
if err == nil {
|
|
t.Fatalf("parseIPGroupAutoConfig(%s) error = nil, want error", tc.raw)
|
|
}
|
|
return
|
|
}
|
|
if err != nil {
|
|
t.Fatalf("parseIPGroupAutoConfig(%s) error = %v", tc.raw, err)
|
|
}
|
|
if cfg.Lookback != tc.want {
|
|
t.Errorf("Lookback = %q, want %q", cfg.Lookback, tc.want)
|
|
}
|
|
if cfg.lookbackDuration != tc.wantDur {
|
|
t.Errorf("lookbackDuration = %v, want %v", cfg.lookbackDuration, tc.wantDur)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestCountStatusMatchesSupportsClassTokens(t *testing.T) {
|
|
counts := map[int]int{
|
|
200: 10,
|
|
201: 5,
|
|
404: 20,
|
|
403: 10,
|
|
500: 4,
|
|
502: 1,
|
|
}
|
|
cases := []struct {
|
|
name string
|
|
code any
|
|
want int
|
|
}{
|
|
{name: "exact int", code: 404, want: 20},
|
|
{name: "exact string", code: "403", want: 10},
|
|
{name: "2xx class", code: "2xx", want: 15},
|
|
{name: "4xx class upper", code: "4XX", want: 30},
|
|
{name: "5xx class", code: "5xx", want: 5},
|
|
{name: "unknown class", code: "9xx", want: 0},
|
|
{name: "invalid token", code: "abc", want: 0},
|
|
{name: "float exact", code: float64(200), want: 10},
|
|
{name: "float non-int", code: 200.5, want: 0},
|
|
}
|
|
for _, tc := range cases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
got := countStatusMatches(counts, tc.code)
|
|
if got != tc.want {
|
|
t.Errorf("countStatusMatches(%v) = %d, want %d", tc.code, got, tc.want)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestStatusRatioClassTokenInExpr(t *testing.T) {
|
|
cleanup := setupIPGroupSyncTestDB(t)
|
|
defer cleanup()
|
|
ctx := context.Background()
|
|
|
|
now := time.Now().UTC()
|
|
// 100 requests, 80 of which are 404 → 4xx ratio 0.8
|
|
seedWAFAccessLogs(t, ctx, now, "203.0.113.40", "app.example.com", 100, 80)
|
|
// mostly OK → should not match
|
|
seedWAFAccessLogs(t, ctx, now, "203.0.113.41", "app.example.com", 100, 10)
|
|
|
|
result, err := TestIPGroupAutoConfig(ctx, IPGroupAutoTestInput{
|
|
AutoConfig: json.RawMessage(`{
|
|
"lookback": "60m",
|
|
"rules": [
|
|
{"name":"高 4xx 占比","expr":"request_count >= 100 && StatusRatio(\"4xx\") >= 0.8"}
|
|
]
|
|
}`),
|
|
})
|
|
require.NoError(t, err)
|
|
assert.Equal(t, 1, result.MatchedCount)
|
|
require.Len(t, result.MatchedIPs, 1)
|
|
assert.Equal(t, "203.0.113.40", result.MatchedIPs[0])
|
|
}
|