scanner

Documentation

Index

• Variables
• type Analyzer
• type AnalyzerAnalyzeArgs
• type AnalyzerAnalyzeExpectation
• type AnalyzerAnalyzeReturns
• type Driver
• type MockAnalyzer
  • func (_m *MockAnalyzer) Analyze(ctx context.Context) (types.ImageReference, error)
  • func (_m *MockAnalyzer) ApplyAnalyzeExpectation(e AnalyzerAnalyzeExpectation)
  • func (_m *MockAnalyzer) ApplyAnalyzeExpectations(expectations []AnalyzerAnalyzeExpectation)
• type MockDriver
  • func (_m *MockDriver) ApplyScanExpectation(e ScanExpectation)
  • func (_m *MockDriver) ApplyScanExpectations(expectations []ScanExpectation)
  • func (_m *MockDriver) Scan(target string, imageID digest.Digest, layerIDs []string, ...) (report.Results, *fanaltypes.OS, bool, error)
• type ScanArgs
• type ScanExpectation
• type ScanReturns
• type Scanner
  • func NewScanner(driver Driver, ac Analyzer) Scanner
  • func (s Scanner) ScanImage(options types.ScanOptions) (report.Results, error)

Variables

var RemoteArchiveSet = wire.NewSet(
	types.GetDockerOption,
	docker.NewDockerArchiveExtractor,
	wire.Bind(new(extractor.Extractor), new(docker.Extractor)),
	RemoteSuperSet,
)

var RemoteDockerSet = wire.NewSet(
	types.GetDockerOption,
	docker.NewDockerExtractor,
	wire.Bind(new(extractor.Extractor), new(docker.Extractor)),
	RemoteSuperSet,
)

var RemoteSuperSet = wire.NewSet(
	analyzer.New,
	wire.Bind(new(Analyzer), new(analyzer.Config)),
	client.SuperSet,
	wire.Bind(new(Driver), new(client.Scanner)),
	NewScanner,
)

RemoteSuperSet is used in the client mode

var StandaloneArchiveSet = wire.NewSet(
	types.GetDockerOption,
	docker.NewDockerArchiveExtractor,
	wire.Bind(new(extractor.Extractor), new(docker.Extractor)),
	StandaloneSuperSet,
)

var StandaloneDockerSet = wire.NewSet(
	types.GetDockerOption,
	docker.NewDockerExtractor,
	wire.Bind(new(extractor.Extractor), new(docker.Extractor)),
	StandaloneSuperSet,
)

var StandaloneSuperSet = wire.NewSet(
	analyzer.New,
	wire.Bind(new(Analyzer), new(analyzer.Config)),
	local.SuperSet,
	wire.Bind(new(Driver), new(local.Scanner)),
	NewScanner,
)

StandaloneSuperSet is used in the standalone mode

Types

type Analyzer

type Analyzer interface {
	Analyze(ctx context.Context) (info ftypes.ImageReference, err error)
}

type AnalyzerAnalyzeArgs

type AnalyzerAnalyzeArgs struct {
	Ctx         context.Context
	CtxAnything bool
}

type AnalyzerAnalyzeExpectation

type AnalyzerAnalyzeExpectation struct {
	Args    AnalyzerAnalyzeArgs
	Returns AnalyzerAnalyzeReturns
}

type AnalyzerAnalyzeReturns

type AnalyzerAnalyzeReturns struct {
	Info types.ImageReference
	Err  error
}

type Driver

type Driver interface {
	Scan(target string, imageID digest.Digest, layerIDs []string, options types.ScanOptions) (results report.Results, osFound *ftypes.OS, eols bool, err error)
}

type MockAnalyzer

type MockAnalyzer struct {
	mock.Mock
}

MockAnalyzer is an autogenerated mock type for the Analyzer type

func (*MockAnalyzer) Analyze

func (_m *MockAnalyzer) Analyze(ctx context.Context) (types.ImageReference, error)

Analyze provides a mock function with given fields: ctx

func (*MockAnalyzer) ApplyAnalyzeExpectation

func (_m *MockAnalyzer) ApplyAnalyzeExpectation(e AnalyzerAnalyzeExpectation)

func (*MockAnalyzer) ApplyAnalyzeExpectations

func (_m *MockAnalyzer) ApplyAnalyzeExpectations(expectations []AnalyzerAnalyzeExpectation)

type MockDriver

type MockDriver struct {
	mock.Mock
}

MockDriver is an autogenerated mock type for the Driver type

func (*MockDriver) ApplyScanExpectation

func (_m *MockDriver) ApplyScanExpectation(e ScanExpectation)

func (*MockDriver) ApplyScanExpectations

func (_m *MockDriver) ApplyScanExpectations(expectations []ScanExpectation)

func (*MockDriver) Scan

func (_m *MockDriver) Scan(target string, imageID digest.Digest, layerIDs []string, options types.ScanOptions) (report.Results, *fanaltypes.OS, bool, error)

Scan provides a mock function with given fields: target, imageID, layerIDs, options

type ScanArgs

type ScanArgs struct {
	Target           string
	TargetAnything   bool
	ImageID          digest.Digest
	ImageIDAnything  bool
	LayerIDs         []string
	LayerIDsAnything bool
	Options          types.ScanOptions
	OptionsAnything  bool
}

type ScanExpectation

type ScanExpectation struct {
	Args    ScanArgs
	Returns ScanReturns
}

type ScanReturns

type ScanReturns struct {
	Results report.Results
	OsFound *fanaltypes.OS
	Eols    bool
	Err     error
}

type Scanner

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

func NewScanner

func NewScanner(driver Driver, ac Analyzer) Scanner

func (Scanner) ScanImage

func (s Scanner) ScanImage(options types.ScanOptions) (report.Results, error)