planstore

type LocalPlanStore struct {
	// SeparatePlanDir is the plan store directory when it is configured to be
	// distinct from the data dir. Plans written there outlive the checkout, so
	// a working dir lost to a restart can still be recovered without an
	// external store. Empty means plans live inside the checkout and die with
	// it, which leaves nothing to recover from.
	SeparatePlanDir string
}

type PlanStore interface {
	// Save persists a plan file after terraform writes it to planPath.
	Save(ctx command.ProjectContext, planPath string) error
	// Load ensures a plan file exists at planPath before terraform reads it.
	Load(ctx command.ProjectContext, planPath string) error
	// Remove deletes a plan file (local + external) after apply/import/state-rm.
	Remove(ctx command.ProjectContext, planPath string) error
	// ListWorkspaces returns the distinct workspace names that have stored
	// plans for the given pull request. Used by the "apply all" path so that
	// every workspace can be cloned before RestorePlans writes plans into it
	// (Clone falls through to forceClone which os.RemoveAll's the target dir,
	// wiping any restored plan files). Implementations that don't support
	// restore should return (nil, nil).
	ListWorkspaces(owner, repo string, pullNum int) ([]string, error)
	// RestorePlans discovers and downloads all plans for a pull request into
	// pullDir. Only used by the "apply all" path (buildAllProjectCommandsByPlan)
	// where the set of planned projects is unknown. Targeted apply does not
	// call this; DefaultProjectCommandRunner.doApply calls Load before plan
	// validation so the local .tfplan exists after a re-clone.
	// Callers must ensure each workspace directory is cloned (has a .git) before
	// invoking this; see ListWorkspaces.
	//
	// Capability probe: callers may invoke this with an empty pullDir to detect
	// whether the implementation supports restore at all. Implementations that
	// don't support restore MUST return ErrRestoreNotSupported. Implementations
	// that do support restore MUST treat empty pullDir as a no-op (return nil).
	RestorePlans(pullDir, owner, repo string, pullNum int) error
	// DeleteForPull removes all stored plan files for a pull request.
	// Called during PR close/merge cleanup.
	DeleteForPull(owner, repo string, pullNum int) error
	// DeletePlanForProject removes a specific project's plan from external storage.
	// Called when a single lock is deleted via the UI or API.
	DeletePlanForProject(owner, repo string, pullNum int, workspace, repoRelDir, projectName string) error
}

type S3Client interface {
	HeadBucket(ctx context.Context, params *s3.HeadBucketInput, optFns ...func(*s3.Options)) (*s3.HeadBucketOutput, error)
	PutObject(ctx context.Context, params *s3.PutObjectInput, optFns ...func(*s3.Options)) (*s3.PutObjectOutput, error)
	GetObject(ctx context.Context, params *s3.GetObjectInput, optFns ...func(*s3.Options)) (*s3.GetObjectOutput, error)
	DeleteObject(ctx context.Context, params *s3.DeleteObjectInput, optFns ...func(*s3.Options)) (*s3.DeleteObjectOutput, error)
	ListObjectsV2(ctx context.Context, params *s3.ListObjectsV2Input, optFns ...func(*s3.Options)) (*s3.ListObjectsV2Output, error)
}

type S3PlanStore struct {
	// contains filtered or unexported fields
}

type S3PlanStoreConfig struct {
	Bucket         string
	Region         string
	Prefix         string
	Endpoint       string
	ForcePathStyle bool
	Profile        string
}