Filter resources by tags (#55)

* Filter things by tags

* Filter devices by tags

* Update filter command

* Update readme filter

* Update mocks

Author: Paolo Calao

README.md

@@ -65,12 +65,12 @@ Use this command to provision a device:
 
 ## Device commands
 
-Once a device has been created thorugh the provisioning procedure, it can be deleted by using the following command:
-`$ arduino-cloud-cli device delete --id <deviceID>`
-
-Devices currently present on Arduino IoT Cloud can be retrieved by using this command:
+Devices currently present on Arduino IoT Cloud can be retrieved with:
 `$ arduino-cloud-cli device list`
 
+It has an optional `--tags` flag that allows to list only the devices having all the provided tags:
+`$ arduino-cloud-cli device list --tags <key0>=<value0>,<key1>=<value1>`
+
 Add tags to a device. Tags should be passed as a comma-separated list of `<key>=<value>` items:
 
 `$ arduino-cloud-cli device create-tags --id <deviceID> --tags <key0>=<value0>,<key1>=<value1>`
@@ -106,6 +106,12 @@ Print only the thing associated to the passed device:
 
 `$ arduino-cloud-cli thing list --device-id <deviceID>`
 
+Print only the things that have all the passed tags:
+
+`$ arduino-cloud-cli thing list --tags <key0>=<value0>,<key1>=<value1>`
+
+Things can be deleted using the thing delete command. This command accepts two mutually exclusive flags: `--id` and `--tags`. Only one of them must be passed. When the `--id` is passed, the thing having such ID gets deleted:
+
 Delete a thing with the following command:
 
 `$ arduino-cloud-cli thing delete --id <thingID>`

cli/device/list.go

@@ -28,20 +28,32 @@ import (
 	"github.com/spf13/cobra"
 )
 
+var listFlags struct {
+	tags map[string]string
+}
+
 func initListCommand() *cobra.Command {
 	listCommand := &cobra.Command{
 		Use:   "list",
 		Short: "List devices",
 		Long:  "List devices on Arduino IoT Cloud",
 		Run:   runListCommand,
 	}
+	listCommand.Flags().StringToStringVar(
+		&listFlags.tags,
+		"tags",
+		nil,
+		"Comma-separated list of tags with format <key>=<value>.\n"+
+			"List only devices that match the provided tags.",
+	)
 	return listCommand
 }
 
 func runListCommand(cmd *cobra.Command, args []string) {
 	logrus.Info("Listing devices")
 
-	devs, err := device.List()
+	params := &device.ListParams{Tags: listFlags.tags}
+	devs, err := device.List(params)
 	if err != nil {
 		feedback.Errorf("Error during device list: %v", err)
 		os.Exit(errorcodes.ErrGeneric)

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")
+	listCommand.Flags().StringToStringVar(
+		&listFlags.tags,
+		"tags",
+		nil,
+		"Comma-separated list of tags with format <key>=<value>.\n"+
+			"List only things that match the provided tags.",
+	)
 	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/device/list.go

@@ -32,9 +32,15 @@ type DeviceInfo struct {
 	FQBN   string `json:"fqbn"`
 }
 
+// ListParams contains the optional parameters needed
+// to filter the devices to be listed.
+type ListParams struct {
+	Tags map[string]string // If tags are provided, only devices that have all these tags are listed.
+}
+
 // List command is used to list
 // the devices of Arduino IoT Cloud.
-func List() ([]DeviceInfo, error) {
+func List(params *ListParams) ([]DeviceInfo, error) {
 	conf, err := config.Retrieve()
 	if err != nil {
 		return nil, err
@@ -44,7 +50,7 @@ func List() ([]DeviceInfo, error) {
 		return nil, err
 	}
 
-	foundDevices, err := iotClient.DeviceList()
+	foundDevices, err := iotClient.DeviceList(params.Tags)
 	if err != nil {
 		return nil, err
 	}

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

@@ -30,7 +30,7 @@ import (
 type Client interface {
 	DeviceCreate(fqbn, name, serial, devType string) (*iotclient.ArduinoDevicev2, error)
 	DeviceDelete(id string) error
-	DeviceList() ([]iotclient.ArduinoDevicev2, error)
+	DeviceList(tags map[string]string) ([]iotclient.ArduinoDevicev2, error)
 	DeviceShow(id string) (*iotclient.ArduinoDevicev2, error)
 	DeviceOTA(id string, file *os.File, expireMins int) error
 	DeviceTagsCreate(id string, tags map[string]string) error
@@ -40,7 +40,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)
 	ThingTagsCreate(id string, tags map[string]string) error
 	ThingTagsDelete(id string, keys []string) error
 	DashboardCreate(dashboard *iotclient.Dashboardv2) (*iotclient.ArduinoDashboardv2, error)
@@ -96,8 +96,18 @@ func (cl *client) DeviceDelete(id string) error {
 
 // DeviceList retrieves and returns a list of all Arduino IoT Cloud devices
 // belonging to the user performing the request.
-func (cl *client) DeviceList() ([]iotclient.ArduinoDevicev2, error) {
-	devices, _, err := cl.api.DevicesV2Api.DevicesV2List(cl.ctx, nil)
+func (cl *client) DeviceList(tags map[string]string) ([]iotclient.ArduinoDevicev2, error) {
+	opts := &iotclient.DevicesV2ListOpts{}
+	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)
+	}
+
+	devices, _, err := cl.api.DevicesV2Api.DevicesV2List(cl.ctx, opts)
 	if err != nil {
 		err = fmt.Errorf("listing devices: %w", errorDetail(err))
 		return nil, err
@@ -216,7 +226,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)
 
@@ -228,6 +238,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))