github

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(t http.RoundTripper, cache *cache.ValidableCache, watchMinInterval string, ...) *Client
  • func (c *Client) PollInterval(cat pollLimitCategory) time.Duration
  • func (c *Client) Rate(cat rateLimitCategory) github.Rate
  • func (c *Client) Validate(path string) error
• type ClientConfig
  • func (c ClientConfig) IsZero() bool
• type ClientPool
  • func NewClientPool() *ClientPool
  • func NewClientPoolFromTokens(urlToConfig map[string]ClientConfig, cache *cache.ValidableCache, ...) (*ClientPool, error)
  • func (p *ClientPool) Client(username, repo string) (*Client, bool)
  • func (p *ClientPool) Clients() map[*Client][]*lookout.RepositoryInfo
  • func (p *ClientPool) GitAuth(ctx context.Context, repoInfo *lookout.RepositoryInfo) transport.AuthMethod
  • func (p *ClientPool) RemoveClient(c *Client)
  • func (p *ClientPool) Repos() []string
  • func (p *ClientPool) ReposByClient(c *Client) []*lookout.RepositoryInfo
  • func (p *ClientPool) Subscribe(ch chan ClientPoolEvent)
  • func (p *ClientPool) Unsubscribe(ch chan ClientPoolEvent)
  • func (p *ClientPool) Update(c *Client, newRepos []*lookout.RepositoryInfo)
• type ClientPoolEvent
• type ClientPoolEventType
• type Installations
  • func NewInstallations(appID int, privateKey string, cache *cache.ValidableCache, ...) (*Installations, error)
  • func (t *Installations) Sync() error
• type Poster
  • func NewPoster(pool *ClientPool, conf ProviderConfig) *Poster
  • func (p *Poster) Post(ctx context.Context, e lookout.Event, aCommentsList []lookout.AnalyzerComments) error
  • func (p *Poster) Status(ctx context.Context, e lookout.Event, status lookout.AnalysisStatus) error
• type ProviderConfig
• type StatusCreator
• type Watcher
  • func NewWatcher(pool *ClientPool) (*Watcher, error)
  • func (w *Watcher) Watch(ctx context.Context, cb lookout.EventHandler) error

Constants

const Provider = "github"

Variables

var (
	// ErrLineOutOfDiff is returned when the file line number is not
	// in the patch diff
	ErrLineOutOfDiff = errors.NewKind("line number is not in diff")
	// ErrLineNotAddition is returned when the file line number is not
	// a + change in the patch diff
	ErrLineNotAddition = errors.NewKind("line number is not an added change")
	// ErrFileNotFound is returned when the file name is not part of the diff
	ErrFileNotFound = errors.NewKind("file not found")
	// ErrBadPatch is returned when there was a problem parsing the diff
	ErrBadPatch = errors.NewKind("diff patch could not be parsed")
)

var (
	// ErrGitHubAPI signals an error while making a request to the GitHub API.
	ErrGitHubAPI = errors.NewKind("github api error")
	// ErrEventNotSupported signals that this provider does not support the
	// given event for a given operation.
	ErrEventNotSupported = errors.NewKind("event not supported")
)

var (
	NoErrNotModified       = errors.NewKind("Not modified")
	ErrParsingEventPayload = errors.NewKind("Parse error in event")

	// RequestTimeout is the max time to wait until the request context is
	// cancelled.
	RequestTimeout = time.Second * 5
)

Types

type Client

type Client struct {
	*github.Client
	// contains filtered or unexported fields
}

Client is a wrapper for github.Client that supports cache and provides rate limit information

func NewClient

func NewClient(
	t http.RoundTripper,
	cache *cache.ValidableCache,
	watchMinInterval string,
	gitAuth gitAuthFn,
	timeout time.Duration,
) *Client

NewClient creates new Client

func (*Client) PollInterval

func (c *Client) PollInterval(cat pollLimitCategory) time.Duration

PollInterval returns last duration from X-Poll-Interval for a client by category

func (*Client) Rate

func (c *Client) Rate(cat rateLimitCategory) github.Rate

Rate returns last github.Rate for a client by category

func (*Client) Validate

func (c *Client) Validate(path string) error

Validate validates cache by path

type ClientConfig

type ClientConfig struct {
	User        string
	Token       string
	MinInterval string
}

ClientConfig holds github username, token and watch interval

func (ClientConfig) IsZero

func (c ClientConfig) IsZero() bool

IsZero return true if config is empty and false otherwise

type ClientPool

type ClientPool struct {
	// contains filtered or unexported fields
}

ClientPool holds mapping of repositories to clients

func NewClientPool

func NewClientPool() *ClientPool

NewClientPool creates new pool of clients with repositories

func NewClientPoolFromTokens

