gospec

package
v0.0.0-...-a210816 Latest Latest
Warning

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

Go to latest
Published: Jul 31, 2014 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ALL printMode = iota
	ONLY_FAILING
)

Variables

This section is empty.

Functions

func Contains

func Contains(actual_ interface{}, expected interface{}) (match bool, pos Message, neg Message, err error)

The actual collection must contain the expected value.

func ContainsAll

func ContainsAll(actual_ interface{}, expected_ interface{}) (match bool, pos Message, neg Message, err error)

The actual collection must contain all expected elements, but it may contain also other non-expected elements. The order of elements is not significant.

func ContainsAny

func ContainsAny(actual_ interface{}, expected_ interface{}) (match bool, pos Message, neg Message, err error)

The actual collection must contain at least one of the expected elements.

func ContainsExactly

func ContainsExactly(actual_ interface{}, expected_ interface{}) (match bool, pos Message, neg Message, err error)

The actual collection must contain all expected elements and nothing else. The order of elements is not significant.

func ContainsInOrder

func ContainsInOrder(actual_ interface{}, expected_ interface{}) (match bool, pos Message, neg Message, err error)

The actual collection must contain all expected elements, in the same order, and nothing else.

func ContainsInPartialOrder

func ContainsInPartialOrder(actual_ interface{}, expected_ interface{}) (match bool, pos Message, neg Message, err error)

The actual collection must contain all expected objects, in the same order, but it may contain also other non-expected objects. For example [1, 2, 2, 3, 4] contains in partial order [1, 2, 3]. See http://en.wikipedia.org/wiki/Partial_order for further information.

func Equals

func Equals(actual interface{}, expected interface{}) (match bool, pos Message, neg Message, err error)

The actual value must equal the expected value. For primitives the equality operator is used. All other objects must implement the Equality interface.

func Errorf

func Errorf(format string, args ...interface{}) error

Constructs an error message the same way as fmt.Sprintf(), but the string is created lazily when it is used, if it is used at all. This avoids unnecessary string parsing in matchers, because most of the time there are no failures and thus the error messages are not used.

func IsFalse

func IsFalse(actual interface{}, _ interface{}) (match bool, pos Message, neg Message, err error)

The actual value must be <false>.

func IsNil

func IsNil(actual interface{}, _ interface{}) (match bool, pos Message, neg Message, err error)

The actual value must be <nil>, or a typed nil pointer inside an interface value. See http://groups.google.com/group/golang-nuts/browse_thread/thread/d900674d491ef8d for discussion on how in Go typed nil values can turn into non-nil interface values.

func IsSame

func IsSame(actual interface{}, expected interface{}) (match bool, pos Message, neg Message, err error)

The actual value must be a pointer to the same object as the expected value.

func IsTrue

func IsTrue(actual interface{}, _ interface{}) (match bool, pos Message, neg Message, err error)

The actual value must be <true>.

func Main

func Main(runner *Runner)

Executes the specs which have been added to the Runner and prints the results to stdout. Exits the process after it is finished - with zero or non-zero exit value, depending on whether any specs failed.

func MainGoTest

func MainGoTest(runner *Runner, t *testing.T)

Executes the specs which have been added to the Runner and prints the results to stdout. Fails the surrounding test if any of the specs fails.

func Satisfies

func Satisfies(actual interface{}, criteria interface{}) (match bool, pos Message, neg Message, err error)

The actual value must satisfy the given criteria.

func Values

func Values(values ...interface{}) []interface{}

Easy array creation, to give multiple expected values to a matcher.

Types

type Context

type Context interface {

	// Creates a child spec for the currently executing spec. Specs can be
	// nested unlimitedly. The name should describe what is the behaviour being
	// specified by this spec, and the closure should express the same
	// specification as code.
	Specify(name string, closure func())

	// Makes an expectation. For example:
	//    c.Expect(theAnswer, Equals, 42)
	//    c.Expect(theAnswer, Not(Equals), 666)
	//    c.Expect(thereIsASpoon, IsFalse)
	Expect(actual interface{}, matcher Matcher, expected ...interface{})

	// Makes an assumption. Otherwise the same as an expectation,
	// but on failure will not continue executing the child specs.
	Assume(actual interface{}, matcher Matcher, expected ...interface{})
}

Context controls the execution of the current spec. Child specs can be created with the Specify method.

type Equality

type Equality interface {
	Equals(other interface{}) bool
}

type Error

type Error struct {
	Type       ErrorType
	Message    string
	Actual     string
	StackTrace []*Location
}

