Report structured session validation and inspection results
This commit is contained in:
146
internal/app/session_inspection_command.go
Normal file
146
internal/app/session_inspection_command.go
Normal file
@@ -0,0 +1,146 @@
|
||||
package app
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"gitea.maximumdirect.net/eric/narratio/internal/artifacts"
|
||||
"gitea.maximumdirect.net/eric/narratio/internal/config"
|
||||
"go.maximumdirect.net/commandkit"
|
||||
)
|
||||
|
||||
type sessionInspectionInput struct {
|
||||
Selection configurationSelection
|
||||
PreviousSession commandkit.Supplied[string]
|
||||
Remote commandkit.Supplied[bool]
|
||||
}
|
||||
|
||||
type sessionValidationReport struct {
|
||||
Campaign string `json:"campaign"`
|
||||
SessionID string `json:"session_id"`
|
||||
SessionSource string `json:"session_source,omitempty"`
|
||||
Valid bool `json:"valid"`
|
||||
Findings []finding `json:"findings"`
|
||||
}
|
||||
|
||||
func sessionInspectionSpec(name, summary string, remoteOption bool) commandkit.CommandSpec[*sessionInspectionInput] {
|
||||
common := newConfigurationFlags(func(input **sessionInspectionInput) *configurationSelection { return &(*input).Selection })
|
||||
flags := []commandkit.Flag[*sessionInspectionInput]{common.Config, common.Overlay, common.Campaign, common.CampaignFile, common.SessionFile, common.PartyFile, common.SecretsDir,
|
||||
commandkit.ValueFlag(commandkit.FlagMeta{Name: "previous-session-id", Usage: "Assert the previous session identity."}, nil, stringValue, func(input **sessionInspectionInput, value commandkit.Supplied[string]) {
|
||||
(*input).PreviousSession = value
|
||||
}),
|
||||
}
|
||||
if remoteOption {
|
||||
flags = append(flags, commandkit.BoolFlag(commandkit.FlagMeta{Name: "remote", Usage: "Inspect remote publication and locks."}, false, func(input **sessionInspectionInput, value commandkit.Supplied[bool]) { (*input).Remote = value }))
|
||||
}
|
||||
return commandkit.CommandSpec[*sessionInspectionInput]{Name: name, Summary: summary, NewInput: func() *sessionInspectionInput { return &sessionInspectionInput{} }, Flags: flags,
|
||||
Arguments: []commandkit.Argument[*sessionInspectionInput]{commandkit.ValueArgument(commandkit.ArgumentMeta{Name: "SESSION", Usage: "Session identity."}, true, stringValue, func(input **sessionInspectionInput, value commandkit.Supplied[string]) {
|
||||
(*input).Selection.Session = value
|
||||
})},
|
||||
CheckInput: func(input *sessionInspectionInput) error { return checkConfigurationSelection(input.Selection) },
|
||||
}
|
||||
}
|
||||
|
||||
func sessionValidationCommand(deps commandDependencies) commandkit.Command {
|
||||
spec := sessionInspectionSpec("validate", "Check session readiness without executing work.", false)
|
||||
spec.Run = func(invocation commandkit.Invocation, input *sessionInspectionInput) commandkit.Outcome {
|
||||
report, err := validateSelectedSession(invocation.Context, input, deps)
|
||||
if report != nil {
|
||||
err = errors.Join(err, invocation.Reporter().Report(commandkit.Report{Value: report}))
|
||||
}
|
||||
return operationOutcome(err)
|
||||
}
|
||||
return commandkit.NewCommand(spec)
|
||||
}
|
||||
|
||||
func validateSelectedSession(ctx context.Context, input *sessionInspectionInput, deps commandDependencies) (report *sessionValidationReport, err error) {
|
||||
deps = normalizeCommandDependencies(deps)
|
||||
deps.secretsBootstrap = &secretsBootstrap{}
|
||||
acquired := newConfigurationAcquisition(input.Selection, deps)
|
||||
acquired.previousSessionID = input.PreviousSession.Value
|
||||
defer func() { err = errors.Join(err, acquired.Close()) }()
|
||||
cfg, err := acquired.Domain(ctx)
|
||||
if err != nil {
|
||||
return &sessionValidationReport{Campaign: input.Selection.Campaign.Value, SessionID: input.Selection.Session.Value, Findings: []finding{errorFinding("config", err.Error())}}, err
|
||||
}
|
||||
return inspectSessionValidation(ctx, cfg, deps)
|
||||
}
|
||||
|
||||
func inspectSessionValidation(ctx context.Context, cfg *config.Config, deps commandDependencies) (*sessionValidationReport, error) {
|
||||
report := &sessionValidationReport{Campaign: cfg.Session.Campaign, SessionID: cfg.Session.SessionID, SessionSource: sessionSourceSummary(cfg), Findings: []finding{}}
|
||||
var resultErr error
|
||||
fail := func(category string, err error) {
|
||||
if err != nil {
|
||||
report.Findings = append(report.Findings, errorFinding(category, err.Error()))
|
||||
resultErr = errors.Join(resultErr, err)
|
||||
}
|
||||
}
|
||||
if err := config.Validate(cfg); err != nil {
|
||||
fail("config", err)
|
||||
} else {
|
||||
report.Findings = append(report.Findings, okFinding("config", "resolved pipeline, campaign, and session config"))
|
||||
}
|
||||
for _, check := range inspectStableInputs(cfg) {
|
||||
if check.Err != nil {
|
||||
fail("inputs", fmt.Errorf("%s: %w", check.Name, check.Err))
|
||||
} else {
|
||||
report.Findings = append(report.Findings, okFinding("inputs", check.Name+": "+check.Path))
|
||||
}
|
||||
}
|
||||
local := inspectLocalAudioPresence(cfg)
|
||||
if local.Checked {
|
||||
if local.Err != nil {
|
||||
fail("audio", local.Err)
|
||||
} else {
|
||||
report.Findings = append(report.Findings, okFinding("audio", fmt.Sprintf("%d local audio file(s)", len(local.Paths))))
|
||||
}
|
||||
}
|
||||
store, storeErr := objectStoreIfConfiguredWithDependencies(ctx, cfg, deps)
|
||||
fail("storage", storeErr)
|
||||
if cfg.Session.Inputs.AudioS3 != nil {
|
||||
if storeErr != nil {
|
||||
report.Findings = append(report.Findings, errorFinding("audio", "remote audio cannot be checked because storage is unavailable"))
|
||||
} else {
|
||||
remote := inspectRemoteAudioPresence(ctx, cfg, store)
|
||||
if remote.Err != nil {
|
||||
fail("audio", remote.Err)
|
||||
} else {
|
||||
report.Findings = append(report.Findings, okFinding("audio", fmt.Sprintf("%d remote .flac object(s)", len(remote.Keys))))
|
||||
}
|
||||
}
|
||||
}
|
||||
effective, effectiveErr := resolveEffectiveArtifacts(cfg, nil)
|
||||
fail("config", effectiveErr)
|
||||
if effectiveErr == nil {
|
||||
previous := inspectPreviousArtifactReadiness(ctx, cfg, store, artifacts.CollectPreviousArtifactRequirements(configuredScriptoriumArtifacts(cfg), effective))
|
||||
if len(previous.Requirements) == 0 {
|
||||
report.Findings = append(report.Findings, okFinding("previous", "no previous-session artifacts required"))
|
||||
} else if previous.Err != nil {
|
||||
fail("previous", previous.Err)
|
||||
} else {
|
||||
for _, requirement := range previous.Requirements {
|
||||
message := fmt.Sprintf("%s required=%t", requirement.Name, requirement.Required)
|
||||
if !requirement.Required && previousRequirementSkipped(previous.SkippedMissing, requirement.Name) {
|
||||
message += " unavailable"
|
||||
}
|
||||
report.Findings = append(report.Findings, okFinding("previous", message))
|
||||
}
|
||||
}
|
||||
}
|
||||
locks := inspectRemoteLocks(ctx, cfg, store)
|
||||
if locks.Err != nil {
|
||||
fail("locks", locks.Err)
|
||||
} else if len(locks.Locks) == 0 {
|
||||
report.Findings = append(report.Findings, okFinding("locks", "no publish locks"))
|
||||
} else {
|
||||
for _, lock := range locks.Locks {
|
||||
report.Findings = append(report.Findings, warnFinding("locks", fmt.Sprintf("%s locked: %s", lock.Source, strings.TrimSpace(lock.Reason))))
|
||||
}
|
||||
}
|
||||
paths := artifacts.NewLocalStore(cfg.Pipeline.Workspace.Root).SessionPathsFor(cfg.Session.Campaign, cfg.Session.SessionID)
|
||||
report.Findings = append(report.Findings, infoFinding("workspace", "manifest path: "+paths.ManifestPath))
|
||||
report.Valid = resultErr == nil
|
||||
return report, resultErr
|
||||
}
|
||||
Reference in New Issue
Block a user