gatherers

Documentation

Overview

Package gatherers contains routines for different types of inventory gatherers

Package gatherers contains routines for different types of inventory gatherers

Package gatherers contains routines for different types of inventory gatherers

Index

• func InitializeGatherers(context context.T) (SupportedGatherer, InstalledGatherer)
• type InstalledGatherer
• type Mock
  • func NewMockDefault() *Mock
  • func (m *Mock) Name() string
  • func (m *Mock) RequestStop(stopType contracts.StopType) error
  • func (m *Mock) Run(context context.T, configuration model.Config) ([]model.Item, error)
• type SupportedGatherer
• type T

Functions

func InitializeGatherers

func InitializeGatherers(context context.T) (SupportedGatherer, InstalledGatherer)

InitializeGatherers collects supported and installed gatherers

Types

type InstalledGatherer

type InstalledGatherer map[string]T

InstalledGatherer is a map of gatherers of all platforms

type Mock

type Mock struct {
	mock.Mock
}

Mock represents a mocked gatherer.

func NewMockDefault

func NewMockDefault() *Mock

NewMockDefault returns an instance of Mock with default expectations set.

func (*Mock) Name

func (m *Mock) Name() string

Name mock implementation of namesake

func (*Mock) RequestStop

func (m *Mock) RequestStop(stopType contracts.StopType) error

RequestStop mock implementation of namesake

func (*Mock) Run

func (m *Mock) Run(context context.T, configuration model.Config) ([]model.Item, error)

Run mock implementation of namesake

type SupportedGatherer

type SupportedGatherer map[string]T

SupportedGatherer is a map of supported gatherer on current platform

type T

type T interface {
	//returns the Name of the gatherer
	Name() string
	//runs the gatherer with a given configuration
	//returns array of inventory.Item as custom gatherer collects multiple
	//inventory items at a time
	Run(context context.T, configuration model.Config) ([]model.Item, error)
	//stops the execution of a gatherer
	RequestStop(stopType contracts.StopType) error
}

T defines operations that all inventory gatherers support