rename to RequireModel

Author: giulio93

internal/e2e/daemon/brick_test.go

@@ -83,7 +83,7 @@ func TestBricksList(t *testing.T) {
 		require.Equal(t, bIdx.Description, *brick.Description)
 		require.Equal(t, "Arduino", *brick.Author)
 		require.Equal(t, "installed", *brick.Status)
-		require.Equal(t, bIdx.ModelRequired, *brick.RequireModel)
+		require.Equal(t, bIdx.RequireModel, *brick.RequireModel)
 	}
 }
 

internal/orchestrator/bricks/bricks.go

@@ -64,7 +64,7 @@ func (s *Service) List() (BrickListResult, error) {
 			Description:   brick.Description,
 			Category:      brick.Category,
 			Status:        "installed",
-			ModelRequired: brick.ModelRequired,
+			RequiredModel: brick.RequireModel,
 			Models: f.Map(s.modelsIndex.GetModelsByBrick(brick.ID), func(m modelsindex.AIModel) string {
 				return m.ID
 			}),
@@ -89,7 +89,7 @@ func (s *Service) AppBrickInstancesList(a *app.ArduinoApp) (AppBrickInstancesRes
 			Author:          "Arduino", // TODO: for now we only support our bricks
 			Category:        brick.Category,
 			Status:          "installed",
-			ModelRequired:   brick.ModelRequired, // TODO: in case is not set by the user, should we return false?
+			RequiredModel:   brick.RequireModel,  // TODO: in case is not set by the user, should we return false?
 			ModelID:         brickInstance.Model, // TODO: in case is not set by the user, should we return the default model?
 			Variables:       variablesMap,        // TODO: do we want to show also the default value of not explicitly set variables?
 			ConfigVariables: configVariables,
@@ -123,7 +123,7 @@ func (s *Service) AppBrickInstanceDetails(a *app.ArduinoApp, brickID string) (Br
 		Author:          "Arduino", // TODO: for now we only support our bricks
 		Category:        brick.Category,
 		Status:          "installed", // For now every Arduino brick are installed
-		ModelRequired:   brick.ModelRequired,
+		RequiredModel:   brick.RequireModel,
 		Variables:       variables,
 		ConfigVariables: configVariables,
 		ModelID:         modelID,
@@ -203,7 +203,7 @@ func (s *Service) BricksDetails(id string, idProvider *app.IDProvider,
 		Author:        "Arduino", // TODO: for now we only support our bricks
 		Description:   brick.Description,
 		Category:      brick.Category,
-		ModelRequired: brick.ModelRequired,
+		RequiredModel: brick.RequireModel,
 		Status:        "installed", // For now every Arduino brick are installed
 		Variables:     variables,
 		Readme:        readme,

internal/orchestrator/bricks/types.go

@@ -26,7 +26,7 @@ type BrickListItem struct {
 	Description   string   `json:"description"`
 	Category      string   `json:"category"`
 	Status        string   `json:"status"`
-	ModelRequired bool     `json:"require_model"`
+	RequiredModel bool     `json:"require_model"`
 	Models        []string `json:"models"`
 }
 
@@ -42,7 +42,7 @@ type BrickInstance struct {
 	Status          string                `json:"status"`
 	Variables       map[string]string     `json:"variables,omitempty" description:"Deprecated: use config_variables instead. This field is kept for backward compatibility."`
 	ConfigVariables []BrickConfigVariable `json:"config_variables,omitempty"`
-	ModelRequired   bool                  `json:"require_model,omitempty"`
+	RequiredModel   bool                  `json:"require_model,omitempty"`
 	ModelID         string                `json:"model,omitempty"`
 }
 
@@ -75,7 +75,7 @@ type BrickDetailsResult struct {
 	Description   string                   `json:"description"`
 	Category      string                   `json:"category"`
 	Status        string                   `json:"status"`
-	ModelRequired bool                     `json:"require_model"`
+	RequiredModel bool                     `json:"require_model"`
 	Variables     map[string]BrickVariable `json:"variables,omitempty"`
 	Readme        string                   `json:"readme"`
 	ApiDocsPath   string                   `json:"api_docs_path"`

internal/orchestrator/bricksindex/bricks_index.go

@@ -57,7 +57,7 @@ type Brick struct {
 	RequireContainer          bool            `yaml:"require_container"`
 	Variables                 []BrickVariable `yaml:"variables,omitempty"`
 	Ports                     []string        `yaml:"ports,omitempty"`
-	ModelRequired             bool            `yaml:"require_model,omitempty"`
+	RequireModel              bool            `yaml:"require_model,omitempty"`
 	ModelName                 string          `yaml:"model_name,omitempty"`
 	MountDevicesIntoContainer bool            `yaml:"mount_devices_into_container,omitempty"`
 	RequiredDevices           []string        `yaml:"required_devices,omitempty"`

internal/orchestrator/bricksindex/bricks_index_test.go

@@ -156,7 +156,7 @@ func TestBricksIndex(t *testing.T) {
   - name: EI_V_ANOMALY_DETECTION_MODEL
     default_value: /models/ootb/ei/concrete-crack-anomaly-detection.eim
     description: path to the model file
-- id: arduino:fake_no_model
+- id: arduino:missing-model-require
   name: Camera Scanner
   description: Scans a camera for barcodes and QR codes
   require_container: false
@@ -178,7 +178,7 @@ func TestBricksIndex(t *testing.T) {
 	require.True(t, found)
 	require.Equal(t, "Image Classification", b_ic.Name)
 	require.Equal(t, "mobilenet-image-classification", b_ic.ModelName)
-	require.True(t, b_ic.ModelRequired)
+	require.True(t, b_ic.RequireModel)
 	require.Len(t, b_ic.Variables, 2)
 	require.Equal(t, "CUSTOM_MODEL_PATH", b_ic.Variables[0].Name)
 	require.Equal(t, "/opt/models/ei/", b_ic.Variables[0].DefaultValue)
@@ -191,9 +191,9 @@ func TestBricksIndex(t *testing.T) {
 
 	b_db, found := index.FindBrickByID("arduino:dbstorage_tsstore")
 	require.True(t, found)
-	require.False(t, b_db.ModelRequired)
+	require.False(t, b_db.RequireModel)
 
-	b_fake, found := index.FindBrickByID("arduino:fake_no_model")
+	bNoRequiredModel, found := index.FindBrickByID("arduino:missing-model-require")
 	require.True(t, found)
-	require.False(t, b_fake.ModelRequired)
+	require.False(t, bNoRequiredModel.RequireModel)
 }

internal/orchestrator/orchestrator.go

@@ -733,7 +733,7 @@ func AppDetails(
 			}
 			res.Name = bi.Name
 			res.Category = bi.Category
-			res.ModelRequired = bi.ModelRequired
+			res.ModelRequired = bi.RequireModel
 			return res
 		}),
 	}, nil