synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-12 00:14:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(cli): refactor TestServer/Prometheus to use testutil.Eventually (#17295)

Browse Source 
Updates https://github.com/coder/internal/issues/282

Refactors existing tests to use `testutil.Eventually` which plays nicer
with `testutil.Context`.
This commit is contained in:
Cian Johnston
2025-04-08 16:53:22 +01:00
committed by GitHub
parent 44ddc9f654
commit 389e88ec82
1 changed files with 46 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
cli/server_test.go
View File

@ -1208,7 +1208,7 @@ func TestServer(t *testing.T) {
}
}
return htmlFirstServedFound
}, testutil.WaitMedium, testutil.IntervalFast, "no html_first_served telemetry item")
}, testutil.WaitLong, testutil.IntervalSlow, "no html_first_served telemetry item")
})
t.Run("Prometheus", func(t *testing.T) {
t.Parallel()
@ -1216,9 +1216,7 @@ func TestServer(t *testing.T) {
t.Run("DBMetricsDisabled", func(t *testing.T) {
t.Parallel()
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
defer cancel()
ctx := testutil.Context(t, testutil.WaitLong)
randPort := testutil.RandomPort(t)
inv, cfg := clitest.New(t,
"server",
@ -1235,46 +1233,45 @@ func TestServer(t *testing.T) {
clitest.Start(t, inv)
_ = waitAccessURL(t, cfg)
var res *http.Response
require.Eventually(t, func() bool {
req, err := http.NewRequestWithContext(ctx, "GET", fmt.Sprintf("http://127.0.0.1:%d", randPort), nil)
assert.NoError(t, err)
// nolint:bodyclose
res, err = http.DefaultClient.Do(req)
testutil.Eventually(ctx, t, func(ctx context.Context) bool {
req, err := http.NewRequestWithContext(ctx, "GET", fmt.Sprintf("http://127.0.0.1:%d/metrics", randPort), nil)
if err != nil {
t.Logf("error creating request: %s", err.Error())
return false
}
// nolint:bodyclose
res, err := http.DefaultClient.Do(req)
if err != nil {
t.Logf("error hitting prometheus endpoint: %s", err.Error())
return false
}
defer res.Body.Close()
scanner := bufio.NewScanner(res.Body)
hasActiveUsers := false
var activeUsersFound bool
var scannedOnce bool
for scanner.Scan() {
line := scanner.Text()
if !scannedOnce {
t.Logf("scanned: %s", line) // avoid spamming logs
scannedOnce = true
}
if strings.HasPrefix(line, "coderd_db_query_latencies_seconds") {
t.Errorf("db metrics should not be tracked when --prometheus-collect-db-metrics is not enabled")
}
// This metric is manually registered to be tracked in the server. That's
// why we test it's tracked here.
if strings.HasPrefix(scanner.Text(), "coderd_api_active_users_duration_hour") {
hasActiveUsers = true
continue
if strings.HasPrefix(line, "coderd_api_active_users_duration_hour") {
activeUsersFound = true
}
if strings.HasPrefix(scanner.Text(), "coderd_db_query_latencies_seconds") {
t.Fatal("db metrics should not be tracked when --prometheus-collect-db-metrics is not enabled")
}
t.Logf("scanned %s", scanner.Text())
}
if scanner.Err() != nil {
t.Logf("scanner err: %s", scanner.Err().Error())
return false
}
return hasActiveUsers
}, testutil.WaitShort, testutil.IntervalFast, "didn't find coderd_api_active_users_duration_hour in time")
return activeUsersFound
}, testutil.IntervalSlow, "didn't find coderd_api_active_users_duration_hour in time")
})
t.Run("DBMetricsEnabled", func(t *testing.T) {
t.Parallel()
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
defer cancel()
ctx := testutil.Context(t, testutil.WaitLong)
randPort := testutil.RandomPort(t)
inv, cfg := clitest.New(t,
"server",
@ -1291,31 +1288,34 @@ func TestServer(t *testing.T) {
clitest.Start(t, inv)
_ = waitAccessURL(t, cfg)
var res *http.Response
require.Eventually(t, func() bool {
req, err := http.NewRequestWithContext(ctx, "GET", fmt.Sprintf("http://127.0.0.1:%d", randPort), nil)
assert.NoError(t, err)
// nolint:bodyclose
res, err = http.DefaultClient.Do(req)
testutil.Eventually(ctx, t, func(ctx context.Context) bool {
req, err := http.NewRequestWithContext(ctx, "GET", fmt.Sprintf("http://127.0.0.1:%d/metrics", randPort), nil)
if err != nil {
t.Logf("error creating request: %s", err.Error())
return false
}
// nolint:bodyclose
res, err := http.DefaultClient.Do(req)
if err != nil {
t.Logf("error hitting prometheus endpoint: %s", err.Error())
return false
}
defer res.Body.Close()
scanner := bufio.NewScanner(res.Body)
hasDBMetrics := false
var dbMetricsFound bool
var scannedOnce bool
for scanner.Scan() {
if strings.HasPrefix(scanner.Text(), "coderd_db_query_latencies_seconds") {
hasDBMetrics = true
line := scanner.Text()
if !scannedOnce {
t.Logf("scanned: %s", line) // avoid spamming logs
scannedOnce = true
}
t.Logf("scanned %s", scanner.Text())
if strings.HasPrefix(line, "coderd_db_query_latencies_seconds") {
dbMetricsFound = true
}
if scanner.Err() != nil {
t.Logf("scanner err: %s", scanner.Err().Error())
return false
}
return hasDBMetrics
}, testutil.WaitShort, testutil.IntervalFast, "didn't find coderd_db_query_latencies_seconds in time")
return dbMetricsFound
}, testutil.IntervalSlow, "didn't find coderd_db_query_latencies_seconds in time")
})
})
t.Run("GitHubOAuth", func(t *testing.T) {