engine

Documentation

Index

• Constants
• type Engine
  • func (e *Engine) Run(ctx context.Context, options RunOptions) (*Results, resultspkg.ScanAnalytics, []error, []error)
• type Error
• type ErrorCode
• type EvaluationError
• type MissingRemoteSubmodulesError
• type MissingTermError
• type Results
• type RunOptions
• type SubmoduleLoadingError

Constants

const (
	ErrorCodeNoLoadableInputs               = engine.ErrorCodeNoLoadableInputs
	ErrorCodeUnableToRecognizeInputType     = engine.ErrorCodeUnableToRecognizeInputType
	ErrorCodeUnsupportedInputType           = engine.ErrorCodeUnsupportedInputType
	ErrorCodeUnableToResolveLocation        = engine.ErrorCodeUnableToResolveLocation
	ErrorCodeUnrecognizedFileExtension      = engine.ErrorCodeUnrecognizedFileExtension
	ErrorCodeFailedToParseInput             = engine.ErrorCodeFailedToParseInput
	ErrorCodeInvalidInput                   = engine.ErrorCodeInvalidInput
	ErrorCodeUnableToReadFile               = engine.ErrorCodeUnableToReadFile
	ErrorCodeUnableToReadDir                = engine.ErrorCodeUnableToReadDir
	ErrorCodeUnableToReadStdin              = engine.ErrorCodeUnableToReadStdin
	ErrorCodeFailedToLoadRegoAPI            = engine.ErrorCodeFailedToLoadRegoAPI
	ErrorCodeFailedToLoadRules              = engine.ErrorCodeFailedToLoadRules
	ErrorCodeFailedToCompile                = engine.ErrorCodeFailedToCompile
	ErrorCodeUnableToReadPath               = engine.ErrorCodeUnableToReadPath
	ErrorCodeFailedToMakeResourcesResolvers = engine.ErrorCodeFailedToMakeResourcesResolvers
	ErrorCodeResourcesResolverError         = engine.ErrorCodeResourcesResolverError
	ErrorCodeSubmoduleLoadingError          = engine.ErrorCodeSubmoduleLoadingError
	ErrorCodeMissingRemoteSubmodulesError   = engine.ErrorCodeMissingRemoteSubmodulesError
	ErrorCodeEvaluationError                = engine.ErrorCodeEvaluationError
	ErrorCodeMissingTermError               = engine.ErrorCodeMissingTermError
)

Types

type Engine

type Engine struct {
	FS afero.Fs
}

func (*Engine) Run

func (e *Engine) Run(ctx context.Context, options RunOptions) (*Results, resultspkg.ScanAnalytics, []error, []error)

type Error

type Error = engine.Error

type ErrorCode

type ErrorCode = engine.ErrorCode

type EvaluationError

type EvaluationError = engine.EvaluationError

type MissingRemoteSubmodulesError

type MissingRemoteSubmodulesError = engine.MissingRemoteSubmodulesError

type MissingTermError

type MissingTermError = engine.MissingTermError

type Results

type Results = engine.Results

type RunOptions

type RunOptions struct {
	Paths                []string
	SnykBundle           io.ReadCloser
	CustomRuleBundles    []bundle.Reader
	OrgPublicID          string
	SnykCloudEnvironment string
	SnykClient           cloudapi.Client
	Scan                 string
	DetectionDepth       int
	VarFile              string
	Logger               *zerolog.Logger
}

type SubmoduleLoadingError

type SubmoduleLoadingError = engine.SubmoduleLoadingError