theater

package module

Go to main page

Versions in this module

v0

v0.5.0

May 18, 2026

Changes in this version

+ const HTTPDiagnosticFailureBodyParse

+ const HTTPDiagnosticFailureExpectation

+ const HTTPDiagnosticFailureHeader

+ const HTTPDiagnosticFailureNetwork

+ const HTTPDiagnosticFailureRequest

+ const HTTPDiagnosticFailureStatus

+ const HTTPDiagnosticFailureTLS

+ const HTTPDiagnosticFailureTimeout

+ const NodeDiagnosticKindPreflight

+ func Version() string

+ type HTTPDiagnosticFailureKind = reportmodel.HTTPDiagnosticFailureKind

+ type HTTPRequestFingerprint = reportmodel.HTTPRequestFingerprint

+ type HTTPResponseMetadata = reportmodel.HTTPResponseMetadata

+ type MatcherPreflightArgIssue = specmodel.MatcherPreflightArgIssue

+ type MatcherPreflightArgRule = specmodel.MatcherPreflightArgRule

+ type MatcherPreflightPolicy = specmodel.MatcherPreflightPolicy

+ type PreflightDiagnostic = reportmodel.PreflightDiagnostic

+ type PreflightSpec = specmodel.PreflightSpec

type RunOptions

+ RunID string

type RunResult

+ RunID string

+ TheaterVersion string

v0.4.0

May 16, 2026

Changes in this version

+ const NodeDiagnosticKindHTTP

type ActionRequest

+ Diagnostics DiagnosticRecorder

+ type DiagnosticRecorder interface

+ RecordDiagnostic func(NodeDiagnostic)

+ type HTTPDiagnostic = reportmodel.HTTPDiagnostic

+ type NodeDiagnostic = reportmodel.NodeDiagnostic

+ type NodeDiagnosticKind = reportmodel.NodeDiagnosticKind

v0.3.0

May 15, 2026

Changes in this version

+ type HTTPAuthBindingSpec = specmodel.HTTPAuthBindingSpec

+ type HTTPAuthSlotInitializer interface

+ InitializeHTTPAuthSlots func(resources ResourceScope, bindings map[string]Values) error

v0.2.0

May 11, 2026

Changes in this version

+ const BindingKindCoalesce

+ const BindingKindEnv

v0.1.0

May 7, 2026

Changes in this version

+ const BindingKindGenerate

+ const BindingKindList

+ const BindingKindLiteral

+ const BindingKindObject

+ const BindingKindRef

+ const BindingKindString

+ const CapabilityFamilyAction

+ const CapabilityFamilyGenerator

+ const CapabilityFamilyInventory

+ const CapabilityFamilyMatcher

+ const CapabilityFamilyReportExporter

+ const CapabilityFamilyStateBackend

+ const CapabilityFamilyTransform

+ const CapabilityProviderBuiltin

+ const CapabilityProviderPlugin

+ const CaptureArtifactRef

+ const CaptureOmit

+ const CaptureSummary

+ const DebugBoundaryKindAct

+ const DebugBoundaryKindAction

+ const DebugBoundaryKindExpectation

+ const DebugBoundaryKindScenarioCall

+ const DebugBoundaryPhaseAfter

+ const DebugBoundaryPhaseBefore

+ const DecodeJSON

+ const DefaultScenarioLogPreviewLimitBytes

+ const DefaultScenarioLogRecordsPerAct

+ const DefaultScenarioLogRecordsPerRun

+ const EventKindActFinished

+ const EventKindActRunning

+ const EventKindActionFinished

+ const EventKindActionRunning

+ const EventKindExpectationFinished

+ const EventKindLogEmitted

+ const EventKindScenarioFinished

+ const EventKindScenarioRunning

+ const EventKindStageFinished

+ const EventKindStageRunning

+ const FailureKindAction

+ const FailureKindDefinition

+ const FailureKindExpectation

+ const FailureKindInternal

+ const FailureKindObservation

+ const FailureKindSetup

+ const FailureKindTimeout

+ const HTTPAPIKeyInHeader

