qaengine

Documentation

Overview

Package qaengine contains the types used for the question answering part of the CLI.

Index

• Constants
• type Cache
  • func NewCache(file string) (cache *Cache)
  • func (cache *Cache) AddSolution(p Problem) error
  • func (cache *Cache) GetSolution(p Problem) (ans Problem, err error)
  • func (cache *Cache) Load() error
  • func (cache *Cache) Write() error
• type CacheSpec
• type Config
  • func NewConfig(outputPath string, configStrings, configFiles []string) (config *Config)
  • func (c *Config) AddSolution(p Problem) error
  • func (c *Config) GetSolution(p Problem) (Problem, error)
  • func (c *Config) Load() (err error)
  • func (c *Config) Write() error
• type Problem
  • func NewConfirmProblem(probid, desc string, context []string, def bool) (p Problem, err error)
  • func NewInputProblem(probid, desc string, context []string, def string) (p Problem, err error)
  • func NewMultiSelectProblem(probid, desc string, context []string, def []string, opts []string) (p Problem, err error)
  • func NewMultilineInputProblem(probid, desc string, context []string, def string) (p Problem, err error)
  • func NewPasswordProblem(probid, desc string, context []string) (p Problem, err error)
  • func NewSelectProblem(probid, desc string, context []string, def string, opts []string) (p Problem, err error)
  • func (p *Problem) GetBoolAnswer() (ans bool, err error)
  • func (p *Problem) GetSliceAnswer() (ans []string, err error)
  • func (p *Problem) GetStringAnswer() (ans string, err error)
  • func (p *Problem) SetAnswer(ans []string) error
• type SolutionForm
• type SolutionFormType
• type Store

Constants

const (
	// OtherAnswer - Use as one of the answers, when there is a option to enter the answer in Select Question Type
	OtherAnswer = "Other (specify custom option)"
)

const QACacheKind types.Kind = "QACache"

QACacheKind defines kind of QA Cache

Types

type Cache

type Cache struct {
	types.TypeMeta   `yaml:",inline"`
	types.ObjectMeta `yaml:"metadata,omitempty"`
	Spec             CacheSpec `yaml:"spec,omitempty"`
}

Cache stores the answers for reuse

func NewCache

func NewCache(file string) (cache *Cache)

NewCache creates new cache instance

func (*Cache) AddSolution

func (cache *Cache) AddSolution(p Problem) error

AddSolution adds a problem to solution cache

func (*Cache) GetSolution

func (cache *Cache) GetSolution(p Problem) (ans Problem, err error)

GetSolution reads a solution for the problem

func (*Cache) Load

func (cache *Cache) Load() error

Load loads and merges cache

func (*Cache) Write

func (cache *Cache) Write() error

Write writes cache to disk

type CacheSpec

type CacheSpec struct {

	// Problems stores the list of problems with resolutions
	Problems []Problem `yaml:"solutions"`
	// contains filtered or unexported fields
}

CacheSpec stores the cache data

type Config

type Config struct {
	OutputPath string
	// contains filtered or unexported fields
}

Config stores the answers in a yaml file

func NewConfig

func NewConfig(outputPath string, configStrings, configFiles []string) (config *Config)

NewConfig creates a new config instance given config strings and paths to config files

func (*Config) AddSolution

func (c *Config) AddSolution(p Problem) error

AddSolution adds a problem to the config

func (*Config) GetSolution

func (c *Config) GetSolution(p Problem) (Problem, error)

GetSolution reads a solution from the config

func (*Config) Load

func (c *Config) Load() (err error)

Load loads and merges config files and strings

func (*Config) Write

func (c *Config) Write() error

Write writes the config to disk

type Problem

type Problem struct {
	ID       string       `yaml:"id,omitempty" json:"id,omitempty"`
	Desc     string       `yaml:"description,omitempty" json:"description,omitempty"`
	Context  []string     `yaml:"context,omitempty" json:"context,omitempty"`
	Solution SolutionForm `yaml:"solution" json:"solution,omitempty"`
	Resolved bool         `yaml:"resolved,omitempty" json:"resolved,omitempty"`
}

Problem defines the QA problem

func NewConfirmProblem

func NewConfirmProblem(probid, desc string, context []string, def bool) (p Problem, err error)

NewConfirmProblem creates a new instance of confirm problem

func NewInputProblem

func NewInputProblem(probid, desc string, context []string, def string) (p Problem, err error)

NewInputProblem creates a new instance of input problem

func NewMultiSelectProblem

func NewMultiSelectProblem(probid, desc string, context []string, def []string, opts []string) (p Problem, err error)

NewMultiSelectProblem creates a new instance of multiselect problem

func NewMultilineInputProblem

func NewMultilineInputProblem(probid, desc string, context []string, def string) (p Problem, err error)

NewMultilineInputProblem creates a new instance of multiline input problem

func NewPasswordProblem

func NewPasswordProblem(probid, desc string, context []string) (p Problem, err error)

NewPasswordProblem creates a new instance of password problem

func NewSelectProblem

func NewSelectProblem(probid, desc string, context []string, def string, opts []string) (p Problem, err error)

NewSelectProblem creates a new instance of select problem

func (*Problem) GetBoolAnswer

func (p *Problem) GetBoolAnswer() (ans bool, err error)

GetBoolAnswer returns a bool as answer if the solution type supports it

func (*Problem) GetSliceAnswer

func (p *Problem) GetSliceAnswer() (ans []string, err error)

GetSliceAnswer returns a slice as answer if the solution type supports it

func (*Problem) GetStringAnswer

func (p *Problem) GetStringAnswer() (ans string, err error)

GetStringAnswer returns a string as answer if the solution type supports it

func (*Problem) SetAnswer

func (p *Problem) SetAnswer(ans []string) error

SetAnswer sets the answer

type SolutionForm

type SolutionForm struct {
	Type    SolutionFormType `yaml:"type,omitempty" json:"type,omitempty"`
	Default []string         `yaml:"default,omitempty" json:"default,omitempty"`
	Options []string         `yaml:"options,omitempty" json:"options,omitempty"`
	Answer  []string         `yaml:"answer" json:"answer"`
}

SolutionForm defines the solution

type SolutionFormType

type SolutionFormType string

SolutionFormType is the type that defines different types of solutions possible

const (
	// SelectSolutionFormType defines a single select solution type
	SelectSolutionFormType SolutionFormType = "Select"
	// MultiSelectSolutionFormType defines a multi-select solution type
	MultiSelectSolutionFormType SolutionFormType = "MultiSelect"
	// InputSolutionFormType allows single line user input
	InputSolutionFormType SolutionFormType = "Input"
	// MultilineSolutionFormType allows multiple user input
	MultilineSolutionFormType SolutionFormType = "MultiLine"
	// PasswordSolutionFormType allows password entry
	PasswordSolutionFormType SolutionFormType = "Password"
	// ConfirmSolutionFormType allows yes/no answers
	ConfirmSolutionFormType SolutionFormType = "Confirm"
)

type Store

type Store interface {
	Load() error
	GetSolution(Problem) (Problem, error)

	Write() error
	AddSolution(p Problem) error
}

Store helps store answers