[feature] Added basic validation for parameters

tavern/internal/c2/c2test/ent.go

@@ -98,14 +98,14 @@ func NewRandomAssignedTask(ctx context.Context, graph *ent.Client, beaconIdentif
 		SetName(namegen.NewComplex()).
 		SetEldritch(fmt.Sprintf(`print("%s")`, namegen.NewComplex())).
 		SetDescription(string(newRandomBytes(120))).
-		SetParamDefs(`{"test":"string"}`).
+		SetParamDefs(`[{"name":"test-param","label":"Test","type":"string","placeholder":"Enter text..."}]`).
 		AddFiles(files...).
 		SaveX(ctx)
 	quest := graph.Quest.Create().
 		SetName(namegen.NewComplex()).
 		SetBundle(bundle).
 		SetTome(tome).
-		SetParameters(fmt.Sprintf(`{"test":"%v"}`, namegen.NewComplex())).
+		SetParameters(fmt.Sprintf(`{"test-param":"%v"}`, namegen.NewComplex())).
 		SaveX(ctx)
 
 	return graph.Task.Create().

tavern/internal/ent/schema/quest.go

@@ -7,6 +7,7 @@ import (
 	"entgo.io/ent/schema"
 	"entgo.io/ent/schema/edge"
 	"entgo.io/ent/schema/field"
+	"realm.pub/tavern/internal/ent/schema/validators"
 )
 
 // Quest holds the schema definition for the Quest entity.
@@ -24,6 +25,7 @@ func (Quest) Fields() []ent.Field {
 			).
 			Comment("Name of the quest"),
 		field.String("parameters").
+			Validate(validators.NewJSONStringString()).
 			SchemaType(map[string]string{
 				dialect.MySQL: "LONGTEXT", // Override MySQL, improve length maximum
 			}).

tavern/internal/ent/schema/tome.go

@@ -12,6 +12,7 @@ import (
 	"entgo.io/ent/schema/field"
 	"golang.org/x/crypto/sha3"
 	"realm.pub/tavern/internal/ent/hook"
+	"realm.pub/tavern/internal/ent/schema/validators"
 )
 
 // Tome holds the schema definition for the Tome entity.
@@ -32,11 +33,12 @@ func (Tome) Fields() []ent.Field {
 		field.String("description").
 			Comment("Information about the tome"),
 		field.String("param_defs").
+			Validate(validators.NewTomeParameterDefinitions()).
 			Optional().
 			SchemaType(map[string]string{
 				dialect.MySQL: "LONGTEXT", // Override MySQL, improve length maximum
 			}).
-			Comment("JSON string describing what parameters are used with the tome"),
+			Comment("JSON string describing what parameters are used with the tome. Requires a list of JSON objects, one for each parameter."),
 		field.String("hash").
 			MaxLen(100).
 			Annotations(

tavern/internal/ent/schema/validators/json.go

@@ -0,0 +1,40 @@
+package validators
+
+import (
+	"encoding/json"
+
+	"realm.pub/tavern/tomes"
+)
+
+// NewJSONStringString returns a validator that errors if the string field has a value that cannot be JSON unmarshalled to a map[string]string.
+func NewJSONStringString() func(string) error {
+	return func(data string) error {
+		if data == "" {
+			return nil
+		}
+		var dataMap map[string]string
+		return json.Unmarshal([]byte(data), &dataMap)
+	}
+}
+
+// NewTomeParameterDefinitions returns a validator that errors if the string field has a value that cannot be JSON unmarshalled to a []tomes.TomeParamDefinition.
+func NewTomeParameterDefinitions() func(string) error {
+	return func(data string) error {
+		if data == "" {
+			return nil
+		}
+		var paramDefs []tomes.ParamDefinition
+		if err := json.Unmarshal([]byte(data), &paramDefs); err != nil {
+			return err
+		}
+
+		// Validate parameters
+		for _, paramDef := range paramDefs {
+			if err := paramDef.Validate(); err != nil {
+				return err
+			}
+		}
+
+		return nil
+	}
+}

tavern/internal/ent/schema/validators/json_test.go

@@ -0,0 +1,97 @@
+package validators_test
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"realm.pub/tavern/internal/ent/schema/validators"
+)
+
+func TestNewJSONStringString(t *testing.T) {
+	tests := []struct {
+		name    string
+		data    string
+		wantErr error
+	}{
+		{
+			name:    "Empty",
+			data:    ``,
+			wantErr: nil,
+		},
+		{
+			name:    "Valid",
+			data:    `{"data":"stuff"}`,
+			wantErr: nil,
+		},
+		{
+			name:    "Invalid",
+			data:    `blah`,
+			wantErr: &json.SyntaxError{},
+		},
+		{
+			name:    "Partial",
+			data:    `{"blah":"stuff"`,
+			wantErr: &json.SyntaxError{},
+		},
+	}
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			err := validators.NewJSONStringString()(tc.data)
+			if tc.wantErr == nil {
+				assert.NoError(t, err)
+				return
+			}
+			assert.ErrorAs(t, err, &tc.wantErr)
+		})
+	}
+}
+
+func TestNewTomeParameterDefinitions(t *testing.T) {
+	tests := []struct {
+		name    string
+		data    string
+		wantErr error
+	}{
+		{
+			name:    "Empty",
+			data:    ``,
+			wantErr: nil,
+		},
+		{
+			name:    "Int32",
+			data:    `[{"name":"an-int","type": "int32"}]`,
+			wantErr: nil,
+		},
+		{
+			name:    "Multiple",
+			data:    `[{"name":"an-int","type":"int32"},{"name":"a-str","type": "string"}]`,
+			wantErr: nil,
+		},
+		{
+			name:    "Valid",
+			data:    `[{"name":"stuff","type":"string"}]`,
+			wantErr: nil,
+		},
+		{
+			name:    "Invalid",
+			data:    `blah`,
+			wantErr: &json.SyntaxError{},
+		},
+		{
+			name:    "Partial",
+			data:    `{"blah":"stuff"`,
+			wantErr: &json.SyntaxError{},
+		},
+	}
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			err := validators.NewTomeParameterDefinitions()(tc.data)
+			if tc.wantErr == nil {
+				assert.NoError(t, err)
+				return
+			}
+			assert.ErrorAs(t, err, &tc.wantErr)
+		})
+	}
+}

