mirror of
https://github.com/coder/coder.git
synced 2026-06-02 20:48:20 +00:00
Cian Johnston
65b7658568
Follow-up to [review comment on #23025](https://github.com/coder/coder/pull/23025#discussion_r2930309487) from @mafredri. Extracts the repeated `logSink` / `fakeSink` test pattern into a shared `testutil.FakeSink` and migrates all existing call sites. > 🤖 This PR was created with the help of Coder Agents, and will be reviewed by my human. 🧑💻 --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
103 lines
3.4 KiB
Go
103 lines
3.4 KiB
Go
package backends_test
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"database/sql"
|
|
"encoding/json"
|
|
"net"
|
|
"net/http"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/fatih/structs"
|
|
"github.com/google/uuid"
|
|
"github.com/sqlc-dev/pqtype"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"cdr.dev/slog/v3"
|
|
"cdr.dev/slog/v3/sloggers/slogjson"
|
|
"github.com/coder/coder/v2/coderd/database"
|
|
"github.com/coder/coder/v2/enterprise/audit"
|
|
"github.com/coder/coder/v2/enterprise/audit/audittest"
|
|
"github.com/coder/coder/v2/enterprise/audit/backends"
|
|
"github.com/coder/coder/v2/testutil"
|
|
)
|
|
|
|
func TestSlogExporter(t *testing.T) {
|
|
t.Parallel()
|
|
t.Run("OK", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
var (
|
|
ctx, cancel = context.WithCancel(context.Background())
|
|
|
|
sink = testutil.NewFakeSink(t)
|
|
logger = sink.Logger(slog.LevelInfo)
|
|
exporter = backends.NewSlogExporter(logger)
|
|
|
|
alog = audittest.RandomLog()
|
|
)
|
|
defer cancel()
|
|
|
|
err := exporter.ExportStruct(ctx, alog, "audit_log")
|
|
require.NoError(t, err)
|
|
entries := sink.Entries()
|
|
require.Len(t, entries, 1)
|
|
require.Equal(t, entries[0].Message, "audit_log")
|
|
require.Len(t, entries[0].Fields, len(structs.Fields(alog)))
|
|
})
|
|
t.Run("FormatsCorrectly", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
var (
|
|
ctx, cancel = context.WithCancel(context.Background())
|
|
|
|
buf = bytes.NewBuffer(nil)
|
|
logger = slog.Make(slogjson.Sink(buf))
|
|
exporter = backends.NewSlogExporter(logger)
|
|
|
|
_, inet, _ = net.ParseCIDR("127.0.0.1/32")
|
|
alog = database.AuditLog{
|
|
ID: uuid.UUID{1},
|
|
Time: time.Unix(1257894000, 0).UTC(),
|
|
UserID: uuid.UUID{2},
|
|
OrganizationID: uuid.UUID{3},
|
|
Ip: pqtype.Inet{
|
|
IPNet: *inet,
|
|
Valid: true,
|
|
},
|
|
UserAgent: sql.NullString{String: "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4896.127 Safari/537.36", Valid: true},
|
|
ResourceType: database.ResourceTypeOrganization,
|
|
ResourceID: uuid.UUID{4},
|
|
ResourceTarget: "colin's organization",
|
|
ResourceIcon: "photo.png",
|
|
Action: database.AuditActionDelete,
|
|
Diff: []byte(`{"1": 2}`),
|
|
StatusCode: http.StatusNoContent,
|
|
AdditionalFields: []byte(`{"name":"doug","species":"cat"}`),
|
|
RequestID: uuid.UUID{5},
|
|
}
|
|
)
|
|
defer cancel()
|
|
|
|
err := exporter.ExportStruct(ctx, alog, "audit_log", slog.F("actor", &audit.Actor{
|
|
ID: uuid.UUID{2},
|
|
Username: "coadler",
|
|
Email: "doug@coder.com",
|
|
}))
|
|
require.NoError(t, err)
|
|
logger.Sync()
|
|
|
|
s := struct {
|
|
Fields json.RawMessage `json:"fields"`
|
|
}{}
|
|
err = json.Unmarshal(buf.Bytes(), &s)
|
|
require.NoError(t, err)
|
|
|
|
expected := `{"ID":"01000000-0000-0000-0000-000000000000","Time":"2009-11-10T23:00:00Z","UserID":"02000000-0000-0000-0000-000000000000","OrganizationID":"03000000-0000-0000-0000-000000000000","Ip":"127.0.0.1","UserAgent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4896.127 Safari/537.36","ResourceType":"organization","ResourceID":"04000000-0000-0000-0000-000000000000","ResourceTarget":"colin's organization","Action":"delete","Diff":{"1":2},"StatusCode":204,"AdditionalFields":{"name":"doug","species":"cat"},"RequestID":"05000000-0000-0000-0000-000000000000","ResourceIcon":"photo.png","actor":{"id":"02000000-0000-0000-0000-000000000000","email":"doug@coder.com","username":"coadler"}}`
|
|
assert.Equal(t, expected, string(s.Fields))
|
|
})
|
|
}
|