hosts

Documentation

Index

• func Run(m *manager.Manager) error
• type Github
  • func NewGithubClient(m *manager.Manager) (*Github, error)
  • func (g *Github) Audit()
  • func (g *Github) AuditPR()
• type Gitlab
  • func NewGitlabClient(m *manager.Manager) (*Gitlab, error)
  • func (g *Gitlab) Audit()
  • func (g *Gitlab) AuditPR()
• type Host

Functions

func Run

func Run(m *manager.Manager) error

Run kicks off a host audit. This function accepts a manager and determines what host it should audit

Types

type Github

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

Github wraps a github client and manager. This struct implements what the Host interface defines.

func NewGithubClient

func NewGithubClient(m *manager.Manager) (*Github, error)

NewGithubClient accepts a manager struct and returns a Github host pointer which will be used to perform a github audit on an organization, user, or PR.

func (*Github) Audit

func (g *Github) Audit()

Audit will audit a github user or organization's repos.

func (*Github) AuditPR

func (g *Github) AuditPR()

AuditPR audits a single github PR

type Gitlab

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

Gitlab wraps a gitlab client and manager. This struct implements what the Host interface defines.

func NewGitlabClient

func NewGitlabClient(m *manager.Manager) (*Gitlab, error)

NewGitlabClient accepts a manager struct and returns a Gitlab host pointer which will be used to perform a gitlab audit on an group or user.

func (*Gitlab) Audit

func (g *Gitlab) Audit()

Audit will audit a github user or organization's repos.

func (*Gitlab) AuditPR

func (g *Gitlab) AuditPR()

AuditPR TODO not implemented

type Host

type Host interface {
	Audit()
	AuditPR()
}

Host is an interface used for defining external git hosting providers like github and gitlab. TODO add bitbucket