feat: add validation for app descriptors and corresponding test cases

Author: dido18

internal/orchestrator/app/testdata/validator/bricks-list.yaml

@@ -0,0 +1,9 @@
+bricks:
+- id: arduino:arduino_cloud
+  name: Arduino Cloud
+  description: Connects to Arduino Cloud
+  variables:
+  - name: ARDUINO_DEVICE_ID
+    description: Arduino Cloud Device ID
+  - name: ARDUINO_SECRET
+    description: Arduino Cloud Secret

internal/orchestrator/app/testdata/validator/empty-bricks-app.yaml

@@ -0,0 +1,4 @@
+name: App with empty bricks
+description: App with empty bricks
+
+bricks: []

internal/orchestrator/app/testdata/validator/missing-required-app.yaml

@@ -0,0 +1,4 @@
+name: App with no required variables
+description: App with no required variables
+bricks:
+  - arduino:arduino_cloud

internal/orchestrator/app/testdata/validator/mixed-required-app.yaml

@@ -0,0 +1,6 @@
+name: App only one required variable filled
+description: App only one required variable filled
+bricks:
+  - arduino:arduino_cloud:
+      variables:
+        ARDUINO_DEVICE_ID: "my-device-id"

internal/orchestrator/app/testdata/validator/no-bricks-app.yaml

@@ -0,0 +1,2 @@
+name: App with no bricks
+description: App with no bricks description

internal/orchestrator/app/testdata/validator/not-found-brick-app.yaml

@@ -0,0 +1,4 @@
+name: App no existing brick
+description: App no existing brick
+bricks:
+  - arduino:not_existing_brick

internal/orchestrator/app/validator.go

@@ -0,0 +1,38 @@
+package app
+
+import (
+	"fmt"
+
+	"github.com/arduino/arduino-app-cli/internal/orchestrator/bricksindex"
+)
+
+func ValidateAppDescriptor(a AppDescriptor, index *bricksindex.BricksIndex) error {
+	return validatebricks(a, index)
+}
+
+func validatebricks(a AppDescriptor, index *bricksindex.BricksIndex) error {
+	for _, appBrick := range a.Bricks {
+		indexBrick, found := index.FindBrickByID(appBrick.ID)
+		if !found {
+			return fmt.Errorf("brick %q not found", appBrick.ID)
+		}
+
+		// check the bricks variables inside the app.yaml are valid given a brick definition
+		for appBrickName := range appBrick.Variables {
+			_, exist := indexBrick.GetVariable(appBrickName)
+			if !exist {
+				return fmt.Errorf("variable %q does not exist on brick %q", appBrickName, indexBrick.ID)
+			}
+		}
+
+		// check all required variables has a value
+		for _, indexBrickVariable := range indexBrick.Variables {
+			if indexBrickVariable.IsRequired() {
+				if _, exist := appBrick.Variables[indexBrickVariable.Name]; !exist {
+					return fmt.Errorf("variable %q is required by brick %q", indexBrickVariable.Name, indexBrick.ID)
+				}
+			}
+		}
+	}
+	return nil
+}

internal/orchestrator/app/validator_test.go

@@ -0,0 +1,53 @@
+package app
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/arduino/go-paths-helper"
+
+	"github.com/arduino/arduino-app-cli/internal/orchestrator/bricksindex"
+)
+
+func TestValidateAppDescriptor(t *testing.T) {
+	bricksIndex, err := bricksindex.GenerateBricksIndexFromFile(paths.New("testdata/validator"))
+	require.Nil(t, err)
+
+	t.Run("valid app descriptor with no bricks", func(t *testing.T) {
+		app, err := ParseDescriptorFile(paths.New("testdata/validator/no-bricks-app.yaml"))
+		require.NoError(t, err)
+		err = ValidateAppDescriptor(app, bricksIndex)
+		assert.NoError(t, err)
+	})
+
+	t.Run("valid app descriptor with empty list of bricks", func(t *testing.T) {
+		app, err := ParseDescriptorFile(paths.New("testdata/validator/empty-bricks-app.yaml"))
+		require.NoError(t, err)
+		err = ValidateAppDescriptor(app, bricksIndex)
+		assert.NoError(t, err)
+	})
+
+	t.Run("invalid app descriptor with missing required variable", func(t *testing.T) {
+		app, err := ParseDescriptorFile(paths.New("testdata/validator/missing-required-app.yaml"))
+		require.NoError(t, err)
+		err = ValidateAppDescriptor(app, bricksIndex)
+		assert.Equal(t, "variable \"ARDUINO_DEVICE_ID\" is required by brick \"arduino:arduino_cloud\"", err.Error())
+	})
+
+	t.Run("invalid app descriptor with a missing required variable among two", func(t *testing.T) {
+		app, err := ParseDescriptorFile(paths.New("testdata/validator/mixed-required-app.yaml"))
+		require.NoError(t, err)
+		err = ValidateAppDescriptor(app, bricksIndex)
+		assert.Equal(t, "variable \"ARDUINO_DEVICE_ID\" is required by brick \"arduino:arduino_cloud\"", err.Error())
+	})
+
+	t.Run("invalid app descriptor with not found brick id", func(t *testing.T) {
+		app, err := ParseDescriptorFile(paths.New("testdata/validator/not-found-brick-app.yaml"))
+		require.NoError(t, err)
+		err = ValidateAppDescriptor(app, bricksIndex)
+		assert.Equal(t, "brick \"arduino:not_existing_brick\" not found", err.Error())
+	})
+
+}