models

type ApprovalStatus struct {
	IsApproved bool
	ApprovedBy string
	Date       time.Time
}

type CommitStatus int

type DriftDetectionPath struct {
	// Directory is the relative path to the Terraform directory.
	Directory string `json:"directory"`
	// Workspace is the Terraform workspace (optional).
	Workspace string `json:"workspace,omitempty"`
}

type DriftDetectionRequest struct {
	// Repository is the full repository name (owner/repo). Required.
	Repository string `json:"repository"`
	// Ref is the git reference (branch/tag/commit) to check for drift. Required.
	Ref string `json:"ref"`
	// BaseBranch is required when ref is a raw commit SHA or tag value.
	// It preserves Atlantis repo-config branch filtering and undiverged checks.
	BaseBranch string `json:"base_branch,omitempty"`
	// Type is the VCS provider type (Github/Gitlab). Required.
	Type string `json:"type"`
	// Projects is a list of project names to check. If empty, all projects are checked.
	Projects []string `json:"projects,omitempty"`
	// Paths is a list of paths to check. If empty, project names are used.
	Paths []DriftDetectionPath `json:"paths,omitempty"`
}

type DriftDetectionResult 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 the drift status for each project checked.
	Projects []ProjectDrift `json:"projects"`
	// DetectedAt is when the drift detection was performed.
	DetectedAt time.Time `json:"detected_at"`
	// TotalProjects is the total number of projects checked.
	TotalProjects int `json:"total_projects"`
	// ProjectsWithDrift is the number of projects that have drift.
	ProjectsWithDrift int `json:"projects_with_drift"`
}

type DriftStatusResponse struct {
	// Repository is the full repository name (owner/repo).
	Repository string `json:"repository"`
	// Projects contains the drift status for each project.
	Projects []ProjectDrift `json:"projects"`
	// CheckedAt is when the drift check was performed.
	CheckedAt time.Time `json:"checked_at"`
	// TotalProjects is the total number of projects checked.
	TotalProjects int `json:"total_projects"`
	// ProjectsWithDrift is the number of projects that have drift.
	ProjectsWithDrift int `json:"projects_with_drift"`
}

type DriftSummary struct {
	// HasDrift indicates whether any drift was detected.
	HasDrift bool `json:"has_drift"`
	// 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 (Terraform 1.5+).
	ToImport int `json:"to_import"`
	// ToForget is the number of resources to forget.
	ToForget int `json:"to_forget"`
	// Summary is a human-readable summary of the drift.
	Summary string `json:"summary"`
	// ChangesOutside indicates if Terraform detected changes made outside of Terraform.
	ChangesOutside bool `json:"changes_outside"`
}

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

type ImportSuccess struct {
	// Output is the output from terraform import
	Output string
	// RePlanCmd is the command that users should run to re-plan this project.
	RePlanCmd string
}

type MergeableStatus struct {
	IsMergeable bool
	// Short human readable explanation of why the PR is (or is not) mergeable
	Reason string
	// BlockingStatuses holds the names of the commit statuses that caused the
	// pull request to be considered not mergeable because of the project's
	// "Only allow merge if pipeline succeeds" setting. It lets per-project
	// command requirement checks ignore statuses that belong to other projects
	// in the same pull request (a failing plan in project B must not block an
	// apply of project A). Currently only populated by the GitLab client.
	BlockingStatuses []string
}

type Plan struct {
	// Project is the project this plan is for.
	Project Project
	// LocalPath is the absolute path to the plan on disk
	// (versus the relative path from the repo root).
	LocalPath string
}

type PlanSuccess struct {
	// TerraformOutput is the output from Terraform of running plan.
	TerraformOutput string
	// LockURL is the full URL to the lock held by this plan.
	LockURL string
	// RePlanCmd is the command that users should run to re-plan this project.
	RePlanCmd string
	// ApplyCmd is the command that users should run to apply this plan.
	ApplyCmd string
	// MergedAgain is true if we're using the checkout merge strategy and the
	// branch we're merging into had been updated, and we had to merge again
	// before planning
	MergedAgain bool
}

type PlanSuccessStats struct {
	Import, Add, Change, Destroy, Forget int
	Changes, ChangesOutside              bool
}

type PolicyCheckResults struct {
	PreConftestOutput  string
	PostConftestOutput string
	// PolicySetResults is the output from policy check binary(conftest|opa)
	PolicySetResults []PolicySetResult
	// LockURL is the full URL to the lock held by this policy check.
	LockURL string
	// RePlanCmd is the command that users should run to re-plan this project.
	RePlanCmd string
	// ApplyCmd is the command that users should run to apply this plan.
	ApplyCmd string
	// ApprovePoliciesCmd is the command that users should run to approve policies for this plan.
	ApprovePoliciesCmd string
	// HasDiverged is true if we're using the checkout merge strategy and the
	// branch we're merging into has been updated since we cloned and merged
	// it.
	HasDiverged bool
}