+ const HTTPAPIKeyInQuery

+ const HTTPAuthNone

+ const HTTPSessionNone

+ const LogFormatJSON

+ const LogFormatText

+ const LogStatusEmitted

+ const LogStatusError

+ const LogStatusOmitted

+ const NodeKindAct

+ const NodeKindAction

+ const NodeKindExpectation

+ const NodeKindLog

+ const NodeKindScenario

+ const PhaseCompile

+ const PhaseRun

+ const PhaseValidate

+ const RunDocumentSchemaVersion

+ const SensitivityInternal

+ const SensitivityNone

+ const SensitivityPersonal

+ const SensitivitySecret

+ const SeverityError

+ const SeverityHint

+ const SkipReasonExplicit

+ const SkipReasonStageAborted

+ const StateExpiryReclaim

+ const StateExpiryStale

+ const StateGuaranteeLocalAtomic

+ const StateGuaranteeReadOnly

+ const StateGuaranteeSharedAtomic

+ const StateGuaranteeSharedOptimistic

+ const StatusCanceled

+ const StatusFailed

+ const StatusPassed

+ const StatusPending

+ const StatusRunning

+ const StatusSkipped

+ const SubjectFromProperty

+ const TerminationReasonConverged

+ const TerminationReasonDeadlineExceeded

+ const TerminationReasonParentCanceled

+ const TerminationReasonTerminalFailure

+ const TransitionOnCancel

+ const TransitionOnFail

+ const TransitionOnPass

+ const TransitionOnTimeout

+ const TriggerPredicateDone

+ const TriggerPredicateFailure

+ const TriggerPredicateSuccess

+ func ExportRunDocument(ctx context.Context, resolver ReportExporterResolver, document RunDocument, ...) error

+ func IsMatcherMismatch(err error) bool

+ func MismatchError(err error) error

+ func ValidateTerminalOutcome(status Status, failure *Failure) error

+ type ActSpec = specmodel.ActSpec

+ type Action interface

+ Contract func() ActionContract

+ Run func(ctx context.Context, request ActionRequest) (Outputs, error)

+ type ActionCapabilityDescriptor struct

+ Inputs map[string]ValueContract

+ Outputs map[string]ValueContract

+ type ActionContract = specmodel.ActionContract

+ type ActionErrorDetails interface

+ FailureSummary func() string

+ PartialOutputs func() Outputs

+ type ActionObservations = reportmodel.ActionObservations

+ type ActionRegistrar interface

+ RegisterAction func(ref string, action Action) error

+ type ActionRequest struct

+ Args Args

+ Attempt int

+ HTTP *HTTPSpec

+ HTTPCapture *HTTPAuthCaptureSpec

+ Paths PathContext

+ Reporter observe.Reporter

+ Resources ResourceScope

+ State *statemodel.Manager

+ type ActionResolver interface

+ ResolveAction func(ref string) (Action, error)

+ type ActionSpec = specmodel.ActionSpec

+ type ArgSpec = specmodel.ArgSpec

+ type Args = specmodel.Args

+ type ArtifactRef = reportmodel.ArtifactRef

+ type AssertSpec = specmodel.AssertSpec

+ type AttemptReport = reportmodel.AttemptReport

+ type BindingKind = specmodel.BindingKind

+ type BindingSpec = specmodel.BindingSpec

+ type CapabilityDescriptor struct

+ Action *ActionCapabilityDescriptor

+ Family CapabilityFamily

+ Generator *GeneratorCapabilityDescriptor

+ Inventory *InventoryCapabilityDescriptor

+ Matcher *MatcherCapabilityDescriptor

+ Provider CapabilityProvider

+ Ref string

+ ReportExporter *ReportExporterCapabilityDescriptor

+ StateBackend *StateBackendCapabilityDescriptor

+ Summary string

+ Transform *TransformCapabilityDescriptor

+ func DescribeCapabilities(catalog *Catalog, matchers *MatcherCatalog) []CapabilityDescriptor

+ func DescribePluginCapabilities(catalog *PluginCatalog) []CapabilityDescriptor

