Documentation
¶
Overview ¶
Package settingstest provides test doubles for the settings.Provider interface.
Index ¶
- type StubProvider
- func (s *StubProvider) GetBool(id string) (bool, error)
- func (s *StubProvider) GetCategories() []settings.Category
- func (s *StubProvider) GetCategory(_ string) (settings.Category, error)
- func (s *StubProvider) GetCategoryValues(_ string) (map[string]interface{}, error)
- func (s *StubProvider) GetFloat(id string) (float64, error)
- func (s *StubProvider) GetFloatSlice(id string) ([]float64, error)
- func (s *StubProvider) GetInt(id string) (int, error)
- func (s *StubProvider) GetIntSlice(id string) ([]int, error)
- func (s *StubProvider) GetSetting(_ string) (settings.Setting, error)
- func (s *StubProvider) GetSettingValue(_ string) (any, error)
- func (s *StubProvider) GetString(id string) (string, error)
- func (s *StubProvider) GetStringSlice(id string) ([]string, error)
- func (s *StubProvider) Initialize(_ context.Context, _ ...settings.Category) error
- func (s *StubProvider) ListSettings() settings.Store
- func (s *StubProvider) LoadSettings() error
- func (s *StubProvider) RegisterChangeHandler(categoryID string, fn settings.CategoryChangeFunc)
- func (s *StubProvider) RegisterSetting(_ string, _ settings.Setting) error
- func (s *StubProvider) RegisterSettings(_ string, _ ...settings.Setting) error
- func (s *StubProvider) ResetSetting(_ string) error
- func (s *StubProvider) SaveSettings() error
- func (s *StubProvider) SetSetting(_ string, _ any) error
- func (s *StubProvider) SetSettings(_ map[string]any) error
- func (s *StubProvider) TriggerChange(categoryID string, vals map[string]any)
- func (s *StubProvider) Values() map[string]any
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type StubProvider ¶
type StubProvider struct {
Strings map[string]string
StringSlices map[string][]string
Ints map[string]int
IntSlices map[string][]int
Floats map[string]float64
FloatSlices map[string][]float64
Bools map[string]bool
Values_ map[string]any
// contains filtered or unexported fields
}
StubProvider implements settings.Provider with canned return values. All methods return zero values by default. Populate the map fields to make specific getters return data.
Usage:
sp := &settingstest.StubProvider{
StringSlices: map[string][]string{"kubeconfigs": {"/path"}},
}
func (*StubProvider) GetCategories ¶
func (s *StubProvider) GetCategories() []settings.Category
func (*StubProvider) GetCategory ¶
func (s *StubProvider) GetCategory(_ string) (settings.Category, error)
func (*StubProvider) GetCategoryValues ¶
func (s *StubProvider) GetCategoryValues(_ string) (map[string]interface{}, error)
func (*StubProvider) GetFloatSlice ¶
func (s *StubProvider) GetFloatSlice(id string) ([]float64, error)
func (*StubProvider) GetIntSlice ¶
func (s *StubProvider) GetIntSlice(id string) ([]int, error)
func (*StubProvider) GetSetting ¶
func (s *StubProvider) GetSetting(_ string) (settings.Setting, error)
func (*StubProvider) GetSettingValue ¶
func (s *StubProvider) GetSettingValue(_ string) (any, error)
func (*StubProvider) GetStringSlice ¶
func (s *StubProvider) GetStringSlice(id string) ([]string, error)
func (*StubProvider) Initialize ¶
func (*StubProvider) ListSettings ¶
func (s *StubProvider) ListSettings() settings.Store
func (*StubProvider) LoadSettings ¶
func (s *StubProvider) LoadSettings() error
func (*StubProvider) RegisterChangeHandler ¶ added in v0.3.0
func (s *StubProvider) RegisterChangeHandler(categoryID string, fn settings.CategoryChangeFunc)
func (*StubProvider) RegisterSetting ¶
func (s *StubProvider) RegisterSetting(_ string, _ settings.Setting) error
func (*StubProvider) RegisterSettings ¶
func (s *StubProvider) RegisterSettings(_ string, _ ...settings.Setting) error
func (*StubProvider) ResetSetting ¶
func (s *StubProvider) ResetSetting(_ string) error
func (*StubProvider) SaveSettings ¶
func (s *StubProvider) SaveSettings() error
func (*StubProvider) SetSetting ¶
func (s *StubProvider) SetSetting(_ string, _ any) error
func (*StubProvider) SetSettings ¶
func (s *StubProvider) SetSettings(_ map[string]any) error
func (*StubProvider) TriggerChange ¶ added in v0.3.0
func (s *StubProvider) TriggerChange(categoryID string, vals map[string]any)
TriggerChange invokes the registered change handler for the given category with the provided values. Safe for concurrent use.
func (*StubProvider) Values ¶
func (s *StubProvider) Values() map[string]any
Click to show internal directories.
Click to hide internal directories.