Resolve net config

Author: rjtokenring

cli/template/apply.go

@@ -1,6 +1,6 @@
 // This file is part of arduino-cloud-cli.
 //
-// Copyright (C) 2021 ARDUINO SA (http://www.arduino.cc/)
+// Copyright (C) 2024 ARDUINO SA (http://www.arduino.cc/)
 //
 // This program is free software: you can redistribute it and/or modify
 // it under the terms of the GNU Affero General Public License as published
@@ -20,6 +20,7 @@ package template
 import (
 	"fmt"
 	"os"
+	"strings"
 
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
@@ -29,8 +30,10 @@ import (
 )
 
 type applyFlags struct {
-	templateId   string
-	templateName string
+	templateId     string
+	templatePrefix string
+	deviceId       string
+	netCredentials string
 }
 
 func initTemplateApplyCommand() *cobra.Command {
@@ -47,11 +50,14 @@ func initTemplateApplyCommand() *cobra.Command {
 		},
 	}
 
-	applyCommand.Flags().StringVarP(&flags.templateId, "template-id", "t", "", "Template id")
-	applyCommand.Flags().StringVarP(&flags.templateName, "name", "n", "", "Name")
+	applyCommand.Flags().StringVarP(&flags.templateId, "template-id", "t", "", "Template ID")
+	applyCommand.Flags().StringVarP(&flags.templatePrefix, "prefix", "p", "", "Prefix to apply to the name of created resources")
+	applyCommand.Flags().StringVarP(&flags.deviceId, "device-id", "d", "", "Device ID")
+	applyCommand.Flags().StringVarP(&flags.netCredentials, "network-credentials", "n", "", "Network credentials")
 
 	applyCommand.MarkFlagRequired("template-id")
-	applyCommand.MarkFlagRequired("name")
+	applyCommand.MarkFlagRequired("prefix")
+	applyCommand.MarkFlagRequired("device-id")
 
 	return applyCommand
 }
@@ -61,27 +67,18 @@ func runTemplateApplyCommand(flags *applyFlags) error {
 	if err != nil {
 		return fmt.Errorf("retrieving credentials: %w", err)
 	}
-	return template.ApplyCustomTemplates(cred, flags.templateId)
-}
-
-/*
 
-curl --location --request PUT 'http://localhost:9000/iot/v1/templates' \
---header 'Accept: application/yaml' \
---header 'Content-Type: application/json' \
---header 'Authorization: ' \
---data '{
-    "template_name": "home",
-    "custom_template_id": "d864f20e-dcf4-4c8a-b3e7-f1bfffe86f60",
-    "things_options": {
-        "home-3a06e": {
-            "device_id": "08d75172-335e-4cb9-b401-83eb4db213fb",
-            "secrets": {
-                "SECRET_SSID": "asdas",
-                "SECRET_OPTIONAL_PASS": "asdsad"
-            }
-        }
-    }
-}'
+	deviceNetCredentials := make(map[string]string)
+	if flags.netCredentials != "" {
+		configNetArray := strings.Split(strings.Trim(flags.netCredentials, " "), ",")
+		for _, netConfig := range configNetArray {
+			netConfigArray := strings.Split(netConfig, "=")
+			if len(netConfigArray) != 2 {
+				return fmt.Errorf("invalid network configuration: %s", netConfig)
+			}
+			deviceNetCredentials[netConfigArray[0]] = netConfigArray[1]
+		}
+	}
 
-*/
+	return template.ApplyCustomTemplates(cred, flags.templateId, flags.deviceId, flags.templatePrefix, deviceNetCredentials)
+}

command/template/apply.go

@@ -1,6 +1,6 @@
 // This file is part of arduino-cloud-cli.
 //
-// Copyright (C) 2021 ARDUINO SA (http://www.arduino.cc/)
+// Copyright (C) 2024 ARDUINO SA (http://www.arduino.cc/)
 //
 // This program is free software: you can redistribute it and/or modify
 // it under the terms of the GNU Affero General Public License as published
@@ -18,34 +18,90 @@
 package template
 
 import (
+	"context"
 	"fmt"
 
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cloud-cli/config"
+	"github.com/arduino/arduino-cloud-cli/internal/iot"
 	storageapi "github.com/arduino/arduino-cloud-cli/internal/storage-api"
+	iotclient "github.com/arduino/iot-client-go/v2"
 	"github.com/gofrs/uuid"
 	"github.com/sirupsen/logrus"
 )
 
