analyze

Documentation

Overview

Package analyze can analyze things.

Index

• Constants
• type Analyzer
  • func NewAnalyzer(scmClient ScmClient, gitClient GitClient, formatter Formatter, ...) *Analyzer
  • func (a *Analyzer) AnalyzeLocalRepo(ctx context.Context, repoPath string) error
  • func (a *Analyzer) AnalyzeOrg(ctx context.Context, org string, numberOfGoroutines *int) error
  • func (a *Analyzer) AnalyzeRepo(ctx context.Context, repoString string) error
• type Formatter
• type GitClient
• type RepoBatch
• type Repository
• type ScmClient

Constants

const TEMP_DIR_PREFIX = "poutine-*"

Types

type Analyzer

type Analyzer struct {
	ScmClient ScmClient
	GitClient GitClient
	Formatter Formatter
	Config    *models.Config
}

func NewAnalyzer

func NewAnalyzer(scmClient ScmClient, gitClient GitClient, formatter Formatter, config *models.Config) *Analyzer

func (*Analyzer) AnalyzeLocalRepo

func (a *Analyzer) AnalyzeLocalRepo(ctx context.Context, repoPath string) error

func (*Analyzer) AnalyzeOrg

func (a *Analyzer) AnalyzeOrg(ctx context.Context, org string, numberOfGoroutines *int) error

func (*Analyzer) AnalyzeRepo

func (a *Analyzer) AnalyzeRepo(ctx context.Context, repoString string) error

type Formatter

type Formatter interface {
	Format(ctx context.Context, report *opa.FindingsResult, packages []*models.PackageInsights) error
}

type GitClient

type GitClient interface {
	Clone(ctx context.Context, clonePath string, url string, token string, ref string) error
	CommitSHA(clonePath string) (string, error)
	LastCommitDate(ctx context.Context, clonePath string) (time.Time, error)
	GetRemoteOriginURL(ctx context.Context, repoPath string) (string, error)
	GetRepoHeadBranchName(ctx context.Context, repoPath string) (string, error)
}

type RepoBatch

type RepoBatch struct {
	TotalCount   int
	Repositories []Repository
	Err          error
}

type Repository

type Repository interface {
	GetProviderName() string
	GetRepoIdentifier() string
	GetIsFork() bool
	BuildGitURL(baseURL string) string
}

type ScmClient

type ScmClient interface {
	GetOrgRepos(ctx context.Context, org string) <-chan RepoBatch
	GetRepo(ctx context.Context, org string, name string) (Repository, error)
	GetToken() string
	GetProviderName() string
	GetProviderVersion(ctx context.Context) (string, error)
	GetProviderBaseURL() string
	ParseRepoAndOrg(string) (string, string, error)
}