Parser: check required fields (#344)

* Parser: check required fields

* TestAdditionalInstances fixture: include additional_container's port

* Include additional container's port in TestAdditionalContainerInstances

internal/evaluator/evaluator_test.go

@@ -171,6 +171,7 @@ aliases: &container_body
       image: mysql:latest
       cpu: 1
       memory: 1024
+      port: 3306
       environment:
         MYSQL_ROOT_PASSWORD: ""
 

pkg/parser/nameable/nameable.go

@@ -3,4 +3,5 @@ package nameable
 type Nameable interface {
 	Matches(s string) bool
 	String() string
+	MapKey() string
 }

pkg/parser/nameable/regex.go

@@ -25,6 +25,10 @@ func (rn *RegexNameable) String() string {
 	return rn.re.String()
 }
 
+func (rn *RegexNameable) MapKey() string {
+	return "RegexNameable(" + rn.re.String() + ")"
+}
+
 func (rn *RegexNameable) FirstGroupOrDefault(s string, defaultValue string) string {
 	submatch := rn.re.FindStringSubmatch(s)
 	if submatch == nil {

pkg/parser/nameable/simple.go

@@ -19,3 +19,7 @@ func (sn *SimpleNameable) Name() string {
 func (sn *SimpleNameable) String() string {
 	return sn.name
 }
+
+func (sn *SimpleNameable) MapKey() string {
+	return "SimpleNameable(" + sn.name + ")"
+}

pkg/parser/parseable/parseable.go

@@ -37,8 +37,6 @@ func (parser *DefaultParser) Parse(node *node.Node) error {
 		}
 	}
 
-	// Check required fields
-
 	for _, child := range node.Children {
 		// double check collectible fields
 		for _, collectibleField := range parser.collectibleFields {
@@ -51,17 +49,30 @@ func (parser *DefaultParser) Parse(node *node.Node) error {
 		}
 	}
 
+	seenFields := map[string]struct{}{}
+
 	for _, child := range node.Children {
 		for _, field := range parser.fields {
 			if field.name.Matches(child.Name) {
+				seenFields[field.name.MapKey()] = struct{}{}
+
 				if err := field.onFound(child); err != nil {
 					return err
 				}
+
 				break
 			}
 		}
 	}
 
+	for _, field := range parser.fields {
+		_, seen := seenFields[field.name.MapKey()]
+
+		if field.required && !seen {
+			return node.ParserError("required field %q was not set", field.name.String())
+		}
+	}
+
 	return nil
 }
 

pkg/parser/parser_test.go

@@ -54,6 +54,27 @@ func TestValidConfigs(t *testing.T) {
 	}
 }
 
+func TestInvalidConfigs(t *testing.T) {
+	var invalidCases = []struct {
+		Name  string
+		Error string
+	}{
+		{"invalid-missing-required-field", "parsing error: 6:3: required field \"steps\" was not set"},
+	}
+
+	for _, invalidCase := range invalidCases {
+		invalidCase := invalidCase
+
+		t.Run(invalidCase.Name, func(t *testing.T) {
+			p := parser.New()
+			_, err := p.ParseFromFile(context.Background(), absolutize(invalidCase.Name+".yml"))
+
+			require.Error(t, err)
+			assert.Equal(t, invalidCase.Error, err.Error())
+		})
+	}
+}
+
 func TestAdditionalInstances(t *testing.T) {
 	containerInstanceReflect := (&api.ContainerInstance{}).ProtoReflect()
 	p := parser.New(parser.WithAdditionalInstances(map[string]protoreflect.MessageDescriptor{

pkg/parser/testdata/invalid-missing-required-field.yml

@@ -0,0 +1,6 @@
+container:
+  image: debian:latest
+
+# Pipe is missing "steps" required field
+pipe:
+  script: true

pkg/parser/testdata/proto-instance.json

@@ -19,7 +19,8 @@
           },
           "image": "mysql:latest",
           "memory": 1024,
-          "name": "mysql"
+          "name": "mysql",
+          "containerPort": 3306
         }
       ],
       "cpu": 2.5,
@@ -57,7 +58,8 @@
           },
           "image": "mysql:latest",
           "memory": 1024,
-          "name": "mysql"
+          "name": "mysql",
+          "containerPort": 3306
         }
       ],
       "cpu": 2.5,

pkg/parser/testdata/proto-instance.yml

@@ -8,6 +8,7 @@ aliases: &container_body
       image: mysql:latest
       cpu: 1
       memory: 1024
+      port: 3306
       environment:
         MYSQL_ROOT_PASSWORD: ""