add brickInstance variables full info

Author: mirkoCrobu

cmd/gendoc/docs.go

@@ -909,7 +909,7 @@ Contains a JSON object with the details of an error.
 			})(nil),
 			CustomSuccessResponse: &CustomResponseDef{
 				ContentType:   "application/json",
-				DataStructure: bricks.BrickInstance{},
+				DataStructure: bricks.BrickInstanceDetails{},
 				Description:   "Successful response",
 				StatusCode:    http.StatusOK,
 			},

internal/api/docs/openapi.yaml

@@ -159,7 +159,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/BrickInstance'
+                $ref: '#/components/schemas/BrickInstanceDetails'
           description: Successful response
         "400":
           $ref: '#/components/responses/BadRequest'
@@ -1183,7 +1183,7 @@ components:
       properties:
         bricks:
           items:
-            $ref: '#/components/schemas/BrickInstance'
+            $ref: '#/components/schemas/BrickInstanceDetails'
           nullable: true
           type: array
       type: object
@@ -1319,7 +1319,7 @@ components:
             $ref: '#/components/schemas/BrickVariable'
           type: object
       type: object
-    BrickInstance:
+    BrickInstanceDetails:
       properties:
         author:
           type: string
@@ -1335,9 +1335,18 @@ components:
           type: string
         variables:
           additionalProperties:
-            type: string
+            $ref: '#/components/schemas/BrickInstanceVariable'
           type: object
       type: object
+    BrickInstanceVariable:
+      properties:
+        description:
+          type: string
+        required:
+          type: boolean
+        value:
+          type: string
+      type: object
     BrickListItem:
       properties:
         author:

internal/e2e/client/client.gen.go

