manager

type CommitFile struct {
	FileName string
	Content  string
	Delete   bool
}

type Credentials struct {
	Token string
}

type EnsureProjectAccessTokenOptions struct {
	// UID is a unique identifier for the token.
	// If set, the given UID will be compared with the UID of the existing token.
	// The token will be force updated if the UIDs do not match.
	UID *string
}

type EnvVar struct {
	Name  string
	Value string

	GitlabOptions EnvVarGitlabOptions
}

type EnvVarGitlabOptions struct {
	Description *string
	Protected   *bool
	Masked      *bool
	Raw         *bool
}

type Implementation interface {
	// IsType returns true, if the given URL is handleable by the given implementation (Github,Gitlab, etc.)
	IsType(URL *url.URL) (bool, error)
	// New returns a clean new Repo implementation with the given URL
	New(options RepoOptions) (Repo, error)
}

type ProjectAccessToken struct {
	UID       string
	Token     string
	ExpiresAt time.Time
}

type Repo interface {
	// Type returns the type of the repo
	Type() string
	// FullURL returns the full url to the repository for ssh pulling
	FullURL() *url.URL
	Create() error
	// Update will enforce the defined keys to be deployed to the repository, it will return true if an actual change
	// happened
	Update() (bool, error)
	// Read will read the repository and populate it with the deployed keys.
	// Implementations MUST return ErrRepoNotFound if the repository does not exist.
	Read() error
	// Remove will remove the git project according to the recycle policy
	Remove() error
	Connect() error
	// CommitTemplateFiles uploads given files to the repository.
	// files that contain exactly the deletion magic string should be removed
	// when calling this function. TODO: will be replaced with something better in the future.
	CommitTemplateFiles() error
	// EnsureProjectAccessToken will ensure that the project access token is set in the repository.
	// If the token is expired or not set, a new token will be created.
	// Depending on the implementation the token name might be used as a prefix.
	EnsureProjectAccessToken(ctx context.Context, name string, opts EnsureProjectAccessTokenOptions) (ProjectAccessToken, error)
	// EnsureCIVariables will ensure that the given variables are set in the CI/CD pipeline.
	// The managedVariables is used to identify the variables that are managed by the operator.
	// Variables that are not managed by the operator will be ignored.
	// Variables that are managed but not in variables will be deleted.
	EnsureCIVariables(ctx context.Context, managedVariables []string, variables []EnvVar) error
}

type RepoOptions struct {
	Credentials    Credentials
	DeployKeys     map[string]synv1alpha1.DeployKey
	Logger         logr.Logger
	URL            *url.URL
	Path           string
	RepoName       string
	DisplayName    string
	TemplateFiles  map[string]string
	DeletionPolicy synv1alpha1.DeletionPolicy

	// Clock is used to get the current time. It is used to mock the time in tests.
	// If not set, time.Now() will be used.
	Clock interface {
		Now() time.Time
	}
}