shishantbiswas/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-06-07 15:08:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: extract testutil.FakeSink for slog test assertions (#23208)

Browse Source 
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>
This commit is contained in:
Cian Johnston
2026-03-18 17:02:38 +00:00
committed by GitHub
parent 2577d16af2
commit 65b7658568
6 changed files with 314 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files
coderd/httpapi/websocket_internal_test.go
+11 -38
View File
@@ -4,7 +4,6 @@ import (
"context"
"net/http"
"net/http/httptest"
"sync"
"testing"
"time"
@@ -17,32 +16,6 @@ import (
"github.com/coder/websocket"
)
// logSink captures log entries so tests can assert on log levels.
type logSink struct {
mu sync.Mutex
entries []slog.SinkEntry
}
func (s *logSink) LogEntry(_ context.Context, e slog.SinkEntry) {
s.mu.Lock()
defer s.mu.Unlock()
s.entries = append(s.entries, e)
}
func (*logSink) Sync() {}
func (s *logSink) entriesAtLevel(level slog.Level) []slog.SinkEntry {
s.mu.Lock()
defer s.mu.Unlock()
var result []slog.SinkEntry
for _, e := range s.entries {
if e.Level == level {
result = append(result, e)
}
}
return result
}
// websocketPair sets up an httptest server with a websocket endpoint and
// returns the server-side conn. The server handler stays alive until ctx
// is done.
@@ -85,8 +58,8 @@ func TestHeartbeatClose(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)
sink := &logSink{}
logger := slog.Make(sink).Leveled(slog.LevelDebug)
sink := testutil.NewFakeSink(t)
logger := sink.Logger()
mClock := quartz.NewMock(t)
// Trap ticker creation so we can synchronize startup.
@@ -119,10 +92,10 @@ func TestHeartbeatClose(t *testing.T) {
// A closed connection is a normal shutdown condition. The
// error should be logged at Debug, not Error.
errorEntries := sink.entriesAtLevel(slog.LevelError)
errorEntries := sink.Entries(func(e slog.SinkEntry) bool { return e.Level == slog.LevelError })
assert.Empty(t, errorEntries,
"closed connection should not produce error-level logs, got: %+v", errorEntries)
debugEntries := sink.entriesAtLevel(slog.LevelDebug)
debugEntries := sink.Entries(func(e slog.SinkEntry) bool { return e.Level == slog.LevelDebug })
assert.NotEmpty(t, debugEntries,
"expected a debug-level log entry for the closed connection")
})
@@ -131,8 +104,8 @@ func TestHeartbeatClose(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)
sink := &logSink{}
logger := slog.Make(sink).Leveled(slog.LevelDebug)
sink := testutil.NewFakeSink(t)
logger := sink.Logger()
mClock := quartz.NewMock(t)
trap := mClock.Trap().NewTicker("HeartbeatClose")
@@ -161,7 +134,7 @@ func TestHeartbeatClose(t *testing.T) {
t.Fatal("timed out waiting for heartbeatClose to return")
}
errorEntries := sink.entriesAtLevel(slog.LevelError)
errorEntries := sink.Entries(func(e slog.SinkEntry) bool { return e.Level == slog.LevelError })
assert.Empty(t, errorEntries,
"context cancellation should not produce error-level logs, got: %+v", errorEntries)
})
@@ -170,8 +143,8 @@ func TestHeartbeatClose(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)
sink := &logSink{}
logger := slog.Make(sink).Leveled(slog.LevelDebug)
sink := testutil.NewFakeSink(t)
logger := sink.Logger()
mClock := quartz.NewMock(t)
trap := mClock.Trap().NewTicker("HeartbeatClose")
@@ -200,10 +173,10 @@ func TestHeartbeatClose(t *testing.T) {
}
// No logs should be emitted during normal operation.
errorEntries := sink.entriesAtLevel(slog.LevelError)
errorEntries := sink.Entries(func(e slog.SinkEntry) bool { return e.Level == slog.LevelError })
assert.Empty(t, errorEntries,
"successful pings should not produce error-level logs, got: %+v", errorEntries)
debugEntries := sink.entriesAtLevel(slog.LevelDebug)
debugEntries := sink.Entries(func(e slog.SinkEntry) bool { return e.Level == slog.LevelDebug })
assert.Empty(t, debugEntries,
"successful pings should not produce debug-level logs, got: %+v", debugEntries)
})