Fix required marker value handling (#517)

kro will now check the values and handle them accordingly. The truthy
values are "true", "yes", and "1". The supported falsey values are
"false" and "no".
---------

Co-authored-by: Gereon Frey <[email protected]>
Co-authored-by: Amine <[email protected]>

Author: 3 people

pkg/simpleschema/transform.go

@@ -224,8 +224,15 @@ func (tf *transformer) applyMarkers(schema *extv1.JSONSchemaProps, markers []*Ma
 	for _, marker := range markers {
 		switch marker.MarkerType {
 		case MarkerTypeRequired:
-			if parentSchema != nil {
+			switch isRequired, err := strconv.ParseBool(marker.Value); {
+			case err != nil:
+				return fmt.Errorf("failed to parse required marker value: %w", err)
+			case parentSchema == nil:
+				return fmt.Errorf("required marker can't be applied; parent schema is nil")
+			case isRequired:
 				parentSchema.Required = append(parentSchema.Required, key)
+			default:
+				// ignore
 			}
 		case MarkerTypeDefault:
 			var defaultValue []byte

pkg/simpleschema/transform_test.go

@@ -15,9 +15,12 @@
 package simpleschema
 
 import (
+	"fmt"
 	"reflect"
+	"slices"
 	"testing"
 
+	"github.com/stretchr/testify/assert"
 	extv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 )
 
@@ -450,6 +453,28 @@ func TestBuildOpenAPISchema(t *testing.T) {
 			},
 			wantErr: false,
 		},
+		{
+			name: "Invalid Required Marker value",
+			obj: map[string]interface{}{
+				"data": "string | required=invalid",
+			},
+			want:    nil,
+			wantErr: true,
+		},
+		{
+			name: "Required Marker handling",
+			obj: map[string]interface{}{
+				"req_1": "string | required=true",
+			},
+			want: &extv1.JSONSchemaProps{
+				Type: "object",
+				Properties: map[string]extv1.JSONSchemaProps{
+					"req_1": {Type: "string"},
+				},
+				Required: []string{"req_1"},
+			},
+			wantErr: false,
+		},
 	}
 
 	for _, tt := range tests {
@@ -459,13 +484,48 @@ func TestBuildOpenAPISchema(t *testing.T) {
 				t.Errorf("BuildOpenAPISchema() error = %v, wantErr %v", err, tt.wantErr)
 				return
 			}
+			assert.Equal(t, got, tt.want)
 			if !reflect.DeepEqual(got, tt.want) {
 				t.Errorf("BuildOpenAPISchema() = %+v, want %+v", got, tt.want)
 			}
 		})
 	}
 }
 
+func TestApplyMarkers_Required(t *testing.T) {
+	transformer := newTransformer()
+
+	tests := []struct {
+		value    string
+		required bool
+		err      error
+	}{
+		{"true", true, nil},
+		{"True", true, nil},
+		{"TRUE", true, nil},
+		{"1", true, nil},
+		{"false", false, nil},
+		{"False", false, nil},
+		{"FALSE", false, nil},
+		{"invalid", false, fmt.Errorf("failed to parse required marker value: strconv.ParseBool: parsing \"invalid\": invalid syntax")},
+		{"no", false, fmt.Errorf("failed to parse required marker value: strconv.ParseBool: parsing \"no\": invalid syntax")},
+	}
+	for _, tt := range tests {
+		t.Run(fmt.Sprintf("Required Marker %s", tt.value), func(t *testing.T) {
+			parentSchema := &extv1.JSONSchemaProps{}
+			markers := []*Marker{{MarkerType: MarkerTypeRequired, Value: tt.value}}
+			err := transformer.applyMarkers(nil, markers, "myFieldName", parentSchema)
+			if err != nil && err.Error() != tt.err.Error() {
+				t.Errorf("ApplyMarkers() error = %q, expected error %q", err, tt.err)
+			}
+			// If there was no error, check if the required field was added to the parent schema.
+			if err == nil && tt.required != slices.Contains(parentSchema.Required, "myFieldName") {
+				t.Errorf("ApplyMarkers() = %v, want %v", parentSchema.Required, tt.required)
+			}
+		})
+	}
+}
+
 func TestLoadPreDefinedTypes(t *testing.T) {
 	transformer := newTransformer()