Automated cherry pick of #1875: Require VACs to use SI units

examples/kubernetes/demo-vol-create.yaml

@@ -0,0 +1,59 @@
+apiVersion: storage.k8s.io/v1
+kind: StorageClass
+metadata:
+  name: test-sc
+provisioner: pd.csi.storage.gke.io
+parameters:
+  type: "hyperdisk-balanced"
+  provisioned-iops-on-create: "3000"
+  provisioned-throughput-on-create: "150Mi"
+volumeBindingMode: WaitForFirstConsumer
+---
+apiVersion: storage.k8s.io/v1beta1
+kind: VolumeAttributesClass
+metadata:
+  name: silver
+driverName: pd.csi.storage.gke.io
+parameters:
+  iops: "3000"
+  throughput: "150Mi"
+---
+apiVersion: storage.k8s.io/v1beta1
+kind: VolumeAttributesClass
+metadata:
+  name: gold
+driverName: pd.csi.storage.gke.io
+parameters:
+  iops: "3013"
+  throughput: "151Mi"
+---
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: test-pvc
+spec:
+  storageClassName: test-sc
+  volumeAttributesClassName: silver
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 64Gi
+---
+apiVersion: v1
+kind: Pod
+metadata:
+  name: nginx
+spec:
+  volumes:
+  - name: vol
+    persistentVolumeClaim:
+      claimName: test-pvc
+  containers:
+  - name: nginx
+    image: nginx:1.14.2
+    ports:
+    - containerPort: 80
+    volumeMounts:
+    - mountPath: "/vol"
+      name: vol

pkg/common/parameters.go

@@ -343,7 +343,7 @@ func ExtractModifyVolumeParameters(parameters map[string]string) (ModifyVolumePa
 			}
 			modifyVolumeParams.IOPS = &iops
 		case "throughput":
-			throughput, err := ConvertStringToInt64(value)
+			throughput, err := ConvertMiStringToInt64(value)
 			if err != nil {
 				return ModifyVolumeParameters{}, fmt.Errorf("parameters contain invalid throughput parameter: %w", err)
 			}

pkg/common/parameters_test.go

@@ -485,7 +485,7 @@ func TestSnapshotParameters(t *testing.T) {
 func TestExtractModifyVolumeParameters(t *testing.T) {
 	parameters := map[string]string{
 		"iops":       "1000",
-		"throughput": "500",
+		"throughput": "500Mi",
 	}
 
 	iops := int64(1000)

pkg/gce-pd-csi-driver/controller_test.go

@@ -1789,7 +1789,7 @@ func TestCreateVolumeWithVolumeAttributeClassParameters(t *testing.T) {
 						},
 					},
 				},
-				MutableParameters: map[string]string{"iops": "20000", "throughput": "600"},
+				MutableParameters: map[string]string{"iops": "20000", "throughput": "600Mi"},
 			},
 			expIops:       20000,
 			expThroughput: 600,
@@ -1822,7 +1822,7 @@ func TestCreateVolumeWithVolumeAttributeClassParameters(t *testing.T) {
 						},
 					},
 				},
-				MutableParameters: map[string]string{"iops": "20000", "throughput": "600"},
+				MutableParameters: map[string]string{"iops": "20000", "throughput": "600Mi"},
 			},
 			expIops:       0,
 			expThroughput: 0,
