Create constants for keys used in map lookup

kubernetes-sigs · Feb 14, 2019 · bd10db8 · bd10db8
1 parent d961621
commit bd10db8
Show file tree

Hide file tree

Showing 6 changed files with 98 additions and 52 deletions.
diff --git a/pkg/driver/constants.go b/pkg/driver/constants.go
@@ -0,0 +1,42 @@
+/*
+Copyright 2018 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 driver
+
+// constants of keys in PublishContext
+const (
+	// devicePathKey represents key for device path in PublishContext
+	// devicePath is the device path where the volume is attached to
+	DevicePathKey = "devicePath"
+)
+
+// constants of keys in volume parameters
+const (
+	// FsTypeKey represents key for filesystem type
+	FsTypeKey = "fsType"
+
+	// VolumeTypeKey represents key for volume type
+	VolumeTypeKey = "type"
+
+	// IopsPerGBKey represents key for IOPS per GB
+	IopsPerGBKey = "iopsPerGB"
+
+	// EncryptedKey represents key for whether filesystem is encrypted
+	EncryptedKey = "encrypted"
+
+	// KmsKeyId represents key for KMS encryption key
+	KmsKeyIdKey = "kmsKeyId"
+)
diff --git a/pkg/driver/controller.go b/pkg/driver/controller.go
@@ -87,7 +87,7 @@ func (d *Driver) CreateVolume(ctx context.Context, req *csi.CreateVolumeRequest)
 	}
 
 	volumeParams := req.GetParameters()
-	fsType := volumeParams["fsType"]
+	fsType := volumeParams[FsTypeKey]
 
 	// volume exists already
 	if disk != nil {
@@ -97,10 +97,10 @@ func (d *Driver) CreateVolume(ctx context.Context, req *csi.CreateVolumeRequest)
 
 	// create a new volume
 	zone := pickAvailabilityZone(req.GetAccessibilityRequirements())
-	volumeType := volumeParams["type"]
+	volumeType := volumeParams[VolumeTypeKey]
 	iopsPerGB := 0
 	if volumeType == cloud.VolumeTypeIO1 {
-		iopsPerGB, err = strconv.Atoi(volumeParams["iopsPerGB"])
+		iopsPerGB, err = strconv.Atoi(volumeParams[IopsPerGBKey])
 		if err != nil {
 			return nil, status.Errorf(codes.InvalidArgument, "Could not parse invalid iopsPerGB: %v", err)
 		}
@@ -110,9 +110,9 @@ func (d *Driver) CreateVolume(ctx context.Context, req *csi.CreateVolumeRequest)
 		isEncrypted bool
 		kmsKeyId    string
 	)
-	if volumeParams["encrypted"] == "true" {
+	if volumeParams[EncryptedKey] == "true" {
 		isEncrypted = true
-		kmsKeyId = volumeParams["kmsKeyId"]
+		kmsKeyId = volumeParams[KmsKeyIdKey]
 	}
 
 	opts := &cloud.DiskOptions{
@@ -192,7 +192,7 @@ func (d *Driver) ControllerPublishVolume(ctx context.Context, req *csi.Controlle
 	}
 	klog.V(5).Infof("ControllerPublishVolume: volume %s attached to node %s through device %s", volumeID, nodeID, devicePath)
 
-	pvInfo := map[string]string{"devicePath": devicePath}
+	pvInfo := map[string]string{DevicePathKey: devicePath}
 	return &csi.ControllerPublishVolumeResponse{PublishContext: pvInfo}, nil
 }
 
@@ -328,7 +328,7 @@ func newCreateVolumeResponse(disk *cloud.Disk) *csi.CreateVolumeResponse {
 			VolumeId:      disk.VolumeID,
 			CapacityBytes: util.GiBToBytes(disk.CapacityGiB),
 			VolumeContext: map[string]string{
-				"fsType": disk.FsType,
+				FsTypeKey: disk.FsType,
 			},
 			AccessibleTopology: []*csi.Topology{
 				{

diff --git a/pkg/driver/controller_test.go b/pkg/driver/controller_test.go
@@ -65,7 +65,7 @@ func TestCreateVolume(t *testing.T) {
 			expVol: &csi.Volume{
 				CapacityBytes: stdVolSize,
 				VolumeId:      "vol-test",
-				VolumeContext: map[string]string{"fsType": ""},
+				VolumeContext: map[string]string{FsTypeKey: ""},
 			},
 		},
 		{
@@ -95,7 +95,7 @@ func TestCreateVolume(t *testing.T) {
 			expVol: &csi.Volume{
 				CapacityBytes: stdVolSize,
 				VolumeId:      "vol-test",
-				VolumeContext: map[string]string{"fsType": ""},
+				VolumeContext: map[string]string{FsTypeKey: ""},
 			},
 		},
 		{
@@ -124,7 +124,7 @@ func TestCreateVolume(t *testing.T) {
 			expVol: &csi.Volume{
 				CapacityBytes: cloud.DefaultVolumeSize,
 				VolumeId:      "vol-test",
-				VolumeContext: map[string]string{"fsType": ""},
+				VolumeContext: map[string]string{FsTypeKey: ""},
 			},
 		},
 		{
@@ -138,7 +138,7 @@ func TestCreateVolume(t *testing.T) {
 			expVol: &csi.Volume{
 				CapacityBytes: 2147483648, // 1 GiB + 1 byte = 2 GiB
 				VolumeId:      "vol-test",
-				VolumeContext: map[string]string{"fsType": ""},
+				VolumeContext: map[string]string{FsTypeKey: ""},
 			},
 		},
 		{
@@ -147,12 +147,12 @@ func TestCreateVolume(t *testing.T) {
 				Name:               "vol-test",
 				CapacityRange:      stdCapRange,
 				VolumeCapabilities: stdVolCap,
-				Parameters:         map[string]string{"fsType": defaultFsType},
+				Parameters:         map[string]string{FsTypeKey: defaultFsType},
 			},
 			expVol: &csi.Volume{
 				CapacityBytes: stdVolSize,
 				VolumeId:      "vol-test",
-				VolumeContext: map[string]string{"fsType": defaultFsType},
+				VolumeContext: map[string]string{FsTypeKey: defaultFsType},
 			},
 		},
 		{
@@ -162,14 +162,14 @@ func TestCreateVolume(t *testing.T) {
 				CapacityRange:      stdCapRange,
 				VolumeCapabilities: stdVolCap,
 				Parameters: map[string]string{
-					"type":      cloud.VolumeTypeIO1,
-					"iopsPerGB": "5",
+					VolumeTypeKey: cloud.VolumeTypeIO1,
+					IopsPerGBKey:  "5",
 				},
 			},
 			expVol: &csi.Volume{
 				CapacityBytes: stdVolSize,
 				VolumeId:      "vol-test",
-				VolumeContext: map[string]string{"fsType": ""},
+				VolumeContext: map[string]string{FsTypeKey: ""},
 			},
 		},
 		{
@@ -179,46 +179,46 @@ func TestCreateVolume(t *testing.T) {
 				CapacityRange:      stdCapRange,
 				VolumeCapabilities: stdVolCap,
 				Parameters: map[string]string{
-					"type": cloud.VolumeTypeSC1,
+					VolumeTypeKey: cloud.VolumeTypeSC1,
 				},
 			},
 			expVol: &csi.Volume{
 				CapacityBytes: stdVolSize,
 				VolumeId:      "vol-test",
-				VolumeContext: map[string]string{"fsType": ""},
+				VolumeContext: map[string]string{FsTypeKey: ""},
 			},
 		},
 		{
-			name: "success with volume encrpytion",
+			name: "success with volume encryption",
 			req: &csi.CreateVolumeRequest{
 				Name:               "vol-test",
 				CapacityRange:      stdCapRange,
 				VolumeCapabilities: stdVolCap,
 				Parameters: map[string]string{
-					"encrypted": "true",
+					EncryptedKey: "true",
 				},
 			},
 			expVol: &csi.Volume{
 				CapacityBytes: stdVolSize,
 				VolumeId:      "vol-test",
-				VolumeContext: map[string]string{"fsType": ""},
+				VolumeContext: map[string]string{FsTypeKey: ""},
 			},
 		},
 		{
-			name: "success with volume encrpytion with KMS key",
+			name: "success with volume encryption with KMS key",
 			req: &csi.CreateVolumeRequest{
 				Name:               "vol-test",
 				CapacityRange:      stdCapRange,
 				VolumeCapabilities: stdVolCap,
 				Parameters: map[string]string{
-					"encrypted": "true",
-					"kmsKeyId":  "arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef",
+					EncryptedKey: "true",
+					KmsKeyIdKey:  "arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef",
 				},
 			},
 			expVol: &csi.Volume{
 				CapacityBytes: stdVolSize,
 				VolumeId:      "vol-test",
-				VolumeContext: map[string]string{"fsType": ""},
+				VolumeContext: map[string]string{FsTypeKey: ""},
 			},
 		},
 		{
@@ -228,7 +228,7 @@ func TestCreateVolume(t *testing.T) {
 				CapacityRange:      stdCapRange,
 				VolumeCapabilities: stdVolCap,
 				Parameters: map[string]string{
-					"fsType": expFsType,
+					FsTypeKey: expFsType,
 				},
 				AccessibilityRequirements: &csi.TopologyRequirement{
 					Requisite: []*csi.Topology{
@@ -243,7 +243,7 @@ func TestCreateVolume(t *testing.T) {
 				CapacityRange:      stdCapRange,
 				VolumeCapabilities: stdVolCap,
 				Parameters: map[string]string{
-					"fsType": expFsType,
+					FsTypeKey: expFsType,
 				},
 				AccessibilityRequirements: &csi.TopologyRequirement{
 					Requisite: []*csi.Topology{
@@ -256,7 +256,7 @@ func TestCreateVolume(t *testing.T) {
 			expVol: &csi.Volume{
 				CapacityBytes: stdVolSize,
 				VolumeId:      "vol-test",
-				VolumeContext: map[string]string{"fsType": expFsType},
+				VolumeContext: map[string]string{FsTypeKey: expFsType},
 				AccessibleTopology: []*csi.Topology{
 					{
 						Segments: map[string]string{TopologyKey: expZone},

diff --git a/pkg/driver/internal/inflight_test.go b/pkg/driver/internal/inflight_test.go
@@ -20,6 +20,7 @@ import (
 	"testing"
 
 	"github.com/container-storage-interface/spec/lib/go/csi"
+	"github.com/kubernetes-sigs/aws-ebs-csi-driver/pkg/util"
 )
 
 type testRequest struct {
@@ -38,12 +39,15 @@ var stdVolCap = []*csi.VolumeCapability{
 		},
 	},
 }
-var stdVolSize = int64(5 * 1024 * 1024 * 1024)
-var stdCapRange = &csi.CapacityRange{RequiredBytes: stdVolSize}
-var stdParams = map[string]string{
-	"fsType":     "ext3",
-	"volumeType": "gp2",
-}
+
+var (
+	stdVolSize  = int64(5 * util.GiB)
+	stdCapRange = &csi.CapacityRange{RequiredBytes: stdVolSize}
+	stdParams   = map[string]string{
+		"key1": "value1",
+		"key2": "value2",
+	}
+)
 
 func TestInFlight(t *testing.T) {
 	testCases := []struct {

diff --git a/pkg/driver/node.go b/pkg/driver/node.go
@@ -82,7 +82,7 @@ func (d *Driver) NodeStageVolume(ctx context.Context, req *csi.NodeStageVolumeRe
 		d.inFlight.Delete(req)
 	}()
 
-	source, ok := req.PublishContext["devicePath"]
+	source, ok := req.PublishContext[DevicePathKey]
 	if !ok {
 		return nil, status.Error(codes.InvalidArgument, "Device path not provided")
 	}
@@ -121,7 +121,7 @@ func (d *Driver) NodeStageVolume(ctx context.Context, req *csi.NodeStageVolumeRe
 
 	// Get fs type that the volume will be formatted with
 	attributes := req.GetVolumeContext()
-	fsType, exists := attributes["fsType"]
+	fsType, exists := attributes[FsTypeKey]
 	if !exists || fsType == "" {
 		fsType = defaultFsType
 	}