ginkgo

README

Jump straight to the docs to learn more.

Feature List

• Ginkgo uses Go's testing package and can live alongside your existing testing tests. It's easy to bootstrap and start writing your first tests

• Structure your BDD-style tests expressively:

  • Nestable Describe and Context container blocks
  • BeforeEach and AfterEach blocks for setup and teardown
  • It blocks that hold your assertions
  • JustBeforeEach blocks that separate creation from configuration (also known as the subject action pattern).

• A comprehensive test runner that lets you:

  • Mark specs as pending
  • Focus individual specs, and groups of specs, either programmatically or on the command line
  • Run your tests in random order, and then reuse random seeds to replicate the same order.
  • Break up your test suite into parallel processes for straightforward test parallelization

• Built-in support for testing asynchronicity

• Built-in support for benchmarking your code. Control the number of benchmark samples as you gather runtimes and other, arbitrary, bits of numerical information about your code.

• ginkgo: a command line interface with plenty of handy command line arguments for running your tests and generating test files.

  The ginkgo CLI is convenient, but purely optional -- Ginkgo works just fine with go test

• A modular architecture that lets you easily:

  • Write custom reporters
  • Adapt an existing matcher library (or write your own!) to work with Ginkgo

Gomega: Ginkgo's Preferred Matcher Library

Learn more about Gomega here

License

Ginkgo is MIT-Licensed

Documentation

Index

• Constants
• func AfterEach(body interface{}, timeout ...float64) bool
• func BeforeEach(body interface{}, timeout ...float64) bool
• func Context(text string, body func()) bool
• func Describe(text string, body func()) bool
• func FContext(text string, body func()) bool
• func FDescribe(text string, body func()) bool
• func FIt(text string, body interface{}, timeout ...float64) bool
• func FMeasure(text string, body func(Benchmarker), samples int) bool
• func Fail(message string, callerSkip ...int)
• func It(text string, body interface{}, timeout ...float64) bool
• func JustBeforeEach(body interface{}, timeout ...float64) bool
• func Measure(text string, body func(Benchmarker), samples int) bool
• func PContext(text string, body func()) bool
• func PDescribe(text string, body func()) bool
• func PIt(text string, body interface{}, timeout ...float64) bool
• func PMeasure(text string, body func(Benchmarker), samples int) bool
• func RunSpecs(t *testing.T, description string)
• func RunSpecsWithCustomReporters(t *testing.T, description string, specReporters []Reporter)
• func RunSpecsWithDefaultAndCustomReporters(t *testing.T, description string, specReporters []Reporter)
• func XContext(text string, body func()) bool
• func XDescribe(text string, body func()) bool
• func XIt(text string, body interface{}, timeout ...float64) bool
• func XMeasure(text string, body func(Benchmarker), samples int) bool
• type Benchmarker
• type Done
• type Reporter

Constants

const GINKGO_VERSION = config.VERSION

Functions

func AfterEach

func AfterEach(body interface{}, timeout ...float64) bool

func BeforeEach

func BeforeEach(body interface{}, timeout ...float64) bool

func Context

func Context(text string, body func()) bool

func Describe

func Describe(text string, body func()) bool

func FContext

func FContext(text string, body func()) bool

func FDescribe

func FDescribe(text string, body func()) bool

func FIt

func FIt(text string, body interface{}, timeout ...float64) bool

func FMeasure

func FMeasure(text string, body func(Benchmarker), samples int) bool

func Fail

func Fail(message string, callerSkip ...int)

func It

func It(text string, body interface{}, timeout ...float64) bool

func JustBeforeEach

func JustBeforeEach(body interface{}, timeout ...float64) bool

func Measure

func Measure(text string, body func(Benchmarker), samples int) bool

func PContext

func PContext(text string, body func()) bool

func PDescribe

func PDescribe(text string, body func()) bool

func PIt

func PIt(text string, body interface{}, timeout ...float64) bool

func PMeasure

func PMeasure(text string, body func(Benchmarker), samples int) bool

func RunSpecs

func RunSpecs(t *testing.T, description string)

func RunSpecsWithCustomReporters

func RunSpecsWithCustomReporters(t *testing.T, description string, specReporters []Reporter)

func RunSpecsWithDefaultAndCustomReporters

func RunSpecsWithDefaultAndCustomReporters(t *testing.T, description string, specReporters []Reporter)

func XContext

func XContext(text string, body func()) bool

func XDescribe

func XDescribe(text string, body func()) bool

func XIt

func XIt(text string, body interface{}, timeout ...float64) bool

func XMeasure

func XMeasure(text string, body func(Benchmarker), samples int) bool

Types

type Benchmarker

type Benchmarker interface {
	Time(name string, body func(), info ...interface{}) (elapsedTime time.Duration)
	RecordValue(name string, value float64, info ...interface{})
}

type Done

type Done chan<- interface{}

type Reporter

type Reporter interface {
	SpecSuiteWillBegin(config config.GinkgoConfigType, summary *types.SuiteSummary)
	ExampleWillRun(exampleSummary *types.ExampleSummary)
	ExampleDidComplete(exampleSummary *types.ExampleSummary)
	SpecSuiteDidEnd(summary *types.SuiteSummary)
}