Skip to content

Commit

Permalink
Merge pull request #7601 from tinyspeck/am_testutil_multiple_vtctlds
Browse files Browse the repository at this point in the history 
[vtadmin/testutil] Add testutil helper to manage the complexity of recursively calling WithTestServer
  • Loading branch information
@rohit-nayak-ps
rohit-nayak-ps authored Mar 4, 2021
2 parents 87db98d + c678b0e commit 49b29d1
Show file tree
Hide file tree
Showing 2 changed files with 94 additions and 56 deletions.
113 changes: 57 additions & 56 deletions go/vt/vtadmin/api_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -367,40 +367,44 @@ func TestGetKeyspaces(t *testing.T) {
},
}

ctx := context.Background()

for _, tt := range tests {
// Note that these test cases were written prior to the existence of
// WithTestServers, so they are all written with the assumption that
// there are exactly 2 clusters.
topos := []*topo.Server{
memorytopo.NewServer("c0_cell1"),
memorytopo.NewServer("c1_cell1"),
}

for cdx, cks := range tt.clusterKeyspaces {
for _, ks := range cks {
testutil.AddKeyspace(context.Background(), t, topos[cdx], ks)
testutil.AddKeyspace(ctx, t, topos[cdx], ks)
}
}

for cdx, css := range tt.clusterShards {
testutil.AddShards(context.Background(), t, topos[cdx], css...)
testutil.AddShards(ctx, t, topos[cdx], css...)
}

// Setting up WithTestServer in a generic, recursive way is... unpleasant,
// so all tests are set-up and run in the context of these two clusters.
testutil.WithTestServer(t, grpcvtctldserver.NewVtctldServer(topos[0]), func(t *testing.T, cluster0Client vtctldclient.VtctldClient) {
testutil.WithTestServer(t, grpcvtctldserver.NewVtctldServer(topos[1]), func(t *testing.T, cluster1Client vtctldclient.VtctldClient) {
clusterClients := []vtctldclient.VtctldClient{cluster0Client, cluster1Client}
servers := []vtctlservicepb.VtctldServer{
grpcvtctldserver.NewVtctldServer(topos[0]),
grpcvtctldserver.NewVtctldServer(topos[1]),
}

clusters := []*cluster.Cluster{
vtadmintestutil.BuildCluster(0, clusterClients[0], nil, nil),
vtadmintestutil.BuildCluster(1, clusterClients[1], nil, nil),
}
testutil.WithTestServers(t, func(t *testing.T, clients ...vtctldclient.VtctldClient) {
clusters := []*cluster.Cluster{
vtadmintestutil.BuildCluster(0, clients[0], nil, nil),
vtadmintestutil.BuildCluster(1, clients[1], nil, nil),
}

api := NewAPI(clusters, grpcserver.Options{}, http.Options{})
resp, err := api.GetKeyspaces(context.Background(), tt.req)
require.NoError(t, err)
api := NewAPI(clusters, grpcserver.Options{}, http.Options{})
resp, err := api.GetKeyspaces(ctx, tt.req)
require.NoError(t, err)

vtadmintestutil.AssertKeyspaceSlicesEqual(t, tt.expected.Keyspaces, resp.Keyspaces)
})
})
vtadmintestutil.AssertKeyspaceSlicesEqual(t, tt.expected.Keyspaces, resp.Keyspaces)
}, servers...)
}
}

Expand Down Expand Up @@ -1052,7 +1056,12 @@ func TestGetSchemas(t *testing.T) {
},
}

ctx := context.Background()

