Skip to content

Commit 4a6756a

Browse files
ThomasK33ThomasK33
authored
fix: isolate test HTTP clients (#25038)
1 parent febabfb commit 4a6756a

8 files changed

Lines changed: 148 additions & 17 deletions

File tree

‎cli/agent_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ func TestWorkspaceAgent(t *testing.T) {
111111
t.Cleanup(func() {
112112
_ = provisionerCloser.Close()
113113
})
114-
client := codersdk.New(serverURL)
114+
client := codersdk.New(serverURL, codersdk.WithHTTPClient(coderdtest.NewIsolatedHTTPClient(serverURL)))
115115
t.Cleanup(func() {
116116
cancelFunc()
117117
_ = provisionerCloser.Close()

‎cli/root_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ func TestDERPHeaders(t *testing.T) {
217217
t.Cleanup(func() {
218218
_ = provisionerCloser.Close()
219219
})
220-
client := codersdk.New(serverURL)
220+
client := codersdk.New(serverURL, codersdk.WithHTTPClient(coderdtest.NewIsolatedHTTPClient(serverURL)))
221221
t.Cleanup(func() {
222222
cancelFunc()
223223
_ = provisionerCloser.Close()

‎cli/templateedit_test.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,7 @@ func TestTemplateEdit(t *testing.T) {
384384
// Create a new client that uses the proxy server.
385385
proxyURL, err := url.Parse(proxy.URL)
386386
require.NoError(t, err)
387-
proxyClient := codersdk.New(proxyURL)
387+
proxyClient := codersdk.New(proxyURL, codersdk.WithHTTPClient(coderdtest.NewIsolatedHTTPClient(proxyURL)))
388388
proxyClient.SetSessionToken(templateAdmin.SessionToken())
389389
t.Cleanup(proxyClient.HTTPClient.CloseIdleConnections)
390390

@@ -515,7 +515,7 @@ func TestTemplateEdit(t *testing.T) {
515515
// Create a new client that uses the proxy server.
516516
proxyURL, err := url.Parse(proxy.URL)
517517
require.NoError(t, err)
518-
proxyClient := codersdk.New(proxyURL)
518+
proxyClient := codersdk.New(proxyURL, codersdk.WithHTTPClient(coderdtest.NewIsolatedHTTPClient(proxyURL)))
519519
proxyClient.SetSessionToken(templateAdmin.SessionToken())
520520
t.Cleanup(proxyClient.HTTPClient.CloseIdleConnections)
521521

@@ -659,7 +659,7 @@ func TestTemplateEdit(t *testing.T) {
659659
// Create a new client that uses the proxy server.
660660
proxyURL, err := url.Parse(proxy.URL)
661661
require.NoError(t, err)
662-
proxyClient := codersdk.New(proxyURL)
662+
proxyClient := codersdk.New(proxyURL, codersdk.WithHTTPClient(coderdtest.NewIsolatedHTTPClient(proxyURL)))
663663
proxyClient.SetSessionToken(templateAdmin.SessionToken())
664664
t.Cleanup(proxyClient.HTTPClient.CloseIdleConnections)
665665

@@ -771,7 +771,7 @@ func TestTemplateEdit(t *testing.T) {
771771
// Create a new client that uses the proxy server.
772772
proxyURL, err := url.Parse(proxy.URL)
773773
require.NoError(t, err)
774-
proxyClient := codersdk.New(proxyURL)
774+
proxyClient := codersdk.New(proxyURL, codersdk.WithHTTPClient(coderdtest.NewIsolatedHTTPClient(proxyURL)))
775775
proxyClient.SetSessionToken(templateAdmin.SessionToken())
776776
t.Cleanup(proxyClient.HTTPClient.CloseIdleConnections)
777777

‎coderd/coderd_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ func TestDERPForceWebSockets(t *testing.T) {
184184
_ = provisionerCloser.Close()
185185
})
186186

187-
client := codersdk.New(serverURL)
187+
client := codersdk.New(serverURL, codersdk.WithHTTPClient(coderdtest.NewIsolatedHTTPClient(serverURL)))
188188
t.Cleanup(func() {
189189
client.HTTPClient.CloseIdleConnections()
190190
})

‎coderd/coderdtest/coderdtest.go‎

Lines changed: 46 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -669,7 +669,7 @@ func NewWithAPI(t testing.TB, options *Options) (*codersdk.Client, io.Closer, *c
669669
if options.IncludeProvisionerDaemon {
670670
provisionerCloser = NewTaggedProvisionerDaemon(t, coderAPI, defaultTestDaemonName, options.ProvisionerDaemonTags, coderd.MemoryProvisionerWithVersionOverride(options.ProvisionerDaemonVersion))
671671
}
672-
client := codersdk.New(serverURL)
672+
client := codersdk.New(serverURL, codersdk.WithHTTPClient(NewIsolatedHTTPClient(serverURL)))
673673
t.Cleanup(func() {
674674
cancelFunc()
675675
_ = provisionerCloser.Close()
@@ -679,6 +679,46 @@ func NewWithAPI(t testing.TB, options *Options) (*codersdk.Client, io.Closer, *c
679679
return client, provisionerCloser, coderAPI
680680
}
681681

682+
// NewIsolatedHTTPClient returns a test client with its own transport.
683+
// Closing idle connections at test cleanup must not close http.DefaultTransport
684+
// while another parallel test is using it.
685+
func NewIsolatedHTTPClient(serverURL *url.URL) *http.Client {
686+
transport := &http.Transport{Proxy: http.ProxyFromEnvironment}
687+
if defaultTransport, ok := http.DefaultTransport.(*http.Transport); ok {
688+
transport = defaultTransport.Clone()
689+
}
690+
if serverURL == nil || serverURL.Scheme != "https" {
691+
transport.TLSClientConfig = nil
692+
return &http.Client{Transport: transport}
693+
}
694+
if transport.TLSClientConfig == nil {
695+
transport.TLSClientConfig = &tls.Config{MinVersion: tls.VersionTLS12}
696+
}
697+
if transport.TLSClientConfig.MinVersion == 0 {
698+
transport.TLSClientConfig.MinVersion = tls.VersionTLS12
699+
}
700+
//nolint:gosec // The coderdtest server uses test-only TLS certificates.
701+
transport.TLSClientConfig.InsecureSkipVerify = true
702+
return &http.Client{Transport: transport}
703+
}
704+
705+
// newHTTPClientWithTransportFrom returns a fresh client that shares the base
706+
// transport without sharing mutable per-client state like CheckRedirect.
707+
func newHTTPClientWithTransportFrom(base *http.Client) *http.Client {
708+
if base == nil {
709+
return NewIsolatedHTTPClient(nil)
710+
}
711+
if base.Transport == nil {
712+
client := NewIsolatedHTTPClient(nil)
713+
client.Timeout = base.Timeout
714+
return client
715+
}
716+
return &http.Client{
717+
Transport: base.Transport,
718+
Timeout: base.Timeout,
719+
}
720+
}
721+
682722
// ProvisionerdCloser wraps a provisioner daemon as an io.Closer that can be called multiple times
683723
type ProvisionerdCloser struct {
684724
mu sync.Mutex
@@ -937,10 +977,11 @@ func createAnotherUserRetry(t testing.TB, client *codersdk.Client, organizationI
937977
require.NoError(t, err)
938978
}
939979

940-
other := codersdk.New(client.URL, codersdk.WithSessionToken(sessionToken))
941-
t.Cleanup(func() {
942-
other.HTTPClient.CloseIdleConnections()
943-
})
980+
other := codersdk.New(
981+
client.URL,
982+
codersdk.WithSessionToken(sessionToken),
983+
codersdk.WithHTTPClient(newHTTPClientWithTransportFrom(client.HTTPClient)),
984+
)
944985

945986
if len(roles) > 0 {
946987
// Find the roles for the org vs the site wide roles

‎coderd/coderdtest/httpclient_test.go‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
package coderdtest_test
2+
3+
import (
4+
"crypto/tls"
5+
"net/http"
6+
"testing"
7+
"time"
8+
9+
"github.com/stretchr/testify/require"
10+
11+
"github.com/coder/coder/v2/coderd/coderdtest"
12+
"github.com/coder/coder/v2/codersdk"
13+
"github.com/coder/coder/v2/testutil"
14+
)
15+
16+
func TestNewIsolatedHTTPClient(t *testing.T) {
17+
t.Parallel()
18+
19+
client := coderdtest.NewIsolatedHTTPClient(testutil.MustURL(t, "http://example.com"))
20+
require.NotNil(t, client.Transport)
21+
require.NotSame(t, http.DefaultTransport, client.Transport)
22+
23+
transport, ok := client.Transport.(*http.Transport)
24+
require.True(t, ok)
25+
require.Nil(t, transport.TLSClientConfig)
26+
}
27+
28+
func TestNewIsolatedHTTPSClient(t *testing.T) {
29+
t.Parallel()
30+
31+
client := coderdtest.NewIsolatedHTTPClient(testutil.MustURL(t, "https://example.com"))
32+
require.NotSame(t, http.DefaultTransport, client.Transport)
33+
34+
transport, ok := client.Transport.(*http.Transport)
35+
require.True(t, ok)
36+
require.NotNil(t, transport.TLSClientConfig)
37+
require.True(t, transport.TLSClientConfig.InsecureSkipVerify)
38+
require.Equal(t, uint16(tls.VersionTLS12), transport.TLSClientConfig.MinVersion)
39+
}
40+
41+
func TestNewIsolatedHTTPClientNilURL(t *testing.T) {
42+
t.Parallel()
43+
44+
client := coderdtest.NewIsolatedHTTPClient(nil)
45+
require.NotNil(t, client.Transport)
46+
require.NotSame(t, http.DefaultTransport, client.Transport)
47+
48+
transport, ok := client.Transport.(*http.Transport)
49+
require.True(t, ok)
50+
require.Nil(t, transport.TLSClientConfig)
51+
}
52+
53+
func TestCreateAnotherUserHTTPClient(t *testing.T) {
54+
t.Parallel()
55+
56+
client := coderdtest.New(t, nil)
57+
first := coderdtest.CreateFirstUser(t, client)
58+
client.HTTPClient.CheckRedirect = func(*http.Request, []*http.Request) error {
59+
return http.ErrUseLastResponse
60+
}
61+
62+
other, _ := coderdtest.CreateAnotherUser(t, client, first.OrganizationID)
63+
64+
require.NotSame(t, client.HTTPClient, other.HTTPClient)
65+
require.Same(t, client.HTTPClient.Transport, other.HTTPClient.Transport)
66+
require.Nil(t, other.HTTPClient.CheckRedirect)
67+
}
68+
69+
func TestCreateAnotherUserHTTPClientDefaultTransport(t *testing.T) {
70+
t.Parallel()
71+
72+
client := coderdtest.New(t, nil)
73+
first := coderdtest.CreateFirstUser(t, client)
74+
base := codersdk.New(
75+
client.URL,
76+
codersdk.WithSessionToken(client.SessionToken()),
77+
codersdk.WithHTTPClient(&http.Client{Timeout: time.Second}),
78+
)
79+
80+
other, _ := coderdtest.CreateAnotherUser(t, base, first.OrganizationID)
81+
82+
require.NotSame(t, base.HTTPClient, other.HTTPClient)
83+
require.NotNil(t, other.HTTPClient.Transport)
84+
require.NotSame(t, http.DefaultTransport, other.HTTPClient.Transport)
85+
require.Equal(t, base.HTTPClient.Timeout, other.HTTPClient.Timeout)
86+
}

‎coderd/workspaces_scoped_test.go‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,11 @@ func TestCompositeWorkspaceScopes(t *testing.T) {
6363
})
6464
require.NoError(t, err, "creating scoped token")
6565

66-
scoped := codersdk.New(adminClient.URL, codersdk.WithSessionToken(resp.Key))
66+
scoped := codersdk.New(
67+
adminClient.URL,
68+
codersdk.WithSessionToken(resp.Key),
69+
codersdk.WithHTTPClient(coderdtest.NewIsolatedHTTPClient(adminClient.URL)),
70+
)
6771
t.Cleanup(func() { scoped.HTTPClient.CloseIdleConnections() })
6872
return scoped
6973
}

‎enterprise/cli/boundary_test.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ func TestBoundaryLicenseVerification(t *testing.T) {
118118

119119
proxyURL, err := url.Parse(proxy.URL)
120120
require.NoError(t, err)
121-
proxyClient := codersdk.New(proxyURL)
121+
proxyClient := codersdk.New(proxyURL, codersdk.WithHTTPClient(coderdtest.NewIsolatedHTTPClient(proxyURL)))
122122
proxyClient.SetSessionToken(client.SessionToken())
123123
t.Cleanup(proxyClient.HTTPClient.CloseIdleConnections)
124124

@@ -182,7 +182,7 @@ func TestBoundaryLicenseVerification(t *testing.T) {
182182

183183
proxyURL, err := url.Parse(proxy.URL)
184184
require.NoError(t, err)
185-
proxyClient := codersdk.New(proxyURL)
185+
proxyClient := codersdk.New(proxyURL, codersdk.WithHTTPClient(coderdtest.NewIsolatedHTTPClient(proxyURL)))
186186
proxyClient.SetSessionToken(client.SessionToken())
187187
t.Cleanup(proxyClient.HTTPClient.CloseIdleConnections)
188188

@@ -219,7 +219,7 @@ func TestBoundaryLicenseVerification(t *testing.T) {
219219

220220
proxyURL, err := url.Parse(proxy.URL)
221221
require.NoError(t, err)
222-
proxyClient := codersdk.New(proxyURL)
222+
proxyClient := codersdk.New(proxyURL, codersdk.WithHTTPClient(coderdtest.NewIsolatedHTTPClient(proxyURL)))
223223
proxyClient.SetSessionToken(client.SessionToken())
224224
t.Cleanup(proxyClient.HTTPClient.CloseIdleConnections)
225225

@@ -286,7 +286,7 @@ func TestBoundaryChildProcessSkipsCheck(t *testing.T) {
286286

287287
proxyURL, err := url.Parse(proxy.URL)
288288
require.NoError(t, err)
289-
proxyClient := codersdk.New(proxyURL)
289+
proxyClient := codersdk.New(proxyURL, codersdk.WithHTTPClient(coderdtest.NewIsolatedHTTPClient(proxyURL)))
290290
proxyClient.SetSessionToken(client.SessionToken())
291291
t.Cleanup(proxyClient.HTTPClient.CloseIdleConnections)
292292

0 commit comments

Comments
 (0)