Add D&D scene description validation

internal/modules/dnd/validate/scenedescriptions/shape/validator.go

@@ -0,0 +1,112 @@
+// Package shape validates required D&D scene description fields.
+package shape
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"gitea.maximumdirect.net/eric/notarius/internal/framework/contracts"
+	"gitea.maximumdirect.net/eric/notarius/internal/framework/pipeline"
+	"gitea.maximumdirect.net/eric/notarius/internal/modules/dnd"
+	"gitea.maximumdirect.net/eric/notarius/internal/modules/dnd/shared/diagnostics"
+)
+
+const (
+	Key        = "extract/dnd/scene-descriptions/shape"
+	ReasonCode = "invalid_scene_description_shape"
+	policy     = "dnd.scene_descriptions.validator.shape.v1"
+)
+
+type Options struct{}
+type Validator struct{}
+
+var _ contracts.TypedValidator[dnd.SceneDescriptionList] = (*Validator)(nil)
+var _ pipeline.CheckpointFingerprintProvider = (*Validator)(nil)
+
+func New(Options) *Validator      { return &Validator{} }
+func (v *Validator) Name() string { return Key }
+func (v *Validator) ExecutionClass() contracts.ExecutionClass {
+	return contracts.ExecutionClassDeterministic
+}
+func (v *Validator) CheckpointFingerprints() []pipeline.CheckpointFingerprint {
+	return []pipeline.CheckpointFingerprint{{Name: "policy", Value: policy}}
+}
+
+func (v *Validator) Validate(_ context.Context, req contracts.TypedValidationRequest[dnd.SceneDescriptionList]) (contracts.ValidationResult, error) {
+	if err := ValidateForStage(req.Value, req.Stage); err != nil {
+		return contracts.ValidationResult{Approved: false, ReasonCode: ReasonCode, Message: err.Error()}, nil
+	}
+	return contracts.ValidationResult{Approved: true}, nil
+}
+
+func Validate(value dnd.SceneDescriptionList) error { return validate(value, false) }
+
+func ValidateForStage(value dnd.SceneDescriptionList, stage string) error {
+	return validate(value, stage == string(pipeline.StageExtract))
+}
+
+func validate(value dnd.SceneDescriptionList, exactlyOne bool) error {
+	issues := make([]string, 0)
+	if value.Scenes == nil {
+		issues = append(issues, "scenes must be present")
+	} else if len(value.Scenes) == 0 {
+		issues = append(issues, "scenes must not be empty")
+	} else if exactlyOne && len(value.Scenes) != 1 {
+		issues = append(issues, "extraction must contain exactly one scene")
+	}
+	for index, scene := range value.Scenes {
+		prefix := fmt.Sprintf("scenes[%d]", index)
+		if strings.TrimSpace(scene.ID) == "" || scene.ID != strings.TrimSpace(scene.ID) {
+			issues = append(issues, prefix+".id must be non-empty and trimmed")
+		}
+		if !ValidKind(scene.Kind) {
+			issues = append(issues, prefix+".kind is unsupported: "+diagnostics.Quote(string(scene.Kind)))
+		}
+		if strings.TrimSpace(scene.Title) == "" || scene.Title != strings.TrimSpace(scene.Title) {
+			issues = append(issues, prefix+".title must be non-empty and trimmed")
+		}
+		if strings.TrimSpace(scene.Summary) == "" || scene.Summary != strings.TrimSpace(scene.Summary) {
+			issues = append(issues, prefix+".summary must be non-empty and trimmed")
+		}
+		if strings.TrimSpace(scene.SourceRef.SourceID) == "" || scene.SourceRef.SourceID != strings.TrimSpace(scene.SourceRef.SourceID) || scene.SourceRef.StartUnitID <= 0 || scene.SourceRef.EndUnitID <= 0 {
+			issues = append(issues, prefix+".source_ref must have a trimmed source ID and positive unit IDs")
+		}
+	}
+	if len(issues) == 0 {
+		return nil
+	}
+	return fmt.Errorf("%s", diagnostics.Aggregate("invalid scene description shape", issues))
+}
+
+func ValidKind(value dnd.SceneKind) bool {
+	switch value {
+	case dnd.SceneKindCombat, dnd.SceneKindNarrative, dnd.SceneKindRecap, dnd.SceneKindMeta:
+		return true
+	default:
+		return false
+	}
+}
+
+func Spec() pipeline.ValidatorSpec {
+	return pipeline.ValidatorSpec{Key: Key, ExecutionClass: contracts.ExecutionClassDeterministic}
+}
+
+func Register(registry *pipeline.ValidatorRegistry) error {
+	return pipeline.RegisterTypedValidatorBuilder(registry, dnd.SceneDescriptionListKind, Spec(), validateOptions, func(request pipeline.BuildRequest) (contracts.TypedValidator[dnd.SceneDescriptionList], error) {
+		options, err := DecodeOptions(request.Options)
+		if err != nil {
+			return nil, err
+		}
+		return New(options), nil
+	})
+}
+
+func DecodeOptions(options map[string]any) (Options, error) {
+	if err := pipeline.RejectUnknownOptions(options); err != nil {
+		return Options{}, err
+	}
+	return Options{}, nil
+}
+
+func validateOptions(options map[string]any) error { _, err := DecodeOptions(options); return err }

