Merge pull request #1982 from Abdomash/profile-server-side-filtering

Add server side filtering for `incus profile list`

Author: stgraber

client/incus_profiles.go

@@ -36,6 +36,22 @@ func (r *ProtocolIncus) GetProfiles() ([]api.Profile, error) {
 	return profiles, nil
 }
 
+// GetProfilesWithFilter returns a filtered list of available Profile structs.
+func (r *ProtocolIncus) GetProfilesWithFilter(filters []string) ([]api.Profile, error) {
+	profiles := []api.Profile{}
+
+	v := url.Values{}
+	v.Set("recursion", "1")
+	v.Set("filter", parseFilters(filters))
+
+	_, err := r.queryStruct("GET", fmt.Sprintf("/profiles?%s", v.Encode()), nil, "", &profiles)
+	if err != nil {
+		return nil, err
+	}
+
+	return profiles, nil
+}
+
 // GetProfilesAllProjects returns a list of profiles across all projects as Profile structs.
 func (r *ProtocolIncus) GetProfilesAllProjects() ([]api.Profile, error) {
 	err := r.CheckExtension("profiles_all_projects")
@@ -52,6 +68,28 @@ func (r *ProtocolIncus) GetProfilesAllProjects() ([]api.Profile, error) {
 	return profiles, nil
 }
 
+// GetProfilesAllProjectsWithFilter returns a filtered list of profiles across all projects as Profile structs.
+func (r *ProtocolIncus) GetProfilesAllProjectsWithFilter(filters []string) ([]api.Profile, error) {
+	err := r.CheckExtension("profiles_all_projects")
+	if err != nil {
+		return nil, fmt.Errorf(`The server is missing the required "profiles_all_projects" API extension`)
+	}
+
+	profiles := []api.Profile{}
+
+	v := url.Values{}
+	v.Set("recursion", "1")
+	v.Set("all-projects", "true")
+	v.Set("filter", parseFilters(filters))
+
+	_, err = r.queryStruct("GET", fmt.Sprintf("/profiles?%s", v.Encode()), nil, "", &profiles)
+	if err != nil {
+		return nil, err
+	}
+
+	return profiles, nil
+}
+
 // GetProfile returns a Profile entry for the provided name.
 func (r *ProtocolIncus) GetProfile(name string) (*api.Profile, string, error) {
 	profile := api.Profile{}

client/interfaces.go

@@ -290,8 +290,10 @@ type InstanceServer interface {
 
 	// Profile functions
 	GetProfilesAllProjects() (profiles []api.Profile, err error)
+	GetProfilesAllProjectsWithFilter(filters []string) ([]api.Profile, error)
 	GetProfileNames() (names []string, err error)
 	GetProfiles() (profiles []api.Profile, err error)
+	GetProfilesWithFilter(filters []string) ([]api.Profile, error)
 	GetProfile(name string) (profile *api.Profile, ETag string, err error)
 	CreateProfile(profile api.ProfilesPost) (err error)
 	UpdateProfile(name string, profile api.ProfilePut, ETag string) (err error)

cmd/incus/profile.go

@@ -6,6 +6,7 @@ import (
 	"io"
 	"net/http"
 	"os"
+	"regexp"
 	"slices"
 	"sort"
 	"strings"
@@ -729,12 +730,20 @@ type cmdProfileList struct {
 // Command returns a cobra.Command for use with (*cobra.Command).AddCommand.
 func (c *cmdProfileList) Command() *cobra.Command {
 	cmd := &cobra.Command{}
-	cmd.Use = usage("list", i18n.G("[<remote>:]"))
+	cmd.Use = usage("list", i18n.G("[<remote>:] [<filter>...]"))
 	cmd.Aliases = []string{"ls"}
 	cmd.Short = i18n.G("List profiles")
 	cmd.Long = cli.FormatSection(i18n.G("Description"), i18n.G(
 		`List profiles
 
+Filters may be of the <key>=<value> form for property based filtering,
+or part of the profile name. Filters must be delimited by a ','.
+
+Examples:
+  - "foo" lists all profiles that start with the name foo
+  - "name=foo" lists all profiles that exactly have the name foo
+  - "description=.*bar.*" lists all profiles with a description that contains "bar"
+
 The -c option takes a (optionally comma-separated) list of arguments
 that control which image attributes to output when displaying in table
 or csv format.
@@ -826,7 +835,7 @@ func (c *cmdProfileList) usedByColumnData(profile api.Profile) string {
 // Run runs the actual command logic.
 func (c *cmdProfileList) Run(cmd *cobra.Command, args []string) error {
 	// Quick checks.
-	exit, err := c.global.checkArgs(cmd, args, 0, 1)
+	exit, err := c.global.checkArgs(cmd, args, 0, -1)
 	if exit {
 		return err
 	}
@@ -835,10 +844,16 @@ func (c *cmdProfileList) Run(cmd *cobra.Command, args []string) error {
 		return errors.New(i18n.G("Can't specify --project with --all-projects"))
 	}
 
-	// Parse remote
+	// Parse remote and filters.
 	remote := ""
-	if len(args) > 0 {
-		remote = args[0]
+	filters := []string{}
+
+	if len(args) != 0 {
+		filters = args
+		if strings.Contains(args[0], ":") && !strings.Contains(args[0], "=") {
+			remote = args[0]
+			filters = args[1:]
+		}
 	}
 
 	resources, err := c.global.parseServers(remote)
@@ -848,18 +863,29 @@ func (c *cmdProfileList) Run(cmd *cobra.Command, args []string) error {
 
 	resource := resources[0]
 
+	flattenedFilters := []string{}
+	for _, filter := range filters {
+		flattenedFilters = append(flattenedFilters, strings.Split(filter, ",")...)
+	}
+
+	filters = flattenedFilters
+
+	if len(filters) > 0 && !strings.Contains(filters[0], "=") {
+		filters[0] = fmt.Sprintf("name=^%s($|.*)", regexp.QuoteMeta(filters[0]))
+	}
+
+	serverFilters, _ := getServerSupportedFilters(filters, []string{}, false)
+
 	// List profiles
 	var profiles []api.Profile
 	if c.flagAllProjects {
-		profiles, err = resource.server.GetProfilesAllProjects()
-		if err != nil {
-			return err
-		}
+		profiles, err = resource.server.GetProfilesAllProjectsWithFilter(serverFilters)
 	} else {
-		profiles, err = resource.server.GetProfiles()
-		if err != nil {
-			return err
-		}
+		profiles, err = resource.server.GetProfilesWithFilter(serverFilters)
+	}
+
+	if err != nil {
+		return err
 	}
 
 	columns, err := c.parseColumns()