@@ -1890,7 +1890,7 @@ func TestVolumeModifyOperation(t *testing.T) {
 			name: "Update volume with valid parameters",
 			req: &csi.ControllerModifyVolumeRequest{
 				VolumeId:          testVolumeID,
-				MutableParameters: map[string]string{"iops": "20000", "throughput": "600"},
+				MutableParameters: map[string]string{"iops": "20000", "throughput": "600Mi"},
 			},
 			diskType: "hyperdisk-balanced",
 			params: &common.DiskParameters{
@@ -1906,7 +1906,7 @@ func TestVolumeModifyOperation(t *testing.T) {
 			name: "Update volume with invalid parameters",
 			req: &csi.ControllerModifyVolumeRequest{
 				VolumeId:          testVolumeID,
-				MutableParameters: map[string]string{"iops": "0", "throughput": "0"},
+				MutableParameters: map[string]string{"iops": "0", "throughput": "0Mi"},
 			},
 			diskType: "hyperdisk-balanced",
 			params: &common.DiskParameters{
@@ -1922,7 +1922,7 @@ func TestVolumeModifyOperation(t *testing.T) {
 			name: "Update volume with valid parameters but invalid disk type",
 			req: &csi.ControllerModifyVolumeRequest{
 				VolumeId:          testVolumeID,
-				MutableParameters: map[string]string{"iops": "20000", "throughput": "600"},
+				MutableParameters: map[string]string{"iops": "20000", "throughput": "600Mi"},
 			},
 			diskType: "pd-ssd",
 			params: &common.DiskParameters{
@@ -2053,7 +2053,7 @@ func TestVolumeModifyErrorHandling(t *testing.T) {
 				},
 			},
 			modifyReq: &csi.ControllerModifyVolumeRequest{
-				MutableParameters: map[string]string{"iops": "3001", "throughput": "151"},
+				MutableParameters: map[string]string{"iops": "3001", "throughput": "151Mi"},
 			},
 			modifyVolumeErrors: map[*meta.Key]error{
 				meta.ZonalKey(name, "us-central1-a"): &googleapi.Error{
@@ -2089,7 +2089,7 @@ func TestVolumeModifyErrorHandling(t *testing.T) {
 				},
 			},
 			modifyReq: &csi.ControllerModifyVolumeRequest{
-				MutableParameters: map[string]string{"iops": "10000", "throughput": "2400"},
+				MutableParameters: map[string]string{"iops": "10000", "throughput": "2400Mi"},
 			},
 			modifyVolumeErrors: map[*meta.Key]error{
 				meta.ZonalKey(name, "us-central1-a"): &googleapi.Error{Code: int(codes.InvalidArgument), Message: "InvalidArgument"},

test/e2e/tests/single_zone_e2e_test.go

@@ -17,8 +17,10 @@ package tests
 import (
 	"context"
 	"fmt"
+	"os"
 	"path/filepath"
 	"regexp"
+	"strconv"
 	"strings"
 	"time"
 
@@ -44,26 +46,36 @@ import (
 const (
 	testNamePrefix = "gcepd-csi-e2e-"
 
-	defaultSizeGb                     int64 = 5
-	defaultExtremeSizeGb              int64 = 500
-	defaultHdTSizeGb                  int64 = 2048
-	defaultHdmlSizeGb                 int64 = 200
-	defaultRepdSizeGb                 int64 = 200
-	defaultMwSizeGb                   int64 = 200
-	defaultVolumeLimit                int64 = 127
-	invalidSizeGb                     int64 = 66000
-	readyState                              = "READY"
-	standardDiskType                        = "pd-standard"
-	ssdDiskType                             = "pd-ssd"
-	extremeDiskType                         = "pd-extreme"
-	hdtDiskType                             = "hyperdisk-throughput"
-	hdmlDiskType                            = "hyperdisk-ml"
-	provisionedIOPSOnCreate                 = "12345"
-	provisionedIOPSOnCreateInt              = int64(12345)
-	provisionedIOPSOnCreateDefaultInt       = int64(100000)
-	provisionedThroughputOnCreate           = "66Mi"
-	provisionedThroughputOnCreateInt        = int64(66)
-	defaultEpsilon                          = 500000000 // 500M
+	defaultSizeGb                       int64 = 5
+	defaultExtremeSizeGb                int64 = 500
+	defaultHdBSizeGb                    int64 = 100
+	defaultHdXSizeGb                    int64 = 100
+	defaultHdTSizeGb                    int64 = 2048
+	defaultHdmlSizeGb                   int64 = 200
+	defaultRepdSizeGb                   int64 = 200
+	defaultMwSizeGb                     int64 = 200
+	defaultVolumeLimit                  int64 = 127
+	invalidSizeGb                       int64 = 66000
+	readyState                                = "READY"
+	standardDiskType                          = "pd-standard"
+	ssdDiskType                               = "pd-ssd"
+	extremeDiskType                           = "pd-extreme"
+	hdbDiskType                               = "hyperdisk-balanced"
+	hdxDiskType                               = "hyperdisk-extreme"
+	hdtDiskType                               = "hyperdisk-throughput"
+	hdmlDiskType                              = "hyperdisk-ml"
+	provisionedIOPSOnCreate                   = "12345"
+	provisionedIOPSOnCreateInt                = int64(12345)
+	provisionedIOPSOnCreateDefaultInt         = int64(100000)
+	provisionedIOPSOnCreateHdb                = "3000"
+	provisionedIOPSOnCreateHdbInt             = int64(3000)
+	provisionedIOPSOnCreateHdx                = "200"
+	provisionedIOPSOnCreateHdxInt             = int64(200)
+	provisionedThroughputOnCreate             = "66Mi"
+	provisionedThroughputOnCreateInt          = int64(66)
+	provisionedThroughputOnCreateHdb          = "150Mi"
+	provisionedThroughputOnCreateHdbInt       = int64(150)
+	defaultEpsilon                            = 500000000 // 500M
 )
 
 var _ = Describe("GCE PD CSI Driver", func() {
@@ -1549,6 +1561,88 @@ var _ = Describe("GCE PD CSI Driver", func() {
 		Entry("with missing multi-zone label", multiZoneTestConfig{diskType: standardDiskType, readOnly: true, hasMultiZoneLabel: false, wantErrSubstring: "points to disk that is missing label \"goog-gke-multi-zone\""}),
 		Entry("with unsupported disk-type pd-extreme", multiZoneTestConfig{diskType: extremeDiskType, readOnly: true, hasMultiZoneLabel: true, wantErrSubstring: "points to disk with unsupported disk type"}),
 	)
+
+	// Mark tests as pending while VolumeAttributesClasses are in beta
+	DescribeTable("Should update metadata when providing valid metadata",
+		func(
+			diskType string,
+			diskSize int64,
+			initialIops *string,
+			initialThroughput *string,
+			updatedIops *string,
+			updatedThroughput *string,
+		) {
+			if !runCMVTests() {
+				Skip("Not running ControllerModifyVolume tests, as RUN_CONTROLLER_MODIFY_VOLUME_TESTS is falsy")
+			}
+			Expect(testContexts).ToNot(BeEmpty())
+			testContext := getRandomTestContext()
+
+			client := testContext.Client
+			instance := testContext.Instance
+			p, z, _ := instance.GetIdentity()
+
+			volName, volId := createAndValidateUniqueZonalDisk(client, p, z, diskType)
+			defer func() {
+				err := client.DeleteVolume(volId)
+				Expect(err).To(BeNil(), "DeleteVolume failed")
+			}()
+
+			// Validate disk created
+			_, err := computeService.Disks.Get(p, z, volName).Do()
+			Expect(err).To(BeNil(), "Could not get disk from cloud directly")
+
+			mutableParams := map[string]string{}
+			if updatedIops != nil {
+				mutableParams["iops"] = *updatedIops
+			}
+			if updatedThroughput != nil {
+				mutableParams["throughput"] = *updatedThroughput
+			}
+			err = client.ControllerModifyVolume(volId, mutableParams)
+			Expect(err).To(BeNil(), "Expected ControllerModifyVolume to succeed")
+
+			err = waitForMetadataUpdate(6, p, z, volName, initialIops, initialThroughput)
+			Expect(err).To(BeNil(), "Expected ControllerModifyVolume to update metadata")
+
+			// Assert ControllerModifyVolume successfully updated metadata
+			disk, err := computeService.Disks.Get(p, z, volName).Do()
+			Expect(err).To(BeNil(), "Could not get disk from cloud directly")
+			if updatedIops != nil {
+				Expect(strconv.FormatInt(disk.ProvisionedIops, 10)).To(Equal(*updatedIops))
+			}
+			if updatedThroughput != nil {
+				Expect(strconv.FormatInt(disk.ProvisionedThroughput, 10)).To(Equal(*updatedThroughput))
+			}
+		},
+		Entry(
+			"for hyperdisk-balanced",
+			hdbDiskType,
+			defaultHdBSizeGb,
+			stringPtr(provisionedIOPSOnCreateHdb),
+			stringPtr(provisionedThroughputOnCreateHdb),
+			stringPtr("3013"),
+			stringPtr("181Mi"),
+		),
+		Entry(
+			"for hyperdisk-extreme",
+			hdxDiskType,
+			defaultHdXSizeGb,
+			stringPtr(provisionedIOPSOnCreateHdx),
+			nil,
+			stringPtr("250"),
+			nil,
+		),
+		Entry(
+			"for hyperdisk-throughput",
+			hdtDiskType,
+			defaultHdTSizeGb,
+			nil,
+			stringPtr(provisionedThroughputOnCreate),
+			nil,
+			stringPtr("70Mi"),
+		),
+	)
 })
 
 func equalWithinEpsilon(a, b, epsiolon int64) bool {
@@ -1571,6 +1665,10 @@ func createAndValidateZonalDisk(client *remote.CsiClient, project, zone string,
 	switch diskType {
 	case extremeDiskType:
 		diskSize = defaultExtremeSizeGb
+	case hdbDiskType:
+		diskSize = defaultHdBSizeGb
+	case hdxDiskType:
+		diskSize = defaultHdXSizeGb
 	case hdtDiskType:
 		diskSize = defaultHdTSizeGb
 	case hdmlDiskType:
@@ -1737,6 +1835,28 @@ var typeToDisk = map[string]*disk{
 			Expect(disk.ProvisionedIops).To(Equal(provisionedIOPSOnCreateInt))
 		},
 	},
+	hdbDiskType: {
+		params: map[string]string{
+			common.ParameterKeyType:                          hdbDiskType,
+			common.ParameterKeyProvisionedIOPSOnCreate:       provisionedIOPSOnCreateHdb,
+			common.ParameterKeyProvisionedThroughputOnCreate: provisionedThroughputOnCreateHdb,
+		},
+		validate: func(disk *compute.Disk) {
+			Expect(disk.Type).To(ContainSubstring(hdbDiskType))
+			Expect(disk.ProvisionedIops).To(Equal(provisionedIOPSOnCreateHdbInt))
+			Expect(disk.ProvisionedThroughput).To(Equal(provisionedThroughputOnCreateHdbInt))
+		},
+	},
+	hdxDiskType: {
+		params: map[string]string{
+			common.ParameterKeyType:                    hdxDiskType,
+			common.ParameterKeyProvisionedIOPSOnCreate: provisionedIOPSOnCreateHdx,
+		},
+		validate: func(disk *compute.Disk) {
+			Expect(disk.Type).To(ContainSubstring(hdxDiskType))
+			Expect(disk.ProvisionedIops).To(Equal(provisionedIOPSOnCreateHdxInt))
+		},
+	},
 	hdtDiskType: {
 		params: map[string]string{
 			common.ParameterKeyType:                          hdtDiskType,
@@ -1775,3 +1895,49 @@ func merge(a, b map[string]string) map[string]string {
 	}
 	return res
 }
+
+func runCMVTests() bool {
+	runCMVStr, ok := os.LookupEnv("RUN_CONTROLLER_MODIFY_VOLUME_TESTS")
+	if !ok {
+		return false
+	}
+
+	runCMVTests, err := strconv.ParseBool(runCMVStr)
+	if err != nil {
+		return false
+	}
+
+	return runCMVTests
+}
+
+func stringPtr(str string) *string {
+	return &str
+}
+
+// waitForMetadataUpdate tries to poll every minute until numMinutes and tests if IOPS/throughput are updated
+func waitForMetadataUpdate(numMinutes int, project, zone, volName string, initialIops *string, initialThroughput *string) error {
+	backoff := wait.Backoff{
+		Duration: 1 * time.Minute,
+		Factor:   1.0,
+		Steps:    numMinutes,
+		Cap:      time.Duration(numMinutes) * time.Minute,
+	}
+	err := wait.ExponentialBackoffWithContext(context.Background(), backoff, func() (bool, error) {
+		disk, err := computeService.Disks.Get(project, zone, volName).Do()
+		if err != nil {
+			return false, nil
+		}
+		if initialIops != nil && strconv.FormatInt(disk.ProvisionedIops, 10) != *initialIops {
+			return true, nil
+		}
+		if initialThroughput != nil {
+			throughput := *initialThroughput
+			// Strip "Mi" from throughput
+			if len(throughput) > 2 && strconv.FormatInt(disk.ProvisionedThroughput, 10) != throughput[:len(throughput)-2] {
+				return true, nil
+			}
+		}
+		return false, nil
+	})
+	return err
+}

test/k8s-integration/config/hdb-volumeattributesclass.yaml

@@ -5,4 +5,4 @@ metadata:
 driverName: pd.csi.storage.gke.io
 parameters:
   iops: "3600"
-  throughput: "290"
+  throughput: "290Mi"