type PolicySetApproval struct {
	Approver string
	Hashes   []string
}

type PolicySetResult struct {
	PolicySetName    string
	PolicyOutput     string
	Passed           bool
	ReqApprovalCount int
	Approvals        []PolicySetApproval
	Hashes           []string
	PolicyItemRegex  string
}

type PolicySetStatus struct {
	PolicySetName   string
	Passed          bool
	Approvals       []PolicySetApproval
	Hashes          []string
	PolicyItemRegex string
}

type Project struct {
	// ProjectName of the project
	ProjectName string
	// RepoFullName is the owner and repo name, ex. "runatlantis/atlantis"
	RepoFullName string
	// Path to project root in the repo.
	// If "." then project is at root.
	// Never ends in "/".
	// todo: rename to RepoRelDir to match rest of project once we can separate
	// out how this is saved in boltdb vs. its usage everywhere else so we don't
	// break existing dbs.
	Path string
}

type ProjectCounts struct {
	Success   int
	Total     int
	Errored   int
	NoChanges int
}

type ProjectDrift struct {
	// ProjectName is the name of the project (from atlantis.yaml).
	ProjectName string `json:"project_name"`
	// Path is the relative path to the project root within the repository.
	Path string `json:"path"`
	// Workspace is the Terraform workspace.
	Workspace string `json:"workspace"`
	// Ref is the git reference (branch/tag/commit) that was checked.
	Ref string `json:"ref"`
	// BaseBranch is the branch context used for repo config branch filters and
	// requirements when Ref is a tag or commit SHA.
	BaseBranch string `json:"base_branch,omitempty"`
	// ResolvedCommit is the checked-out commit SHA that produced this drift
	// record. Remediation uses it to avoid applying stale drift after a moving ref
	// changes.
	ResolvedCommit string `json:"resolved_commit,omitempty"`
	// DetectionID links this drift result to the detection run that produced it.
	DetectionID string `json:"detection_id,omitempty"`
	// Drift contains the drift summary for this project.
	Drift DriftSummary `json:"drift"`
	// LastChecked is when the drift was last detected.
	LastChecked time.Time `json:"last_checked"`
	// Error contains any error message if drift detection failed for this project.
	Error string `json:"error,omitempty"`
}

type ProjectLock struct {
	// Project is the project that is being locked.
	Project Project
	// Pull is the pull request from which the command was run that
	// created this lock.
	Pull PullRequest
	// User is the username of the user that ran the command
	// that created this lock.
	User User
	// Workspace is the Terraform workspace that this
	// lock is being held against.
	Workspace string
	// Time is the time at which the lock was first created.
	Time time.Time
}

type ProjectPlanStatus int

type ProjectRemediationResult struct {
	// ProjectName is the name of the project.
	ProjectName string `json:"project_name"`
	// Path is the relative path to the project.
	Path string `json:"path"`
	// Workspace is the Terraform workspace.
	Workspace string `json:"workspace"`
	// Status is the remediation status for this project.
	Status RemediationStatus `json:"status"`
	// PlanOutput contains the plan output if available.
	PlanOutput string `json:"plan_output,omitempty"`
	// ApplyOutput contains the apply output if action was auto-apply.
	ApplyOutput string `json:"apply_output,omitempty"`
	// Error contains any error message.
	Error string `json:"error,omitempty"`
	// DriftBefore contains the drift state before remediation.
	DriftBefore *DriftSummary `json:"drift_before,omitempty"`
	// DriftAfter contains the drift state after remediation (nil if not re-checked).
	DriftAfter *DriftSummary `json:"drift_after,omitempty"`
}

type ProjectStatus struct {
	Workspace   string
	RepoRelDir  string
	ProjectName string
	// PolicyStatus tracks the policy check status for each policy set.
	PolicyStatus []PolicySetStatus
	// Status is the status of where this project is at in the planning cycle.
	Status ProjectPlanStatus
}

type PullReqStatus struct {
	ApprovalStatus  ApprovalStatus
	MergeableStatus MergeableStatus
}