+ type CapabilityFamily string

+ func CapabilityFamilies() []CapabilityFamily

+ type CapabilityProvider struct

+ Kind CapabilityProviderKind

+ PluginID string

+ PluginVersion string

+ type CapabilityProviderKind string

+ type Capture = reportmodel.Capture

+ type Catalog struct

+ func NewCatalog() *Catalog

+ func (c *Catalog) RegisterAction(ref string, action Action) error

+ func (c *Catalog) RegisterDecorator(ref string, decorator DecoratorDef) error

+ func (c *Catalog) RegisterGenerator(ref string, generator GeneratorDef) error

+ func (c *Catalog) RegisterInventory(ref string, inventory Inventory) error

+ func (c *Catalog) RegisterReportExporter(ref string, exporter ReportExporterDef) error

+ func (c *Catalog) RegisterScenarioScopeInitializer(ref string, factory ScenarioScopeInitializerFactory) error

+ func (c *Catalog) RegisterStateBackend(ref string, backend StateBackendDef) error

+ func (c *Catalog) ResolveAction(ref string) (Action, error)

+ func (c *Catalog) ResolveDecorator(ref string) (DecoratorDef, error)

+ func (c *Catalog) ResolveGenerator(ref string) (GeneratorDef, error)

+ func (c *Catalog) ResolveInventory(ref string) (Inventory, error)

+ func (c *Catalog) ResolveReportExporter(ref string) (ReportExporterDef, error)

+ func (c *Catalog) ResolveStateBackend(ref string) (StateBackendDef, error)

+ type CatalogResolver interface

+ type Contrast = reportmodel.Contrast

+ type DebugBoundaryKind = debugBoundaryKind

+ type DebugBoundaryPhase = debugBoundaryPhase

+ type DebugCheckpoint struct

+ Name string

+ Values Values

+ type DebugCheckpointReporter interface

+ DebugCheckpoint func(DebugCheckpoint)

+ type DebugMode string

+ const DebugModeDump

+ const DebugModeInteractive

+ const DebugModeOff

+ type DebugOptions struct

+ Breakpoints []string

+ DumpPath string

+ Input io.Reader

+ Mode DebugMode

+ Output io.Writer

+ StartPaused bool

+ type DebugPath struct

+ Kind DebugBoundaryKind

+ Path string

+ Phase DebugBoundaryPhase

+ RetryAware bool

+ type DebugPathListing struct

+ Diagnostics []Diagnostic

+ Paths []DebugPath

+ type DebugStateSnapshotter interface

+ DebugStateSnapshot func(context.Context) (Values, error)

+ type DecodeKind = specmodel.DecodeKind

+ type DecoratorContract = specmodel.DecoratorContract

+ type DecoratorDef = specmodel.DecoratorDef

+ type DecoratorFunc = specmodel.DecoratorFunc

+ type DecoratorRegistrar interface

+ RegisterDecorator func(ref string, decorator DecoratorDef) error

+ type DecoratorResolver interface

+ ResolveDecorator func(ref string) (DecoratorDef, error)

+ type DecoratorSpec = specmodel.DecoratorSpec

+ type Diagnostic = reportmodel.Diagnostic

+ type DiagnosticSeverity = reportmodel.DiagnosticSeverity

+ type Event = reportmodel.Event

+ type EventRecorder interface

+ Record func(Event) error

+ type EventuallyReport = reportmodel.EventuallyReport

+ type EventuallySpec = specmodel.EventuallySpec

+ type ExpectationSpec = specmodel.ExpectationSpec

+ type ExportSpec = specmodel.ExportSpec

+ type Failure = reportmodel.Failure

+ type FailureIndexEntry = reportmodel.FailureIndexEntry

+ type FailureKind = reportmodel.FailureKind

+ type GenerationMetadata = reportmodel.GenerationMetadata

+ type GeneratorCapabilityDescriptor struct

+ Args []ArgSpec

+ Produces ValueContract

+ type GeneratorContract struct

+ Args []ArgSpec

+ Produces ValueContract

+ Summary string

+ type GeneratorDef struct