func (*Error) String

func (this *Error) String() string

type ErrorType

type ErrorType int
const (
	ExpectFailed ErrorType = iota
	AssumeFailed
	OtherError
)

type Location

type Location struct {
	// contains filtered or unexported fields
}

func (*Location) File

func (this *Location) File() string

func (*Location) FileName

func (this *Location) FileName() string

func (*Location) Line

func (this *Location) Line() int

func (*Location) Name

func (this *Location) Name() string

func (*Location) String

func (this *Location) String() string

type Matcher

type Matcher func(actual interface{}, expected interface{}) (match bool, pos Message, neg Message, err error)

Matchers are used in expectations to compare the actual and expected values.

Return values:

match: Should be true when `actual` and `expected` match, otherwise false.
pos:   Message for a failed expectation.
neg:   Message for a failed expectation when the matcher is combined with Not.
err:   Message for an unrecoverable error, for example if the arguments had a wrong type.

func IsWithin

func IsWithin(delta float64) Matcher

The actual value must be within delta from the expected value.

func Not

func Not(matcher Matcher) Matcher

Negates the meaning of a Matcher. Matches when the original matcher does not match, and the other way around.

func (Matcher) Match

func (matcher Matcher) Match(actual interface{}, optionalExpected ...interface{}) (match bool, pos Message, neg Message, err error)

Calls the matcher with the actual value and an optional expected value. If no expected value is given, then <nil> will be used.

type Message

type Message interface {
	Actual() interface{}
	Expectation() string
}

func Messagef

func Messagef(actual interface{}, expectationFormat string, expectationArgs ...interface{}) Message

type PrintFormat

type PrintFormat interface {
	PrintPassing(nestingLevel int, name string)
	PrintFailing(nestingLevel int, name string, errors []*Error)
	PrintSummary(passCount int, failCount int)
}

func DefaultPrintFormat

func DefaultPrintFormat(out io.Writer) PrintFormat

PrintFormat for production use.

func SimplePrintFormat

func SimplePrintFormat(out io.Writer) PrintFormat

PrintFormat for use in only tests. Does not print line numbers, colors or other fancy stuff. Makes comparing as a string easier.

type Printer

type Printer struct {
	// contains filtered or unexported fields
}

Printer formats the spec results into a human-readable format.

func NewPrinter

func NewPrinter(format PrintFormat) *Printer

func (*Printer) HideSummary

func (this *Printer) HideSummary()

func (*Printer) ShowAll

func (this *Printer) ShowAll()

func (*Printer) ShowOnlyFailing

func (this *Printer) ShowOnlyFailing()

func (*Printer) ShowSummary

func (this *Printer) ShowSummary()

func (*Printer) VisitEnd

func (this *Printer) VisitEnd(passCount int, failCount int)

func (*Printer) VisitSpec

func (this *Printer) VisitSpec(nestingLevel int, name string, errors []*Error)

type ResultCollector

type ResultCollector struct {
	// contains filtered or unexported fields
}

Collects test results for all specs in a reporting friendly format.

func (*ResultCollector) FailCount

func (r *ResultCollector) FailCount() int

func (*ResultCollector) PassCount

func (r *ResultCollector) PassCount() int

func (*ResultCollector) TotalCount

func (r *ResultCollector) TotalCount() int

func (*ResultCollector) Update

func (r *ResultCollector) Update(spec *specRun)

func (*ResultCollector) Visit

func (r *ResultCollector) Visit(visitor ResultVisitor)

type ResultVisitor

type ResultVisitor interface {
	VisitSpec(nestingLevel int, name string, errors []*Error)
	VisitEnd(passCount int, failCount int)
}

type Runner

type Runner struct {
	// contains filtered or unexported fields
}

Runner executes the specs and collects their results.

func NewRunner

func NewRunner() *Runner

func (*Runner) AddNamedSpec

func (r *Runner) AddNamedSpec(name string, closure func(Context))

Adds a spec for later execution. Uses the provided name instead of retrieving the name of the spec function with reflection.

func (*Runner) AddSpec

func (r *Runner) AddSpec(closure func(Context))

Adds a spec for later execution. Example:

r.AddSpec(SomeSpec);

func (*Runner) Results

func (r *Runner) Results() *ResultCollector

func (*Runner) Run

func (r *Runner) Run()

Executes all the specs which have been added with AddSpec. The specs are executed using as many goroutines as possible, so that even individual spec methods are executed in multiple goroutines.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL