ui

Documentation

Index

• Constants
• Variables
• func DisplayNameForMetric(m *stats.Metric) string
• func Dump(w io.Writer, v interface{})
• func IndentForMetric(m *stats.Metric) string
• func NonTrendMetricValueForSum(t time.Duration, m *stats.Metric) (data string, extra []string)
• func StrWidth(s string) (n int)
• func Summarize(w io.Writer, indent string, data SummaryData)
• func SummarizeCheck(w io.Writer, indent string, check *lib.Check)
• func SummarizeGroup(w io.Writer, indent string, group *lib.Group)
• func SummarizeMetrics(w io.Writer, indent string, t time.Duration, metrics map[string]*stats.Metric)
• func UpdateTrendColumns(stats []string)
• func VerifyTrendColumnStat(stat string) error
• type Field
• type Form
  • func (f Form) Run(r io.Reader, w io.Writer) (map[string]interface{}, error)
• type ProgressBar
  • func (b ProgressBar) String() string
• type StringField
  • func (f StringField) Clean(s string) (interface{}, error)
  • func (f StringField) GetKey() string
  • func (f StringField) GetLabel() string
  • func (f StringField) GetLabelExtra() string
• type SummaryData
• type TrendColumn

Constants

const (
	GroupPrefix   = "█"
	DetailsPrefix = "↳"

	SuccMark = "✓"
	FailMark = "✗"
)

Variables

var (
	StdColor   = color.New()            // Default color.
	ErrorColor = color.New(color.FgRed) // Errors.

	SuccColor     = color.New(color.FgGreen)             // Successful stuff.
	FailColor     = color.New(color.FgRed)               // Failed stuff.
	GrayColor     = color.New(color.Faint)               // Padding and disabled stuff.
	ValueColor    = color.New(color.FgCyan)              // Values of all kinds.
	ExtraColor    = color.New(color.FgCyan, color.Faint) // Extra annotations for values.
	ExtraKeyColor = color.New(color.Faint)               // Keys inside extra annotations.

	TypeColor    = color.New(color.FgYellow) // Syntax: Types.
	CommentColor = color.New(color.FgBlue)   // Syntax: Comments.
)

var (
	ErrStatEmptyString            = errors.New("Invalid stat, empty string")
	ErrStatUnknownFormat          = errors.New("Invalid stat, unknown format")
	ErrPercentileStatInvalidValue = errors.New("Invalid percentile stat value, accepts a number")
)

var TrendColumns = []TrendColumn{
	{"avg", func(s *stats.TrendSink) float64 { return s.Avg }},
	{"min", func(s *stats.TrendSink) float64 { return s.Min }},
	{"med", func(s *stats.TrendSink) float64 { return s.Med }},
	{"max", func(s *stats.TrendSink) float64 { return s.Max }},
	{"p(90)", func(s *stats.TrendSink) float64 { return s.P(0.90) }},
	{"p(95)", func(s *stats.TrendSink) float64 { return s.P(0.95) }},
}

Functions

func DisplayNameForMetric

func DisplayNameForMetric(m *stats.Metric) string

func Dump

func Dump(w io.Writer, v interface{})

func IndentForMetric

func IndentForMetric(m *stats.Metric) string

func NonTrendMetricValueForSum

func NonTrendMetricValueForSum(t time.Duration, m *stats.Metric) (data string, extra []string)

func StrWidth

func StrWidth(s string) (n int)

Returns the actual width of the string.

func Summarize

func Summarize(w io.Writer, indent string, data SummaryData)

Summarizes a dataset and returns whether the test run was considered a success.

func SummarizeCheck

func SummarizeCheck(w io.Writer, indent string, check *lib.Check)

func SummarizeGroup

func SummarizeGroup(w io.Writer, indent string, group *lib.Group)

func SummarizeMetrics

func SummarizeMetrics(w io.Writer, indent string, t time.Duration, metrics map[string]*stats.Metric)

func UpdateTrendColumns

func UpdateTrendColumns(stats []string)

UpdateTrendColumns updates the default trend columns with user defined ones

func VerifyTrendColumnStat

func VerifyTrendColumnStat(stat string) error

VerifyTrendColumnStat checks if stat is a valid trend column

Types

type Field

type Field interface {
	GetKey() string        // Key for the data map.
	GetLabel() string      // Label to print as the prompt.
	GetLabelExtra() string // Extra info for the label, eg. defaults.

	// Sanitize user input and return the field's native type.
	Clean(s string) (interface{}, error)
}

A Field in a form.

type Form

type Form struct {
	Banner string
	Fields []Field
}

A Form used to handle user interactions.

func (Form) Run

func (f Form) Run(r io.Reader, w io.Writer) (map[string]interface{}, error)

Runs the form against the specified input and output.

type ProgressBar

type ProgressBar struct {
	Width       int
	Progress    float64
	Left, Right func() string
}

func (ProgressBar) String

func (b ProgressBar) String() string

type StringField

type StringField struct {
	Key     string
	Label   string
	Default string

	// Length constraints.
	Min, Max int
}

func (StringField) Clean

func (f StringField) Clean(s string) (interface{}, error)

func (StringField) GetKey

func (f StringField) GetKey() string

func (StringField) GetLabel

func (f StringField) GetLabel() string

func (StringField) GetLabelExtra

func (f StringField) GetLabelExtra() string

type SummaryData

type SummaryData struct {
	Opts    lib.Options
	Root    *lib.Group
	Metrics map[string]*stats.Metric
	Time    time.Duration
}

SummaryData represents data passed to Summarize.

type TrendColumn

type TrendColumn struct {
	Key string
	Get func(s *stats.TrendSink) float64
}