Documentation
¶
Overview ¶
Package stepkindtest provides application-neutral fake step kinds for compiler, runtime, and conformance tests.
Index ¶
- func NoopSpec(name, version string) stepkind.StepKindSpec
- type Kind
- type LifecycleKind
- func (k *LifecycleKind) Cancel(ctx context.Context, ref stepkind.ExternalOperationRef) error
- func (k *LifecycleKind) Finalize(ctx context.Context, finalization stepkind.Finalization) error
- func (k *LifecycleKind) Heartbeat(ctx context.Context, ref stepkind.ExternalOperationRef) error
- func (k *LifecycleKind) Observe(ctx context.Context, ref stepkind.ExternalOperationRef) (stepkind.Observation, error)
- func (k *LifecycleKind) Prepare(ctx context.Context, invocation stepkind.Invocation) (stepkind.PreparedInvocation, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NoopSpec ¶
func NoopSpec(name, version string) stepkind.StepKindSpec
NoopSpec returns complete metadata for a pure embedded fake kind.
Types ¶
type Kind ¶
type Kind struct {
SpecValue stepkind.StepKindSpec
ValidateConfigFunc func(context.Context, graph.Config) []diagnostic.Diagnostic
ExecuteFunc func(context.Context, stepkind.PreparedInvocation) (stepkind.StepResult, error)
}
Kind is a fake implementing only the required StepKind lifecycle.
func NewNoopKind ¶
NewNoopKind returns a valid no-op kind with no optional lifecycle hooks.
func (*Kind) Execute ¶
func (k *Kind) Execute(ctx context.Context, invocation stepkind.PreparedInvocation) (stepkind.StepResult, error)
Execute implements stepkind.StepKind.
func (*Kind) ValidateConfig ¶
func (k *Kind) ValidateConfig(ctx context.Context, config graph.Config) []diagnostic.Diagnostic
ValidateConfig implements stepkind.StepKind.
type LifecycleKind ¶
type LifecycleKind struct {
*Kind
PrepareFunc func(context.Context, stepkind.Invocation) (stepkind.PreparedInvocation, error)
ObserveFunc func(context.Context, stepkind.ExternalOperationRef) (stepkind.Observation, error)
CancelFunc func(context.Context, stepkind.ExternalOperationRef) error
HeartbeatFunc func(context.Context, stepkind.ExternalOperationRef) error
FinalizeFunc func(context.Context, stepkind.Finalization) error
}
LifecycleKind is a fake implementing every optional lifecycle interface.
func NewLifecycleKind ¶
func NewLifecycleKind(name, version string) *LifecycleKind
NewLifecycleKind returns a no-op kind that advertises every optional hook.
func (*LifecycleKind) Cancel ¶
func (k *LifecycleKind) Cancel(ctx context.Context, ref stepkind.ExternalOperationRef) error
Cancel implements stepkind.Canceler.
func (*LifecycleKind) Finalize ¶
func (k *LifecycleKind) Finalize(ctx context.Context, finalization stepkind.Finalization) error
Finalize implements stepkind.Finalizer.
func (*LifecycleKind) Heartbeat ¶
func (k *LifecycleKind) Heartbeat(ctx context.Context, ref stepkind.ExternalOperationRef) error
Heartbeat implements stepkind.Heartbeater.
func (*LifecycleKind) Observe ¶
func (k *LifecycleKind) Observe(ctx context.Context, ref stepkind.ExternalOperationRef) (stepkind.Observation, error)
Observe implements stepkind.Observer.
func (*LifecycleKind) Prepare ¶
func (k *LifecycleKind) Prepare(ctx context.Context, invocation stepkind.Invocation) (stepkind.PreparedInvocation, error)
Prepare implements stepkind.Preparer.