+ Contract GeneratorContract

+ Generate func(request GeneratorRequest) (any, error)

+ Validate func(args Values) error

+ type GeneratorRegistrar interface

+ RegisterGenerator func(ref string, generator GeneratorDef) error

+ type GeneratorRequest struct

+ Args Args

+ BindingPath string

+ Generation GenerationMetadata

+ ScenarioCallID string

+ ScenarioSeq int

+ func (r GeneratorRequest) DeriveRand(purpose string) *randv2.Rand

+ func (r GeneratorRequest) RunToken(length int) string

+ func (r GeneratorRequest) SequenceIndex() int64

+ type GeneratorResolver interface

+ ResolveGenerator func(ref string) (GeneratorDef, error)

+ type HTTPAPIKeyAuthSpec = specmodel.HTTPAPIKeyAuthSpec

+ type HTTPAPIKeyIn = specmodel.HTTPAPIKeyIn

+ type HTTPAuthAttachmentSpec = specmodel.HTTPAuthAttachmentSpec

+ type HTTPAuthCaptureSpec = specmodel.HTTPAuthCaptureSpec

+ type HTTPAuthSpec = specmodel.HTTPAuthSpec

+ type HTTPBasicAuthSpec = specmodel.HTTPBasicAuthSpec

+ type HTTPBearerAuthSpec = specmodel.HTTPBearerAuthSpec

+ type HTTPCaptureSourceSpec = specmodel.HTTPCaptureSourceSpec

+ type HTTPFormSlotAuthSpec = specmodel.HTTPFormSlotAuthSpec

+ type HTTPHeaderSlotAuthSpec = specmodel.HTTPHeaderSlotAuthSpec

+ type HTTPIdentitySpec = specmodel.HTTPIdentitySpec

+ type HTTPQuerySlotAuthSpec = specmodel.HTTPQuerySlotAuthSpec

+ type HTTPSessionSpec = specmodel.HTTPSessionSpec

+ type HTTPSpec = specmodel.HTTPSpec

+ type Inventory interface

+ Acquire func(ctx context.Context, req InventoryRequest) (any, error)

+ Contract func() InventoryContract

+ type InventoryCall = specmodel.InventoryCall

+ type InventoryCapabilityDescriptor struct

+ Args []ArgSpec

+ Produces ValueContract

+ type InventoryContract = specmodel.InventoryContract

+ type InventoryRegistrar interface

+ RegisterInventory func(ref string, inventory Inventory) error

+ type InventoryRequest struct

+ Args Args

+ Attempt int

+ HTTP *HTTPSpec

+ Paths PathContext

+ Resources ResourceScope

+ State *statemodel.Manager

+ type InventoryResolver interface

+ ResolveInventory func(ref string) (Inventory, error)

+ type JSONPointer = specmodel.JSONPointer

+ func ParseJSONPointer(raw string) (JSONPointer, error)

+ type LogFormat = specmodel.LogFormat

+ type LogRecord = reportmodel.LogRecord

+ type LogSpec = specmodel.LogSpec

+ type LogStatus = reportmodel.LogStatus

+ type LogSummary = reportmodel.LogSummary

+ type LogValueSpec = specmodel.LogValueSpec

+ type Matcher = specmodel.Matcher

+ type MatcherArg = specmodel.MatcherArg

+ type MatcherCapabilityDescriptor struct

+ Actual ValueContract

+ Args []MatcherArg

+ Sugar SugarSpec

+ type MatcherCatalog = specmodel.MatcherCatalog

+ func NewMatcherCatalog(descriptors ...MatcherDescriptor) (*MatcherCatalog, error)

+ type MatcherCompileContext = specmodel.MatcherCompileContext

+ type MatcherDescriptor = specmodel.MatcherDescriptor

+ type MatcherMismatch interface

+ TheaterMismatch func() bool

+ type MatcherResolver interface

+ Resolve func(ref string) (MatcherDescriptor, error)

+ type MatcherSugarResolver interface

+ ResolveSugarKey func(key string) (MatcherDescriptor, error)