tavern/internal/graphql/schema.graphql

@@ -173,7 +173,7 @@ input CreateTomeInput {
   name: String!
   """Information about the tome"""
   description: String!
-  """JSON string describing what parameters are used with the tome"""
+  """JSON string describing what parameters are used with the tome. Requires a list of JSON objects, one for each parameter."""
   paramDefs: String
   """Eldritch script that will be executed when the tome is run"""
   eldritch: String!
@@ -804,7 +804,7 @@ type Tome implements Node {
   name: String!
   """Information about the tome"""
   description: String!
-  """JSON string describing what parameters are used with the tome"""
+  """JSON string describing what parameters are used with the tome. Requires a list of JSON objects, one for each parameter."""
   paramDefs: String
   """Eldritch script that will be executed when the tome is run"""
   eldritch: String!

tavern/internal/graphql/schema/ent.graphql

@@ -168,7 +168,7 @@ input CreateTomeInput {
   name: String!
   """Information about the tome"""
   description: String!
-  """JSON string describing what parameters are used with the tome"""
+  """JSON string describing what parameters are used with the tome. Requires a list of JSON objects, one for each parameter."""
   paramDefs: String
   """Eldritch script that will be executed when the tome is run"""
   eldritch: String!
@@ -799,7 +799,7 @@ type Tome implements Node {
   name: String!
   """Information about the tome"""
   description: String!
-  """JSON string describing what parameters are used with the tome"""
+  """JSON string describing what parameters are used with the tome. Requires a list of JSON objects, one for each parameter."""
   paramDefs: String
   """Eldritch script that will be executed when the tome is run"""
   eldritch: String!

tavern/internal/www/schema.graphql

@@ -173,7 +173,7 @@ input CreateTomeInput {
   name: String!
   """Information about the tome"""
   description: String!
-  """JSON string describing what parameters are used with the tome"""
+  """JSON string describing what parameters are used with the tome. Requires a list of JSON objects, one for each parameter."""
   paramDefs: String
   """Eldritch script that will be executed when the tome is run"""
   eldritch: String!
@@ -804,7 +804,7 @@ type Tome implements Node {
   name: String!
   """Information about the tome"""
   description: String!
-  """JSON string describing what parameters are used with the tome"""
+  """JSON string describing what parameters are used with the tome. Requires a list of JSON objects, one for each parameter."""
   paramDefs: String
   """Eldritch script that will be executed when the tome is run"""
   eldritch: String!