for _, tt := range tests {
// Note that these test cases were written prior to the existence of
// WithTestServers, so they are all written with the assumption that
// there are exactly 2 clusters.
tt := tt

t.Run(tt.name, func(t *testing.T) {
Expand All @@ -1079,51 +1088,43 @@ func TestGetSchemas(t *testing.T) {
}),
}

// Setting up WithTestServer in a generic, recursive way is... unpleasant,
// so all tests are set-up and run in the context of these two clusters.
testutil.WithTestServer(t, vtctlds[0], func(t *testing.T, cluster0Client vtctldclient.VtctldClient) {
testutil.WithTestServer(t, vtctlds[1], func(t *testing.T, cluster1Client vtctldclient.VtctldClient) {
// Put 'em in a slice so we can look them up by index
clusterClients := []vtctldclient.VtctldClient{cluster0Client, cluster1Client}

// Build the clusters
clusters := make([]*cluster.Cluster, len(topos))
for cdx, toposerver := range topos {
// Handle when a test doesn't define any tablets for a given cluster.
var cts []*vtadminpb.Tablet
if cdx < len(tt.clusterTablets) {
cts = tt.clusterTablets[cdx]
}
testutil.WithTestServers(t, func(t *testing.T, clients ...vtctldclient.VtctldClient) {
clusters := make([]*cluster.Cluster, len(topos))
for cdx, toposerver := range topos {
// Handle when a test doesn't define any tablets for a given cluster.
var cts []*vtadminpb.Tablet
if cdx < len(tt.clusterTablets) {
cts = tt.clusterTablets[cdx]
}

for _, tablet := range cts {
// AddTablet also adds the keyspace + shard for us.
testutil.AddTablet(context.Background(), t, toposerver, tablet.Tablet, nil)

// Adds each SchemaDefinition to the fake TabletManagerClient, or nil
// if there are no schemas for that tablet. (All tablet aliases must
// exist in the map. Otherwise, TabletManagerClient will return an error when
// looking up the schema with tablet alias that doesn't exist.)
alias := topoproto.TabletAliasString(tablet.Tablet.Alias)
tmc.GetSchemaResults[alias] = struct {
Schema *tabletmanagerdatapb.SchemaDefinition
Error error
}{
Schema: tt.tabletSchemas[alias],
Error: nil,
}
for _, tablet := range cts {
// AddTablet also adds the keyspace + shard for us.
testutil.AddTablet(ctx, t, toposerver, tablet.Tablet, nil)

// Adds each SchemaDefinition to the fake TabletManagerClient, or nil
// if there are no schemas for that tablet. (All tablet aliases must
// exist in the map. Otherwise, TabletManagerClient will return an error when
// looking up the schema with tablet alias that doesn't exist.)
alias := topoproto.TabletAliasString(tablet.Tablet.Alias)
tmc.GetSchemaResults[alias] = struct {
Schema *tabletmanagerdatapb.SchemaDefinition
Error error
}{
Schema: tt.tabletSchemas[alias],
Error: nil,
}

clusters[cdx] = vtadmintestutil.BuildCluster(cdx, clusterClients[cdx], cts, nil)
}

api := NewAPI(clusters, grpcserver.Options{}, http.Options{})
clusters[cdx] = vtadmintestutil.BuildCluster(cdx, clients[cdx], cts, nil)
}

api := NewAPI(clusters, grpcserver.Options{}, http.Options{})

resp, err := api.GetSchemas(context.Background(), tt.req)
require.NoError(t, err)
resp, err := api.GetSchemas(ctx, tt.req)
require.NoError(t, err)

vtadmintestutil.AssertSchemaSlicesEqual(t, tt.expected.Schemas, resp.Schemas, tt.name)
})
})
vtadmintestutil.AssertSchemaSlicesEqual(t, tt.expected.Schemas, resp.Schemas, tt.name)
}, vtctlds...)
})
}
}
Expand Down
37 changes: 37 additions & 0 deletions go/vt/vtctl/grpcvtctldserver/testutil/util.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,43 @@ func WithTestServer(
test(t, client)
}

// WithTestServers creates N gRPC servers listening locally with the given RPC
// implementations, and then runs the test func with N clients created, where
// clients[i] points at servers[i].
func WithTestServers(
t *testing.T,
test func(t *testing.T, clients ...vtctldclient.VtctldClient),
servers ...vtctlservicepb.VtctldServer,
) {
// Declare our recursive helper function so it can refer to itself.
var withTestServers func(t *testing.T, servers ...vtctlservicepb.VtctldServer)

// Preallocate a slice of clients we're eventually going to call the test
// function with.
clients := make([]vtctldclient.VtctldClient, 0, len(servers))

withTestServers = func(t *testing.T, servers ...vtctlservicepb.VtctldServer) {
if len(servers) == 0 {
// We've started up all the test servers and accumulated clients for
// each of them (or there were no test servers to start, and we've
// accumulated no clients), so finally we run the test and stop
// recursing.
test(t, clients...)

return
}

// Start up a test server for the head of our server slice, accumulate
// the resulting client, and recurse on the tail of our server slice.
WithTestServer(t, servers[0], func(t *testing.T, client vtctldclient.VtctldClient) {
clients = append(clients, client)
withTestServers(t, servers[1:]...)
})
}

withTestServers(t, servers...)
}

// AddKeyspace adds a keyspace to a topology, failing a test if that keyspace
// could not be added. It shallow copies the proto struct to prevent XXX_ fields
// from changing in the marshalling.
Expand Down

0 comments on commit 49b29d1

Please sign in to comment.