proftest

Documentation

Overview

Package proftest provides some utility routines to test other packages related to profiles.

Index

• func Diff(b1, b2 []byte) (data []byte, err error)
• func EncodeJSON(x interface{}) []byte
• type TestUI
  • func (ui *TestUI) IsTerminal() bool
  • func (ui *TestUI) Print(args ...interface{})
  • func (ui *TestUI) PrintErr(args ...interface{})
  • func (ui *TestUI) ReadLine(_ string) (string, error)
  • func (ui *TestUI) SetAutoComplete(_ func(string) string)
  • func (ui *TestUI) WantBrowser() bool

Functions

func Diff

func Diff(b1, b2 []byte) (data []byte, err error)

Diff compares two byte arrays using the diff tool to highlight the differences. It is meant for testing purposes to display the differences between expected and actual output.

func EncodeJSON

func EncodeJSON(x interface{}) []byte

EncodeJSON encodes a value into a byte array. This is intended for testing purposes.

Types

type TestUI

type TestUI struct {
	T                 *testing.T
	Ignore            int
	AllowRx           string
	NumAllowRxMatches int
	Input             []string
	// contains filtered or unexported fields
}

TestUI implements the plugin.UI interface, triggering test failures if more than Ignore errors not matching AllowRx are printed. Also tracks the number of times the error matches AllowRx in NumAllowRxMatches.

func (*TestUI) IsTerminal

func (ui *TestUI) IsTerminal() bool

IsTerminal indicates if the UI is an interactive terminal.

func (*TestUI) Print

func (ui *TestUI) Print(args ...interface{})

Print messages are discarded by the test UI.

func (*TestUI) PrintErr

func (ui *TestUI) PrintErr(args ...interface{})

PrintErr messages may trigger an error failure. A fixed number of error messages are permitted when appropriate.

func (*TestUI) ReadLine

func (ui *TestUI) ReadLine(_ string) (string, error)

ReadLine returns no input, as no input is expected during testing.

func (*TestUI) SetAutoComplete

func (ui *TestUI) SetAutoComplete(_ func(string) string)

SetAutoComplete is not supported by the test UI.

func (*TestUI) WantBrowser

func (ui *TestUI) WantBrowser() bool

WantBrowser indicates whether a browser should be opened with the -http option.