analysis

Documentation

Index

• Constants
• func WithErrorReporter(errorReporter observability.ErrorReporter) func(*analysisOrchestrator)
• func WithInstrumentor(instrumentor observability.Instrumentor) func(*analysisOrchestrator)
• func WithLogger(logger *zerolog.Logger) func(*analysisOrchestrator)
• func WithResultType(t testModels.Scan) func(*analysisOrchestrator)
• func WithTrackerFactory(factory scan.TrackerFactory) func(*analysisOrchestrator)
• type AnalysisConfig
• type AnalysisOrchestrator
  • func NewAnalysisOrchestrator(config config.Config, httpClient codeClientHTTP.HTTPClient, ...) AnalysisOrchestrator
• type FailedError
  • func (e FailedError) Error() string
• type OptionFunc
• type Request
• type RequestKey

Constants

const (
	StatusComplete  = "COMPLETE"
	StatusFailed    = "FAILED"
	StatusAnalyzing = "ANALYZING"
)

Legacy analysis types and constants

Functions

func WithErrorReporter

func WithErrorReporter(errorReporter observability.ErrorReporter) func(*analysisOrchestrator)

func WithInstrumentor

func WithInstrumentor(instrumentor observability.Instrumentor) func(*analysisOrchestrator)

func WithLogger

func WithLogger(logger *zerolog.Logger) func(*analysisOrchestrator)

func WithResultType

func WithResultType(t testModels.Scan) func(*analysisOrchestrator)

func WithTrackerFactory

func WithTrackerFactory(factory scan.TrackerFactory) func(*analysisOrchestrator)

Types

type AnalysisConfig

type AnalysisConfig struct {
	Report          bool
	ProjectName     *string
	TargetName      *string
	TargetReference *string
	ProjectId       *uuid.UUID
	CommitId        *string
}

type AnalysisOrchestrator

type AnalysisOrchestrator interface {
	RunTest(ctx context.Context, orgId string, b bundle.Bundle, target scan.Target, reportingOptions AnalysisConfig) (*sarif.SarifResponse, *scan.ResultMetaData, error)
	RunTestRemote(ctx context.Context, orgId string, reportingOptions AnalysisConfig) (*sarif.SarifResponse, *scan.ResultMetaData, error)
	RunLegacyTest(ctx context.Context, bundleHash string, shardKey string, limitToFiles []string, severity int) (*sarif.SarifResponse, scan.LegacyScanStatus, error)
}

func NewAnalysisOrchestrator

func NewAnalysisOrchestrator(
	config config.Config,
	httpClient codeClientHTTP.HTTPClient,
	options ...OptionFunc,
) AnalysisOrchestrator

type FailedError

type FailedError struct {
	Msg string
}

func (FailedError) Error

func (e FailedError) Error() string

type OptionFunc

type OptionFunc func(*analysisOrchestrator)

type Request

type Request struct {
	Key             RequestKey     `json:"key"`
	Severity        int            `json:"severity,omitempty"`
	Prioritized     bool           `json:"prioritized,omitempty"`
	Legacy          bool           `json:"legacy"`
	AnalysisContext requestContext `json:"analysisContext"`
}

type RequestKey

type RequestKey struct {
	Type         string   `json:"type"`
	Hash         string   `json:"hash"`
	LimitToFiles []string `json:"limitToFiles,omitempty"`
	Shard        string   `json:"shard"`
}