-func ApplyCustomTemplates(cred *config.Credentials, templateId string) error {
+func ApplyCustomTemplates(cred *config.Credentials, templateId, deviceId, prefix string, networkCredentials map[string]string) error {
 
+	ctx := context.Background()
+
+	// Open clients
 	apiclient := storageapi.NewClient(cred)
+	iotClient, err := iot.NewClient(cred)
+	if err != nil {
+		return err
+	}
 
-	feedback.Printf("Applying template %s", templateId)
+	feedback.Printf("Applying template %s to device %s", templateId, deviceId)
 
 	templateIdUUID, err := uuid.FromString(templateId)
 	if err != nil {
 		return fmt.Errorf("invalid template id: %s", templateId)
 	}
+
+	// Get custom template and verify it is present
 	cstTemplate, err := apiclient.GetCustomTemplate(templateIdUUID)
 	if err != nil {
 		return err
 	}
-	if len(cstTemplate.ThingTemplates) > 0 {
-		mainThing := cstTemplate.ThingTemplates[0]
-		logrus.Debug("Main thing template - id: ", mainThing.Id)
-		//TODO check thing ID proceed
+	if len(cstTemplate.ThingTemplates) <= 0 {
+		return fmt.Errorf("template %s has no thing template", templateId)
 	}
+	mainThing := cstTemplate.ThingTemplates[0]
+	logrus.Debug("Main thing template - id: ", mainThing.Id)
 
+	// Get device and check its connectivity
+	secrets, err := resolveDeviceNetworkConfigurations(ctx, iotClient, deviceId, networkCredentials)
+	if err != nil {
+		return err
+	}
+	for key, value := range secrets {
+		logrus.Info(fmt.Sprintf("Secret %s: %s", key, value))
+	}
 	return nil
 }
+
+func resolveDeviceNetworkConfigurations(ctx context.Context, cl *iot.Client, deviceId string, networkCredentials map[string]string) (map[string]string, error) {
+	device, err := cl.DeviceShow(ctx, deviceId)
+	if err != nil {
+		return nil, err
+	}
+	if device.Type == "" || device.ConnectionType == nil {
+		logrus.Warnf("Device %s has no type or connection-type - type: %s", deviceId, device.Type)
+		return nil, nil // cannot take a decision on this device, try to proceed
+	}
+	logrus.Infof("Device %s - type: %s - connection-type: %s", deviceId, device.Type, *device.ConnectionType)
+
+	credentials, err := cl.DeviceNetworkCredentials(ctx, device.Type, *device.ConnectionType)
+	if err != nil {
+		return nil, err
+	}
+
+	// Check if the provided network credentials are valid. Verify if all the required credentials are present.
+	discoveredCredentials := make(map[string]iotclient.ArduinoCredentialsv1)
+	for _, credential := range credentials {
+		discoveredCredentials[credential.GetSecretName()] = credential
+		if credential.Required {
+			if _, ok := networkCredentials[credential.GetSecretName()]; !ok {
+				return nil, fmt.Errorf("missing mandatory network credential: %s", credential.GetSecretName())
+			}
+		}
+	}
+	// Remove any property that is not supported
+	for key := range networkCredentials {
+		if _, ok := discoveredCredentials[key]; !ok {
+			delete(networkCredentials, key)
+		}
+	}
+
+	return networkCredentials, nil
+}

internal/iot/client.go

@@ -195,6 +195,23 @@ func (cl *Client) DeviceShow(ctx context.Context, id string) (*iotclient.Arduino
 	return dev, nil
 }
 
+// DeviceNetworkCredentials allows to retrieve a specific device network credentials configuration options
+func (cl *Client) DeviceNetworkCredentials(ctx context.Context, deviceType, connection string) ([]iotclient.ArduinoCredentialsv1, error) {
+	ctx, err := ctxWithToken(ctx, cl.token)
+	if err != nil {
+		return nil, err
+	}
+
+	req := cl.api.NetworkCredentialsV1Api.NetworkCredentialsV1Show(ctx, deviceType)
+	req = req.Connection(connection)
+	dev, _, err := cl.api.NetworkCredentialsV1Api.NetworkCredentialsV1ShowExecute(req)
+	if err != nil {
+		err = fmt.Errorf("retrieving device network configuration, %w", errorDetail(err))
+		return nil, err
+	}
+	return dev, nil
+}
+
 // DeviceOTA performs an OTA upload request to Arduino IoT Cloud, passing
 // the ID of the device to be updated and the actual file containing the OTA firmware.
 func (cl *Client) DeviceOTA(ctx context.Context, id string, file *os.File, expireMins int) error {