artifact

Documentation

Index

• type Artifact
• type ArtifactCleanArgs
• type ArtifactCleanExpectation
• type ArtifactCleanReturns
• type ArtifactInspectArgs
• type ArtifactInspectExpectation
• type ArtifactInspectReturns
• type MockArtifact
  • func (_m *MockArtifact) ApplyCleanExpectation(e ArtifactCleanExpectation)
  • func (_m *MockArtifact) ApplyCleanExpectations(expectations []ArtifactCleanExpectation)
  • func (_m *MockArtifact) ApplyInspectExpectation(e ArtifactInspectExpectation)
  • func (_m *MockArtifact) ApplyInspectExpectations(expectations []ArtifactInspectExpectation)
  • func (_m *MockArtifact) Clean(reference types.ArtifactReference) error
  • func (_m *MockArtifact) Inspect(ctx context.Context) (types.ArtifactReference, error)
• type Option
  • func (o *Option) AnalyzerOptions() analyzer.AnalyzerOptions
  • func (o *Option) ConfigAnalyzerOptions() analyzer.ConfigAnalyzerOptions
  • func (o *Option) Sort()
• type WalkOption

Types

type Artifact

type Artifact interface {
	Inspect(ctx context.Context) (reference types.ArtifactReference, err error)
	Clean(reference types.ArtifactReference) error
}

type ArtifactCleanArgs

type ArtifactCleanArgs struct {
	Reference         types.ArtifactReference
	ReferenceAnything bool
}

type ArtifactCleanExpectation

type ArtifactCleanExpectation struct {
	Args    ArtifactCleanArgs
	Returns ArtifactCleanReturns
}

type ArtifactCleanReturns

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

type ArtifactInspectArgs

type ArtifactInspectArgs struct {
	Ctx         context.Context
	CtxAnything bool
}

type ArtifactInspectExpectation

type ArtifactInspectExpectation struct {
	Args    ArtifactInspectArgs
	Returns ArtifactInspectReturns
}

type ArtifactInspectReturns

type ArtifactInspectReturns struct {
	Reference types.ArtifactReference
	Err       error
}

type MockArtifact

type MockArtifact struct {
	mock.Mock
}

MockArtifact is an autogenerated mock type for the Artifact type

func (*MockArtifact) ApplyCleanExpectation

func (_m *MockArtifact) ApplyCleanExpectation(e ArtifactCleanExpectation)

func (*MockArtifact) ApplyCleanExpectations

func (_m *MockArtifact) ApplyCleanExpectations(expectations []ArtifactCleanExpectation)

func (*MockArtifact) ApplyInspectExpectation

func (_m *MockArtifact) ApplyInspectExpectation(e ArtifactInspectExpectation)

func (*MockArtifact) ApplyInspectExpectations

func (_m *MockArtifact) ApplyInspectExpectations(expectations []ArtifactInspectExpectation)

func (*MockArtifact) Clean

func (_m *MockArtifact) Clean(reference types.ArtifactReference) error

Clean provides a mock function with given fields: reference

func (*MockArtifact) Inspect

func (_m *MockArtifact) Inspect(ctx context.Context) (types.ArtifactReference, error)

Inspect provides a mock function with given fields: ctx

type Option

type Option struct {
	AnalyzerGroup     analyzer.Group // It is empty in OSS
	DisabledAnalyzers []analyzer.Type
	DisabledHandlers  []types.HandlerType
	SkipFiles         []string
	SkipDirs          []string
	FilePatterns      []string
	NoProgress        bool
	Insecure          bool
	Offline           bool
	AppDirs           []string
	SBOMSources       []string
	RekorURL          string
	Parallel          int
	AWSRegion         string
	AWSEndpoint       string
	FileChecksum      bool // For SPDX

	// Git repositories
	RepoBranch string
	RepoCommit string
	RepoTag    string

	// For image scanning
	ImageOption types.ImageOptions

	OnlyFetchDFScanRegistrationMeta bool

	MisconfScannerOption misconf.ScannerOption
	SecretScannerOption  analyzer.SecretScannerOption
	LicenseScannerOption analyzer.LicenseScannerOption

	// File walk
	WalkOption WalkOption
}

func (*Option) AnalyzerOptions

func (o *Option) AnalyzerOptions() analyzer.AnalyzerOptions

func (*Option) ConfigAnalyzerOptions

func (o *Option) ConfigAnalyzerOptions() analyzer.ConfigAnalyzerOptions

func (*Option) Sort

func (o *Option) Sort()

type WalkOption

type WalkOption struct {
	ErrorCallback walker.ErrorCallback
}

WalkOption is a struct that allows users to define a custom walking behavior. This option is only available when using Trivy as an imported library and not through CLI flags.