func NewClientPoolFromTokens(
	urlToConfig map[string]ClientConfig,
	cache *cache.ValidableCache,
	timeout time.Duration,
) (*ClientPool, error)

NewClientPoolFromTokens creates new ClientPool based on map[repoURL]ClientConfig later we will need another constructor that would request installations and create pool from it

func (*ClientPool) Client

func (p *ClientPool) Client(username, repo string) (*Client, bool)

Client returns client, ok by username and repository name

func (*ClientPool) Clients

func (p *ClientPool) Clients() map[*Client][]*lookout.RepositoryInfo

Clients returns map[Client]RepositoryInfo

func (*ClientPool) GitAuth

func (p *ClientPool) GitAuth(ctx context.Context, repoInfo *lookout.RepositoryInfo) transport.AuthMethod

GitAuth returns a go-git auth method for a repo

func (*ClientPool) RemoveClient

func (p *ClientPool) RemoveClient(c *Client)

RemoveClient removes client from the pool and notifies about it

func (*ClientPool) Repos

func (p *ClientPool) Repos() []string

Repos returns list of repositories in the pool

func (*ClientPool) ReposByClient

func (p *ClientPool) ReposByClient(c *Client) []*lookout.RepositoryInfo

ReposByClient returns list of repositories by client

func (*ClientPool) Subscribe

func (p *ClientPool) Subscribe(ch chan ClientPoolEvent)

Subscribe allows to subscribe to changes in the pool

func (*ClientPool) Unsubscribe

func (p *ClientPool) Unsubscribe(ch chan ClientPoolEvent)

Unsubscribe stops sending changes to the channel

func (*ClientPool) Update

func (p *ClientPool) Update(c *Client, newRepos []*lookout.RepositoryInfo)

Update updates list of repositories for a client

type ClientPoolEvent

type ClientPoolEvent struct {
	Type   ClientPoolEventType
	Client *Client
}

ClientPoolEvent defines change in ClientPool

type ClientPoolEventType

type ClientPoolEventType string

ClientPoolEventType type of the change in ClientPool

const (
	// ClientPoolEventAdd happens when new client is added in the pool
	ClientPoolEventAdd ClientPoolEventType = "add"
	// ClientPoolEventRemove happens when client is removed from the pool
	ClientPoolEventRemove ClientPoolEventType = "remove"
)

type Installations

type Installations struct {
	Pool *ClientPool
	// contains filtered or unexported fields
}

Installations keeps github installations and allows to sync them

func NewInstallations

func NewInstallations(
	appID int, privateKey string,
	cache *cache.ValidableCache,
	clientTimeout time.Duration,
) (*Installations, error)

NewInstallations creates a new Installations using the App ID and private key

func (*Installations) Sync

func (t *Installations) Sync() error

Sync update state from github

type Poster

type Poster struct {
	// contains filtered or unexported fields
}

Poster posts comments as Pull Request Reviews.

func NewPoster

func NewPoster(pool *ClientPool, conf ProviderConfig) *Poster

NewPoster creates a new poster for the GitHub API.

func (*Poster) Post

func (p *Poster) Post(ctx context.Context, e lookout.Event,
	aCommentsList []lookout.AnalyzerComments) error

Post posts comments as a Pull Request Review. If the event is not a GitHub Pull Request, ErrEventNotSupported is returned. If a GitHub API request fails, ErrGitHubAPI is returned.

func (*Poster) Status

func (p *Poster) Status(ctx context.Context, e lookout.Event, status lookout.AnalysisStatus) error

Status sets the Pull Request global status, visible from the GitHub UI If a GitHub API request fails, ErrGitHubAPI is returned.

type ProviderConfig

type ProviderConfig struct {
	CommentFooter            string `yaml:"comment_footer"`
	PrivateKey               string `yaml:"private_key"`
	AppID                    int    `yaml:"app_id"`
	InstallationSyncInterval string `yaml:"installation_sync_interval"`
}

ProviderConfig represents the yml config

type StatusCreator

type StatusCreator interface {
	// CreateStatus creates a new status for a repository at the specified
	// reference. Ref can be a SHA, a branch name, or a tag name.
	CreateStatus(ctx context.Context, owner, repo, ref string, status *github.RepoStatus) (
		*github.RepoStatus, *github.Response, error)
}

StatusCreator creates statuses on GitHub. *github.RepositoriesService fulfills this interface.

type Watcher

type Watcher struct {
	// contains filtered or unexported fields
}

func NewWatcher

func NewWatcher(pool *ClientPool) (*Watcher, error)

NewWatcher returns a new

func (*Watcher) Watch

func (w *Watcher) Watch(ctx context.Context, cb lookout.EventHandler) error

Watch start to make request to the GitHub API and return the new events.