controllers

type APIController struct {
	APISecret                       []byte
	Locker                          locking.Locker `validate:"required"`
	DriftStorage                    drift.Storage
	RemediationService              drift.RemediationService
	ApplyLockChecker                locking.ApplyLockChecker
	EnableDriftRemediation          bool
	Logger                          logging.SimpleLogging           `validate:"required"`
	Parser                          events.EventParsing             `validate:"required"`
	ProjectCommandBuilder           events.ProjectCommandBuilder    `validate:"required"`
	ProjectPlanCommandRunner        events.ProjectPlanCommandRunner `validate:"required"`
	ProjectPolicyCheckCommandRunner events.ProjectPolicyCheckCommandRunner
	ProjectApplyCommandRunner       events.ProjectApplyCommandRunner `validate:"required"`
	FailOnPreWorkflowHookError      bool
	PreWorkflowHooksCommandRunner   events.PreWorkflowHooksCommandRunner  `validate:"required"`
	PostWorkflowHooksCommandRunner  events.PostWorkflowHooksCommandRunner `validate:"required"`
	RepoAllowlistChecker            *events.RepoAllowlistChecker          `validate:"required"`
	Scope                           tally.Scope                           `validate:"required"`
	VCSClient                       vcs.Client                            `validate:"required"`
	WorkingDir                      events.WorkingDir                     `validate:"required"`
	WorkingDirLocker                events.WorkingDirLocker               `validate:"required"`
	CommitStatusUpdater             events.CommitStatusUpdater            `validate:"required"`
	// PullReqStatusFetcher is optional. When set and the API request supplies a
	// PR number, it is used to populate command.Context.PullRequestStatus so
	// apply requirements like 'mergeable' and 'approved' evaluate against real
	// VCS state instead of always failing.
	PullReqStatusFetcher vcs.PullReqStatusFetcher
	// PullStatusFetcher is optional. When set and the API request supplies a PR
	// number, it is used to populate command.Context.PullStatus so generated
	// policy_check contexts can preserve existing policy approvals.
	PullStatusFetcher events.PullStatusFetcher
	// LivePullHeadFetcher is optional for tests. In production it is used for
	// PR-backed API requests to seed live PR identity data such as base branch.
	LivePullHeadFetcher events.LivePullHeadFetcher
	// DriftWebhookSender sends webhook notifications when drift is detected.
	// Nil when no drift webhooks are configured.
	DriftWebhookSender *webhooks.DriftWebhookSender
	// SilenceVCSStatusNoProjects is whether API should set commit status if no projects are found
	SilenceVCSStatusNoProjects bool
	// contains filtered or unexported fields
}

type APIError struct {
	// Code is a machine-readable error code.
	Code ErrorCode `json:"code"`
	// Message is a human-readable error message.
	Message string `json:"message"`
	// Details contains additional error context (e.g., field-level validation errors).
	Details any `json:"details,omitempty"`
}

type APIMiddleware struct {
	APISecret []byte
	Logger    logging.SimpleLogging
	Responder *APIResponder
}

type APIRequest struct {
	Repository string `validate:"required"`
	Ref        string `validate:"required"`
	BaseBranch string `json:"base_branch,omitempty"`
	Type       string `validate:"required"`
	PR         int
	Projects   []string
	Paths      []APIRequestPath
	// DiscoverProjects enables all-project discovery when no projects or paths
	// are specified. Only drift detection and remediation set this.
	DiscoverProjects bool `json:"-"`
}

type APIRequestPath struct {
	ProjectName string `json:"project_name,omitempty"`
	Directory   string `json:"directory"`
	Workspace   string `json:"workspace,omitempty"`
}

type APIResponder struct {
	Logger logging.SimpleLogging
}

type APIResponse struct {
	// Success indicates whether the request succeeded.
	Success bool `json:"success"`
	// Data contains the response payload on success.
	Data any `json:"data"`
	// Error contains error details on failure.
	Error *APIError `json:"error"`
	// RequestID is a unique identifier for request tracing.
	RequestID string `json:"request_id"`
	// Timestamp is when the response was generated.
	Timestamp time.Time `json:"timestamp"`
}

type CommandResultAPI struct {
	// Command is the command that was executed.
	Command string `json:"command"`
	// Projects contains results for each project.
	Projects []ProjectResultAPI `json:"projects"`
	// TotalProjects is the total number of projects.
	TotalProjects int `json:"total_projects"`
	// SuccessCount is the number of successful projects.
	SuccessCount int `json:"success_count"`
	// FailureCount is the number of failed projects.
	FailureCount int `json:"failure_count"`
	// ExecutedAt is when the command was executed.
	ExecutedAt time.Time `json:"executed_at"`
}

type DriftDetailsAPI struct {
	// ToAdd is the number of resources to add.
	ToAdd int `json:"to_add"`
	// ToChange is the number of resources to change.
	ToChange int `json:"to_change"`
	// ToDestroy is the number of resources to destroy.
	ToDestroy int `json:"to_destroy"`
	// ToImport is the number of resources to import.
	ToImport int `json:"to_import"`
	// ToForget is the number of resources to forget.
	ToForget int `json:"to_forget"`
	// TotalChanges is the total number of changes.
	TotalChanges int `json:"total_changes"`
	// Summary is a human-readable summary.
	Summary string `json:"summary,omitempty"`
	// ChangesOutside indicates if changes were made outside Terraform.
	ChangesOutside bool `json:"changes_outside"`
}