type PullRequest struct {
	// Num is the pull request number or ID.
	Num int
	// HeadCommit is a sha256 that points to the head of the branch that is being
	// pull requested into the base. If the pull request is from Bitbucket Cloud
	// the string will only be 12 characters long because Bitbucket Cloud
	// truncates its commit IDs.
	HeadCommit string
	// URL is the url of the pull request.
	// ex. "https://github.com/runatlantis/atlantis/pull/1"
	URL string
	// HeadBranch is the name of the head branch (the branch that is getting
	// merged into the base).
	HeadBranch string
	// BaseBranch is the name of the base branch (the branch that the pull
	// request is getting merged into).
	BaseBranch string
	// HardenedNonPRRefCheckout makes synthetic non-PR API checkouts fetch the
	// requested ref directly instead of treating it as a branch checkout. This is
	// used by drift/remediation requests that accept branch, tag, and SHA refs.
	HardenedNonPRRefCheckout bool
	// Author is the username of the pull request author.
	Author string
	// Body is the description of the pull request. It may be empty when the VCS
	// payload omits a description.
	Body string
	// State will be one of Open or Closed.
	// Gitlab supports an additional "merged" state but Github doesn't so we map
	// merged to Closed.
	State PullRequestState
	// BaseRepo is the repository that the pull request will be merged into.
	BaseRepo Repo
}

type PullRequestEventType int

type PullRequestOptions struct {
	// When DeleteSourceBranchOnMerge flag is set to true VCS deletes the source branch after the PR is merged
	// Applied by GitLab & AzureDevops
	DeleteSourceBranchOnMerge bool
	// MergeMethod specifies the merge method for the VCS
	// Implemented only for Github
	MergeMethod string
}

type PullRequestState int

type PullStatus struct {
	// Projects are the projects that have been modified in this pull request.
	Projects []ProjectStatus
	// Pull is the original pull request model.
	Pull PullRequest
}

type RemediationAction string

type RemediationRequest struct {
	// Repository is the full repository name (owner/repo). Required.
	Repository string `json:"repository"`
	// StorageRepository is the internal VCS-host-qualified repository key used
	// for cached drift lookups. It is populated by the API controller.
	StorageRepository string `json:"-"`
	// Ref is the git reference (branch/tag/commit) to remediate. Required.
	Ref string `json:"ref"`
	// ExecutionRef is the original git reference used for checkout/fetch. It is
	// populated by the API controller so storage can use normalized Ref while git
	// still receives an explicit ref such as refs/heads/main when supplied.
	ExecutionRef string `json:"-"`
	// BaseBranch is required when ref is a raw commit SHA or tag value.
	// It preserves Atlantis repo-config branch filtering and undiverged checks.
	BaseBranch string `json:"base_branch,omitempty"`
	// Type is the VCS provider type (Github/Gitlab). Required.
	Type string `json:"type"`
	// Action specifies plan-only or auto-apply. Defaults to "plan".
	Action RemediationAction `json:"action"`
	// Projects is a list of project names to remediate. If empty, all stored
	// projects matching the request filters are remediated. To restrict to
	// projects that actually have detected drift, set DriftOnly to true.
	Projects []string `json:"projects,omitempty"`
	// Paths is a list of repo-relative directories/workspaces to remediate.
	Paths []DriftDetectionPath `json:"paths,omitempty"`
	// Workspaces filters remediation to specific workspaces. If empty, all workspaces.
	Workspaces []string `json:"workspaces,omitempty"`
	// DriftOnly if true, only remediates projects that have detected drift.
	DriftOnly bool `json:"drift_only"`
}

type RemediationResult struct {
	// ID is a unique identifier for this remediation run.
	ID string `json:"id"`
	// Repository is the full repository name.
	Repository string `json:"repository"`
	// StorageRepository is the internal VCS-host-qualified repository key used
	// to index remediation history. It is omitted from API responses.
	StorageRepository string `json:"-"`
	// Ref is the git reference that was remediated.
	Ref string `json:"ref"`
	// Action is the remediation action performed.
	Action RemediationAction `json:"action"`
	// Status is the overall remediation status.
	Status RemediationStatus `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"`
	// TotalProjects is the total number of projects targeted.
	TotalProjects int `json:"total_projects"`
	// SuccessCount is the number of projects successfully remediated.
	SuccessCount int `json:"success_count"`
	// FailureCount is the number of projects that failed remediation.
	FailureCount int `json:"failure_count"`
	// Projects contains the remediation result for each project.
	Projects []ProjectRemediationResult `json:"projects"`
	// Error contains any top-level error message.
	Error string `json:"error,omitempty"`
}

type RemediationStatus string

