featurens

package

v2.1.0+incompatible Latest Latest Go to latest Published: Nov 5, 2019 License: Apache-2.0 Imports: 6 Imported by: 246

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/coreos/clair

Links

Open Source Insights

Documentation ¶

Overview ¶

Package featurens exposes functions to dynamically register methods for determining a namespace for features present in an image layer.

Index ¶

func Detect(files tarutil.FilesMap) (*database.Namespace, error)
func RegisterDetector(name string, d Detector)
func RequiredFilenames() (files []string)
func TestDetector(t *testing.T, d Detector, testData []TestData)
type Detector
type TestData

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Detect ¶

func Detect(files tarutil.FilesMap) (*database.Namespace, error)

Detect iterators through all registered Detectors and returns the first non-nil detected namespace.

func RegisterDetector ¶

func RegisterDetector(name string, d Detector)

RegisterDetector makes a detector available by the provided name.

If called twice with the same name, the name is blank, or if the provided Detector is nil, this function panics.

func RequiredFilenames ¶

func RequiredFilenames() (files []string)

RequiredFilenames returns the total list of files required for all registered Detectors.

func TestDetector ¶

func TestDetector(t *testing.T, d Detector, testData []TestData)

TestDetector runs a Detector on each provided instance of TestData and asserts the output to be equal to the expected output.

Types ¶

type Detector ¶

type Detector interface {
	// Detect attempts to determine a Namespace from a FilesMap of an image
	// layer.
	Detect(tarutil.FilesMap) (*database.Namespace, error)

	// RequiredFilenames returns the list of files required to be in the FilesMap
	// provided to the Detect method.
	//
	// Filenames must not begin with "/".
	RequiredFilenames() []string
}

Detector represents an ability to detect a namespace used for organizing features present in an image layer.

type TestData ¶

type TestData struct {
	Files             tarutil.FilesMap
	ExpectedNamespace *database.Namespace
}

TestData represents the data used to test an implementation of Detector.

Source Files ¶

View all Source files

driver.go

Directories ¶

Path	Synopsis
alpinerelease Package alpinerelease implements a featurens.Detector for Alpine Linux based container image layers.	Package alpinerelease implements a featurens.Detector for Alpine Linux based container image layers.
aptsources Package aptsources implements a featurens.Detector for apt based container image layers.	Package aptsources implements a featurens.Detector for apt based container image layers.
lsbrelease Package lsbrelease implements a featurens.Detector for container image layers containing an lsb-release file.	Package lsbrelease implements a featurens.Detector for container image layers containing an lsb-release file.
osrelease Package osrelease implements a featurens.Detector for container image layers containing an os-release file.	Package osrelease implements a featurens.Detector for container image layers containing an os-release file.
redhatrelease Package redhatrelease implements a featurens.Detector for container image layers containing an redhat-release-like files.	Package redhatrelease implements a featurens.Detector for container image layers containing an redhat-release-like files.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL