vcs_clients

Documentation

Index

• Variables
• type Client
• type CommitState
  • func (s CommitState) StateToDesc() string
  • func (s CommitState) String() string
• type Message
  • func (m *Message) AddNewApp(ctx context.Context, app string)
  • func (m *Message) AddToAppMessage(ctx context.Context, app string, msg string)
  • func (m *Message) AddToMessage(ctx context.Context, msg string)
• type WebHookConfig

Variables

var (
	// ErrInvalidType is a sentinel error for use in client implementations
	ErrInvalidType  = errors.New("invalid event type")
	ErrHookNotFound = errors.New("webhook not found")
)

Types

type Client

type Client interface {
	// PostMessage takes in project name in form "owner/repo" (ie zapier/kubechecks), the PR/MR id, and the actual message
	PostMessage(context.Context, *repo.Repo, int, string) *Message
	// UpdateMessage update a message with new content
	UpdateMessage(context.Context, *Message, string) error
	// VerifyHook validates a webhook secret and return the body; must be called even if no secret
	VerifyHook(*http.Request, string) ([]byte, error)
	// ParseHook parses webook payload for valid events
	ParseHook(*http.Request, []byte) (interface{}, error)
	// CreateRepo handles valid events
	CreateRepo(context.Context, interface{}) (*repo.Repo, error)
	// CommitStatus sets a status for a specific commit on the remote VCS
	CommitStatus(context.Context, *repo.Repo, CommitState) error
	// GetHookByUrl gets a webhook by url
	GetHookByUrl(ctx context.Context, repoName, webhookUrl string) (*WebHookConfig, error)
	// CreateHook creates a webhook that points at kubechecks
	CreateHook(ctx context.Context, repoName, webhookUrl, webhookSecret string) error
	// GetName returns the VCS client name (e.g. "github" or "gitlab")
	GetName() string
	// Tidy outdated comments either by hiding or deleting them
	TidyOutdatedComments(context.Context, *repo.Repo) error
}

Client represents a VCS client

type CommitState

type CommitState int

Enum for represnting the state of a commit for posting via CommitStatus

const (
	Pending CommitState = iota
	Running
	Failure
	Success
)

func (CommitState) StateToDesc

func (s CommitState) StateToDesc() string

Return more informative description message based on the enum state

func (CommitState) String

func (s CommitState) String() string

Return literal string representation of this state for use in the request

type Message

type Message struct {
	Lock    sync.Mutex
	Name    string
	Owner   string
	CheckID int
	NoteID  int
	Msg     string
	// Key = Appname, value = Msg
	Apps   map[string]string
	Client Client
}

Message type that allows concurrent updates Has a reference to the owner/repo (ie zapier/kubechecks), the PR/MR id, and the actual messsage

func (*Message) AddNewApp

func (m *Message) AddNewApp(ctx context.Context, app string)

func (*Message) AddToAppMessage

func (m *Message) AddToAppMessage(ctx context.Context, app string, msg string)

func (*Message) AddToMessage

func (m *Message) AddToMessage(ctx context.Context, msg string)

type WebHookConfig

type WebHookConfig struct {
	Url       string
	SecretKey string
	Events    []string
}