@@ -162,7 +162,12 @@ func TestUpsertAppBrickInstance(t *testing.T) {
 	require.NoError(t, err)
 	require.NotEmpty(t, brickInstance.JSON200)
 	require.Equal(t, ImageClassifactionBrickID, *brickInstance.JSON200.Id)
-	require.Equal(t, "/home/arduino/.arduino-bricks/ei-models", (*brickInstance.JSON200.Variables)["CUSTOM_MODEL_PATH"])
+	expectedVariable := client.BrickInstanceVariable{
+		Value:       f.Ptr("/home/arduino/.arduino-bricks/ei-models"),
+		Description: f.Ptr("path to the custom model directory"),
+		Required:    f.Ptr(false),
+	}
+	require.Equal(t, expectedVariable, (*brickInstance.JSON200.Variables)["CUSTOM_MODEL_PATH"])
 	require.Equal(t, "mobilenet-image-classification", *brickInstance.JSON200.Model)
 
 	t.Run("OverrideBrickInstance", func(t *testing.T) {
@@ -311,7 +316,12 @@ func TestUpdateAppBrickInstance(t *testing.T) {
 		require.NoError(t, err)
 		require.NotEmpty(t, brickInstance.JSON200)
 		require.Equal(t, ImageClassifactionBrickID, *brickInstance.JSON200.Id)
-		require.Equal(t, "overidden", (*brickInstance.JSON200.Variables)["CUSTOM_MODEL_PATH"])
+		expectedVariable := client.BrickInstanceVariable{
+			Value:       f.Ptr("overidden"),
+			Description: f.Ptr("path to the custom model directory"),
+			Required:    f.Ptr(false),
+		}
+		require.Equal(t, expectedVariable, (*brickInstance.JSON200.Variables)["CUSTOM_MODEL_PATH"])
 		require.Equal(t, "person-classification", *brickInstance.JSON200.Model)
 	})
 	t.Run("UpdateOnlyModel", func(t *testing.T) {

internal/e2e/daemon/instance_bricks_test.go

@@ -71,36 +71,36 @@ func (s *Service) List() (BrickListResult, error) {
 }
 
 func (s *Service) AppBrickInstancesList(a *app.ArduinoApp) (AppBrickInstancesResult, error) {
-	res := AppBrickInstancesResult{BrickInstances: make([]BrickInstance, len(a.Descriptor.Bricks))}
+	res := AppBrickInstancesResult{BrickInstances: make([]BrickInstanceDetails, len(a.Descriptor.Bricks))}
+
 	for i, brickInstance := range a.Descriptor.Bricks {
 		brick, found := s.bricksIndex.FindBrickByID(brickInstance.ID)
 		if !found {
 			return AppBrickInstancesResult{}, fmt.Errorf("brick not found with id %s", brickInstance.ID)
 		}
-		res.BrickInstances[i] = BrickInstance{
-			ID:        brick.ID,
-			Name:      brick.Name,
-			Author:    "Arduino", // TODO: for now we only support our bricks
-			Category:  brick.Category,
-			Status:    "installed",
-			ModelID:   brickInstance.Model,     // TODO: in case is not set by the user, should we return the default model?
-			Variables: brickInstance.Variables, // TODO: do we want to show also the default value of not explicitly set variables?
-		}
+		res.BrickInstances[i] = s.buildBrickInstanceDetails(brick, brickInstance)
 	}
+
 	return res, nil
 }
-
 func (s *Service) AppBrickInstanceDetails(a *app.ArduinoApp, brickID string) (BrickInstanceDetails, error) {
+
 	brick, found := s.bricksIndex.FindBrickByID(brickID)
 	if !found {
 		return BrickInstanceDetails{}, ErrBrickNotFound
 	}
-	// Check if the brick is already added in the app
+
 	brickIndex := slices.IndexFunc(a.Descriptor.Bricks, func(b app.Brick) bool { return b.ID == brickID })
 	if brickIndex == -1 {
 		return BrickInstanceDetails{}, fmt.Errorf("brick %s not added in the app", brickID)
 	}
+	brickInstance := a.Descriptor.Bricks[brickIndex]
+	details := s.buildBrickInstanceDetails(brick, brickInstance)
 
+	return details, nil
+}
+
+func (s *Service) buildBrickInstanceDetails(brick *bricksindex.Brick, brickInstance app.Brick) BrickInstanceDetails {
 	variables := make(map[string]BrickInstanceVariable, len(brick.Variables))
 	for _, v := range brick.Variables {
 		variables[v.Name] = BrickInstanceVariable{
@@ -109,9 +109,7 @@ func (s *Service) AppBrickInstanceDetails(a *app.ArduinoApp, brickID string) (Br
 			Required:    v.IsRequired(),
 		}
 	}
-	// Add/Update the variables with the ones from the app descriptor
-	appVars := a.Descriptor.Bricks[brickIndex].Variables
-	for varName, appValue := range appVars {
+	for varName, appValue := range brickInstance.Variables {
 		if v, ok := variables[varName]; ok {
 			v.Value = appValue
 			variables[varName] = v
@@ -121,20 +119,20 @@ func (s *Service) AppBrickInstanceDetails(a *app.ArduinoApp, brickID string) (Br
 			}
 		}
 	}
-	modelID := a.Descriptor.Bricks[brickIndex].Model
+
+	modelID := brickInstance.Model
 	if modelID == "" {
 		modelID = brick.ModelName
 	}
-
 	return BrickInstanceDetails{
-		ID:        brickID,
+		ID:        brick.ID,
 		Name:      brick.Name,
-		Author:    "Arduino", // TODO: for now we only support our bricks
+		Author:    "Arduino",
 		Category:  brick.Category,
-		Status:    "installed", // For now every Arduino brick are installed
+		Status:    "installed",
 		Variables: variables,
 		ModelID:   modelID,
-	}, nil
+	}
 }
 
 func (s *Service) BricksDetails(id string) (BrickDetailsResult, error) {

internal/orchestrator/bricks/bricks.go

@@ -30,17 +30,7 @@ type BrickListItem struct {
 }
 
 type AppBrickInstancesResult struct {
-	BrickInstances []BrickInstance `json:"bricks"`
-}
-
-type BrickInstance struct {
-	ID        string            `json:"id"`
-	Name      string            `json:"name"`
-	Author    string            `json:"author"`
-	Category  string            `json:"category"`
-	Status    string            `json:"status"`
-	Variables map[string]string `json:"variables,omitempty"`
-	ModelID   string            `json:"model,omitempty"`
+	BrickInstances []BrickInstanceDetails `json:"bricks"`
 }
 
 type BrickInstanceDetails struct {