providers

type APIKeysAuthenticator interface {
	// Match matches a given user's api keys with the stored ones.
	Match(ctx context.Context, key *models.APIKey) error
	// Encrypt takes an api key secret and encrypts it for storage.
	Encrypt(ctx context.Context, secret []byte) ([]byte, error)
	// Generate a secret and a key ID pair. Returns the secret unencrypted for showing,
	// but does save it encrypted.
	Generate(ctx context.Context, name string, userID int) (*models.APIKey, error)
}

type APIKeysHandler interface {
	Create() echo.HandlerFunc
	Delete() echo.HandlerFunc
	Get() echo.HandlerFunc
	List() echo.HandlerFunc
}

type APIKeysStorer interface {
	// Create an apikey.
	Create(ctx context.Context, key *models.APIKey) (*models.APIKey, error)
	// Delete an apikey.
	Delete(ctx context.Context, id int, userID int) error
	// List will list all apikeys for a user.
	List(ctx context.Context, userID int) ([]*models.APIKey, error)
	// Get an apikey.
	Get(ctx context.Context, id int, userID int) (*models.APIKey, error)
	// GetByAPIKeyID an apikey by apikeyid.
	GetByAPIKeyID(ctx context.Context, id string) (*models.APIKey, error)
}

type AuthHandler interface {
	OAuthLogin() echo.HandlerFunc
	OAuthCallback() echo.HandlerFunc
	Refresh() echo.HandlerFunc
}

type Clock interface {
	Now() time.Time
}

type CommandHandler interface {
	Create() echo.HandlerFunc
	Delete() echo.HandlerFunc
	Get() echo.HandlerFunc
	List() echo.HandlerFunc
	Update() echo.HandlerFunc

	// AddCommandRelForRepository adds an entry for this command id to the given repositoryID.
	AddCommandRelForRepository() echo.HandlerFunc
	// RemoveCommandRelForRepository remove a relation to a repository for a command.
	RemoveCommandRelForRepository() echo.HandlerFunc

	// AddCommandRelForPlatform adds an entry for this command id to the given platform id.
	AddCommandRelForPlatform() echo.HandlerFunc
	// RemoveCommandRelForPlatform remove a relation to a platform for a command.
	RemoveCommandRelForPlatform() echo.HandlerFunc
}

type CommandRunHandler interface {
	GetCommandRun() echo.HandlerFunc
}

type CommandRunStorer interface {
	CreateRun(ctx context.Context, run *models.CommandRun) (*models.CommandRun, error)
	UpdateRunStatus(ctx context.Context, id int, status string, outcome string) error
	Get(ctx context.Context, id int) (*models.CommandRun, error)
}

type CommandSettingsHandler interface {
	Create() echo.HandlerFunc
	Delete() echo.HandlerFunc
	Get() echo.HandlerFunc
	List() echo.HandlerFunc
	Update() echo.HandlerFunc
}

type CommandStorer interface {
	Create(ctx context.Context, c *models.Command) (*models.Command, error)
	Get(ctx context.Context, id int) (*models.Command, error)
	GetByName(ctx context.Context, name string) (*models.Command, error)
	Delete(ctx context.Context, id int) error
	Update(ctx context.Context, c *models.Command) (*models.Command, error)
	List(ctx context.Context, opts *models.ListOptions) ([]*models.Command, error)

	// AddCommandRelForRepository adds an entry for this command id to the given repositoryID.
	AddCommandRelForRepository(ctx context.Context, commandID int, repositoryID int) error
	// RemoveCommandRelForRepository remove a relation to a repository for a command.
	RemoveCommandRelForRepository(ctx context.Context, commandID int, repositoryID int) error

	CreateSetting(ctx context.Context, settings *models.CommandSetting) (*models.CommandSetting, error)
	DeleteSetting(ctx context.Context, id int) error
	ListSettings(ctx context.Context, commandID int) ([]*models.CommandSetting, error)
	GetSetting(ctx context.Context, id int) (*models.CommandSetting, error)
	UpdateSetting(ctx context.Context, setting *models.CommandSetting) error

	// AddCommandRelForPlatform adds a relationship for a platform on a command. This means
	// that this command will support this platform. If the relationship doesn't exist
	// this command will not run on that platform.
	AddCommandRelForPlatform(ctx context.Context, commandID int, platformID int) error
	// RemoveCommandRelForPlatform removes the above relationship, disabling this command
	// for that platform. Meaning this command will not be executed if that platform is
	// detected.
	RemoveCommandRelForPlatform(ctx context.Context, commandID int, platformID int) error
	// IsPlatformSupported returns if a command supports a platform or not.
	IsPlatformSupported(ctx context.Context, commandID, platformID int) (bool, error)
}

type Email interface {
	Notify(email string, event Event, payload Payload) error
}

type EnvironmentConverter interface {
	// LoadValueFromFile provides the ability to load a secret from a docker
	// mounted secret file if the value contains `/run/secret`.
	LoadValueFromFile(f string) (string, error)
}

type Event string

type EventHandler interface {
	List() echo.HandlerFunc
	Get() echo.HandlerFunc
}

type EventsStorer interface {
	Create(ctx context.Context, event *models.Event) (*models.Event, error)
	ListEventsForRepository(ctx context.Context, repoID int, options *models.ListOptions) ([]*models.Event, error)
	GetEvent(ctx context.Context, eventID int) (*models.Event, error)
}

