Filter things by tags

Author: polldo

cli/thing/list.go

@@ -33,6 +33,7 @@ var listFlags struct {
 	ids       []string
 	deviceID  string
 	variables bool
+	tags      map[string]string
 }
 
 func initListCommand() *cobra.Command {
@@ -47,6 +48,13 @@ func initListCommand() *cobra.Command {
 	// list only the thing associated to the passed device id
 	listCommand.Flags().StringVarP(&listFlags.deviceID, "device-id", "d", "", "ID of Device associated to the thing to be retrieved")
 	listCommand.Flags().BoolVarP(&listFlags.variables, "show-variables", "s", false, "Show thing variables")
+	// list only the things that have all the passed tags
+	listCommand.Flags().StringToStringVar(
+		&listFlags.tags,
+		"tags",
+		nil,
+		"List of comma-separated tags. A tag has this format: <key>=<value>",
+	)
 	return listCommand
 }
 
@@ -56,6 +64,7 @@ func runListCommand(cmd *cobra.Command, args []string) {
 	params := &thing.ListParams{
 		IDs:       listFlags.ids,
 		Variables: listFlags.variables,
+		Tags:      listFlags.tags,
 	}
 	if listFlags.deviceID != "" {
 		params.DeviceID = &listFlags.deviceID

command/thing/list.go

@@ -25,9 +25,10 @@ import (
 // ListParams contains the optional parameters needed
 // to filter the things to be listed.
 type ListParams struct {
-	IDs       []string // If IDs is not nil, only things belonging to that list are returned
-	DeviceID  *string  // If DeviceID is provided, only the thing associated to that device is listed.
-	Variables bool     // If Variables is true, variable names are retrieved.
+	IDs       []string          // If IDs is not nil, only things belonging to that list are returned
+	DeviceID  *string           // If DeviceID is provided, only the thing associated to that device is listed.
+	Variables bool              // If Variables is true, variable names are retrieved.
+	Tags      map[string]string // If tags are provided, only things that have all these tags are listed.
 }
 
 // List command is used to list
@@ -42,7 +43,7 @@ func List(params *ListParams) ([]ThingInfo, error) {
 		return nil, err
 	}
 
-	foundThings, err := iotClient.ThingList(params.IDs, params.DeviceID, params.Variables)
+	foundThings, err := iotClient.ThingList(params.IDs, params.DeviceID, params.Variables, params.Tags)
 	if err != nil {
 		return nil, err
 	}

internal/iot/client.go

@@ -38,7 +38,7 @@ type Client interface {
 	ThingUpdate(id string, thing *iotclient.Thing, force bool) error
 	ThingDelete(id string) error
 	ThingShow(id string) (*iotclient.ArduinoThing, error)
-	ThingList(ids []string, device *string, props bool) ([]iotclient.ArduinoThing, error)
+	ThingList(ids []string, device *string, props bool, tags map[string]string) ([]iotclient.ArduinoThing, error)
 	DashboardCreate(dashboard *iotclient.Dashboardv2) (*iotclient.ArduinoDashboardv2, error)
 	DashboardShow(id string) (*iotclient.ArduinoDashboardv2, error)
 	DashboardDelete(id string) error
@@ -186,7 +186,7 @@ func (cl *client) ThingShow(id string) (*iotclient.ArduinoThing, error) {
 }
 
 // ThingList returns a list of things on Arduino IoT Cloud.
-func (cl *client) ThingList(ids []string, device *string, props bool) ([]iotclient.ArduinoThing, error) {
+func (cl *client) ThingList(ids []string, device *string, props bool, tags map[string]string) ([]iotclient.ArduinoThing, error) {
 	opts := &iotclient.ThingsV2ListOpts{}
 	opts.ShowProperties = optional.NewBool(props)
 
@@ -198,6 +198,15 @@ func (cl *client) ThingList(ids []string, device *string, props bool) ([]iotclie
 		opts.DeviceId = optional.NewString(*device)
 	}
 
+	if tags != nil {
+		t := make([]string, 0, len(tags))
+		for key, val := range tags {
+			// Use the 'key:value' format required from the backend
+			t = append(t, key+":"+val)
+		}
+		opts.Tags = optional.NewInterface(t)
+	}
+
 	things, _, err := cl.api.ThingsV2Api.ThingsV2List(cl.ctx, opts)
 	if err != nil {
 		err = fmt.Errorf("retrieving things, %w", errorDetail(err))