domain

type CleanupContext struct {
	Repository *GitRepository
	ValueStore ValueStore
	// contains filtered or unexported fields
}

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

type CleanupServiceInstrumentation interface {
	// FetchedFilesToDelete logs a message indicating that fetching file paths to delete from ValueStore was successful but only if fetchErr is nil.
	// Returns fetchErr unmodified for method chaining.
	FetchedFilesToDelete(fetchErr error, files []Path) error
	// DeletedFile logs a message indicating that deleting file occurred.
	DeletedFile(file Path)
	// WithRepository returns an instance that has the given repository as scope.
	WithRepository(repository *GitRepository) CleanupServiceInstrumentation
}

type Color string

type CommitOptions struct {
	// Message contains the commit message.
	Message string
	// Amend will edit the last commit instead of creating a new one.
	Amend bool
}

type GitRepository struct {
	// RootDir is the full path to the Git root directory in the local filesystem.
	RootDir Path
	// URL is the remote URL of origin.
	URL *GitURL
	// PullRequest is the associated PullRequest for this repository in the remote Git hosting service.
	PullRequest *PullRequest
	// Labels contains the LabelSet that is present in the remote Git hosting service.
	Labels LabelSet

	// CommitBranch in the branch name of the current branch the working tree is in.
	CommitBranch string
	// DefaultBranch is the branch name of the remote default branch (usually `master` or `main`).
	DefaultBranch string
}

type GitRepositoryStore interface {
	// FetchGitRepositories loads a list of GitRepository from a configuration set.
	// Returns an empty list on first error.
	FetchGitRepositories() ([]*GitRepository, error)

	// Clone will download the given GitRepository to local filesystem.
	// The location is specified in GitRepository.RootDir.
	Clone(repository *GitRepository) error
	// Checkout checks out the GitRepository.CommitBranch.
	Checkout(repository *GitRepository) error
	// Fetch retrieves the objects and refs from remote.
	Fetch(repository *GitRepository) error
	// Reset current HEAD to GitRepository.CommitBranch.
	Reset(repository *GitRepository) error
	// Pull integrates objects from remote.
	Pull(repository *GitRepository) error

	// Add stages all files in GitRepository.RootDir.
	Add(repository *GitRepository) error
	// Commit records changes in the repository.
	Commit(repository *GitRepository, options CommitOptions) error
	// Diff returns a `patch`-compatible diff between HEAD and previous commit as string.
	// The diff may be empty.
	Diff(repository *GitRepository) (string, error)

	// Push updates remote refs.
	Push(repository *GitRepository, options PushOptions) error
}

type GitURL url.URL

type Label struct {
	// Name is the label name
	Name string
	// Description adds additional details to the label.
	Description string
	// contains filtered or unexported fields
}

type LabelSet []Label

type LabelStore interface {
	// FetchLabelsForRepository retrieves a LabelSet for the given repository.
	FetchLabelsForRepository(repository *GitRepository) (LabelSet, error)
	// EnsureLabelsForRepository creates or updates the given LabelSet in the given repository.
	// Labels that exist remotely, but not in the given LabelSet are ignored.
	// Remote labels have to be updated when Label.GetColor or Label.Description are not matching.
	//
	// Renaming labels are currently not supported.
	EnsureLabelsForRepository(repository *GitRepository, labels LabelSet) error
	// RemoveLabelsFromRepository remotely removes all labels in the given LabelSet.
	// Only the Label.Name is relevant to determine label equality.
	RemoveLabelsFromRepository(repository *GitRepository, labels LabelSet) error
}

type Path string

type Permissions fs.FileMode

type PullRequest struct {

	// CommitBranch is the branch name of the current working tree.
	CommitBranch string
	// BaseBranch is the branch name into which CommitBranch should be merged into.
	BaseBranch string
	// contains filtered or unexported fields
}

type PullRequestNumber int

type PullRequestService struct {
}

type PullRequestServiceContext struct {
	Repository     *GitRepository
	TemplateEngine TemplateEngine
	Body           string
	Title          string
	TargetBranch   string
	Labels         LabelSet
}

type PullRequestStore interface {
	// FindMatchingPullRequest returns the PullRequest that has the same branch as GitRepository.CommitBranch.
	// If not found, it returns nil without error.
	FindMatchingPullRequest(repository *GitRepository) (*PullRequest, error)

	// EnsurePullRequest creates or updates the GitRepository.PullRequest in the repository.
	//
	//  * This operation does not alter any properties of existing labels.
	//  * Existing labels are left untouched, but any extraneous labels are removed.
	//  * Title and Body are updated.
	//  * Existing Commit and Base branches are left untouched.
	//
	// The first error encountered aborts the operation.
	EnsurePullRequest(repository *GitRepository) error
}

type PushOptions struct {
	// Force overwrites the remote state when pushing.
	Force bool
}

type RenderContext struct {
	Repository    *GitRepository
	ValueStore    ValueStore
	TemplateStore TemplateStore
	Engine        TemplateEngine
	// contains filtered or unexported fields
}

type RenderResult string

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

type RenderServiceInstrumentation interface {
	// FetchedTemplatesFromStore logs a message indicating that fetching templates from TemplateStore was successful, but only if fetchErr is nil.
	// Returns fetchErr unmodified for method chaining.
	FetchedTemplatesFromStore(fetchErr error) error
	// FetchedValuesForTemplate logs a message indicating that fetching Values from ValueStore was successful but only if fetchErr is nil.
	// Returns fetchErr unmodified for method chaining.
	FetchedValuesForTemplate(fetchErr error, template *Template) error
	// AttemptingToRenderTemplate logs a message indicating that the actual rendering is about to begin.
	AttemptingToRenderTemplate(template *Template)
	WrittenRenderResultToFile(template *Template, targetPath Path, writeErr error) error
	// WithRepository creates a new RenderServiceInstrumentation instance using the given GitRepository as context.
	WithRepository(repository *GitRepository) RenderServiceInstrumentation
}

type Template struct {
	// RelativePath is the Path reference to where the template file is contained within the template root directory.
	RelativePath Path
	// FilePermissions defines what file permissions this template file has.
	// Rendered files should have the same permissions as template files.
	FilePermissions Permissions
}

type TemplateEngine interface {
	// Execute renders the given Template with the given Values.
	Execute(template *Template, values Values) (RenderResult, error)

	// ExecuteString renders the given template string with the given Values.
	ExecuteString(template string, values Values) (RenderResult, error)
}

type TemplateStore interface {
	// FetchTemplates lists all templates.
	// It aborts on first error.
	FetchTemplates() ([]*Template, error)
}

type ValueStore interface {
	// FetchValuesForTemplate retrieves the Values for the given template.
	FetchValuesForTemplate(template *Template, repository *GitRepository) (Values, error)
	// FetchUnmanagedFlag returns true if the given template should not be rendered.
	// The implementation may return ErrKeyNotFound if the flag is undefined, as the boolean 'false' is ambiguous.
	FetchUnmanagedFlag(template *Template, repository *GitRepository) (bool, error)
	// FetchTargetPath returns an alternative output path for the given template relative to the Git repository.
	// An empty string indicates that there is no alternative path configured.
	FetchTargetPath(template *Template, repository *GitRepository) (Path, error)
	// FetchFilesToDelete returns a slice of Path that should be deleted in the Git repository.
	// The paths are relative to the Git root directory.
	FetchFilesToDelete(repository *GitRepository) ([]Path, error)
}

type Values map[string]interface{}