type Repo struct {
	// FullName is the owner and repo name separated
	// by a "/", ex. "runatlantis/atlantis", "gitlab/subgroup/atlantis",
	// "Bitbucket Server/atlantis", "azuredevops/project/atlantis".
	FullName string
	// Owner is just the repo owner, ex. "runatlantis" or "gitlab/subgroup"
	// or azuredevops/project. This may contain /'s in the case of GitLab
	// subgroups or Azure DevOps Team Projects. This may contain spaces in
	// the case of Bitbucket Server.
	Owner string
	// Name is just the repo name, ex. "atlantis". This will never have
	// /'s in it.
	Name string
	// CloneURL is the full HTTPS url for cloning with username and token string
	// ex. "https://username:token@github.com/atlantis/atlantis.git".
	CloneURL string
	// SanitizedCloneURL is the full HTTPS url for cloning with the password
	// redacted.
	// ex. "https://user:<redacted>@github.com/atlantis/atlantis.git".
	SanitizedCloneURL string
	// VCSHost is where this repo is hosted.
	VCSHost VCSHost
}

type StateRmSuccess struct {
	// Output is the output from terraform state rm
	Output string
	// RePlanCmd is the command that users should run to re-plan this project.
	RePlanCmd string
}

type TeamAllowlistCheckerContext struct {
	// BaseRepo is the repository that the pull request will be merged into.
	BaseRepo Repo

	// The name of the command that is being executed, i.e. 'plan', 'apply' etc.
	CommandName string

	// EscapedCommentArgs are the extra arguments that were added to the atlantis
	// command, ex. atlantis plan -- -target=resource. We then escape them
	// by adding a \ before each character so that they can be used within
	// sh -c safely, i.e. sh -c "terraform plan $(touch bad)".
	EscapedCommentArgs []string

	// HeadRepo is the repository that is getting merged into the BaseRepo.
	// If the pull request branch is from the same repository then HeadRepo will
	// be the same as BaseRepo.
	HeadRepo Repo

	// Log is a logger that's been set up for this context.
	Log logging.SimpleLogging

	// Pull is the pull request we're responding to.
	Pull PullRequest

	// ProjectName is the name of the project set in atlantis.yaml. If there was
	// no name this will be an empty string.
	ProjectName string

	// RepoDir is the absolute path to the repo root
	RepoDir string

	// RepoRelDir is the directory of this project relative to the repo root.
	RepoRelDir string

	// User is the user that triggered this command.
	User User

	// Verbose is true when the user would like verbose output.
	Verbose bool

	// Workspace is the Terraform workspace this project is in. It will always
	// be set.
	Workspace string

	// API is true if plan/apply by API endpoints
	API bool
}

type User struct {
	Username string
	Teams    []string
}

type VCSHost struct {
	// Hostname is the hostname of the VCS provider, ex. "github.com" or
	// "github-enterprise.example.com".
	Hostname string

	// Type is which type of VCS host this is, ex. GitHub or GitLab.
	Type VCSHostType
}

type VCSHostType int

type VersionSuccess struct {
	VersionOutput string
}

type WorkflowHookCommandContext struct {
	// BaseRepo is the repository that the pull request will be merged into.
	BaseRepo Repo
	// The name of the command that is being executed, i.e. 'plan', 'apply' etc.
	CommandName string
	// Set true if there were any errors during the command execution
	CommandHasErrors bool
	// EscapedCommentArgs are the extra arguments that were added to the atlantis
	// command, ex. atlantis plan -- -target=resource. We then escape them
	// by adding a \ before each character so that they can be used within
	// sh -c safely, i.e. sh -c "terraform plan $(touch bad)".
	EscapedCommentArgs []string
	// HeadRepo is the repository that is getting merged into the BaseRepo.
	// If the pull request branch is from the same repository then HeadRepo will
	// be the same as BaseRepo.
	HeadRepo Repo
	// HookDescription is a description of the hook that is being executed.
	HookDescription string
	// UUID for reference
	HookID string
	// HookStepName is the name of the step that is being executed.
	HookStepName string
	// Log is a logger that's been set up for this context.
	Log logging.SimpleLogging
	// Pull is the pull request we're responding to.
	Pull PullRequest
	// ProjectName is the name of the project set in atlantis.yaml. If there was
	// no name this will be an empty string.
	ProjectName string
	// SuppressJobOutput prevents hook output from being published to the public
	// job stream for API workflows such as drift detection.
	SuppressJobOutput bool
	// RepoRelDir is the directory of this project relative to the repo root.
	RepoRelDir string
	// User is the user that triggered this command.
	User User
	// Verbose is true when the user would like verbose output.
	Verbose bool
	// Workspace is the Terraform workspace this project is in. It will always
	// be set.
	Workspace string
	// API is true if plan/apply by API endpoints
	API bool
}