scope

type ContentResolver ¶

type ContentResolver interface {
	MultipleFileContentsByRef(f ...file.Reference) (map[file.Reference]string, error)
}

ContentResolver knows how to get file content for given file.References

type DirSource ¶

type DirSource struct {
	Path string // the root path to be cataloged
}

DirSource represents a data source that is a filesystem directory tree

type FileResolver ¶

type FileResolver interface {
	FilesByPath(paths ...file.Path) ([]file.Reference, error)
	FilesByGlob(patterns ...string) ([]file.Reference, error)
}

FileResolver knows how to get file.References for given string paths and globs

type ImageSource ¶

type ImageSource struct {
	Img *image.Image // the image object to be cataloged
}

ImageSource represents a data source that is a container image

type Option ¶

type Option int

const (
	UnknownScope Option = iota
	SquashedScope
	AllLayersScope
)

func ParseOption(userStr string) Option

func (o Option) String() string

type Resolver ¶

type Resolver interface {
	ContentResolver
	FileResolver
}

Resolver is an interface that encompasses how to get specific file references and file contents for a generic data source.

type Scope ¶

type Scope struct {
	Option   Option      // specific perspective to catalog
	Resolver Resolver    // a Resolver object to use in file path/glob resolution and file contents resolution
	ImgSrc   ImageSource // the specific image to be cataloged
	DirSrc   DirSource   // the specific directory to be cataloged
}

Scope is an object that captures the data source to be cataloged, configuration, and a specific resolver used in cataloging (based on the data source and configuration)

func NewScope(userInput string, o Option) (Scope, func(), error)

func NewScopeFromDir(path string) (Scope, error)

func NewScopeFromImage(img *image.Image, option Option) (Scope, error)

func (s Scope) Source() interface{}