report.go

package legatus

import (

	"context"

	"go.bigb.es/auxilia/culpa"

)

// ErrNoPrompter is returned by the non-interactive default prompter when a step

// requires a choice it cannot answer.

var ErrNoPrompter = culpa.WithCode(culpa.New("legatus: no interactive prompter configured"), "LEGATUS_NO_PROMPTER")

// Reporter receives engine-driven progress events for human-facing output. It is

// decoupled from structured logging; the engine drives both with no step

// involvement (PC5).

type Reporter interface {

	FlowStart(host, flow string)

	StepStart(host, step string)

	StepDone(host string, r StepResult)

	FlowDone(host string, r FlowResult)

	RunDone(r RunResult)

}

// Prompter answers interactive questions a step may ask. The core is

// non-interactive by default (PC2); a real prompter is injected by the caller.

type Prompter interface {

	Confirm(ctx context.Context, question string) (bool, error)

	Select(ctx context.Context, question string, options []string) (int, error)

}

// NopReporter discards all events. It is the default reporter.

type NopReporter struct{}

func (NopReporter) FlowStart(string, string)    {}

func (NopReporter) StepStart(string, string)    {}

func (NopReporter) StepDone(string, StepResult) {}

func (NopReporter) FlowDone(string, FlowResult) {}

func (NopReporter) RunDone(RunResult)           {}

// DenyPrompter is the non-interactive default: it declines confirmations and

// errors on selections.

type DenyPrompter struct{}

func (DenyPrompter) Confirm(context.Context, string) (bool, error) { return false, nil }

func (DenyPrompter) Select(context.Context, string, []string) (int, error) {

	return -1, ErrNoPrompter

}