woodpecker/server/store/store.go
2024-07-14 01:46:01 +02:00

206 lines
7.7 KiB
Go

// Copyright 2018 Drone.IO Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package store
//go:generate mockery --name Store --output mocks --case underscore --note "+build test"
import (
"context"
"go.woodpecker-ci.org/woodpecker/v2/server/model"
)
// TODO: CreateX func should return new object to not indirect let storage change an existing object (alter ID etc...)
type Store interface {
// Users
// GetUser gets a user by unique ID.
GetUser(int64) (*model.User, error)
// GetUserRemoteID gets a user by remote ID with fallback to login name.
GetUserRemoteID(model.ForgeRemoteID, string) (*model.User, error)
// GetUserLogin gets a user by unique Login name.
GetUserLogin(string) (*model.User, error)
// GetUserList gets a list of all users in the system.
GetUserList(p *model.ListOptions) ([]*model.User, error)
// GetUserCount gets a count of all users in the system.
GetUserCount() (int64, error)
// CreateUser creates a new user account.
CreateUser(*model.User) error
// UpdateUser updates a user account.
UpdateUser(*model.User) error
// DeleteUser deletes a user account.
DeleteUser(*model.User) error
// Repos
// GetRepo gets a repo by unique ID.
GetRepo(int64) (*model.Repo, error)
// GetRepoForgeID gets a repo by its forge ID.
GetRepoForgeID(model.ForgeRemoteID) (*model.Repo, error)
// GetRepoNameFallback gets the repo by its forge ID and if this doesn't exist by its full name.
GetRepoNameFallback(remoteID model.ForgeRemoteID, fullName string) (*model.Repo, error)
// GetRepoName gets a repo by its full name.
GetRepoName(string) (*model.Repo, error)
// GetRepoCount gets a count of all repositories in the system.
GetRepoCount() (int64, error)
// CreateRepo creates a new repository.
CreateRepo(*model.Repo) error
// UpdateRepo updates a user repository.
UpdateRepo(*model.Repo) error
// DeleteRepo deletes a user repository.
DeleteRepo(*model.Repo) error
// Redirections
// CreateRedirection creates a redirection
CreateRedirection(redirection *model.Redirection) error
// HasRedirectionForRepo checks if there's a redirection for the given repo and full name
HasRedirectionForRepo(int64, string) (bool, error)
// Pipelines
// GetPipeline gets a pipeline by unique ID.
GetPipeline(int64) (*model.Pipeline, error)
// GetPipelineNumber gets a pipeline by number.
GetPipelineNumber(*model.Repo, int64) (*model.Pipeline, error)
// GetPipelineLast gets the last pipeline for the branch.
GetPipelineLast(*model.Repo, string) (*model.Pipeline, error)
// GetPipelineLastBefore gets the last pipeline before pipeline number N.
GetPipelineLastBefore(*model.Repo, string, int64) (*model.Pipeline, error)
// GetPipelineList gets a list of pipelines for the repository
GetPipelineList(*model.Repo, *model.ListOptions, *model.PipelineFilter) ([]*model.Pipeline, error)
// GetActivePipelineList gets a list of the active pipelines for the repository
GetActivePipelineList(repo *model.Repo) ([]*model.Pipeline, error)
// GetPipelineQueue gets a list of pipelines in queue.
GetPipelineQueue() ([]*model.Feed, error)
// GetPipelineCount gets a count of all pipelines in the system.
GetPipelineCount() (int64, error)
// CreatePipeline creates a new pipeline and steps.
CreatePipeline(*model.Pipeline, ...*model.Step) error
// UpdatePipeline updates a pipeline.
UpdatePipeline(*model.Pipeline) error
// DeletePipeline deletes a pipeline.
DeletePipeline(*model.Pipeline) error
// Feeds
UserFeed(*model.User) ([]*model.Feed, error)
// Repositories
RepoList(user *model.User, owned, active bool) ([]*model.Repo, error)
RepoListLatest(*model.User) ([]*model.Feed, error)
RepoListAll(active bool, p *model.ListOptions) ([]*model.Repo, error)
// Permissions
PermFind(user *model.User, repo *model.Repo) (*model.Perm, error)
PermUpsert(perm *model.Perm) error
// Configs
ConfigsForPipeline(pipelineID int64) ([]*model.Config, error)
ConfigPersist(*model.Config) (*model.Config, error)
PipelineConfigCreate(*model.PipelineConfig) error
// Secrets
SecretFind(*model.Repo, string) (*model.Secret, error)
SecretList(*model.Repo, bool, *model.ListOptions) ([]*model.Secret, error)
SecretListAll() ([]*model.Secret, error)
SecretCreate(*model.Secret) error
SecretUpdate(*model.Secret) error
SecretDelete(*model.Secret) error
OrgSecretFind(int64, string) (*model.Secret, error)
OrgSecretList(int64, *model.ListOptions) ([]*model.Secret, error)
GlobalSecretFind(string) (*model.Secret, error)
GlobalSecretList(*model.ListOptions) ([]*model.Secret, error)
// Registries
RegistryFind(*model.Repo, string) (*model.Registry, error)
RegistryList(*model.Repo, bool, *model.ListOptions) ([]*model.Registry, error)
RegistryListAll() ([]*model.Registry, error)
RegistryCreate(*model.Registry) error
RegistryUpdate(*model.Registry) error
RegistryDelete(*model.Registry) error
OrgRegistryFind(int64, string) (*model.Registry, error)
OrgRegistryList(int64, *model.ListOptions) ([]*model.Registry, error)
GlobalRegistryFind(string) (*model.Registry, error)
GlobalRegistryList(*model.ListOptions) ([]*model.Registry, error)
// Steps
StepLoad(int64) (*model.Step, error)
StepFind(*model.Pipeline, int) (*model.Step, error)
StepByUUID(string) (*model.Step, error)
StepChild(*model.Pipeline, int, string) (*model.Step, error)
StepList(*model.Pipeline) ([]*model.Step, error)
StepUpdate(*model.Step) error
StepListFromWorkflowFind(*model.Workflow) ([]*model.Step, error)
// Logs
LogFind(*model.Step) ([]*model.LogEntry, error)
LogAppend(logEntry *model.LogEntry) error
LogDelete(*model.Step) error
// Tasks
// TaskList TODO: paginate & opt filter
TaskList() ([]*model.Task, error)
TaskInsert(*model.Task) error
TaskDelete(string) error
// ServerConfig
ServerConfigGet(string) (string, error)
ServerConfigSet(string, string) error
ServerConfigDelete(string) error
// Cron
CronCreate(*model.Cron) error
CronFind(*model.Repo, int64) (*model.Cron, error)
CronList(*model.Repo, *model.ListOptions) ([]*model.Cron, error)
CronUpdate(*model.Repo, *model.Cron) error
CronDelete(*model.Repo, int64) error
CronListNextExecute(int64, int64) ([]*model.Cron, error)
CronGetLock(*model.Cron, int64) (bool, error)
// Forge
ForgeCreate(*model.Forge) error
ForgeGet(int64) (*model.Forge, error)
ForgeList(p *model.ListOptions) ([]*model.Forge, error)
ForgeUpdate(*model.Forge) error
ForgeDelete(*model.Forge) error
// Agent
AgentCreate(*model.Agent) error
AgentFind(int64) (*model.Agent, error)
AgentFindByToken(string) (*model.Agent, error)
AgentList(p *model.ListOptions) ([]*model.Agent, error)
AgentUpdate(*model.Agent) error
AgentDelete(*model.Agent) error
// Workflow
WorkflowGetTree(*model.Pipeline) ([]*model.Workflow, error)
WorkflowsCreate([]*model.Workflow) error
WorkflowsReplace(*model.Pipeline, []*model.Workflow) error
WorkflowLoad(int64) (*model.Workflow, error)
WorkflowUpdate(*model.Workflow) error
// Org
OrgCreate(*model.Org) error
OrgGet(int64) (*model.Org, error)
OrgFindByName(string) (*model.Org, error)
OrgUpdate(*model.Org) error
OrgDelete(int64) error
OrgList(*model.ListOptions) ([]*model.Org, error)
// Org repos
OrgRepoList(*model.Org, *model.ListOptions) ([]*model.Repo, error)
// Store operations
Ping() error
Close() error
Migrate(context.Context, bool) error
}