Add experimental javascript hooks

Author: tsmetana

cmd/mock-driver/main.go

@@ -18,6 +18,7 @@ package main
 import (
 	"flag"
 	"fmt"
+	"io/ioutil"
 	"net"
 	"os"
 	"os/signal"
@@ -26,17 +27,20 @@ import (
 
 	"github.com/kubernetes-csi/csi-test/v3/driver"
 	"github.com/kubernetes-csi/csi-test/v3/mock/service"
+	"gopkg.in/yaml.v2"
 )
 
 func main() {
 	var config service.Config
+	var hooksFile string = ""
 	flag.BoolVar(&config.DisableAttach, "disable-attach", false, "Disables RPC_PUBLISH_UNPUBLISH_VOLUME capability.")
 	flag.StringVar(&config.DriverName, "name", service.Name, "CSI driver name.")
 	flag.Int64Var(&config.AttachLimit, "attach-limit", 2, "number of attachable volumes on a node")
 	flag.BoolVar(&config.NodeExpansionRequired, "node-expand-required", false, "Enables NodeServiceCapability_RPC_EXPAND_VOLUME capacity.")
 	flag.BoolVar(&config.DisableControllerExpansion, "disable-controller-expansion", false, "Disables ControllerServiceCapability_RPC_EXPAND_VOLUME capability.")
 	flag.BoolVar(&config.DisableOnlineExpansion, "disable-online-expansion", false, "Disables online volume expansion capability.")
 	flag.BoolVar(&config.PermissiveTargetPath, "permissive-target-path", false, "Allows the CO to create PublishVolumeRequest.TargetPath, which violates the CSI spec.")
+	flag.StringVar(&hooksFile, "hooks-file", "", "JSON file with hook scripts.")
 	flag.Parse()
 
 	endpoint := os.Getenv("CSI_ENDPOINT")
@@ -46,6 +50,15 @@ func main() {
 		controllerEndpoint = endpoint
 	}
 
+	if hooksFile != "" {
+		execHooks, err := parseHooksFile(hooksFile)
+		if err == nil {
+			config.ExecHooks = execHooks
+		} else {
+			fmt.Printf("Failed to load hooks file %s: %v", hooksFile, err)
+		}
+	}
+
 	// Create mock driver
 	s := service.New(config)
 
@@ -198,3 +211,20 @@ func listen(endpoint string) (net.Listener, func(), error) {
 	l, err := net.Listen(proto, addr)
 	return l, cleanup, err
 }
+
+func parseHooksFile(file string) (*service.Hooks, error) {
+	var hooks service.Hooks
+
+	fr, err := os.Open(file)
+	if err != nil {
+		return nil, err
+	}
+	defer fr.Close()
+	bytes, _ := ioutil.ReadAll(fr)
+	err = yaml.UnmarshalStrict([]byte(bytes), &hooks)
+	if err != nil {
+		return nil, err
+	}
+	fmt.Printf("Hooks file %s loaded\n", file)
+	return &hooks, err
+}

go.mod

@@ -10,11 +10,13 @@ require (
 	github.com/konsorten/go-windows-terminal-sequences v1.0.2 // indirect
 	github.com/onsi/ginkgo v1.10.3
 	github.com/onsi/gomega v1.7.1
+	github.com/robertkrimen/otto v0.0.0-20191219234010-c382bd3c16ff
 	github.com/sirupsen/logrus v1.4.2
 	golang.org/x/net v0.0.0-20191112182307-2180aed22343
 	golang.org/x/sys v0.0.0-20191113165036-4c7a9d0fe056 // indirect
 	golang.org/x/text v0.3.2 // indirect
 	google.golang.org/genproto v0.0.0-20191114150713-6bbd007550de // indirect
 	google.golang.org/grpc v1.25.1
+	gopkg.in/sourcemap.v1 v1.0.5 // indirect
 	gopkg.in/yaml.v2 v2.2.5
 )

go.sum

@@ -34,6 +34,8 @@ github.com/onsi/gomega v1.7.1/go.mod h1:XdKZgCCFLUoM/7CFJVPcG8C1xQ1AJ0vpAezJrB7J
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA=
+github.com/robertkrimen/otto v0.0.0-20191219234010-c382bd3c16ff h1:+6NUiITWwE5q1KO6SAfUX918c+Tab0+tGAM/mtdlUyA=
+github.com/robertkrimen/otto v0.0.0-20191219234010-c382bd3c16ff/go.mod h1:xvqspoSXJTIpemEonrMDFq6XzwHYYgToXWj5eRX1OtY=
 github.com/sirupsen/logrus v1.4.2 h1:SPIRibHv4MatM3XXNO2BJeFLZwZ2LvZgfQ5+UNI2im4=
 github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE=
 github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
@@ -86,6 +88,8 @@ gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/fsnotify.v1 v1.4.7 h1:xOHLXZwVvI9hhs+cLKq5+I5onOuwQLhQwiu63xxlHs4=
 gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys=
+gopkg.in/sourcemap.v1 v1.0.5 h1:inv58fC9f9J3TK2Y2R1NPntXEn3/wjWHkonhIUODNTI=
+gopkg.in/sourcemap.v1 v1.0.5/go.mod h1:2RlvNNSMglmRrcvhfuzp4hQHwOtjxlbjX7UPY/GXb78=
 gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 h1:uRGJdciOHaEIrze2W8Q3AKkepLTh2hOroT7a+7czfdQ=
 gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw=
 gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

mock/service/controller.go

@@ -31,7 +31,9 @@ func (s *service) CreateVolume(
 	if req.VolumeCapabilities == nil {
 		return nil, status.Error(codes.InvalidArgument, "Volume Capabilities cannot be empty")
 	}
-
+	if hookVal, hookMsg := s.execHook("CreateVolumeStart"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
 	// Check to see if the volume already exists.
 	if i, v := s.findVolByName(ctx, req.Name); i >= 0 {
 		// Requested volume name already exists, need to check if the existing volume's
@@ -96,6 +98,10 @@ func (s *service) CreateVolume(
 		TargetPath:      "",
 	}
 
+	if hookVal, hookMsg := s.execHook("CreateVolumeEnd"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	return &csi.CreateVolumeResponse{Volume: &v}, nil
 }
 
@@ -112,6 +118,10 @@ func (s *service) DeleteVolume(
 		return nil, status.Error(codes.InvalidArgument, "Volume ID cannot be empty")
 	}
 
+	if hookVal, hookMsg := s.execHook("DeleteVolumeStart"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	// If the volume does not exist then return an idempotent response.
 	i, _ := s.findVolNoLock("id", req.VolumeId)
 	if i < 0 {
@@ -125,6 +135,10 @@ func (s *service) DeleteVolume(
 	s.vols[len(s.vols)-1] = csi.Volume{}
 	s.vols = s.vols[:len(s.vols)-1]
 	log.WithField("volumeID", req.VolumeId).Debug("mock delete volume")
+
+	if hookVal, hookMsg := s.execHook("DeleteVolumeEnd"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
 	return &csi.DeleteVolumeResponse{}, nil
 }
 
@@ -151,6 +165,10 @@ func (s *service) ControllerPublishVolume(
 		return nil, status.Errorf(codes.NotFound, "Not matching Node ID %s to Mock Node ID %s", req.NodeId, s.nodeID)
 	}
 
+	if hookVal, hookMsg := s.execHook("ControllerPublishVolumeStart"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	s.volsRWL.Lock()
 	defer s.volsRWL.Unlock()
 
@@ -209,6 +227,10 @@ func (s *service) ControllerPublishVolume(
 	v.VolumeContext[ReadOnlyKey] = roVal
 	s.vols[i] = v
 
+	if hookVal, hookMsg := s.execHook("ControllerPublishVolumeEnd"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	return &csi.ControllerPublishVolumeResponse{
 		PublishContext: map[string]string{
 			"device":   device,
@@ -239,6 +261,10 @@ func (s *service) ControllerUnpublishVolume(
 		return nil, status.Errorf(codes.NotFound, "Node ID %s does not match to expected Node ID %s", req.NodeId, s.nodeID)
 	}
 
+	if hookVal, hookMsg := s.execHook("ControllerUnpublishVolumeStart"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	s.volsRWL.Lock()
 	defer s.volsRWL.Unlock()
 
@@ -262,6 +288,10 @@ func (s *service) ControllerUnpublishVolume(
 	delete(v.VolumeContext, ReadOnlyKey)
 	s.vols[i] = v
 
+	if hookVal, hookMsg := s.execHook("ControllerUnpublishVolumeEnd"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	return &csi.ControllerUnpublishVolumeResponse{}, nil
 }
 
@@ -281,6 +311,10 @@ func (s *service) ValidateVolumeCapabilities(
 		return nil, status.Error(codes.NotFound, req.VolumeId)
 	}
 
+	if hookVal, hookMsg := s.execHook("ValidateVolumeCapabilities"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	return &csi.ValidateVolumeCapabilitiesResponse{
 		Confirmed: &csi.ValidateVolumeCapabilitiesResponse_Confirmed{
 			VolumeContext:      req.GetVolumeContext(),
@@ -295,6 +329,10 @@ func (s *service) ListVolumes(
 	req *csi.ListVolumesRequest) (
 	*csi.ListVolumesResponse, error) {
 
+	if hookVal, hookMsg := s.execHook("ListVolumesStart"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	// Copy the mock volumes into a new slice in order to avoid
 	// locking the service's volume slice for the duration of the
 	// ListVolumes RPC.
@@ -359,6 +397,10 @@ func (s *service) ListVolumes(
 		nextToken = fmt.Sprintf("%d", n)
 	}
 
+	if hookVal, hookMsg := s.execHook("ListVolumesEnd"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	return &csi.ListVolumesResponse{
 		Entries:   entries,
 		NextToken: nextToken,
@@ -370,6 +412,10 @@ func (s *service) GetCapacity(
 	req *csi.GetCapacityRequest) (
 	*csi.GetCapacityResponse, error) {
 
+	if hookVal, hookMsg := s.execHook("GetCapacity"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	return &csi.GetCapacityResponse{
 		AvailableCapacity: MaxStorageCapacity,
 	}, nil
@@ -380,6 +426,10 @@ func (s *service) ControllerGetCapabilities(
 	req *csi.ControllerGetCapabilitiesRequest) (
 	*csi.ControllerGetCapabilitiesResponse, error) {
 
+	if hookVal, hookMsg := s.execHook("ControllerGetCapabilitiesStart"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	caps := []*csi.ControllerServiceCapability{
 		{
 			Type: &csi.ControllerServiceCapability_Rpc{
@@ -452,6 +502,10 @@ func (s *service) ControllerGetCapabilities(
 		})
 	}
 
+	if hookVal, hookMsg := s.execHook("ControllerGetCapabilitiesEnd"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	return &csi.ControllerGetCapabilitiesResponse{
 		Capabilities: caps,
 	}, nil
@@ -467,6 +521,10 @@ func (s *service) CreateSnapshot(ctx context.Context,
 		return nil, status.Error(codes.InvalidArgument, "Snapshot SourceVolumeId cannot be empty")
 	}
 
+	if hookVal, hookMsg := s.execHook("CreateSnapshotStart"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	// Check to see if the snapshot already exists.
 	if i, v := s.snapshots.FindSnapshot("name", req.GetName()); i >= 0 {
 		// Requested snapshot name already exists
@@ -481,6 +539,10 @@ func (s *service) CreateSnapshot(ctx context.Context,
 	snapshot := s.newSnapshot(req.GetName(), req.GetSourceVolumeId(), req.GetParameters())
 	s.snapshots.Add(snapshot)
 
+	if hookVal, hookMsg := s.execHook("CreateSnapshotEnd"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	return &csi.CreateSnapshotResponse{Snapshot: &snapshot.SnapshotCSI}, nil
 }
 
@@ -492,6 +554,10 @@ func (s *service) DeleteSnapshot(ctx context.Context,
 		return nil, status.Error(codes.InvalidArgument, "Snapshot ID cannot be empty")
 	}
 
+	if hookVal, hookMsg := s.execHook("DeleteSnapshotStart"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	// If the snapshot does not exist then return an idempotent response.
 	i, _ := s.snapshots.FindSnapshot("id", req.SnapshotId)
 	if i < 0 {
@@ -503,12 +569,21 @@ func (s *service) DeleteSnapshot(ctx context.Context,
 	// themselves have fields that are.
 	s.snapshots.Delete(i)
 	log.WithField("SnapshotId", req.SnapshotId).Debug("mock delete snapshot")
+
+	if hookVal, hookMsg := s.execHook("DeleteSnapshotEnd"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	return &csi.DeleteSnapshotResponse{}, nil
 }
 
 func (s *service) ListSnapshots(ctx context.Context,
 	req *csi.ListSnapshotsRequest) (*csi.ListSnapshotsResponse, error) {
 
+	if hookVal, hookMsg := s.execHook("ListSnapshots"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	// case 1: SnapshotId is not empty, return snapshots that match the snapshot id.
 	if len(req.GetSnapshotId()) != 0 {
 		return getSnapshotById(s, req)
@@ -534,6 +609,10 @@ func (s *service) ControllerExpandVolume(
 		return nil, status.Error(codes.InvalidArgument, "Request capacity cannot be empty")
 	}
 
+	if hookVal, hookMsg := s.execHook("ControllerExpandVolumeStart"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	s.volsRWL.Lock()
 	defer s.volsRWL.Unlock()
 
@@ -567,6 +646,10 @@ func (s *service) ControllerExpandVolume(
 	v.CapacityBytes = requestBytes
 	s.vols[i] = v
 
+	if hookVal, hookMsg := s.execHook("ControllerExpandVolumeEnd"); hookVal != codes.OK {
+		return nil, status.Errorf(hookVal, hookMsg)
+	}
+
 	return resp, nil
 }