internal/modules/dnd/validate/scenedescriptions/shape/validator_test.go

@@ -0,0 +1,65 @@
+package shape
+
+import (
+	"context"
+	"reflect"
+	"testing"
+
+	"gitea.maximumdirect.net/eric/notarius/internal/core/source"
+	"gitea.maximumdirect.net/eric/notarius/internal/framework/contracts"
+	"gitea.maximumdirect.net/eric/notarius/internal/framework/pipeline"
+	"gitea.maximumdirect.net/eric/notarius/internal/modules/dnd"
+)
+
+func TestValidatorRequiresSceneShapeAndExactlyOneExtractionRecord(t *testing.T) {
+	valid := list(scene("one", dnd.SceneKindNarrative, "Arrival", "The party arrives.", 1, 1))
+	validator := New(Options{})
+	for _, test := range []struct {
+		name     string
+		value    dnd.SceneDescriptionList
+		stage    string
+		approved bool
+	}{
+		{name: "valid normalization", value: valid, approved: true},
+		{name: "valid extraction", value: valid, stage: string(pipeline.StageExtract), approved: true},
+		{name: "multiple extraction records", value: list(valid.Scenes[0], scene("two", dnd.SceneKindMeta, "Rules", "The table checks rules.", 2, 2)), stage: string(pipeline.StageExtract)},
+		{name: "nil list", value: dnd.SceneDescriptionList{}},
+		{name: "empty list", value: dnd.SceneDescriptionList{Scenes: []dnd.SceneDescription{}}},
+		{name: "blank ID", value: list(scene(" ", dnd.SceneKindNarrative, "Arrival", "The party arrives.", 1, 1))},
+		{name: "unsupported kind", value: list(scene("one", "other", "Arrival", "The party arrives.", 1, 1))},
+		{name: "untrimmed prose", value: list(scene("one", dnd.SceneKindNarrative, " Arrival ", "The party arrives.", 1, 1))},
+		{name: "empty source reference", value: dnd.SceneDescriptionList{Scenes: []dnd.SceneDescription{{ID: "one", Kind: dnd.SceneKindNarrative, Title: "Arrival", Summary: "The party arrives."}}}},
+	} {
+		t.Run(test.name, func(t *testing.T) {
+			result, err := validator.Validate(context.Background(), contracts.TypedValidationRequest[dnd.SceneDescriptionList]{Stage: test.stage, Value: test.value})
+			if err != nil || result.Approved != test.approved {
+				t.Fatalf("Validate() = %#v, %v; want approved=%t", result, err, test.approved)
+			}
+		})
+	}
+}
+
+func TestValidatorContractAndRegistration(t *testing.T) {
+	registry := pipeline.NewValidatorRegistry()
+	if err := Register(registry); err != nil {
+		t.Fatalf("Register() error = %v", err)
+	}
+	if _, ok := registry.Spec(Key); !ok {
+		t.Fatalf("registry has no spec for %q", Key)
+	}
+	if _, err := DecodeOptions(map[string]any{"unexpected": true}); err == nil {
+		t.Fatal("DecodeOptions() accepted unknown options")
+	}
+	validator := New(Options{})
+	if got, want := validator.CheckpointFingerprints(), []pipeline.CheckpointFingerprint{{Name: "policy", Value: policy}}; !reflect.DeepEqual(got, want) {
+		t.Fatalf("fingerprints = %#v, want %#v", got, want)
+	}
+}
+
+func list(scenes ...dnd.SceneDescription) dnd.SceneDescriptionList {
+	return dnd.SceneDescriptionList{Scenes: scenes}
+}
+
+func scene(id string, kind dnd.SceneKind, title, summary string, start, end int) dnd.SceneDescription {
+	return dnd.SceneDescription{ID: id, Kind: kind, Title: title, Summary: summary, SourceRef: source.SourceRef{SourceID: "session", StartUnitID: start, EndUnitID: end}}
+}