qaengine

Documentation

Overview

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

Index

• Constants
• func ArrayToInterface(ans []string, problemType SolutionFormType) (ansI interface{}, err error)
• func GenerateYAMLFromExpression(expr string) (string, error)
• func InterfaceToArray(ansI interface{}, problemType SolutionFormType) (ans []string, err error)
• func MergeYAMLDatasIntoMap(yamlDatas []string) (mapT, error)
• type Cache
  • func NewCache(file string, persistPasswords bool) (cache *Cache)
  • func (cache *Cache) AddSolution(p Problem) error
  • func (cache *Cache) GetSolution(p Problem) (Problem, error)
  • func (cache *Cache) Load() error
  • func (cache *Cache) Write() error
• type CacheSpec
• type Config
  • func NewConfig(outputPath string, configStrings, configFiles []string, persistPasswords bool) (config *Config)
  • func (c *Config) AddSolution(p Problem) error
  • func (c *Config) Get(key string) (value interface{}, ok bool)
  • 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, hints []string, def bool, ...) (Problem, error)
  • func NewInputProblem(probid, desc string, hints []string, def string, ...) (Problem, error)
  • func NewMultiSelectProblem(probid, desc string, hints []string, def []string, opts []string, ...) (Problem, error)
  • func NewMultilineInputProblem(probid, desc string, hints []string, def string, ...) (Problem, error)
  • func NewPasswordProblem(probid, desc string, hints []string, validator func(interface{}) error) (p Problem, err error)
  • func NewProblem(p *qagrpc.Problem) (prob Problem, err error)
  • func NewSelectProblem(probid, desc string, hints []string, def string, opts []string, ...) (Problem, error)
  • func (p *Problem) SetAnswer(ansI interface{}, validate bool) error
• type SolutionFormType
• type Store
• type ValidationError
  • func (v *ValidationError) Error() string

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

Functions

func ArrayToInterface

func ArrayToInterface(ans []string, problemType SolutionFormType) (ansI interface{}, err error)

ArrayToInterface converts the answer array to interface

func GenerateYAMLFromExpression

func GenerateYAMLFromExpression(expr string) (string, error)

GenerateYAMLFromExpression generates yaml string from yq syntax expression Example: The expression .foo.bar="abc" gives: foo:

bar: abc

func InterfaceToArray

func InterfaceToArray(ansI interface{}, problemType SolutionFormType) (ans []string, err error)

InterfaceToArray converts the answer interface to array

func MergeYAMLDatasIntoMap

func MergeYAMLDatasIntoMap(yamlDatas []string) (mapT, error)

MergeYAMLDatasIntoMap merges multiple yamls together into a map. Later yamls will override earlier yamls.

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, persistPasswords bool) (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) (Problem, 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, persistPasswords bool) (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) Get

func (c *Config) Get(key string) (value interface{}, ok bool)

Get returns the value at the position given by the key in 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" json:"id"`
	Type      SolutionFormType        `yaml:"type,omitempty" json:"type,omitempty"`
	Desc      string                  `yaml:"description,omitempty" json:"description,omitempty"`
	Hints     []string                `yaml:"hints,omitempty" json:"hints,omitempty"`
	Options   []string                `yaml:"options,omitempty" json:"options,omitempty"`
	Default   interface{}             `yaml:"default,omitempty" json:"default,omitempty"`
	Answer    interface{}             `yaml:"answer,omitempty" json:"answer,omitempty"`
	Validator func(interface{}) error `yaml:"-" json:"-"`
}

Problem defines the QA problem

func NewConfirmProblem

func NewConfirmProblem(probid, desc string, hints []string, def bool, validator func(interface{}) error) (Problem, error)

NewConfirmProblem creates a new instance of confirm problem

func NewInputProblem

func NewInputProblem(probid, desc string, hints []string, def string, validator func(interface{}) error) (Problem, error)

NewInputProblem creates a new instance of input problem

func NewMultiSelectProblem

func NewMultiSelectProblem(probid, desc string, hints []string, def []string, opts []string, validator func(interface{}) error) (Problem, error)

NewMultiSelectProblem creates a new instance of multiselect problem

func NewMultilineInputProblem

func NewMultilineInputProblem(probid, desc string, hints []string, def string, validator func(interface{}) error) (Problem, error)

NewMultilineInputProblem creates a new instance of multiline input problem

func NewPasswordProblem

func NewPasswordProblem(probid, desc string, hints []string, validator func(interface{}) error) (p Problem, err error)

NewPasswordProblem creates a new instance of password problem

func NewProblem

func NewProblem(p *qagrpc.Problem) (prob Problem, err error)

NewProblem creates a new problem object from a GRPC problem

func NewSelectProblem

func NewSelectProblem(probid, desc string, hints []string, def string, opts []string, validator func(interface{}) error) (Problem, error)

NewSelectProblem creates a new instance of select problem

func (*Problem) SetAnswer

func (p *Problem) SetAnswer(ansI interface{}, validate bool) error

SetAnswer sets the answer

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"
	// MultilineInputSolutionFormType allows multiple user input
	MultilineInputSolutionFormType SolutionFormType = "MultiLineInput"
	// 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

type ValidationError

type ValidationError struct {
	Reason string
}

ValidationError is the error while validating answer in QA Engine

func (*ValidationError) Error

func (v *ValidationError) Error() string