analyze

Documentation

Overview

Package analyze can analyze things.

Index

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

Constants

const TEMP_DIR_PREFIX = "poutine-*"

Functions

func AnalyzeLocalRepo

func AnalyzeLocalRepo(ctx context.Context, repoPath string, scmClient ScmClient, formatter Formatter) error

func AnalyzeOrg

func AnalyzeOrg(ctx context.Context, org string, scmClient ScmClient, numberOfGoroutines *int, formatter Formatter) error

func AnalyzeRepo

func AnalyzeRepo(ctx context.Context, repoString string, scmClient ScmClient, formatter Formatter) error

Types

type Formatter

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

type RepoBatch

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

type Repository

type Repository interface {
	GetProviderName() string
	GetRepoIdentifier() string
	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)
}