From 7ffdba76366d63e51ff7006685018d41f1934664 Mon Sep 17 00:00:00 2001
From: Danielle Lancashire <dani@hashicorp.com>
Date: Tue, 18 Feb 2020 17:08:00 +0100
Subject: [PATCH] plugins/csi: Implement ConvtrollerValidateCapabilities RPC

---
 plugins/csi/client.go      | 39 ++++++++++++++++++++++++++++++++++++++
 plugins/csi/fake/client.go | 12 ++++++++++++
 plugins/csi/plugin.go      |  4 ++++
 3 files changed, 55 insertions(+)

diff --git a/plugins/csi/client.go b/plugins/csi/client.go
index f51429a26..00d3df9fe 100644
--- a/plugins/csi/client.go
+++ b/plugins/csi/client.go
@@ -274,6 +274,45 @@ func (c *client) ControllerUnpublishVolume(ctx context.Context, req *ControllerU
 	return &ControllerUnpublishVolumeResponse{}, nil
 }
 
+func (c *client) ControllerValidateCapabilties(ctx context.Context, volumeID string, capabilities *VolumeCapability) error {
+	if c == nil {
+		return fmt.Errorf("Client not initialized")
+	}
+	if c.controllerClient == nil {
+		return fmt.Errorf("controllerClient not initialized")
+	}
+
+	if volumeID == "" {
+		return fmt.Errorf("missing VolumeID")
+	}
+
+	if capabilities == nil {
+		return fmt.Errorf("missing Capabilities")
+	}
+
+	req := &csipbv1.ValidateVolumeCapabilitiesRequest{
+		VolumeId: volumeID,
+		VolumeCapabilities: []*csipbv1.VolumeCapability{
+			capabilities.ToCSIRepresentation(),
+		},
+	}
+
+	resp, err := c.controllerClient.ValidateVolumeCapabilities(ctx, req)
+	if err != nil {
+		return err
+	}
+
+	if resp.Confirmed == nil {
+		if resp.Message != "" {
+			return fmt.Errorf("Volume validation failed, message: %s", resp.Message)
+		}
+
+		return fmt.Errorf("Volume validation failed")
+	}
+
+	return nil
+}
+
 //
 // Node Endpoints
 //
diff --git a/plugins/csi/fake/client.go b/plugins/csi/fake/client.go
index b72782126..3809f9333 100644
--- a/plugins/csi/fake/client.go
+++ b/plugins/csi/fake/client.go
@@ -48,6 +48,9 @@ type Client struct {
 	NextControllerUnpublishVolumeErr      error
 	ControllerUnpublishVolumeCallCount    int64
 
+	NextControllerValidateVolumeErr   error
+	ControllerValidateVolumeCallCount int64
+
 	NextNodeGetCapabilitiesResponse *csi.NodeCapabilitySet
 	NextNodeGetCapabilitiesErr      error
 	NodeGetCapabilitiesCallCount    int64
@@ -153,6 +156,15 @@ func (c *Client) ControllerUnpublishVolume(ctx context.Context, req *csi.Control
 	return c.NextControllerUnpublishVolumeResponse, c.NextControllerUnpublishVolumeErr
 }
 
+func (c *Client) ControllerValidateCapabilties(ctx context.Context, volumeID string, capabilities *csi.VolumeCapability) error {
+	c.Mu.Lock()
+	defer c.Mu.Unlock()
+
+	c.ControllerValidateVolumeCallCount++
+
+	return c.NextControllerValidateVolumeErr
+}
+
 func (c *Client) NodeGetCapabilities(ctx context.Context) (*csi.NodeCapabilitySet, error) {
 	c.Mu.Lock()
 	defer c.Mu.Unlock()
diff --git a/plugins/csi/plugin.go b/plugins/csi/plugin.go
index 26c7227e7..c38198241 100644
--- a/plugins/csi/plugin.go
+++ b/plugins/csi/plugin.go
@@ -40,6 +40,10 @@ type CSIPlugin interface {
 	// ControllerUnpublishVolume is used to deattach a remote volume from a cluster node.
 	ControllerUnpublishVolume(ctx context.Context, req *ControllerUnpublishVolumeRequest) (*ControllerUnpublishVolumeResponse, error)
 
+	// ControllerValidateCapabilities is used to validate that a volume exists and
+	// supports the requested capability.
+	ControllerValidateCapabilties(ctx context.Context, volumeID string, capabilities *VolumeCapability) error
+
 	// NodeGetCapabilities is used to return the available capabilities from the
 	// Node Service.
 	NodeGetCapabilities(ctx context.Context) (*NodeCapabilitySet, error)