ui

package
v0.25.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 13, 2019 License: AGPL-3.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

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

	SuccMark = "✓"
	FailMark = "✗"
)

Variables

View Source 
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.
)
View Source 
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")
)
View Source 
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 added in v0.18.0 

func DisplayNameForMetric(m *stats.Metric) string

func Dump added in v0.18.0 

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

func IndentForMetric added in v0.18.0 

func IndentForMetric(m *stats.Metric) string

func NonTrendMetricValueForSum added in v0.18.0 

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

func StrWidth added in v0.18.0 

func StrWidth(s string) (n int)

Returns the actual width of the string.

func Summarize added in v0.18.0 

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

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

func SummarizeCheck added in v0.18.0 

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

func SummarizeGroup added in v0.18.0 

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

func SummarizeMetrics added in v0.18.0 

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

func UpdateTrendColumns added in v0.19.0 

func UpdateTrendColumns(stats []string)

UpdateTrendColumns updates the default trend columns with user defined ones

func VerifyTrendColumnStat added in v0.19.0 

func VerifyTrendColumnStat(stat string) error

VerifyTrendColumnStat checks if stat is a valid trend column

Types

type Field added in v0.16.0 

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.
	GetContents(io.Reader) (string, error) // Read the field contents from the supplied reader

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

A Field in a form.

type Form added in v0.16.0 

type Form struct {
	Banner string
	Fields []Field
}

A Form used to handle user interactions.

func (Form) Run added in v0.16.0 

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

Run executes the form against the specified input and output.

type PasswordField added in v0.23.0 

type PasswordField struct {
	Key   string
	Label string
	Min   int
}

PasswordField masks password input

func (PasswordField) Clean added in v0.23.0 

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

Clean just checks if the minimum length is exceeded, it doesn't trim the string!

func (PasswordField) GetContents added in v0.23.0 

func (f PasswordField) GetContents(r io.Reader) (string, error)

GetContents simply reads a string in cleartext from the supplied reader

func (PasswordField) GetKey added in v0.23.0 

func (f PasswordField) GetKey() string

GetKey returns the field's key

func (PasswordField) GetLabel added in v0.23.0 

func (f PasswordField) GetLabel() string

GetLabel returns the field's label

func (PasswordField) GetLabelExtra added in v0.23.0 

func (f PasswordField) GetLabelExtra() string

GetLabelExtra doesn't return anything so we don't expose the current password

type ProgressBar 

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

func (ProgressBar) String 

func (b ProgressBar) String() string

type StringField added in v0.16.0 

type StringField struct {
	Key     string
	Label   string
	Default string

	// Length constraints.
	Min, Max int
}

StringField is just a simple field for reading cleartext strings

func (StringField) Clean added in v0.16.0 

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

Clean trims the spaces in the string and checks for min and max length

func (StringField) GetContents added in v0.23.0 

func (f StringField) GetContents(r io.Reader) (string, error)

GetContents simply reads a string in cleartext from the supplied reader It's compllicated and doesn't use t he bufio utils because we can't read ahead of the newline and consume more of the stdin, because we'll mess up the next form field

func (StringField) GetKey added in v0.16.0 

func (f StringField) GetKey() string

GetKey returns the field's key

func (StringField) GetLabel added in v0.16.0 

func (f StringField) GetLabel() string

GetLabel returns the field's label

func (StringField) GetLabelExtra added in v0.16.0 

func (f StringField) GetLabelExtra() string

GetLabelExtra returns the field's default value

type SummaryData added in v0.18.0 

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 added in v0.18.0 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.