type Executor interface {
	// CreateRun creates a run for an event.
	// The created run will have to be saved somehow. This is up to the implementation.
	// It MUST use the Event's ID as identification because that's what defines/holds
	// the currently running commands. The loose coupling between a run and the commands
	// is the event. So to cancel a Run, the user will provide the Event's ID.
	CreateRun(ctx context.Context, event *models.Event, commands []*models.Command) error
	// CancelRun will cancel a run and mark all commands as cancelled.
	// The ID here is the ID of the event corresponding to this run.
	CancelRun(ctx context.Context, id int) error
}

type Generator struct{}

type HookHandler interface {
	// HandleHooks handles all hooks incoming to Krok.
	HandleHooks() echo.HandlerFunc
}

type Hooks interface {
	// Execute will be called for the command which can be executed.
	// opts is a variable number of arguments which can be given to a hook.
	// exp.: Environment properties, auth information, tokens, etc.
	Execute(ctx context.Context, raw string, opts ...interface{}) (string, bool, error)
}

type KrokClock struct{}

type OAuthAuthenticator interface {
	GetAuthCodeURL(state string) string
	Exchange(ctx context.Context, code string) (*oauth2.Token, error)
	GenerateState(redirectURL string) (string, error)
	VerifyState(rawToken string) (string, error)
}

type Payload string

type Platform interface {
	// CreateHook creates a hook for the respective platform.
	// Events define the events this hook subscribes to. Since we don't want all hooks
	// to subscribe to all events all the time, we provide the option to the user
	// to select the events.
	CreateHook(ctx context.Context, repo *models.Repository) error
	// ValidateRequest will take a hook and verify it being a valid hook request according to
	// platform rules.
	ValidateRequest(ctx context.Context, r *http.Request, repoID int) error
	// GetEventID Based on the platform, retrieve the ID of the event.
	GetEventID(ctx context.Context, r *http.Request) (string, error)
	// GetEventType Based on the platform, retrieve the Type of the event.
	GetEventType(ctx context.Context, r *http.Request) (string, error)
}

type PlatformTokenProvider interface {
	GetTokenForPlatform(vcs int) (string, error)
	SaveTokenForPlatform(token string, vcs int) error
}

type Ready interface {
	Ready(ctx context.Context) bool
}

type ReadyHandler interface {
	Ready() echo.HandlerFunc
}

type RepositoryAuth interface {
	// GetRepositoryAuth returns auth data for a repository.
	GetRepositoryAuth(ctx context.Context, id int) (*models.Auth, error)
	// CreateRepositoryAuth creates auth data for a repository in vault.
	CreateRepositoryAuth(ctx context.Context, repositoryID int, info *models.Auth) error
}

type RepositoryHandler interface {
	Create() echo.HandlerFunc
	Delete() echo.HandlerFunc
	Get() echo.HandlerFunc
	List() echo.HandlerFunc
	Update() echo.HandlerFunc
}

type RepositoryStorer interface {
	Create(ctx context.Context, c *models.Repository) (*models.Repository, error)
	Get(ctx context.Context, id int) (*models.Repository, error)
	GetByName(ctx context.Context, name string) (*models.Repository, error)
	Delete(ctx context.Context, id int) error
	Update(ctx context.Context, c *models.Repository) (*models.Repository, error)
	List(ctx context.Context, opt *models.ListOptions) ([]*models.Repository, error)
}

type SupportedPlatformListHandler interface {
	ListSupportedPlatforms() echo.HandlerFunc
}

type TokenHandler interface {
	TokenHandler() echo.HandlerFunc
}

type TokenIssuer interface {
	Create(token *models.User) (*oauth2.Token, error)
	Refresh(ctx context.Context, refreshToken string) (*oauth2.Token, error)
}

type UUIDGenerator interface {
	Generate() (string, error)
}

type UserHandler interface {
	GetUser() echo.HandlerFunc
	ListUsers() echo.HandlerFunc
	DeleteUser() echo.HandlerFunc
	UpdateUser() echo.HandlerFunc
	CreateUser() echo.HandlerFunc
}

type UserMiddleware interface {
	JWT() echo.MiddlewareFunc
}

type UserStorer interface {
	Create(ctx context.Context, c *models.User) (*models.User, error)
	Delete(ctx context.Context, id int) error
	List(ctx context.Context) ([]*models.User, error)
	Get(ctx context.Context, id int) (*models.User, error)
	GetByEmail(ctx context.Context, email string) (*models.User, error)
	Update(ctx context.Context, user *models.User) (*models.User, error)
}

type VCSTokenHandler interface {
	Create() echo.HandlerFunc
}

type Vault interface {
	// LoadSecrets unlocks the vault and loads in all secrets.
	LoadSecrets() error
	// ListSecrets lists all secret names. Not the values.
	ListSecrets() []string
	// SaveSecrets saves all the secrets to the vault. Persisting new values.
	SaveSecrets() error
	// AddSecret adds a value to the vault.
	AddSecret(key string, value []byte)
	// DeleteSecret deletes a secret from the vault.
	DeleteSecret(key string)
	// GetSecret returns a single secret's value from the vault.
	GetSecret(key string) ([]byte, error)
}

type VaultHandler interface {
	GetSecret() echo.HandlerFunc
	ListSecrets() echo.HandlerFunc
	DeleteSecret() echo.HandlerFunc
	UpdateSecret() echo.HandlerFunc
	CreateSecret() echo.HandlerFunc
}

type VaultStorer interface {
	// Init initializes the medium by creating the file, or bootstrapping the
	// db or simply setting up an in-memory mock storage device. The Init
	// function of a storage medium should be idempotent. Meaning it should
	// be callable multiple times without changing the underlying medium.
	Init() error
	// Read will read bytes from the storage medium and return it to the caller.
	Read() (data []byte, err error)
	// Write will store the passed in data. How, is up to the implementor. Syncing
	// is up the caller. Otherwise data will be overwritten.
	Write(data []byte) error
}