scm

Documentation

Index

• Constants
• func PushInitRepo(client ClientOperation, commitInfo *git.CommitInfo) error
• type ClientOperation
  • func NewClient(repoInfo *git.RepoInfo) (ClientOperation, error)
  • func NewClientWithAuth(repoInfo *git.RepoInfo) (ClientOperation, error)
• type MockScmClient
  • func (m *MockScmClient) AddRepoSecret(secretKey, secretValue string) error
  • func (m *MockScmClient) AddWebhook(webhookConfig *git.WebhookConfig) error
  • func (m *MockScmClient) DeleteFiles(commitInfo *git.CommitInfo) error
  • func (m *MockScmClient) DeleteRepo() error
  • func (m *MockScmClient) DeleteWebhook(webhookConfig *git.WebhookConfig) error
  • func (m *MockScmClient) DescribeRepo() (*git.RepoInfo, error)
  • func (m *MockScmClient) DownloadRepo() (string, error)
  • func (m *MockScmClient) GetPathInfo(path string) ([]*git.RepoFileStatus, error)
  • func (m *MockScmClient) InitRepo() error
  • func (m *MockScmClient) PushFiles(commitInfo *git.CommitInfo, checkUpdate bool) (bool, error)
• type SCMInfo
  • func (s *SCMInfo) BuildRepoInfo() (*git.RepoInfo, error)
  • func (s *SCMInfo) Encode() map[string]any
  • func (s *SCMInfo) NewClientWithAuthFromScm() (ClientOperation, error)

Constants

const (
	DefaultCommitMsg = "init with devstream"
	TransitBranch    = "init-with-devstream"
)

Functions

func PushInitRepo

func PushInitRepo(client ClientOperation, commitInfo *git.CommitInfo) error

Types

type ClientOperation

type ClientOperation interface {
	InitRepo() error
	DeleteRepo() error
	DownloadRepo() (string, error)
	DescribeRepo() (*git.RepoInfo, error)
	PushFiles(commitInfo *git.CommitInfo, checkUpdate bool) (bool, error)
	DeleteFiles(commitInfo *git.CommitInfo) error
	GetPathInfo(path string) ([]*git.RepoFileStatus, error)
	AddWebhook(webhookConfig *git.WebhookConfig) error
	DeleteWebhook(webhookConfig *git.WebhookConfig) error
	AddRepoSecret(secretKey, secretValue string) error
}

func NewClient

func NewClient(repoInfo *git.RepoInfo) (ClientOperation, error)

func NewClientWithAuth

func NewClientWithAuth(repoInfo *git.RepoInfo) (ClientOperation, error)

type MockScmClient

type MockScmClient struct {
	InitRaiseError         error
	PushRaiseError         error
	GetPathInfoError       error
	DownloadRepoError      error
	AddRepoSecretError     error
	DownloadRepoValue      string
	NeedRollBack           bool
	DeleteFuncIsRun        bool
	GetPathInfoReturnValue []*git.RepoFileStatus
}

func (*MockScmClient) AddRepoSecret

func (m *MockScmClient) AddRepoSecret(secretKey, secretValue string) error

func (*MockScmClient) AddWebhook

func (m *MockScmClient) AddWebhook(webhookConfig *git.WebhookConfig) error

func (*MockScmClient) DeleteFiles

func (m *MockScmClient) DeleteFiles(commitInfo *git.CommitInfo) error

func (*MockScmClient) DeleteRepo

func (m *MockScmClient) DeleteRepo() error

func (*MockScmClient) DeleteWebhook

func (m *MockScmClient) DeleteWebhook(webhookConfig *git.WebhookConfig) error

func (*MockScmClient) DescribeRepo

func (m *MockScmClient) DescribeRepo() (*git.RepoInfo, error)

func (*MockScmClient) DownloadRepo

func (m *MockScmClient) DownloadRepo() (string, error)

func (*MockScmClient) GetPathInfo

func (m *MockScmClient) GetPathInfo(path string) ([]*git.RepoFileStatus, error)

func (*MockScmClient) InitRepo

func (m *MockScmClient) InitRepo() error

func (*MockScmClient) PushFiles

func (m *MockScmClient) PushFiles(commitInfo *git.CommitInfo, checkUpdate bool) (bool, error)

type SCMInfo

type SCMInfo struct {
	// SCM URL related info
	CloneURL string `mapstructure:"url,omitempty" yaml:"url"`
	APIURL   string `mapstructure:"apiURL,omitempty" yaml:"apiURL"`
	// SCM Basic related info
	Owner string `yaml:"owner" mapstructure:"owner,omitempty"`
	Org   string `yaml:"org" mapstructure:"org,omitempty"`
	Name  string `yaml:"name" mapstructure:"name,omitempty"`
	Type  string `mapstructure:"scmType,omitempty" yaml:"scmType"`
	// common fields
	Branch        string `mapstructure:"branch,omitempty" yaml:"branch"`
	SSHPrivateKey string `mapstructure:"sshPrivateKey,omitempty"`
}

SCMInfo can use BasicRepo and URLRepo to get scm info

func (*SCMInfo) BuildRepoInfo

func (s *SCMInfo) BuildRepoInfo() (*git.RepoInfo, error)

BuildRepoInfo will return RepoInfo from SCMInfo

func (*SCMInfo) Encode

func (s *SCMInfo) Encode() map[string]any

func (*SCMInfo) NewClientWithAuthFromScm

func (s *SCMInfo) NewClientWithAuthFromScm() (ClientOperation, error)