-
Notifications
You must be signed in to change notification settings - Fork 159
Implement ValidateVolumeCapabilities and refactor parameter handling for more comprehensive validation of existing disks in all cloud calls #467
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| /* | ||
| Copyright 2020 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 common | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strings" | ||
| ) | ||
|
|
||
| const ( | ||
| ParameterKeyType = "type" | ||
| ParameterKeyReplicationType = "replication-type" | ||
| ParameterKeyDiskEncryptionKmsKey = "disk-encryption-kms-key" | ||
|
|
||
| replicationTypeNone = "none" | ||
| ) | ||
|
|
||
| // DiskParameters contains normalized and defaulted disk parameters | ||
| type DiskParameters struct { | ||
| // Values: pd-standard OR pd-ssd | ||
| // Default: pd-standard | ||
| DiskType string | ||
| // Values: "none", regional-pd | ||
| // Default: "none" | ||
| ReplicationType string | ||
| // Values: {string} | ||
| // Default: "" | ||
| DiskEncryptionKMSKey string | ||
| } | ||
|
|
||
| // ExtractAndDefaultParameters will take the relevant parameters from a map and | ||
| // put them into a well defined struct making sure to default unspecified fields | ||
| func ExtractAndDefaultParameters(parameters map[string]string) (DiskParameters, error) { | ||
| p := DiskParameters{ | ||
| DiskType: "pd-standard", // Default | ||
| ReplicationType: replicationTypeNone, // Default | ||
| DiskEncryptionKMSKey: "", // Default | ||
| } | ||
| for k, v := range parameters { | ||
| if k == "csiProvisionerSecretName" || k == "csiProvisionerSecretNamespace" { | ||
| // These are hardcoded secrets keys required to function but not needed by GCE PD | ||
| continue | ||
| } | ||
| switch strings.ToLower(k) { | ||
| case ParameterKeyType: | ||
| if v != "" { | ||
| p.DiskType = strings.ToLower(v) | ||
| } | ||
| case ParameterKeyReplicationType: | ||
| if v != "" { | ||
| p.ReplicationType = strings.ToLower(v) | ||
| } | ||
| case ParameterKeyDiskEncryptionKmsKey: | ||
| // Resource names (e.g. "keyRings", "cryptoKeys", etc.) are case sensitive, so do not change case | ||
| p.DiskEncryptionKMSKey = v | ||
| default: | ||
| return p, fmt.Errorf("parameters contains invalid option %q", k) | ||
| } | ||
| } | ||
| return p, nil | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| /* | ||
| Copyright 2020 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 common | ||
|
|
||
| import ( | ||
| "reflect" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestExtractAndDefaultParameters(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| parameters map[string]string | ||
| expectParams DiskParameters | ||
| expectErr bool | ||
| }{ | ||
| { | ||
| name: "defaults", | ||
| parameters: map[string]string{}, | ||
| expectParams: DiskParameters{ | ||
| DiskType: "pd-standard", | ||
| ReplicationType: "none", | ||
| DiskEncryptionKMSKey: "", | ||
| }, | ||
| }, | ||
| { | ||
| name: "specified empties", | ||
| parameters: map[string]string{ParameterKeyType: "", ParameterKeyReplicationType: "", ParameterKeyDiskEncryptionKmsKey: ""}, | ||
| expectParams: DiskParameters{ | ||
| DiskType: "pd-standard", | ||
| ReplicationType: "none", | ||
| DiskEncryptionKMSKey: "", | ||
| }, | ||
| }, | ||
| { | ||
| name: "random keys", | ||
| parameters: map[string]string{ParameterKeyType: "", "foo": "", ParameterKeyDiskEncryptionKmsKey: ""}, | ||
| expectErr: true, | ||
| }, | ||
| { | ||
| name: "real values", | ||
| parameters: map[string]string{ParameterKeyType: "pd-ssd", ParameterKeyReplicationType: "regional-pd", ParameterKeyDiskEncryptionKmsKey: "foo/key"}, | ||
| expectParams: DiskParameters{ | ||
| DiskType: "pd-ssd", | ||
| ReplicationType: "regional-pd", | ||
| DiskEncryptionKMSKey: "foo/key", | ||
| }, | ||
| }, | ||
| { | ||
| name: "partial spec", | ||
| parameters: map[string]string{ParameterKeyDiskEncryptionKmsKey: "foo/key"}, | ||
| expectParams: DiskParameters{ | ||
| DiskType: "pd-standard", | ||
| ReplicationType: "none", | ||
| DiskEncryptionKMSKey: "foo/key", | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range tests { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| p, err := ExtractAndDefaultParameters(tc.parameters) | ||
| if gotErr := err != nil; gotErr != tc.expectErr { | ||
| t.Fatalf("ExtractAndDefaultParameters(%+v) = %v; expectedErr: %v", tc.parameters, err, tc.expectErr) | ||
| } | ||
| if err != nil { | ||
| return | ||
| } | ||
|
|
||
| if !reflect.DeepEqual(p, tc.expectParams) { | ||
| t.Errorf("ExtractAndDefaultParameters(%+v) = %v; expected params: %v", tc.parameters, p, tc.expectParams) | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should it be considered an error if a user specified a key without a value?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in-tree PD just treats that case as the default. I tried setting
type: ""and it just created apd-standardwithout complaining - I think we should be backwards compatible here