type DriftDetectionResultAPI struct {
	// ID is a unique identifier for this detection run.
	ID string `json:"id"`
	// Repository is the full repository name.
	Repository string `json:"repository"`
	// Projects contains drift status for each project checked.
	Projects []DriftProjectAPI `json:"projects"`
	// DetectedAt is when drift detection was performed.
	DetectedAt time.Time `json:"detected_at"`
	// Summary provides aggregate drift statistics.
	Summary DriftSummaryAPI `json:"summary"`
}

type DriftProjectAPI struct {
	// ProjectName is the name of the project.
	ProjectName string `json:"project_name"`
	// Directory is the relative path to the project.
	Directory string `json:"directory"`
	// Workspace is the Terraform workspace.
	Workspace string `json:"workspace"`
	// Ref is the git reference that was checked.
	Ref string `json:"ref"`
	// BaseBranch is the branch context used for repo config branch filters.
	BaseBranch string `json:"base_branch,omitempty"`
	// ResolvedCommit is the checked-out commit SHA that produced this drift record.
	ResolvedCommit string `json:"resolved_commit,omitempty"`
	// DetectionID links this result to the detection run that produced it.
	DetectionID string `json:"detection_id,omitempty"`
	// HasDrift indicates whether drift was detected.
	HasDrift bool `json:"has_drift"`
	// Drift contains drift details if drift was detected.
	Drift *DriftDetailsAPI `json:"drift,omitempty"`
	// LastChecked is when drift was last checked.
	LastChecked time.Time `json:"last_checked"`
	// Error contains any error message if detection failed.
	Error string `json:"error,omitempty"`
}

type DriftStatusAPI struct {
	// Repository is the full repository name.
	Repository string `json:"repository"`
	// Projects contains drift status for each project.
	Projects []DriftProjectAPI `json:"projects"`
	// CheckedAt is when the status was checked.
	CheckedAt time.Time `json:"checked_at"`
	// Summary provides aggregate drift statistics.
	Summary DriftSummaryAPI `json:"summary"`
}

type DriftSummaryAPI struct {
	// TotalProjects is the total number of projects.
	TotalProjects int `json:"total_projects"`
	// ProjectsWithDrift is the number of projects with drift.
	ProjectsWithDrift int `json:"projects_with_drift"`
	// ProjectsWithoutDrift is the number of projects without drift.
	ProjectsWithoutDrift int `json:"projects_without_drift"`
	// ProjectsWithErrors is the number of projects with errors.
	ProjectsWithErrors int `json:"projects_with_errors"`
}

type ErrorCode string

type GithubAppController struct {
	AtlantisURL         *url.URL              `validate:"required"`
	Logger              logging.SimpleLogging `validate:"required"`
	GithubSetupComplete bool
	GithubHostname      string `validate:"required"`
	GithubOrg           string
}

type JobIDKeyGenerator struct{}

type JobsController struct {
	AtlantisVersion          string                       `validate:"required"`
	AtlantisURL              *url.URL                     `validate:"required"`
	Logger                   logging.SimpleLogging        `validate:"required"`
	ProjectJobsTemplate      web_templates.TemplateWriter `validate:"required"`
	ProjectJobsErrorTemplate web_templates.TemplateWriter `validate:"required"`
	Database                 db.Database                  `validate:"required"`
	WsMux                    *websocket.Multiplexor       `validate:"required"`
	KeyGenerator             JobIDKeyGenerator
	StatsScope               tally.Scope `validate:"required"`
}

type ListLocksResult struct {
	Locks []LockDetail
}

type ListLocksResultAPI struct {
	// Locks contains the list of active locks.
	Locks []LockDetailAPI `json:"locks"`
	// TotalCount is the total number of locks.
	TotalCount int `json:"total_count"`
}

type LockDetail struct {
	Name            string
	ProjectName     string
	ProjectRepo     string
	ProjectRepoPath string
	PullID          int `json:",string"`
	PullURL         string
	User            string
	Workspace       string
	Time            time.Time
}

type LockDetailAPI struct {
	// ID is the unique lock identifier.
	ID string `json:"id"`
	// ProjectName is the name of the locked project.
	ProjectName string `json:"project_name"`
	// Repository is the full repository name (owner/repo).
	Repository string `json:"repository"`
	// Path is the relative path to the project within the repository.
	Path string `json:"path"`
	// Workspace is the Terraform workspace.
	Workspace string `json:"workspace"`
	// PullRequestID is the PR number that holds the lock.
	PullRequestID int `json:"pull_request_id"`
	// PullRequestURL is the URL to the pull request.
	PullRequestURL string `json:"pull_request_url"`
	// LockedBy is the username who created the lock.
	LockedBy string `json:"locked_by"`
	// LockedAt is when the lock was acquired.
	LockedAt time.Time `json:"locked_at"`
}

