featurens

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, toUse []database.Detector) ([]database.LayerNamespace, error)
• func ListDetectors() []database.Detector
• func RegisterDetector(name string, version string, d Detector)
• func RequiredFilenames(toUse []database.Detector) (files []string)
• func TestDetector(t *testing.T, d Detector, testData []TestData)
• type Detector
• type TestData

Functions

func Detect

func Detect(files tarutil.FilesMap, toUse []database.Detector) ([]database.LayerNamespace, error)

Detect uses detectors specified to retrieve the detect result.

func ListDetectors

func ListDetectors() []database.Detector

ListDetectors returns the info of all registered namespace detectors.

func RegisterDetector

func RegisterDetector(name string, version 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(toUse []database.Detector) (files []string)

RequiredFilenames returns all file patterns that will be passed to the given extensions. These patterns are expressed as regexps. Any extension metadata that has non namespace-detector type will be skipped.

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 a list of patterns for filenames that will
	// be in the FilesMap provided to the Detect method.
	//
	// The patterns are expressed as regexps, and will be matched against
	// full paths that do not include the leading "/".
	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.