gospel

package module

v0.0.0-...-82b9a6c Latest Latest Go to latest Published: Oct 8, 2019 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/r7kamura/gospel

Links

Open Source Insights

README ¶

Gospel

BDD-style testing library for Golang.

Install

go get github.com/r7kamura/gospel

Usage

package main

import (
	. "github.com/r7kamura/gospel"
	"testing"
)

func TestDescribe(t *testing.T) {
	Describe(t, "Expectation#To", func() {
		Context("with Equal", func() {
			It("evaluates actual == expected", func() {
				Expect(1).To(Equal, 1)
			})
		})

		Context("with NotEqual", func() {
			Before(func() {
				// Called before each examples in this Context.
			})

			After(func() {
				// Called after each examples in this Context.
			})

			It("evaluates actual != expected", func() {
				Expect(1).To(NotEqual, 2)
			})
		})

		Context("with Exist", func() {
			It("evaluates actual != nil", func() {
				Expect(1).To(Exist)
			})
		})

		Context("with NotExist", func() {
			It("evaluates actual == nil", func() {
				Expect(nil).To(NotExist)
			})
		})
	})
}

$ go test

$ go test -v

Documentation ¶

Index ¶

Variables
func After(filter func())
func Before(filter func())
func Context(description string, callback func())
func Describe(t *testing.T, description string, callback func())
func Equal(values ...interface{}) (failureMessage string)
func Exist(values ...interface{}) (failureMessage string)
func It(message string, evaluator func())
func NotEqual(values ...interface{}) (failureMessage string)
func NotExist(values ...interface{}) (failureMessage string)
type DocumentFormatter
- func (formatter *DocumentFormatter) Failed(example *Example, message string)
- func (formatter *DocumentFormatter) Started(example *Example)
- func (formatter *DocumentFormatter) Succeeded(example *Example)
type DotFormatter
- func (formatter *DotFormatter) Failed(example *Example, message string)
- func (formatter *DotFormatter) Started(example *Example)
- func (formatter *DotFormatter) Succeeded(example *Example)
type Example
- func (example *Example) Descriptions() []string
- func (example *Example) Evaluate()
- func (example *Example) Failed(message string)
- func (example *Example) FullDescription() string
- func (example *Example) Run()
- func (example *Example) Started()
- func (example *Example) Succeeded()
type ExampleGroup
- func (group *ExampleGroup) Ancestors() []*ExampleGroup
- func (group *ExampleGroup) PrintResult()
- func (group *ExampleGroup) ReverseAncestors() []*ExampleGroup
- func (group *ExampleGroup) ReverseAncestorsAndSelf() []*ExampleGroup
- func (group *ExampleGroup) Root() *ExampleGroup
- func (group *ExampleGroup) RunAfterFilters()
- func (group *ExampleGroup) RunBeforeFilters()
type Expectation
- func Expect(actual interface{}) *Expectation
- func (expectation *Expectation) To(matcher Matcher, expected ...interface{})
type Formatter
type Matcher

Constants ¶

This section is empty.

Variables ¶

View Source

var Output = colorable.NewColorableStdout()

Functions ¶

func After ¶

func After(filter func())

func Before ¶

func Before(filter func())

func Context ¶

func Context(description string, callback func())

func Describe ¶

func Describe(t *testing.T, description string, callback func())

func Equal ¶

func Equal(values ...interface{}) (failureMessage string)

Checks if actual == expected.

func Exist ¶

func Exist(values ...interface{}) (failureMessage string)

Checks if actual != nil.

func It ¶

func It(message string, evaluator func())

func NotEqual ¶

func NotEqual(values ...interface{}) (failureMessage string)

Checks if actual != expected.

func NotExist ¶

func NotExist(values ...interface{}) (failureMessage string)

Checks if actual == nil.

Types ¶

type DocumentFormatter ¶

type DocumentFormatter struct{}

func (*DocumentFormatter) Failed ¶

func (formatter *DocumentFormatter) Failed(example *Example, message string)

func (*DocumentFormatter) Started ¶

func (formatter *DocumentFormatter) Started(example *Example)

func (*DocumentFormatter) Succeeded ¶

func (formatter *DocumentFormatter) Succeeded(example *Example)

type DotFormatter ¶

type DotFormatter struct{}

func (*DotFormatter) Failed ¶

func (formatter *DotFormatter) Failed(example *Example, message string)

func (*DotFormatter) Started ¶

func (formatter *DotFormatter) Started(example *Example)

Does nothing.

func (*DotFormatter) Succeeded ¶

func (formatter *DotFormatter) Succeeded(example *Example)

type Example ¶

type Example struct {
	*ExampleGroup
	Message    string
	Evaluator  func()
	HasFailure bool
	Formatter
}

func It() creates a new Example object.

func (*Example) Descriptions ¶

func (example *Example) Descriptions() []string

Returns its ExamplesGroups' descriptions as an array of string.

func (*Example) Evaluate ¶

func (example *Example) Evaluate()

Invokes its Evaluator function.

func (*Example) Failed ¶

func (example *Example) Failed(message string)

Called when any of expectations failed.

func (*Example) FullDescription ¶

func (example *Example) FullDescription() string

Returns its entire descriptions + message as a string.

func (*Example) Run ¶

func (example *Example) Run()

func It() calls this function to run the newly created example.

func (*Example) Started ¶

func (example *Example) Started()

Called when started.

func (*Example) Succeeded ¶

func (example *Example) Succeeded()

Called when all of expectations passed.

type ExampleGroup ¶

type ExampleGroup struct {
	*testing.T
	Parent        *ExampleGroup
	Description   string
	Result        string
	BeforeFilters []func()
	AfterFilters  []func()
}

Describe or Context creates this object.

func (*ExampleGroup) Ancestors ¶

func (group *ExampleGroup) Ancestors() []*ExampleGroup

Returns its ancestor ExampleGroups in ascending order according to distance.

func (*ExampleGroup) PrintResult ¶

func (group *ExampleGroup) PrintResult()

In non-verbose mode, we print test results for each Describe.

func (*ExampleGroup) ReverseAncestors ¶

func (group *ExampleGroup) ReverseAncestors() []*ExampleGroup

Returns its ancestor ExampleGroups in descending order according to distance.

func (*ExampleGroup) ReverseAncestorsAndSelf ¶

func (group *ExampleGroup) ReverseAncestorsAndSelf() []*ExampleGroup

Merges its ancestors and itself.

func (*ExampleGroup) Root ¶

func (group *ExampleGroup) Root() *ExampleGroup

Gets root ExampleGroup defined by Describe func.

func (*ExampleGroup) RunAfterFilters ¶

func (group *ExampleGroup) RunAfterFilters()

Runs all AfterFilters defined to its ancestors and itself.

func (*ExampleGroup) RunBeforeFilters ¶

func (group *ExampleGroup) RunBeforeFilters()

Runs all BeforeFilters defined to its ancestors and itself.

type Expectation ¶

type Expectation struct {
	*Example
	Actual interface{}
}

func Expect() creates a new Expectation object.

func Expect ¶

func Expect(actual interface{}) *Expectation

func (*Expectation) To ¶

func (expectation *Expectation) To(matcher Matcher, expected ...interface{})

Checks if a given matcher satisfies actual & optional values.

type Formatter ¶

type Formatter interface {
	Started(*Example)
	Failed(*Example, string)
	Succeeded(*Example)
}

type Matcher ¶

type Matcher func(...interface{}) string

Returns a non-empty failure message if given actual & optional values are not matched.

Source Files ¶

View all Source files

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