Skip to content

Commit 52a257e

Browse files
janardhanvissajanardhanvissa
authored
cleanup: replace dial with newclient (#7967)
1 parent d48317f commit 52a257e

15 files changed

+137
-124
lines changed

‎balancer_wrapper_test.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,11 @@ func (s) TestBalancer_StateListenerBeforeConnect(t *testing.T) {
7070
stub.Register(t.Name(), bf)
7171
svcCfg := fmt.Sprintf(`{ "loadBalancingConfig": [{%q: {}}] }`, t.Name())
7272

73-
cc, err := Dial("fake", WithTransportCredentials(insecure.NewCredentials()), WithDefaultServiceConfig(svcCfg))
73+
cc, err := NewClient("passthrough:///test.server", WithTransportCredentials(insecure.NewCredentials()), WithDefaultServiceConfig(svcCfg))
7474
if err != nil {
75-
t.Fatal("Error dialing:", err)
75+
t.Fatalf("grpc.NewClient() failed: %v", err)
7676
}
77+
cc.Connect()
7778
started.Fire()
7879

7980
// Wait for the LB policy to call NewSubConn and cc.Close.

‎clientconn_test.go

+70-63
Large diffs are not rendered by default.

‎examples/features/customloadbalancer/client/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ func main() {
6161

6262
cc, err := grpc.NewClient(mr.Scheme()+":///", grpc.WithResolvers(mr), grpc.WithTransportCredentials(insecure.NewCredentials()))
6363
if err != nil {
64-
log.Fatalf("Failed to dial: %v", err)
64+
log.Fatalf("grpc.NewClient() failed: %v", err)
6565
}
6666
defer cc.Close()
6767
ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)

‎resolver_test.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -120,13 +120,14 @@ func (s) TestResolverAddressesToEndpoints(t *testing.T) {
120120
a2 := attributes.New("a", "b")
121121
r.InitialState(resolver.State{Addresses: []resolver.Address{{Addr: "addr1", BalancerAttributes: a1}, {Addr: "addr2", BalancerAttributes: a2}}})
122122

123-
cc, err := Dial(r.Scheme()+":///",
123+
cc, err := NewClient(r.Scheme()+":///",
124124
WithTransportCredentials(insecure.NewCredentials()),
125125
WithResolvers(r),
126126
WithDefaultServiceConfig(fmt.Sprintf(`{"loadBalancingConfig": [{"%s":{}}]}`, balancerName)))
127127
if err != nil {
128-
t.Fatalf("Unexpected error dialing: %v", err)
128+
t.Fatalf("grpc.NewClient() failed: %v", err)
129129
}
130+
cc.Connect()
130131
defer cc.Close()
131132

132133
select {

‎test/clientconn_state_transition_test.go

+9-9
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ func (s) TestStateTransitions_ReadyToConnecting(t *testing.T) {
239239
conn.Close()
240240
}()
241241

242-
client, err := grpc.Dial(lis.Addr().String(),
242+
client, err := grpc.NewClient(lis.Addr().String(),
243243
grpc.WithTransportCredentials(insecure.NewCredentials()),
244244
grpc.WithDefaultServiceConfig(fmt.Sprintf(`{"loadBalancingConfig": [{"%s":{}}]}`, stateRecordingBalancerName)))
245245
if err != nil {
@@ -250,7 +250,7 @@ func (s) TestStateTransitions_ReadyToConnecting(t *testing.T) {
250250
ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
251251
defer cancel()
252252
go testutils.StayConnected(ctx, client)
253-
253+
testutils.AwaitNotState(ctx, t, client, connectivity.Idle)
254254
stateNotifications := testBalancerBuilder.nextStateNotifier()
255255

256256
want := []connectivity.State{
@@ -327,7 +327,7 @@ func (s) TestStateTransitions_TriesAllAddrsBeforeTransientFailure(t *testing.T)
327327
{Addr: lis1.Addr().String()},
328328
{Addr: lis2.Addr().String()},
329329
}})
330-
client, err := grpc.Dial("whatever:///this-gets-overwritten",
330+
client, err := grpc.NewClient("whatever:///this-gets-overwritten",
331331
grpc.WithTransportCredentials(insecure.NewCredentials()),
332332
grpc.WithDefaultServiceConfig(fmt.Sprintf(`{"loadBalancingConfig": [{"%s":{}}]}`, stateRecordingBalancerName)),
333333
grpc.WithConnectParams(grpc.ConnectParams{
@@ -342,7 +342,7 @@ func (s) TestStateTransitions_TriesAllAddrsBeforeTransientFailure(t *testing.T)
342342
t.Fatal(err)
343343
}
344344
defer client.Close()
345-
345+
client.Connect()
346346
stateNotifications := testBalancerBuilder.nextStateNotifier()
347347
want := []connectivity.State{
348348
connectivity.Connecting,
@@ -430,15 +430,15 @@ func (s) TestStateTransitions_MultipleAddrsEntersReady(t *testing.T) {
430430
{Addr: lis1.Addr().String()},
431431
{Addr: lis2.Addr().String()},
432432
}})
433-
client, err := grpc.Dial("whatever:///this-gets-overwritten",
433+
client, err := grpc.NewClient("whatever:///this-gets-overwritten",
434434
grpc.WithTransportCredentials(insecure.NewCredentials()),
435435
grpc.WithDefaultServiceConfig(fmt.Sprintf(`{"loadBalancingConfig": [{"%s":{}}]}`, stateRecordingBalancerName)),
436436
grpc.WithResolvers(rb))
437437
if err != nil {
438438
t.Fatal(err)
439439
}
440440
defer client.Close()
441-
441+
client.Connect()
442442
ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
443443
defer cancel()
444444
go testutils.StayConnected(ctx, client)
@@ -574,15 +574,15 @@ func (s) TestConnectivityStateSubscriber(t *testing.T) {
574574
// Create the ClientConn.
575575
const testResName = "any"
576576
rb := manual.NewBuilderWithScheme(testResName)
577-
cc, err := grpc.Dial(testResName+":///",
577+
cc, err := grpc.NewClient(testResName+":///",
578578
grpc.WithResolvers(rb),
579579
grpc.WithDefaultServiceConfig(fmt.Sprintf(`{"loadBalancingConfig": [{"%s":{}}]}`, testBalName)),
580580
grpc.WithTransportCredentials(insecure.NewCredentials()),
581581
)
582582
if err != nil {
583-
t.Fatalf("Unexpected error from grpc.Dial: %v", err)
583+
t.Fatalf("grpc.NewClient() failed: %v", err)
584584
}
585-
585+
cc.Connect()
586586
// Subscribe to state updates. Use a buffer size of 1 to allow the
587587
// Shutdown state to go into the channel when Close()ing.
588588
connCh := make(chan connectivity.State, 1)

‎test/goaway_test.go

+4-7
Original file line numberDiff line numberDiff line change
@@ -591,17 +591,14 @@ func (s) TestGoAwayThenClose(t *testing.T) {
591591
{Addr: lis1.Addr().String()},
592592
{Addr: lis2.Addr().String()},
593593
}})
594-
cc, err := grpc.DialContext(ctx, r.Scheme()+":///", grpc.WithResolvers(r), grpc.WithTransportCredentials(insecure.NewCredentials()))
594+
cc, err := grpc.NewClient(r.Scheme()+":///", grpc.WithResolvers(r), grpc.WithTransportCredentials(insecure.NewCredentials()))
595595
if err != nil {
596596
t.Fatalf("Error creating client: %v", err)
597597
}
598598
defer cc.Close()
599599

600600
client := testgrpc.NewTestServiceClient(cc)
601601

602-
t.Log("Waiting for the ClientConn to enter READY state.")
603-
testutils.AwaitState(ctx, t, cc, connectivity.Ready)
604-
605602
// We make a streaming RPC and do an one-message-round-trip to make sure
606603
// it's created on connection 1.
607604
//
@@ -674,12 +671,12 @@ func (s) TestGoAwayStreamIDSmallerThanCreatedStreams(t *testing.T) {
674671
ctCh.Send(ct)
675672
}()
676673

677-
cc, err := grpc.Dial(lis.Addr().String(), grpc.WithTransportCredentials(insecure.NewCredentials()))
674+
cc, err := grpc.NewClient(lis.Addr().String(), grpc.WithTransportCredentials(insecure.NewCredentials()))
678675
if err != nil {
679-
t.Fatalf("error dialing: %v", err)
676+
t.Fatalf("grpc.NewClient(%q) = %v", lis.Addr().String(), err)
680677
}
681678
defer cc.Close()
682-
679+
cc.Connect()
683680
ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
684681
defer cancel()
685682

‎test/gracefulstop_test.go

+4-6
Original file line numberDiff line numberDiff line change
@@ -138,21 +138,19 @@ func (s) TestGracefulStop(t *testing.T) {
138138

139139
<-dlis.closeCalled // Block until GracefulStop calls dlis.Close()
140140

141-
// Dial the server. This will cause a connection to be accepted. This will
142-
// also unblock the Close method .
143-
ctx, dialCancel := context.WithTimeout(context.Background(), defaultTestTimeout)
144-
defer dialCancel()
145141
dialer := func(ctx context.Context, _ string) (net.Conn, error) { return dlis.Dial(ctx) }
146-
cc, err := grpc.DialContext(ctx, "", grpc.WithTransportCredentials(insecure.NewCredentials()), grpc.WithContextDialer(dialer))
142+
cc, err := grpc.NewClient("passthrough:///", grpc.WithTransportCredentials(insecure.NewCredentials()), grpc.WithContextDialer(dialer))
147143
if err != nil {
148-
t.Fatalf("grpc.DialContext(_, %q, _) = %v", lis.Addr().String(), err)
144+
t.Fatalf("grpc.NewClient(%q) = %v", lis.Addr().String(), err)
149145
}
150146
client := testgrpc.NewTestServiceClient(cc)
151147
defer cc.Close()
152148

153149
// 4. Make an RPC.
154150
// The server would send a GOAWAY first, but we are delaying the server's
155151
// writes for now until the client writes more than the preface.
152+
// This will cause a connection to be accepted. This will
153+
// also unblock the Close method.
156154
ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
157155
if _, err = client.FullDuplexCall(ctx); err == nil || status.Code(err) != codes.Unavailable {
158156
t.Fatalf("FullDuplexCall= _, %v; want _, <status code Unavailable>", err)

‎test/retry_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -635,7 +635,7 @@ func (s) TestRetryStats(t *testing.T) {
635635
}
636636
}]}`)))
637637
if err != nil {
638-
t.Fatalf("failed to dial due to err: %v", err)
638+
t.Fatalf("grpc.NewClient(%q) = %v", lis.Addr().String(), err)
639639
}
640640
defer cc.Close()
641641

‎test/xds/xds_client_federation_test.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ func (s) TestClientSideFederation(t *testing.T) {
138138
// Create a ClientConn and make a successful RPC.
139139
cc, err := grpc.NewClient(fmt.Sprintf("xds:///%s", serviceName), grpc.WithTransportCredentials(insecure.NewCredentials()), grpc.WithResolvers(resolver))
140140
if err != nil {
141-
t.Fatalf("failed to dial local test server: %v", err)
141+
t.Fatalf("grpc.NewClient() failed: %v", err)
142142
}
143143
defer cc.Close()
144144

@@ -234,7 +234,7 @@ func (s) TestClientSideFederationWithOnlyXDSTPStyleLDS(t *testing.T) {
234234
// Create a ClientConn and make a successful RPC.
235235
cc, err := grpc.NewClient(fmt.Sprintf("xds:///%s", serviceName), grpc.WithTransportCredentials(insecure.NewCredentials()), grpc.WithResolvers(resolver))
236236
if err != nil {
237-
t.Fatalf("failed to dial local test server: %v", err)
237+
t.Fatalf("grpc.NewClient() failed: %v", err)
238238
}
239239
defer cc.Close()
240240

@@ -278,7 +278,7 @@ func (s) TestFederation_UnknownAuthorityInDialTarget(t *testing.T) {
278278
target := fmt.Sprintf("xds:///%s", serviceName)
279279
cc, err := grpc.NewClient(target, grpc.WithTransportCredentials(insecure.NewCredentials()), grpc.WithResolvers(xdsResolver))
280280
if err != nil {
281-
t.Fatalf("Dialing target %q: %v", target, err)
281+
t.Fatalf("grpc.NewClient() failed %q: %v", target, err)
282282
}
283283
defer cc.Close()
284284
t.Log("Created ClientConn to test service")
@@ -333,7 +333,7 @@ func (s) TestFederation_UnknownAuthorityInReceivedResponse(t *testing.T) {
333333
target := fmt.Sprintf("xds:///%s", serviceName)
334334
cc, err := grpc.NewClient(target, grpc.WithTransportCredentials(insecure.NewCredentials()), grpc.WithResolvers(xdsResolver))
335335
if err != nil {
336-
t.Fatalf("Dialing target %q: %v", target, err)
336+
t.Fatalf("grpc.NewClient() failed %q: %v", target, err)
337337
}
338338
defer cc.Close()
339339
t.Log("Created ClientConn to test service")

‎test/xds/xds_security_config_nack_test.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -191,9 +191,9 @@ func (s) TestUnmarshalListener_WithUpdateValidatorFunc(t *testing.T) {
191191
}
192192

193193
// Create a ClientConn with the xds scheme and make an RPC.
194-
cc, err := grpc.DialContext(ctx, fmt.Sprintf("xds:///%s", serviceName), grpc.WithTransportCredentials(creds), grpc.WithResolvers(xdsResolver))
194+
cc, err := grpc.NewClient(fmt.Sprintf("xds:///%s", serviceName), grpc.WithTransportCredentials(creds), grpc.WithResolvers(xdsResolver))
195195
if err != nil {
196-
t.Fatalf("failed to dial local test server: %v", err)
196+
t.Fatalf("grpc.NewClient() failed: %v", err)
197197
}
198198
defer cc.Close()
199199

@@ -359,7 +359,7 @@ func (s) TestUnmarshalCluster_WithUpdateValidatorFunc(t *testing.T) {
359359

360360
cc, err := grpc.NewClient(fmt.Sprintf("xds:///%s", serviceName), grpc.WithTransportCredentials(insecure.NewCredentials()), grpc.WithResolvers(xdsResolver))
361361
if err != nil {
362-
t.Fatalf("failed to dial local test server: %v", err)
362+
t.Fatalf("grpc.NewClient() failed: %v", err)
363363
}
364364
defer cc.Close()
365365

‎test/xds/xds_server_rbac_test.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -245,9 +245,9 @@ func (s) TestServerSideXDS_RouteConfiguration(t *testing.T) {
245245
t.Fatal(err)
246246
}
247247

248-
cc, err := grpc.DialContext(ctx, fmt.Sprintf("xds:///%s", serviceName), grpc.WithTransportCredentials(insecure.NewCredentials()), grpc.WithResolvers(xdsResolver))
248+
cc, err := grpc.NewClient(fmt.Sprintf("xds:///%s", serviceName), grpc.WithTransportCredentials(insecure.NewCredentials()), grpc.WithResolvers(xdsResolver))
249249
if err != nil {
250-
t.Fatalf("failed to dial local test server: %v", err)
250+
t.Fatalf("grpc.NewClient() failed: %v", err)
251251
}
252252
defer cc.Close()
253253

@@ -678,9 +678,9 @@ func (s) TestRBACHTTPFilter(t *testing.T) {
678678
t.Fatal(err)
679679
}
680680

681-
cc, err := grpc.DialContext(ctx, fmt.Sprintf("xds:///%s", serviceName), grpc.WithTransportCredentials(insecure.NewCredentials()), grpc.WithResolvers(xdsResolver))
681+
cc, err := grpc.NewClient(fmt.Sprintf("xds:///%s", serviceName), grpc.WithTransportCredentials(insecure.NewCredentials()), grpc.WithResolvers(xdsResolver))
682682
if err != nil {
683-
t.Fatalf("failed to dial local test server: %v", err)
683+
t.Fatalf("grpc.NewClient() failed: %v", err)
684684
}
685685
defer cc.Close()
686686

@@ -860,9 +860,9 @@ func (s) TestRBACToggledOn_WithBadRouteConfiguration(t *testing.T) {
860860
t.Fatal(err)
861861
}
862862

863-
cc, err := grpc.DialContext(ctx, fmt.Sprintf("xds:///%s", serviceName), grpc.WithTransportCredentials(insecure.NewCredentials()), grpc.WithResolvers(xdsResolver))
863+
cc, err := grpc.NewClient(fmt.Sprintf("xds:///%s", serviceName), grpc.WithTransportCredentials(insecure.NewCredentials()), grpc.WithResolvers(xdsResolver))
864864
if err != nil {
865-
t.Fatalf("failed to dial local test server: %v", err)
865+
t.Fatalf("grpc.NewClient() failed: %v", err)
866866
}
867867
defer cc.Close()
868868

‎test/xds/xds_server_serving_mode_test.go

+12-8
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import (
2626
"time"
2727

2828
"google.golang.org/grpc"
29+
"google.golang.org/grpc/codes"
2930
"google.golang.org/grpc/connectivity"
3031
"google.golang.org/grpc/credentials"
3132
"google.golang.org/grpc/credentials/insecure"
@@ -34,6 +35,7 @@ import (
3435
"google.golang.org/grpc/internal/testutils"
3536
"google.golang.org/grpc/internal/testutils/xds/e2e"
3637
"google.golang.org/grpc/internal/testutils/xds/e2e/setup"
38+
"google.golang.org/grpc/status"
3739
"google.golang.org/grpc/xds"
3840

3941
v3listenerpb "github.com/envoyproxy/go-control-plane/envoy/config/listener/v3"
@@ -247,15 +249,15 @@ func (s) TestServerSideXDS_ServingModeChanges(t *testing.T) {
247249
// Create a ClientConn to the first listener and make a successful RPCs.
248250
cc1, err := grpc.NewClient(lis1.Addr().String(), grpc.WithTransportCredentials(insecure.NewCredentials()))
249251
if err != nil {
250-
t.Fatalf("failed to dial local test server: %v", err)
252+
t.Fatalf("grpc.NewClient() failed: %v", err)
251253
}
252254
defer cc1.Close()
253255
waitForSuccessfulRPC(ctx, t, cc1)
254256

255257
// Create a ClientConn to the second listener and make a successful RPCs.
256258
cc2, err := grpc.NewClient(lis2.Addr().String(), grpc.WithTransportCredentials(insecure.NewCredentials()))
257259
if err != nil {
258-
t.Fatalf("failed to dial local test server: %v", err)
260+
t.Fatalf("grpc.NewClient() failed: %v", err)
259261
}
260262
defer cc2.Close()
261263
waitForSuccessfulRPC(ctx, t, cc2)
@@ -309,12 +311,14 @@ func (s) TestServerSideXDS_ServingModeChanges(t *testing.T) {
309311
waitForFailedRPC(ctx, t, cc1)
310312
waitForFailedRPC(ctx, t, cc2)
311313

312-
// Make sure new connection attempts to "not-serving" servers fail. We use a
313-
// short timeout since we expect this to fail.
314-
sCtx, sCancel := context.WithTimeout(ctx, defaultTestShortTimeout)
315-
defer sCancel()
316-
if _, err := grpc.DialContext(sCtx, lis1.Addr().String(), grpc.WithBlock(), grpc.WithTransportCredentials(insecure.NewCredentials())); err == nil {
317-
t.Fatal("successfully created clientConn to a server in \"not-serving\" state")
314+
// Make sure new connection attempts to "not-serving" servers fail.
315+
if cc1, err = grpc.NewClient(lis1.Addr().String(), grpc.WithTransportCredentials(insecure.NewCredentials())); err != nil {
316+
t.Fatal("Failed to create clientConn to a server in \"not-serving\" state")
317+
}
318+
defer cc1.Close()
319+
320+
if _, err := testgrpc.NewTestServiceClient(cc1).FullDuplexCall(ctx); status.Code(err) != codes.Unavailable {
321+
t.Fatalf("FullDuplexCall failed with status code: %v, want: Unavailable", status.Code(err))
318322
}
319323

320324
// Update the management server with both listener resources.

‎xds/internal/balancer/cdsbalancer/cdsbalancer_security_test.go

+5-4
Original file line numberDiff line numberDiff line change
@@ -167,10 +167,11 @@ func setupForSecurityTests(t *testing.T, bootstrapContents []byte, clientCreds,
167167
r.InitialState(state)
168168

169169
// Create a ClientConn with the specified transport credentials.
170-
cc, err := grpc.Dial(r.Scheme()+":///test.service", grpc.WithTransportCredentials(clientCreds), grpc.WithResolvers(r))
170+
cc, err := grpc.NewClient(r.Scheme()+":///test.service", grpc.WithTransportCredentials(clientCreds), grpc.WithResolvers(r))
171171
if err != nil {
172-
t.Fatalf("Failed to dial local test server: %v", err)
172+
t.Fatalf("grpc.NewClient() failed: %v", err)
173173
}
174+
cc.Connect()
174175
t.Cleanup(func() { cc.Close() })
175176

176177
// Start a test service backend with the specified transport credentials.
@@ -563,7 +564,7 @@ func (s) TestSecurityConfigUpdate_BadToGood(t *testing.T) {
563564
ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout)
564565
defer cancel()
565566
if err := mgmtServer.Update(ctx, resources); err != nil {
566-
t.Fatal(err)
567+
t.Fatalf("Failed to update management server with initial resources: %v", err)
567568
}
568569

569570
testutils.AwaitState(ctx, t, cc, connectivity.TransientFailure)
@@ -578,7 +579,7 @@ func (s) TestSecurityConfigUpdate_BadToGood(t *testing.T) {
578579
SkipValidation: true,
579580
}
580581
if err := mgmtServer.Update(ctx, resources); err != nil {
581-
t.Fatal(err)
582+
t.Fatalf("Failed to update management server with valid resources: %v", err)
582583
}
583584

584585
// Verify that a successful RPC can be made over a secure connection.

0 commit comments

Comments
 (0)