opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-10-16 14:48:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

test(cli): bind GitHub OAuth tests to loopback (#28980)

Browse Source 
On macOS, the Coder test server listening on all addresses could share a
port with another test’s loopback listener. Go enables `SO_REUSEADDR` by
default, allowing overlapping addresses such as `[::]:61025` and
`127.0.0.1:61025`. The OAuth test’s SDK connects to `127.0.0.1:61025`,
so its requests could reach the other server and report GitHub
authentication as disabled despite the intended server being correctly
configured.

Bind the GitHub OAuth default-provider tests to `127.0.0.1:0`, matching
the SDK’s address and preventing this overlap. Remove the retries
introduced in #28358 and #28622: they were unnecessary to fix the flake.

To test this fix, I had an agent connect to a live GitHub macOS runner
with [wush](https://github.com/coder/wush), reproduce the flake, and
verify the new changes actually resolve it.

Refs
https://linear.app/codercom/issue/ENG-3285/flake-testserveroauth2githubdefaultprovidernewdeployment

<sub>Generated by Coder Agents on behalf of @hugodutka.</sub>
This commit is contained in:
Hugo Dutka
2026-09-07 13:09:14 +00:00
committed by GitHub
parent 60f1582239
commit 1ecb834300
1 changed files with 11 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cli/server_test.go
+11 -21
View File
@@ -397,18 +397,6 @@ func TestServer(t *testing.T) {
createUserPostRestart bool
}
waitAuthMethods := func(t *testing.T, ctx context.Context, client *codersdk.Client, expected codersdk.GithubAuthMethod) codersdk.AuthMethods {
t.Helper()
var authMethods codersdk.AuthMethods
testutil.Eventually(ctx, t, func(ctx context.Context) bool {
var err error
authMethods, err = client.AuthMethods(ctx)
return err == nil && authMethods.Github == expected
}, testutil.IntervalFast, "github auth method did not reach expected state: %+v", expected)
return authMethods
}
runGitHubProviderTest := func(t *testing.T, tc testCase) {
t.Parallel()
@@ -426,7 +414,8 @@ func TestServer(t *testing.T) {
args := []string{
"server",
"--postgres-url", dbURL,
"--http-address", ":0",
// Match the client's loopback address to avoid overlapping wildcard listeners on macOS.
"--http-address", "127.0.0.1:0",
"--access-url", "https://example.com",
}
if tc.githubClientID != "" {
@@ -463,12 +452,11 @@ func TestServer(t *testing.T) {
}
client := codersdk.New(accessURL)
expectedGithubAuthMethod := codersdk.GithubAuthMethod{
Enabled: tc.expectGithubEnabled,
DefaultProviderConfigured: tc.expectGithubDefaultProviderConfigured,
}
authMethods := waitAuthMethods(t, ctx, client, expectedGithubAuthMethod)
require.Equal(t, expectedGithubAuthMethod, authMethods.Github)
authMethods, err := client.AuthMethods(ctx)
require.NoError(t, err)
require.Equal(t, tc.expectGithubEnabled, authMethods.Github.Enabled)
require.Equal(t, tc.expectGithubDefaultProviderConfigured, authMethods.Github.DefaultProviderConfigured)
cancelFunc()
select {
@@ -489,8 +477,10 @@ func TestServer(t *testing.T) {
client = codersdk.New(accessURL)
ctx = testutil.Context(t, testutil.WaitLong)
authMethods = waitAuthMethods(t, ctx, client, expectedGithubAuthMethod)
require.Equal(t, expectedGithubAuthMethod, authMethods.Github)
authMethods, err = client.AuthMethods(ctx)
require.NoError(t, err)
require.Equal(t, tc.expectGithubEnabled, authMethods.Github.Enabled)
require.Equal(t, tc.expectGithubDefaultProviderConfigured, authMethods.Github.DefaultProviderConfigured)
}
for _, tc := range []testCase{