/* Copyright 2023 The Kubernetes Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package plugin import ( "context" "fmt" "net" "os" "path/filepath" "sync" "testing" "github.com/stretchr/testify/assert" "google.golang.org/grpc" drapbv1alpha2 "k8s.io/kubelet/pkg/apis/dra/v1alpha2" drapbv1alpha3 "k8s.io/kubelet/pkg/apis/dra/v1alpha3" ) type fakeV1alpha3GRPCServer struct { drapbv1alpha3.UnimplementedNodeServer } func (f *fakeV1alpha3GRPCServer) NodePrepareResource(ctx context.Context, in *drapbv1alpha3.NodePrepareResourcesRequest) (*drapbv1alpha3.NodePrepareResourcesResponse, error) { return &drapbv1alpha3.NodePrepareResourcesResponse{Claims: map[string]*drapbv1alpha3.NodePrepareResourceResponse{"dummy": {CDIDevices: []string{"dummy"}}}}, nil } func (f *fakeV1alpha3GRPCServer) NodeUnprepareResource(ctx context.Context, in *drapbv1alpha3.NodeUnprepareResourcesRequest) (*drapbv1alpha3.NodeUnprepareResourcesResponse, error) { return &drapbv1alpha3.NodeUnprepareResourcesResponse{}, nil } func (f *fakeV1alpha3GRPCServer) NodeListAndWatchResources(req *drapbv1alpha3.NodeListAndWatchResourcesRequest, srv drapbv1alpha3.Node_NodeListAndWatchResourcesServer) error { if err := srv.Send(&drapbv1alpha3.NodeListAndWatchResourcesResponse{}); err != nil { return err } if err := srv.Send(&drapbv1alpha3.NodeListAndWatchResourcesResponse{}); err != nil { return err } return nil } type fakeV1alpha2GRPCServer struct { drapbv1alpha2.UnimplementedNodeServer } func (f *fakeV1alpha2GRPCServer) NodePrepareResource(ctx context.Context, in *drapbv1alpha2.NodePrepareResourceRequest) (*drapbv1alpha2.NodePrepareResourceResponse, error) { return &drapbv1alpha2.NodePrepareResourceResponse{CdiDevices: []string{"dummy"}}, nil } func (f *fakeV1alpha2GRPCServer) NodeUnprepareResource(ctx context.Context, in *drapbv1alpha2.NodeUnprepareResourceRequest) (*drapbv1alpha2.NodeUnprepareResourceResponse, error) { return &drapbv1alpha2.NodeUnprepareResourceResponse{}, nil } type tearDown func() func setupFakeGRPCServer(version string) (string, tearDown, error) { p, err := os.MkdirTemp("", "dra_plugin") if err != nil { return "", nil, err } closeCh := make(chan struct{}) addr := filepath.Join(p, "server.sock") teardown := func() { close(closeCh) os.RemoveAll(addr) } listener, err := net.Listen("unix", addr) if err != nil { teardown() return "", nil, err } s := grpc.NewServer() switch version { case v1alpha2Version: fakeGRPCServer := &fakeV1alpha2GRPCServer{} drapbv1alpha2.RegisterNodeServer(s, fakeGRPCServer) case v1alpha3Version: fakeGRPCServer := &fakeV1alpha3GRPCServer{} drapbv1alpha3.RegisterNodeServer(s, fakeGRPCServer) default: return "", nil, fmt.Errorf("unsupported version: %s", version) } go func() { go s.Serve(listener) <-closeCh s.GracefulStop() }() return addr, teardown, nil } func TestGRPCConnIsReused(t *testing.T) { addr, teardown, err := setupFakeGRPCServer(v1alpha3Version) if err != nil { t.Fatal(err) } defer teardown() reusedConns := make(map[*grpc.ClientConn]int) wg := sync.WaitGroup{} m := sync.Mutex{} p := &plugin{ endpoint: addr, version: v1alpha3Version, } conn, err := p.getOrCreateGRPCConn() defer func() { err := conn.Close() if err != nil { t.Error(err) } }() if err != nil { t.Fatal(err) } // ensure the plugin we are using is registered draPlugins.add("dummy-plugin", p) defer draPlugins.delete("dummy-plugin") // we call `NodePrepareResource` 2 times and check whether a new connection is created or the same is reused for i := 0; i < 2; i++ { wg.Add(1) go func() { defer wg.Done() client, err := NewDRAPluginClient("dummy-plugin") if err != nil { t.Error(err) return } req := &drapbv1alpha3.NodePrepareResourcesRequest{ Claims: []*drapbv1alpha3.Claim{ { Namespace: "dummy-namespace", Uid: "dummy-uid", Name: "dummy-claim", ResourceHandle: "dummy-resource", }, }, } client.NodePrepareResources(context.TODO(), req) client.(*plugin).Lock() conn := client.(*plugin).conn client.(*plugin).Unlock() m.Lock() defer m.Unlock() reusedConns[conn]++ }() } wg.Wait() // We should have only one entry otherwise it means another gRPC connection has been created if len(reusedConns) != 1 { t.Errorf("expected length to be 1 but got %d", len(reusedConns)) } if counter, ok := reusedConns[conn]; ok && counter != 2 { t.Errorf("expected counter to be 2 but got %d", counter) } } func TestNewDRAPluginClient(t *testing.T) { for _, test := range []struct { description string setup func(string) tearDown pluginName string shouldError bool }{ { description: "plugin name is empty", setup: func(_ string) tearDown { return func() {} }, pluginName: "", shouldError: true, }, { description: "plugin name not found in the list", setup: func(_ string) tearDown { return func() {} }, pluginName: "plugin-name-not-found-in-the-list", shouldError: true, }, { description: "plugin exists", setup: func(name string) tearDown { draPlugins.add(name, &plugin{}) return func() { draPlugins.delete(name) } }, pluginName: "dummy-plugin", }, } { t.Run(test.description, func(t *testing.T) { teardown := test.setup(test.pluginName) defer teardown() client, err := NewDRAPluginClient(test.pluginName) if test.shouldError { assert.Nil(t, client) assert.Error(t, err) } else { assert.NotNil(t, client) assert.Nil(t, err) } }) } } func TestNodeUnprepareResource(t *testing.T) { for _, test := range []struct { description string serverSetup func(string) (string, tearDown, error) serverVersion string request *drapbv1alpha3.NodeUnprepareResourcesRequest }{ { description: "server supports v1alpha3", serverSetup: setupFakeGRPCServer, serverVersion: v1alpha3Version, request: &drapbv1alpha3.NodeUnprepareResourcesRequest{}, }, { description: "server supports v1alpha2, plugin client should fallback", serverSetup: setupFakeGRPCServer, serverVersion: v1alpha2Version, request: &drapbv1alpha3.NodeUnprepareResourcesRequest{ Claims: []*drapbv1alpha3.Claim{ { Namespace: "dummy-namespace", Uid: "dummy-uid", Name: "dummy-claim", ResourceHandle: "dummy-resource", }, }, }, }, } { t.Run(test.description, func(t *testing.T) { addr, teardown, err := setupFakeGRPCServer(test.serverVersion) if err != nil { t.Fatal(err) } defer teardown() p := &plugin{ endpoint: addr, version: v1alpha3Version, clientTimeout: PluginClientTimeout, } conn, err := p.getOrCreateGRPCConn() defer func() { err := conn.Close() if err != nil { t.Error(err) } }() if err != nil { t.Fatal(err) } draPlugins.add("dummy-plugin", p) defer draPlugins.delete("dummy-plugin") client, err := NewDRAPluginClient("dummy-plugin") if err != nil { t.Fatal(err) } _, err = client.NodeUnprepareResources(context.TODO(), test.request) if err != nil { t.Fatal(err) } }) } } func TestListAndWatchResources(t *testing.T) { for _, test := range []struct { description string serverSetup func(string) (string, tearDown, error) serverVersion string request *drapbv1alpha3.NodeListAndWatchResourcesRequest responses []*drapbv1alpha3.NodeListAndWatchResourcesResponse expectError string }{ { description: "server supports NodeResources API", serverSetup: setupFakeGRPCServer, serverVersion: v1alpha3Version, request: &drapbv1alpha3.NodeListAndWatchResourcesRequest{}, responses: []*drapbv1alpha3.NodeListAndWatchResourcesResponse{ {}, {}, }, expectError: "EOF", }, { description: "server doesn't support NodeResources API", serverSetup: setupFakeGRPCServer, serverVersion: v1alpha2Version, request: new(drapbv1alpha3.NodeListAndWatchResourcesRequest), expectError: "Unimplemented", }, } { t.Run(test.description, func(t *testing.T) { addr, teardown, err := setupFakeGRPCServer(test.serverVersion) if err != nil { t.Fatal(err) } defer teardown() p := &plugin{ endpoint: addr, version: v1alpha3Version, } conn, err := p.getOrCreateGRPCConn() defer func() { err := conn.Close() if err != nil { t.Error(err) } }() if err != nil { t.Fatal(err) } draPlugins.add("dummy-plugin", p) defer draPlugins.delete("dummy-plugin") client, err := NewDRAPluginClient("dummy-plugin") if err != nil { t.Fatal(err) } stream, err := client.NodeListAndWatchResources(context.Background(), test.request) if err != nil { t.Fatal(err) } var actualResponses []*drapbv1alpha3.NodeListAndWatchResourcesResponse var actualErr error for { resp, err := stream.Recv() if err != nil { actualErr = err break } actualResponses = append(actualResponses, resp) } assert.Equal(t, test.responses, actualResponses) assert.Contains(t, actualErr.Error(), test.expectError) }) } }