mirror of
https://github.com/vmware-tanzu/velero.git
synced 2026-01-08 06:15:40 +00:00
Move validation of plugins (#1953)
* Move validation of plugins Signed-off-by: Carlisia <carlisia@vmware.com>
This commit is contained in:
54
pkg/plugin/framework/validation.go
Normal file
54
pkg/plugin/framework/validation.go
Normal file
@@ -0,0 +1,54 @@
|
||||
/*
|
||||
Copyright 2019 the Velero contributors.
|
||||
|
||||
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 framework
|
||||
|
||||
import (
|
||||
"github.com/pkg/errors"
|
||||
"k8s.io/apimachinery/pkg/util/sets"
|
||||
)
|
||||
|
||||
// ValidateObjectStoreConfigKeys ensures that an object store's config
|
||||
// is valid by making sure each `config` key is in the `validKeys` list.
|
||||
// The special keys "bucket" and "prefix" are always considered valid.
|
||||
func ValidateObjectStoreConfigKeys(config map[string]string, validKeys ...string) error {
|
||||
// `bucket` and `prefix` are automatically added to all object
|
||||
// store config by velero, so add them as valid keys.
|
||||
return validateConfigKeys(config, append(validKeys, "bucket", "prefix")...)
|
||||
}
|
||||
|
||||
// ValidateVolumeSnapshotterConfigKeys ensures that a volume snapshotter's
|
||||
// config is valid by making sure each `config` key is in the `validKeys` list.
|
||||
func ValidateVolumeSnapshotterConfigKeys(config map[string]string, validKeys ...string) error {
|
||||
return validateConfigKeys(config, validKeys...)
|
||||
}
|
||||
|
||||
func validateConfigKeys(config map[string]string, validKeys ...string) error {
|
||||
validKeysSet := sets.NewString(validKeys...)
|
||||
|
||||
var invalidKeys []string
|
||||
for k := range config {
|
||||
if !validKeysSet.Has(k) {
|
||||
invalidKeys = append(invalidKeys, k)
|
||||
}
|
||||
}
|
||||
|
||||
if len(invalidKeys) > 0 {
|
||||
return errors.Errorf("config has invalid keys %v; valid keys are %v", invalidKeys, validKeys)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
37
pkg/plugin/framework/validation_test.go
Normal file
37
pkg/plugin/framework/validation_test.go
Normal file
@@ -0,0 +1,37 @@
|
||||
/*
|
||||
Copyright 2019 the Velero contributors.
|
||||
|
||||
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 framework
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
func TestValidateConfigKeys(t *testing.T) {
|
||||
assert.NoError(t, validateConfigKeys(nil))
|
||||
assert.NoError(t, validateConfigKeys(map[string]string{}))
|
||||
assert.NoError(t, validateConfigKeys(map[string]string{"foo": "bar"}, "foo"))
|
||||
assert.NoError(t, validateConfigKeys(map[string]string{"foo": "bar", "bar": "baz"}, "foo", "bar"))
|
||||
|
||||
assert.Error(t, validateConfigKeys(map[string]string{"foo": "bar"}))
|
||||
assert.Error(t, validateConfigKeys(map[string]string{"foo": "bar"}, "Foo"))
|
||||
assert.Error(t, validateConfigKeys(map[string]string{"foo": "bar", "boo": ""}, "foo"))
|
||||
|
||||
assert.NoError(t, ValidateObjectStoreConfigKeys(map[string]string{"bucket": "foo"}))
|
||||
assert.Error(t, ValidateVolumeSnapshotterConfigKeys(map[string]string{"bucket": "foo"}))
|
||||
}
|
||||
Reference in New Issue
Block a user