+ type NodeAddress = reportmodel.NodeAddress

+ type NodeKind = reportmodel.NodeKind

+ type NodeReport = reportmodel.NodeReport

+ type ObservedStream = reportmodel.ObservedStream

+ type ObservedValue = reportmodel.ObservedValue

+ type Outputs = specmodel.Outputs

+ type ParamSpec = specmodel.ParamSpec

+ type PathContext = specmodel.PathContext

+ type PayloadMetadata = reportmodel.PayloadMetadata

+ type Phase = reportmodel.Phase

+ type PickStepSpec = specmodel.PickStepSpec

+ type PickWhereClauseSpec = specmodel.PickWhereClauseSpec

+ type PluginCatalog struct

+ func LoadPluginCatalog(base *Catalog, matchers *MatcherCatalog, configPath, lockPath string) (*PluginCatalog, error)

+ func LoadPluginDescriptorCatalog(base *Catalog, matchers *MatcherCatalog, configPath, lockPath string) (*PluginCatalog, error)

+ func NewPluginCatalog(base *Catalog, matchers *MatcherCatalog, options PluginCatalogOptions) (*PluginCatalog, error)

+ func (c *PluginCatalog) Resolve(ref string) (MatcherDescriptor, error)

+ func (c *PluginCatalog) ResolveAction(ref string) (Action, error)

+ func (c *PluginCatalog) ResolveDecorator(ref string) (DecoratorDef, error)

+ func (c *PluginCatalog) ResolveGenerator(ref string) (GeneratorDef, error)

+ func (c *PluginCatalog) ResolveInventory(ref string) (Inventory, error)

+ func (c *PluginCatalog) ResolveReportExporter(ref string) (ReportExporterDef, error)

+ func (c *PluginCatalog) ResolveStateBackend(ref string) (StateBackendDef, error)

+ func (c *PluginCatalog) ResolveSugarKey(key string) (MatcherDescriptor, error)

+ type PluginCatalogOptions struct

+ Config pluginregistry.ConfigFile

+ Lock pluginregistry.LockFile

+ RequireLock bool

+ RootDir string

+ type Preview = reportmodel.Preview

+ type ProjectedPayload struct

+ Metadata PayloadMetadata

+ Preview string

+ func SafeProjectText(raw string, metadata PayloadMetadata, limit int) ProjectedPayload

+ type Projector struct

+ func NewProjector() *Projector

+ func (p *Projector) Document(events []Event) (RunDocument, error)

+ func (p *Projector) Project(events []Event) (Report, error)

+ type PropertySpec = specmodel.PropertySpec

+ type RefSpec = specmodel.RefSpec

+ type RegexpStepSpec = specmodel.RegexpStepSpec

+ type RelativeSubjectSpec = specmodel.RelativeSubjectSpec

+ type Report = reportmodel.Report

+ type ReportExportSpec struct

+ Ref string

+ With Values

+ type ReportExporterCapabilityDescriptor struct

+ Params []ParamSpec

+ type ReportExporterDef struct

+ Export func(ctx context.Context, config Values, document RunDocument) error

+ Params []ParamSpec

+ type ReportExporterRegistrar interface

+ RegisterReportExporter func(ref string, exporter ReportExporterDef) error

+ type ReportExporterResolver interface

+ ResolveReportExporter func(ref string) (ReportExporterDef, error)

+ type ResourceKey struct

+ Name string

+ Namespace string

+ func NewResourceKey(namespace, name string) ResourceKey

+ type ResourceScope interface

+ GetOrCreate func(key ResourceKey, create func() any) any

+ func NewResourceScope() ResourceScope

+ type RunDocument = reportmodel.RunDocument

+ type RunOptions struct

+ Debug *DebugOptions

+ Events EventRecorder

+ Live observe.Sink

+ ReportExporters []ReportExportSpec

+ type RunResult struct

+ Diagnostics []Diagnostic

+ Report Report

+ func (r RunResult) Document() RunDocument

+ func (r RunResult) MarshalJSON() ([]byte, error)

+ type Runner struct

