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) (*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

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.