mirrors/velero
1
0
Fork 0
mirror of https://github.com/vmware-tanzu/velero.git synced 2026-01-05 21:14:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Minor refactor plus better documentation for naming

Browse Source 
Signed-off-by: Carlisia <carlisia@vmware.com>
This commit is contained in:
Carlisia
2020-12-14 16:52:52 -08:00
parent 2f635e14ce
commit 203a103fc4
4 changed files with 107 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
pkg/plugin/clientmgmt/manager.go
View File

@@ -131,10 +131,8 @@ func (m *manager) getRestartableProcess(kind framework.PluginKind, name string)
// GetObjectStore returns a restartableObjectStore for name.
func (m *manager) GetObjectStore(name string) (velero.ObjectStore, error) {
// Backwards compatibility with non-namespaced, built-in plugins.
if !strings.Contains(name, "/") {
name = "velero.io/" + name
}
name = sanitizeName(name)
restartableProcess, err := m.getRestartableProcess(framework.PluginKindObjectStore, name)
if err != nil {
return nil, err
@@ -147,10 +145,8 @@ func (m *manager) GetObjectStore(name string) (velero.ObjectStore, error) {
// GetVolumeSnapshotter returns a restartableVolumeSnapshotter for name.
func (m *manager) GetVolumeSnapshotter(name string) (velero.VolumeSnapshotter, error) {
// Backwards compatibility with non-namespaced, built-in plugins.
if !strings.Contains(name, "/") {
name = "velero.io/" + name
}
name = sanitizeName(name)
restartableProcess, err := m.getRestartableProcess(framework.PluginKindVolumeSnapshotter, name)
if err != nil {
return nil, err
@@ -183,10 +179,8 @@ func (m *manager) GetBackupItemActions() ([]velero.BackupItemAction, error) {
// GetBackupItemAction returns a restartableBackupItemAction for name.
func (m *manager) GetBackupItemAction(name string) (velero.BackupItemAction, error) {
// Backwards compatibility with non-namespaced, built-in plugins.
if !strings.Contains(name, "/") {
name = "velero.io/" + name
}
name = sanitizeName(name)
restartableProcess, err := m.getRestartableProcess(framework.PluginKindBackupItemAction, name)
if err != nil {
return nil, err
@@ -218,10 +212,8 @@ func (m *manager) GetRestoreItemActions() ([]velero.RestoreItemAction, error) {
// GetRestoreItemAction returns a restartableRestoreItemAction for name.
func (m *manager) GetRestoreItemAction(name string) (velero.RestoreItemAction, error) {
// Backwards compatibility with non-namespaced, built-in plugins.
if !strings.Contains(name, "/") {
name = "velero.io/" + name
}
name = sanitizeName(name)
restartableProcess, err := m.getRestartableProcess(framework.PluginKindRestoreItemAction, name)
if err != nil {
return nil, err
@@ -253,11 +245,8 @@ func (m *manager) GetDeleteItemActions() ([]velero.DeleteItemAction, error) {
// GetDeleteItemAction returns a restartableDeleteItemAction for name.
func (m *manager) GetDeleteItemAction(name string) (velero.DeleteItemAction, error) {
// Backwards compatibility with non-namespaced plugins, following principle of least surprise
// since DeleteItemActions were not bundled with Velero when plugins were non-namespaced.
if !strings.Contains(name, "/") {
name = "velero.io/" + name
}
name = sanitizeName(name)
restartableProcess, err := m.getRestartableProcess(framework.PluginKindDeleteItemAction, name)
if err != nil {
return nil, err
@@ -266,3 +255,14 @@ func (m *manager) GetDeleteItemAction(name string) (velero.DeleteItemAction, err
r := newRestartableDeleteItemAction(name, restartableProcess)
return r, nil
}
// sanitizeName adds "velero.io" to legacy plugins that weren't namespaced.
func sanitizeName(name string) string {
// Backwards compatibility with non-namespaced Velero plugins, following principle of least surprise
// since DeleteItemActions were not bundled with Velero when plugins were non-namespaced.
if !strings.Contains(name, "/") {
name = "velero.io/" + name
}
return name
}

34
pkg/plugin/clientmgmt/manager_test.go
View File

@@ -574,3 +574,37 @@ func TestGetDeleteItemActions(t *testing.T) {
})
}
}
func TestSanitizeName(t *testing.T) {
tests := []struct {
name, pluginName, expectedName string
}{
{
name: "Legacy, non-namespaced plugin",
pluginName: "aws",
expectedName: "velero.io/aws",
},
{
name: "A Velero plugin",
pluginName: "velero.io/aws",
expectedName: "velero.io/aws",
},
{
name: "A non-Velero plugin with a Velero namespace",
pluginName: "velero.io/plugin-for-velero",
expectedName: "velero.io/plugin-for-velero",
},
{
name: "A non-Velero plugin with a non-Velero namespace",
pluginName: "digitalocean.com/velero",
expectedName: "digitalocean.com/velero",
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
sanitizedName := sanitizeName(tc.pluginName)
assert.Equal(t, sanitizedName, tc.expectedName)
})
}
}