+ func NewRunner(catalog CatalogResolver, matchers MatcherResolver) *Runner

+ func (r *Runner) Run(ctx context.Context, spec StageSpec, options RunOptions) (result RunResult, err error)

+ type ScenarioCallSpec = specmodel.ScenarioCallSpec

+ type ScenarioDependencySpec = specmodel.ScenarioDependencySpec

+ type ScenarioScopeInitializer interface

+ Close func()

+ InitializeScenarioScope func(resources ResourceScope)

+ type ScenarioScopeInitializerFactory func() ScenarioScopeInitializer

+ type ScenarioScopeInitializerRegistrar interface

+ RegisterScenarioScopeInitializer func(ref string, factory ScenarioScopeInitializerFactory) error

+ type ScenarioSpec = specmodel.ScenarioSpec

+ type Secret = secretvalue.Value

+ func NewSecret(value any) Secret

+ type Sensitivity = reportmodel.Sensitivity

+ type SkipReason = reportmodel.SkipReason

+ type SourceRef = reportmodel.SourceRef

+ type StageSpec = specmodel.StageSpec

+ type StateBackend = statemodel.Backend

+ type StateBackendCapabilityDescriptor struct

+ Descriptor StateDescriptor

+ Params []ParamSpec

+ type StateBackendDef struct

+ Describe func(config Values) (StateDescriptor, error)

+ Open func(config Values) (StateBackend, error)

+ Params []ParamSpec

+ type StateBackendRegistrar interface

+ RegisterStateBackend func(ref string, backend StateBackendDef) error

+ type StateBackendResolver interface

+ ResolveStateBackend func(ref string) (StateBackendDef, error)

+ type StateBackendSpec = specmodel.StateBackendSpec

+ type StateClaimHandle = statemodel.ClaimHandle

+ type StateClaimResult = statemodel.ClaimResult

+ type StateDescriptor = statemodel.Descriptor

+ type StateExpiryPolicy = statemodel.ExpiryPolicy

+ type StateGuaranteeTier = statemodel.GuaranteeTier

+ type StateLeaseSpec = statemodel.LeaseSpec

+ type StateManager = statemodel.Manager

+ type StatePoolHandle = statemodel.PoolHandle

+ type StateRecordHandle = statemodel.RecordHandle

+ type StateRecordSnapshot = statemodel.RecordSnapshot

+ type StateSelector = statemodel.Selector

+ type StateSpec = specmodel.StateSpec

+ type Status = reportmodel.Status

+ type SubjectSourceKind = specmodel.SubjectSourceKind

+ type SubjectSpec = specmodel.SubjectSpec

+ type SugarForm = specmodel.SugarForm

+ const SugarFormFixedTuple

+ const SugarFormNone

+ const SugarFormUnary

+ type SugarSpec = specmodel.SugarSpec

+ type Summary = reportmodel.Summary

+ type TerminationReason = reportmodel.TerminationReason

+ type ThroughStepSpec = specmodel.ThroughStepSpec

+ type TransformCapabilityDescriptor struct

+ Accepts ValueContract

+ Params []ParamSpec

+ Produces ValueContract

+ type TransitionOutcome = specmodel.TransitionOutcome

+ type TransitionSpec = specmodel.TransitionSpec

+ type TriggerPredicate = specmodel.TriggerPredicate

+ type Validator struct

+ func NewValidator(catalog CatalogResolver, matchers MatcherResolver) *Validator

+ func (v *Validator) ListDebugPaths(spec StageSpec) (DebugPathListing, error)

+ func (v *Validator) Validate(spec StageSpec) []Diagnostic

+ type ValueContract = specmodel.ValueContract

+ type ValueKind = specmodel.ValueKind

+ const ValueKindAny

+ const ValueKindBool

+ const ValueKindBytes

+ const ValueKindList

+ const ValueKindNull

+ const ValueKindNumber

+ const ValueKindObject

+ const ValueKindString

+ type ValueKindSet = specmodel.ValueKindSet

+ func NewValueKindSet(kinds ...ValueKind) ValueKindSet

+ type Values = specmodel.Values

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL