preflight

type BranchPushedEvent struct {
	Type   string    `json:"type"`
	ID     uuid.UUID `json:"preflight_id"`
	Branch string    `json:"branch"`
	Commit string    `json:"commit"`
	// Base is Commit's parent: where HEAD forked from BaseBranch, or HEAD
	// when the default branch could not be determined (BaseBranch empty).
	Base       string `json:"base"`
	BaseBranch string `json:"base_branch,omitempty"`
	// Changes is false when the working tree matched Base, in which case
	// Commit is Base itself.
	Changes bool `json:"changes"`
}

type CleanupEntry struct {
	ID     uuid.UUID  `json:"preflight_id"`
	Branch string     `json:"branch"`
	Commit string     `json:"commit"`
	RunID  *uuid.UUID `json:"run_id,omitempty"`
	Status string     `json:"status"`
	Error  string     `json:"error,omitempty"`
}

type CleanupOptions struct {
	Client    *apiclient.Client
	Repo      *Repo
	ProjectID string
	// ID limits the cleanup to one preflight. Zero means every preflight
	// branch on the remote.
	ID uuid.UUID
	// IncludeRunning also deletes branches whose run has not ended, or has
	// not started within startGrace of the commit. By default those are
	// skipped: the preflight that pushed them may still be watching or waiting.
	IncludeRunning bool
	DryRun         bool
	// Confirm is called with the branches about to be deleted, once they are
	// known and before any is deleted; an error stops the cleanup with nothing
	// deleted. It is not called for a dry run, or when nothing is to be
	// deleted. Nil means no confirmation.
	Confirm func(toDelete []CleanupEntry) error
}

type ErrNoRun struct {
	Branch string
	Waited time.Duration
}

type FailedStep struct {
	Execution int    `json:"execution"`
	Num       int    `json:"num"`
	Name      string `json:"name"`
	ExitCode  *int   `json:"exit_code,omitempty"`
}

type FailedTest struct {
	Classname string `json:"classname"`
	Name      string `json:"name"`
	Message   string `json:"message"`
}

type GitError struct {
	Op  string
	Err error
}

type JobFailedEvent struct {
	Type string     `json:"type"`
	Job  JobFailure `json:"job"`
}

type JobFailure struct {
	ID          uuid.UUID    `json:"id"`
	Name        string       `json:"name"`
	WorkflowID  uuid.UUID    `json:"workflow_id"`
	Workflow    string       `json:"workflow"`
	URL         string       `json:"url"`
	FailedSteps []FailedStep `json:"failed_steps"`
	// FailedTests holds at most MaxFailedTests entries; FailedTestCount is
	// the full number.
	FailedTests     []FailedTest `json:"failed_tests"`
	FailedTestCount int          `json:"failed_test_count"`
}

type JobRef struct {
	ID       uuid.UUID `json:"id"`
	Name     string    `json:"name"`
	Workflow string    `json:"workflow"`
	URL      string    `json:"url"`
}

type Observer interface {
	BranchPushed(BranchPushedEvent) error
	WaitingForRun(branch string)
	RunStarted(RunStartedEvent) error
	Progress(Progress)
	JobFailed(JobFailedEvent) error
	RunSummary(RunSummaryEvent) error
}

type Options struct {
	Client      *apiclient.Client
	Repo        *Repo
	ProjectSlug string
	// ID names the preflight and its branch. Zero means generate one.
	ID uuid.UUID
	// Watch follows the run after it starts. Without it, Run returns once the
	// run exists and the branch is left in place.
	Watch bool
	// FailFast stops at the first failed job instead of waiting for the run.
	FailFast bool
	// Cleanup cancels a run the preflight stopped watching early and deletes
	// the branch.
	Cleanup  bool
	Interval time.Duration
	Timeout  time.Duration
	// RunWait is how long to wait for the push to start a run.
	RunWait  time.Duration
	RunURL   func(runID uuid.UUID) string
	JobURL   func(workflowID, jobID uuid.UUID) string
	Observer Observer
}

type Progress struct {
	Elapsed   time.Duration
	Workflows []WorkflowProgress
}

type ProjectError struct {
	Slug string
	Err  error
}

type RemoteBranch struct {
	ID     uuid.UUID
	Name   string
	Commit string
}

type Repo struct {
	// Dir is the top level of the working tree.
	Dir string
	// Remote is the remote branches are pushed to and deleted from.
	Remote string
	// contains filtered or unexported fields
}

type RunError struct {
	Type    string `json:"type"`
	Message string `json:"message"`
}

type RunStartedEvent struct {
	Type    string    `json:"type"`
	RunID   uuid.UUID `json:"run_id"`
	Project string    `json:"project"`
	Branch  string    `json:"branch"`
	Commit  string    `json:"commit"`
	URL     string    `json:"url"`
}

type RunSummaryEvent struct {
	Type    string    `json:"type"`
	RunID   uuid.UUID `json:"run_id"`
	Outcome string    `json:"outcome"`
	// Ended is false when the preflight stopped before the run did: at the
	// first failure, on timeout or on Ctrl+C.
	Ended      bool       `json:"ended"`
	DurationMS int64      `json:"duration_ms"`
	URL        string     `json:"url"`
	Errors     []RunError `json:"errors"`
	FailedJobs []JobRef   `json:"failed_jobs"`
	// RunCanceled is true when the preflight canceled what was left of the
	// run on its way out.
	RunCanceled   bool   `json:"run_canceled"`
	BranchDeleted bool   `json:"branch_deleted"`
	CleanupError  string `json:"cleanup_error,omitempty"`
}

type Snapshot struct {
	// Commit is the SHA to push.
	Commit string
	// Base is Commit's parent: where HEAD forked from the remote's default
	// branch, or HEAD itself when that cannot be determined.
	Base string
	// BaseBranch is the default branch Base was found on, or "" when Base
	// fell back to HEAD.
	BaseBranch string
	// Changed is false when the working tree matched Base, in which case
	// Commit is Base itself.
	Changed bool
}

type WorkflowProgress struct {
	Name   string
	Status string
	Jobs   int
	Done   int
}