refactor: improve error handling and logging in validation functions

Author: dido18

internal/orchestrator/app/validator.go

@@ -10,10 +10,9 @@ import (
 
 // ValidateBricks checks that all bricks referenced in the given AppDescriptor exist in the provided BricksIndex,
 // It collects and returns all validation errors as a single joined error, allowing the caller to see all issues at once rather than stopping at the first error.
-// If the index or the app is nil, validation is skipped and nil is returned.
 func ValidateBricks(a AppDescriptor, index *bricksindex.BricksIndex) error {
 	if index == nil {
-		return nil
+		return fmt.Errorf("bricks index cannot be nil")
 	}
 
 	var allErrors error
@@ -28,6 +27,7 @@ func ValidateBricks(a AppDescriptor, index *bricksindex.BricksIndex) error {
 		for appBrickVariableName := range appBrick.Variables {
 			_, exist := indexBrick.GetVariable(appBrickVariableName)
 			if !exist {
+				// TODO: we should return warnings
 				slog.Warn("variable is referenced but not declared in the brick configuration", "variable", appBrickVariableName, "brick", indexBrick.ID)
 			}
 		}

internal/orchestrator/app/validator_test.go

@@ -14,7 +14,7 @@ import (
 
 func TestValidateAppDescriptorBricks(t *testing.T) {
 	bricksIndex, err := bricksindex.GenerateBricksIndexFromFile(paths.New("testdata/validator"))
-	require.Nil(t, err)
+	require.NoError(t, err)
 	require.NotNil(t, bricksIndex)
 
 	testCases := []struct {

internal/orchestrator/bricks/bricks.go

@@ -290,8 +290,7 @@ func (s *Service) BrickCreate(
 	for _, brickVar := range brick.Variables {
 		if brickVar.DefaultValue == "" {
 			if _, exist := req.Variables[brickVar.Name]; !exist {
-				// See issue https://github.com/arduino/arduino-app-cli/issues/68
-				slog.Warn("[Skip] a required variable is not set by user", "variable", brickVar.Name)
+				slog.Warn("[Skip] a required variable is not set by user", "variable", brickVar.Name, "brick", brickVar.Name)
 			}
 		}
 	}