mirror of
https://github.com/vmware-tanzu/velero.git
synced 2026-08-15 19:56:06 +00:00
JosephandClaude Opus 4.6
3c49bbec75
Register cobra completion callbacks for all commands that accept existing Velero resource names. A centralized completeNames helper uses apimachinery's meta.ExtractList/Accessor to list resources with a 3-second timeout, filter by prefix, and deduplicate already-typed arguments. Wires ValidArgsFunction on 20 commands and RegisterFlagCompletionFunc on 9 flags across backup, restore, schedule, backuplocation, snapshotlocation, repo, and debug. Closes #9782 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Joseph <jvaikath@redhat.com>
98 lines
3.0 KiB
Go
98 lines
3.0 KiB
Go
/*
|
|
Copyright 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 cli
|
|
|
|
import (
|
|
"context"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/spf13/cobra"
|
|
"k8s.io/apimachinery/pkg/api/meta"
|
|
kbclient "sigs.k8s.io/controller-runtime/pkg/client"
|
|
|
|
velerov1api "github.com/vmware-tanzu/velero/pkg/apis/velero/v1"
|
|
"github.com/vmware-tanzu/velero/pkg/client"
|
|
)
|
|
|
|
// completionFunc is the function signature for cobra's ValidArgsFunction.
|
|
type completionFunc = func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)
|
|
|
|
// completeNames builds a completion function for any Velero list type.
|
|
// It extracts resource names via apimachinery's meta helpers.
|
|
func completeNames(f client.Factory, list kbclient.ObjectList) completionFunc {
|
|
return func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
|
|
kbClient, err := f.KubebuilderClient()
|
|
if err != nil {
|
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
|
}
|
|
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
|
|
defer cancel()
|
|
freshList := list.DeepCopyObject().(kbclient.ObjectList)
|
|
if err := kbClient.List(ctx, freshList, &kbclient.ListOptions{Namespace: f.Namespace()}); err != nil {
|
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
|
}
|
|
items, err := meta.ExtractList(freshList)
|
|
if err != nil {
|
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
|
}
|
|
seen := make(map[string]bool, len(args))
|
|
for _, a := range args {
|
|
seen[a] = true
|
|
}
|
|
var filtered []string
|
|
for _, item := range items {
|
|
accessor, err := meta.Accessor(item)
|
|
if err != nil {
|
|
continue
|
|
}
|
|
name := accessor.GetName()
|
|
if seen[name] {
|
|
continue
|
|
}
|
|
if strings.HasPrefix(name, toComplete) {
|
|
filtered = append(filtered, name)
|
|
}
|
|
}
|
|
return filtered, cobra.ShellCompDirectiveNoFileComp
|
|
}
|
|
}
|
|
|
|
func CompleteBackupNames(f client.Factory) completionFunc {
|
|
return completeNames(f, &velerov1api.BackupList{})
|
|
}
|
|
|
|
func CompleteRestoreNames(f client.Factory) completionFunc {
|
|
return completeNames(f, &velerov1api.RestoreList{})
|
|
}
|
|
|
|
func CompleteScheduleNames(f client.Factory) completionFunc {
|
|
return completeNames(f, &velerov1api.ScheduleList{})
|
|
}
|
|
|
|
func CompleteBackupStorageLocationNames(f client.Factory) completionFunc {
|
|
return completeNames(f, &velerov1api.BackupStorageLocationList{})
|
|
}
|
|
|
|
func CompleteVolumeSnapshotLocationNames(f client.Factory) completionFunc {
|
|
return completeNames(f, &velerov1api.VolumeSnapshotLocationList{})
|
|
}
|
|
|
|
func CompleteBackupRepositoryNames(f client.Factory) completionFunc {
|
|
return completeNames(f, &velerov1api.BackupRepositoryList{})
|
|
}
|