incus: Improve completion for config keys

lxc · Nov 16, 2024 · 34b0056 · 34b0056
1 parent d098f46
commit 34b0056
Show file tree

Hide file tree

Showing 2 changed files with 114 additions and 4 deletions.
diff --git a/cmd/incus/completion.go b/cmd/incus/completion.go
@@ -238,12 +238,110 @@ func (g *cmdGlobal) cmpImages(toComplete string) ([]string, cobra.ShellCompDirec
 	return results, cmpDirectives
 }
 
+// cmpInstanceKeys provides shell completion for all instance configuration keys.
+// It takes an instance name to determine instance type and returns a list of all instance configuration keys along with a shell completion directive.
+func (g *cmdGlobal) cmpInstanceKeys(instanceName string) ([]string, cobra.ShellCompDirective) {
+	var keys []string
+	cmpDirectives := cobra.ShellCompDirectiveNoFileComp
+
+	_, instanceNameOnly, found := strings.Cut(instanceName, ":")
+	if instanceNameOnly == "" && found {
+		serverKeys, directives := g.cmpServerAllKeys(instanceName)
+		keys = append(keys, serverKeys...)
+		cmpDirectives = directives
+
+		return keys, cmpDirectives
+	}
+
+	resources, err := g.ParseServers(instanceName)
+	if err != nil || len(resources) == 0 {
+		return nil, cobra.ShellCompDirectiveError
+	}
+
+	resource := resources[0]
+	client := resource.server
+
+	inst, _, err := client.GetInstance(instanceName)
+	if err != nil {
+		return nil, cobra.ShellCompDirectiveError
+	}
+
+	instanceType := inst.Type
+
+	if instanceType == "container" {
+		for k := range instance.InstanceConfigKeysContainer {
+			keys = append(keys, k)
+		}
+	} else if instanceType == "virtual-machine" {
+		for k := range instance.InstanceConfigKeysVM {
+			keys = append(keys, k)
+		}
+	}
+
+	for k := range instance.InstanceConfigKeysAny {
+		keys = append(keys, k)
+	}
+
+	return keys, cmpDirectives
+}
+
+// cmpInstanceAllKeys provides shell completion for all possible instance configuration keys.
+// It returns a list of all possible instance configuration keys along with a shell completion directive.
 func (g *cmdGlobal) cmpInstanceAllKeys() ([]string, cobra.ShellCompDirective) {
-	keys := []string{}
+	keys := make([]string, 0, len(instance.InstanceConfigKeysContainer)+len(instance.InstanceConfigKeysVM)+len(instance.InstanceConfigKeysAny))
+	cmpDirectives := cobra.ShellCompDirectiveNoFileComp
+
+	for k := range instance.InstanceConfigKeysContainer {
+		keys = append(keys, k)
+	}
+
+	for k := range instance.InstanceConfigKeysVM {
+		keys = append(keys, k)
+	}
+
 	for k := range instance.InstanceConfigKeysAny {
 		keys = append(keys, k)
 	}
 
+	return keys, cmpDirectives
+}
+
+// cmpServerAllKeys provides shell completion for all server configuration keys.
+// It takes an instance name and returns a list of all server configuration keys along with a shell completion directive.
+func (g *cmdGlobal) cmpServerAllKeys(instanceName string) ([]string, cobra.ShellCompDirective) {
+	resources, err := g.ParseServers(instanceName)
+	if err != nil || len(resources) == 0 {
+		return nil, cobra.ShellCompDirectiveError
+	}
+
+	resource := resources[0]
+	client := resource.server
+
+	metadataConfiguration, err := client.GetMetadataConfiguration()
+	if err != nil {
+		return nil, cobra.ShellCompDirectiveError
+	}
+
+	server, ok := metadataConfiguration.Config["server"]
+	if !ok {
+		return nil, cobra.ShellCompDirectiveError
+	}
+
+	keyCount := 0
+	for _, field := range server {
+		keyCount += len(field.Keys)
+	}
+
+	keys := make([]string, 0, keyCount)
+
+	for _, field := range server {
+		for _, keyMap := range field.Keys {
+			for key := range keyMap {
+				keys = append(keys, key)
+			}
+		}
+	}
+
 	return keys, cobra.ShellCompDirectiveNoFileComp
 }
 

diff --git a/cmd/incus/config.go b/cmd/incus/config.go
@@ -395,11 +395,15 @@ func (c *cmdConfigGet) Command() *cobra.Command {
 
 	cmd.ValidArgsFunction = func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 		if len(args) == 0 {
+			if strings.Contains(toComplete, ".") {
+				return c.global.cmpServerAllKeys(toComplete)
+			}
+
 			return c.global.cmpInstances(toComplete)
 		}
 
 		if len(args) == 1 {
-			return c.global.cmpInstanceAllKeys()
+			return c.global.cmpInstanceKeys(args[0])
 		}
 
 		return nil, cobra.ShellCompDirectiveNoFileComp
@@ -540,11 +544,15 @@ incus config set core.https_address=[::]:8443
 
 	cmd.ValidArgsFunction = func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 		if len(args) == 0 {
+			if strings.Contains(toComplete, ".") {
+				return c.global.cmpServerAllKeys(toComplete)
+			}
+
 			return c.global.cmpInstances(toComplete)
 		}
 
 		if len(args) == 1 {
-			return c.global.cmpInstanceAllKeys()
+			return c.global.cmpInstanceKeys(args[0])
 		}
 
 		return nil, cobra.ShellCompDirectiveNoFileComp
@@ -889,11 +897,15 @@ func (c *cmdConfigUnset) Command() *cobra.Command {
 
 	cmd.ValidArgsFunction = func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 		if len(args) == 0 {
+			if strings.Contains(toComplete, ".") {
+				return c.global.cmpServerAllKeys(toComplete)
+			}
+
 			return c.global.cmpInstances(toComplete)
 		}
 
 		if len(args) == 1 {
-			return c.global.cmpInstanceAllKeys()
+			return c.global.cmpInstanceKeys(args[0])
 		}
 
 		return nil, cobra.ShellCompDirectiveNoFileComp