[csi-manila] added csi-sanity tests

Gopkg.toml

@@ -92,6 +92,10 @@
 name = "github.com/kubernetes-csi/csi-lib-utils"
 source = "https://github.com/kubernetes-csi/csi-lib-utils"
 
+[[constraint]]
+  name = "github.com/kubernetes-csi/csi-test"
+  version = "v2.2.0"
+
 # Picked up from k/k Godeps/Godeps.json
 [[override]]
 name = "sigs.k8s.io/structured-merge-diff"

Makefile

@@ -137,9 +137,12 @@ unit: depend
 functional:
 	@echo "$@ not yet implemented"
 
-test-csi-sanity: depend
+test-cinder-csi-sanity: depend
 	go test $(GIT_HOST)/$(BASE_DIR)/pkg/csi/cinder/sanity/
 
+test-manila-csi-sanity: depend
+	go test $(GIT_HOST)/$(BASE_DIR)/pkg/csi/manila/sanity/
+
 fmt:
 	hack/verify-gofmt.sh
 

docs/developers-csi-manila.md

@@ -1,5 +1,12 @@
 # CSI Manila developer's guide
 
+## Running CSI Sanity tests
+
+Sanity tests create a real instance of driver with fake Manila client and CSI forwarding node plugin.
+See [Sanity check](https://github.com/kubernetes-csi/csi-test/tree/master/pkg/sanity) for more info.
+
+Run the test suite with `make test-manila-csi-sanity`.
+
 ## Share adapters
 
 A share adapter is an interface found here `pkg/csi/manila/shareadapters/shareadapter.go` that forms an adapter between a Manila share and a CSI plugin.

docs/using-cinder-csi-plugin.md

@@ -283,10 +283,10 @@ Filesystem      Size  Used Avail Use% Mounted on
 
 ## Running Sanity Tests
 
-Sanity tests creates a real instance of driver and fake cloud provider.
+Sanity tests create a real instance of driver and fake cloud provider.
 see [Sanity check](https://github.com/kubernetes-csi/csi-test/tree/master/pkg/sanity) for more info.
 ```
-$ make test-csi-sanity
+$ make test-cinder-csi-sanity
 ```
 
 ## Using CSC tool

pkg/csi/cinder/sanity/sanity_test.go

@@ -3,17 +3,24 @@ package sanity
 import (
 	"io/ioutil"
 	"os"
+	"path"
 	"testing"
 
 	"k8s.io/cloud-provider-openstack/pkg/csi/cinder"
 
 	"github.com/kubernetes-csi/csi-test/pkg/sanity"
 )
 
-//start sanity test for driver
+// start sanity test for driver
 func TestDriver(t *testing.T) {
+	basePath, err := ioutil.TempDir("", "cinder.csi.openstack.org")
+	if err != nil {
+		t.Fatal(err)
+	}
 
-	socket := "/tmp/csi.sock"
+	defer os.RemoveAll(basePath)
+
+	socket := path.Join(basePath, "csi.sock")
 	endpoint := "unix://" + socket
 	cluster := "kubernetes"
 	nodeID := "45678"
@@ -25,25 +32,13 @@ func TestDriver(t *testing.T) {
 
 	d.SetupDriver(c, fakemnt, fakemet)
 
-	//TODO: Stop call
+	// TODO: Stop call
 
 	go d.Run()
 
-	mntDir, err := ioutil.TempDir("", "mnt")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer os.RemoveAll(mntDir)
-
-	mntStageDir, err := ioutil.TempDir("", "mnt-stage")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer os.RemoveAll(mntStageDir)
-
 	config := &sanity.Config{
-		TargetPath:  mntDir,
-		StagingPath: mntStageDir,
+		TargetPath:  path.Join(basePath, "mnt"),
+		StagingPath: path.Join(basePath, "mnt-stage"),
 		Address:     endpoint,
 	}
 

pkg/csi/manila/controllerserver.go

@@ -33,6 +33,7 @@ import (
 	"k8s.io/cloud-provider-openstack/pkg/csi/manila/options"
 	"k8s.io/cloud-provider-openstack/pkg/csi/manila/responsebroker"
 	"k8s.io/cloud-provider-openstack/pkg/csi/manila/shareadapters"
+	clouderrors "k8s.io/cloud-provider-openstack/pkg/util/errors"
 	"k8s.io/klog"
 )
 
@@ -229,7 +230,7 @@ func (cs *controllerServer) CreateSnapshot(ctx context.Context, req *csi.CreateS
 	// Retrieve the source share
 
 	if sourceShare, res.err = manilaClient.GetShareByID(req.GetSourceVolumeId()); res.err != nil {
-		if isManilaErrNotFound(res.err) {
+		if clouderrors.IsNotFound(res.err) {
 			return nil, status.Errorf(codes.NotFound, "failed to create a snapshot (%s) for share %s because the share doesn't exist: %v", req.GetName(), req.GetSourceVolumeId(), err)
 		}
 
@@ -250,7 +251,7 @@ func (cs *controllerServer) CreateSnapshot(ctx context.Context, req *csi.CreateS
 			return nil, status.Errorf(codes.DeadlineExceeded, "deadline exceeded while waiting for snapshot %s of share %s to become available", snapshot.ID, req.GetSourceVolumeId())
 		}
 
-		if isManilaErrNotFound(res.err) {
+		if clouderrors.IsNotFound(res.err) {
 			return nil, status.Errorf(codes.NotFound, "failed to create a snapshot (%s) for share %s because the share doesn't exist: %v", req.GetName(), req.GetSourceVolumeId(), err)
 		}
 
@@ -370,7 +371,7 @@ func (cs *controllerServer) ValidateVolumeCapabilities(ctx context.Context, req
 
 	share, err := manilaClient.GetShareByID(req.GetVolumeId())
 	if err != nil {
-		if isManilaErrNotFound(err) {
+		if clouderrors.IsNotFound(err) {
 			return nil, status.Errorf(codes.NotFound, "share %s not found: %v", req.GetVolumeId(), err)
 		}
 

pkg/csi/manila/nodeserver.go

@@ -28,6 +28,7 @@ import (
 	"google.golang.org/grpc/status"
 	"k8s.io/cloud-provider-openstack/pkg/csi/manila/options"
 	"k8s.io/cloud-provider-openstack/pkg/csi/manila/shareadapters"
+	clouderrors "k8s.io/cloud-provider-openstack/pkg/util/errors"
 	"k8s.io/klog"
 )
 
@@ -61,12 +62,20 @@ func (ns *nodeServer) buildVolumeContext(volID volumeID, shareOpts *options.Node
 	if shareOpts.ShareID != "" {
 		share, err = manilaClient.GetShareByID(shareOpts.ShareID)
 		if err != nil {
-			return nil, nil, status.Errorf(codes.InvalidArgument, "failed to retrieve share %s: %v", shareOpts.ShareID, err)
+			if clouderrors.IsNotFound(err) {
+				return nil, nil, status.Errorf(codes.NotFound, "share %s not found: %v", shareOpts.ShareID, err)
+			}
+
+			return nil, nil, status.Errorf(codes.Internal, "failed to retrieve share %s: %v", shareOpts.ShareID, err)
 		}
 	} else {
 		share, err = manilaClient.GetShareByName(shareOpts.ShareName)
 		if err != nil {
-			return nil, nil, status.Errorf(codes.InvalidArgument, "failed to retrieve share named %s: %v", shareOpts.ShareName, err)
+			if clouderrors.IsNotFound(err) {
+				return nil, nil, status.Errorf(codes.NotFound, "no share named %s found: %v", shareOpts.ShareName, err)
+			}
+
+			return nil, nil, status.Errorf(codes.Internal, "failed to retrieve share named %s: %v", shareOpts.ShareName, err)
 		}
 	}
 

pkg/csi/manila/sanity/fake-secrets.yaml

@@ -0,0 +1,49 @@
+CreateVolumeSecret:
+  os-authURL: fake-url
+  os-region: fake-region
+  os-userID: fake-user-id
+  os-password: fake-password
+  os-domainID: fake-domain-id
+  os-projectID: fake-project-id
+DeleteVolumeSecret:
+  os-authURL: fake-url
+  os-region: fake-region
+  os-userID: fake-user-id
+  os-password: fake-password
+  os-domainID: fake-domain-id
+  os-projectID: fake-project-id
+CreateSnapshotSecret:
+  os-authURL: fake-url
+  os-region: fake-region
+  os-userID: fake-user-id
+  os-password: fake-password
+  os-domainID: fake-domain-id
+  os-projectID: fake-project-id
+DeleteSnapshotSecret:
+  os-authURL: fake-url
+  os-region: fake-region
+  os-userID: fake-user-id
+  os-password: fake-password
+  os-domainID: fake-domain-id
+  os-projectID: fake-project-id
+ControllerValidateVolumeCapabilitiesSecret:
+  os-authURL: fake-url
+  os-region: fake-region
+  os-userID: fake-user-id
+  os-password: fake-password
+  os-domainID: fake-domain-id
+  os-projectID: fake-project-id
+NodeStageVolumeSecret:
+  os-authURL: fake-url
+  os-region: fake-region
+  os-userID: fake-user-id
+  os-password: fake-password
+  os-domainID: fake-domain-id
+  os-projectID: fake-project-id
+NodePublishVolumeSecret:
+  os-authURL: fake-url
+  os-region: fake-region
+  os-userID: fake-user-id
+  os-password: fake-password
+  os-domainID: fake-domain-id
+  os-projectID: fake-project-id

pkg/csi/manila/sanity/fakecsiclient.go

@@ -0,0 +1,85 @@
+/*
+Copyright 2019 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 sanity
+
+import (
+	"context"
+	"time"
+
+	"github.com/container-storage-interface/spec/lib/go/csi"
+	"google.golang.org/grpc"
+	"k8s.io/cloud-provider-openstack/pkg/csi/manila/csiclient"
+)
+
+type fakeIdentitySvcClient struct{}
+
+func (c fakeIdentitySvcClient) GetPluginInfo(context.Context) (*csi.GetPluginInfoResponse, error) {
+	return &csi.GetPluginInfoResponse{
+		Name:          "fake-fwd-driver",
+		VendorVersion: "1.0.0",
+	}, nil
+}
+
+func (c fakeIdentitySvcClient) ProbeForever(*grpc.ClientConn, time.Duration) error { return nil }
+
+type fakeNodeSvcClient struct{}
+
+func (c fakeNodeSvcClient) GetCapabilities(context.Context) (*csi.NodeGetCapabilitiesResponse, error) {
+	return &csi.NodeGetCapabilitiesResponse{
+		Capabilities: []*csi.NodeServiceCapability{
+			{
+				Type: &csi.NodeServiceCapability_Rpc{
+					Rpc: &csi.NodeServiceCapability_RPC{
+						Type: csi.NodeServiceCapability_RPC_STAGE_UNSTAGE_VOLUME,
+					},
+				},
+			},
+		},
+	}, nil
+}
+
+func (c fakeNodeSvcClient) StageVolume(context.Context, *csi.NodeStageVolumeRequest) (*csi.NodeStageVolumeResponse, error) {
+	return &csi.NodeStageVolumeResponse{}, nil
+}
+
+func (c fakeNodeSvcClient) UnstageVolume(context.Context, *csi.NodeUnstageVolumeRequest) (*csi.NodeUnstageVolumeResponse, error) {
+	return &csi.NodeUnstageVolumeResponse{}, nil
+}
+
+func (c fakeNodeSvcClient) PublishVolume(context.Context, *csi.NodePublishVolumeRequest) (*csi.NodePublishVolumeResponse, error) {
+	return &csi.NodePublishVolumeResponse{}, nil
+}
+
+func (c fakeNodeSvcClient) UnpublishVolume(context.Context, *csi.NodeUnpublishVolumeRequest) (*csi.NodeUnpublishVolumeResponse, error) {
+	return &csi.NodeUnpublishVolumeResponse{}, nil
+}
+
+type fakeCSIClientBuilder struct{}
+
+func (b fakeCSIClientBuilder) NewConnection(string) (*grpc.ClientConn, error) { return nil, nil }
+
+func (b fakeCSIClientBuilder) NewConnectionWithContext(context.Context, string) (*grpc.ClientConn, error) {
+	return nil, nil
+}
+
+func (b fakeCSIClientBuilder) NewNodeServiceClient(conn *grpc.ClientConn) csiclient.Node {
+	return &fakeNodeSvcClient{}
+}
+
+func (b fakeCSIClientBuilder) NewIdentityServiceClient(conn *grpc.ClientConn) csiclient.Identity {
+	return &fakeIdentitySvcClient{}
+}