type LocksController struct {
	AtlantisVersion    string                       `validate:"required"`
	AtlantisURL        *url.URL                     `validate:"required"`
	Locker             locking.Locker               `validate:"required"`
	Logger             logging.SimpleLogging        `validate:"required"`
	ApplyLocker        locking.ApplyLocker          `validate:"required"`
	VCSClient          vcs.Client                   `validate:"required"`
	LockDetailTemplate web_templates.TemplateWriter `validate:"required"`
	WorkingDir         events.WorkingDir            `validate:"required"`
	WorkingDirLocker   events.WorkingDirLocker      `validate:"required"`
	Database           db.Database                  `validate:"required"`
	DeleteLockCommand  events.DeleteLockCommand     `validate:"required"`
}

type PlanDetailsAPI struct {
	// HasChanges indicates whether the plan contains changes.
	HasChanges bool `json:"has_changes"`
	// ToAdd is the number of resources to add.
	ToAdd int `json:"to_add"`
	// ToChange is the number of resources to change.
	ToChange int `json:"to_change"`
	// ToDestroy is the number of resources to destroy.
	ToDestroy int `json:"to_destroy"`
	// ToImport is the number of resources to import.
	ToImport int `json:"to_import"`
	// ToForget is the number of resources to forget.
	ToForget int `json:"to_forget"`
	// Summary is a human-readable summary.
	Summary string `json:"summary,omitempty"`
}

type ProjectResultAPI struct {
	// ProjectName is the name of the project (from atlantis.yaml).
	ProjectName string `json:"project_name"`
	// Directory is the relative path to the project root.
	Directory string `json:"directory"`
	// Workspace is the Terraform workspace.
	Workspace string `json:"workspace"`
	// Command is the command that was executed.
	Command string `json:"command"`
	// Status indicates whether the command succeeded or failed.
	Status string `json:"status"`
	// Output contains the command output (plan/apply output).
	Output string `json:"output,omitempty"`
	// Error contains any error message.
	Error string `json:"error,omitempty"`
	// Failure contains any failure message (different from error).
	Failure string `json:"failure,omitempty"`
	// Plan contains plan-specific details if this was a plan command.
	Plan *PlanDetailsAPI `json:"plan,omitempty"`
}

type RemediationListAPI struct {
	// Repository is the full repository name.
	Repository string `json:"repository"`
	// Count is the number of results returned.
	Count int `json:"count"`
	// Results contains the remediation results.
	Results []RemediationResultAPI `json:"results"`
}

type RemediationProjectAPI struct {
	// ProjectName is the name of the project.
	ProjectName string `json:"project_name"`
	// Directory is the relative path to the project.
	Directory string `json:"directory"`
	// Workspace is the Terraform workspace.
	Workspace string `json:"workspace"`
	// Status is the remediation status for this project.
	Status string `json:"status"`
	// PlanOutput contains the plan output.
	PlanOutput string `json:"plan_output,omitempty"`
	// ApplyOutput contains the apply output.
	ApplyOutput string `json:"apply_output,omitempty"`
	// Error contains any error message.
	Error string `json:"error,omitempty"`
	// DriftBefore contains drift state before remediation.
	DriftBefore *DriftDetailsAPI `json:"drift_before,omitempty"`
	// DriftAfter contains drift state after remediation.
	DriftAfter *DriftDetailsAPI `json:"drift_after,omitempty"`
}

type RemediationResultAPI struct {
	// ID is the unique identifier for this remediation.
	ID string `json:"id"`
	// Repository is the full repository name.
	Repository string `json:"repository"`
	// Ref is the git reference that was remediated.
	Ref string `json:"ref"`
	// Action is the remediation action performed.
	Action string `json:"action"`
	// Status is the overall remediation status.
	Status string `json:"status"`
	// StartedAt is when the remediation started.
	StartedAt time.Time `json:"started_at"`
	// CompletedAt is when the remediation completed.
	CompletedAt *time.Time `json:"completed_at,omitempty"`
	// Projects contains results for each project.
	Projects []RemediationProjectAPI `json:"projects"`
	// Summary provides aggregate statistics.
	Summary RemediationSummaryAPI `json:"summary"`
	// Error contains any top-level error.
	Error string `json:"error,omitempty"`
}

type RemediationSummaryAPI struct {
	// TotalProjects is the total number of projects targeted.
	TotalProjects int `json:"total_projects"`
	// SuccessCount is the number of successful remediations.
	SuccessCount int `json:"success_count"`
	// FailureCount is the number of failed remediations.
	FailureCount int `json:"failure_count"`
}

type StatusController struct {
	Logger          logging.SimpleLogging `validate:"required"`
	Drainer         *events.Drainer       `validate:"required"`
	AtlantisVersion string                `validate:"required"`
}

type StatusResponse struct {
	ShuttingDown    bool   `json:"shutting_down"`
	InProgressOps   int    `json:"in_progress_operations"`
	AtlantisVersion string `json:"version"`
}

type ValidationError struct {
	Field   string `json:"field"`
	Message string `json:"message"`
}