workspace

Documentation

Index

• type Workspace
  • func Load(workspacePath string) (*Workspace, error)
  • func (w *Workspace) CheckRequiredPluginsInstalled() error
  • func (w *Workspace) Close()
  • func (w *Workspace) GetChildControls() []*modconfig.Control
  • func (w *Workspace) GetControl(controlName string) (*modconfig.Control, bool)
  • func (w *Workspace) GetControlMap() map[string]*modconfig.Control
  • func (w *Workspace) GetMod(modName string) *modconfig.Mod
  • func (w *Workspace) GetQuery(queryName string) (*modconfig.Query, bool)
  • func (w *Workspace) GetQueryMap() map[string]*modconfig.Query
  • func (w *Workspace) GetResourceMaps() *modconfig.WorkspaceResourceMaps
  • func (w *Workspace) GetSortedBenchmarksAndControlNames() []string
  • func (w *Workspace) GetSortedNamedQueryNames() []string
  • func (w *Workspace) LoadExclusions() error
  • func (w *Workspace) Mods() []*modconfig.Mod
  • func (w *Workspace) PublishReportEvent(e reportevents.ReportEvent)
  • func (w *Workspace) RegisterReportEventHandler(handler reportevents.ReportEventHandler)
  • func (w *Workspace) SetupWatcher(client *db.Client) error

Types

type Workspace

type Workspace struct {
	Path string
	Mod  *modconfig.Mod

	// maps of mod resources from this mod and ALL DEPENDENCIES, keyed by long and short names
	QueryMap     map[string]*modconfig.Query
	ControlMap   map[string]*modconfig.Control
	BenchmarkMap map[string]*modconfig.Benchmark
	ModMap       map[string]*modconfig.Mod
	ReportMap    map[string]*modconfig.Report
	PanelMap     map[string]*modconfig.Panel
	// contains filtered or unexported fields
}

func Load

func Load(workspacePath string) (*Workspace, error)

Load creates a Workspace and loads the workspace mod

func (*Workspace) CheckRequiredPluginsInstalled

func (w *Workspace) CheckRequiredPluginsInstalled() error

func (*Workspace) Close

func (w *Workspace) Close()

func (*Workspace) GetChildControls

func (w *Workspace) GetChildControls() []*modconfig.Control

GetChildControls builds a flat list of all controls in the worlspace, including dependencies

func (*Workspace) GetControl

func (w *Workspace) GetControl(controlName string) (*modconfig.Control, bool)

func (*Workspace) GetControlMap

func (w *Workspace) GetControlMap() map[string]*modconfig.Control

func (*Workspace) GetMod

func (w *Workspace) GetMod(modName string) *modconfig.Mod

GetMod attempts to return the mod with a name matching 'modName' It first checks the workspace mod, then checks all mod dependencies

func (*Workspace) GetQuery

func (w *Workspace) GetQuery(queryName string) (*modconfig.Query, bool)

func (*Workspace) GetQueryMap

func (w *Workspace) GetQueryMap() map[string]*modconfig.Query

func (*Workspace) GetResourceMaps

func (w *Workspace) GetResourceMaps() *modconfig.WorkspaceResourceMaps

func (*Workspace) GetSortedBenchmarksAndControlNames

func (w *Workspace) GetSortedBenchmarksAndControlNames() []string

func (*Workspace) GetSortedNamedQueryNames

func (w *Workspace) GetSortedNamedQueryNames() []string

func (*Workspace) LoadExclusions

func (w *Workspace) LoadExclusions() error

func (*Workspace) Mods

func (w *Workspace) Mods() []*modconfig.Mod

Mods returns a flat list of all mods - the workspace mod and depdnency mods

func (*Workspace) PublishReportEvent

func (w *Workspace) PublishReportEvent(e reportevents.ReportEvent)

func (*Workspace) RegisterReportEventHandler

func (w *Workspace) RegisterReportEventHandler(handler reportevents.ReportEventHandler)

func (*Workspace) SetupWatcher

func (w *Workspace) SetupWatcher(client *db.Client) error