gobdd

README

GOBDD

This is a BDD testing framework. Uses gherkin for the test's syntax. Project is under active development.

More detailed documentation can be found on the docs page: https://go-bdd.github.io/doc/

Contributing

All contributions are very much welcome. If you'd like to help with GoBDD development, please see open issues and submit your pull request via GitHub.

Support

If you didn't find the answer to your question in the documentation, feel free to ask us directly!

Please join us on the #go-bdd-library channel on the Gophers slack: You can get an invite here. You can find updates about the progress on Twiter: GoBdd.

You can support my work using issuehunt or by buying me a coffee.

Documentation

Overview

This project is created as the alternative to https://github.com/DATA-DOG/godog and is inspirited by it. There are a few differences between both solutions:

- GoBDD uses the built-in testing framework

- GoBDD is run as standard test case (not a separate program)

- you can use every Go native feature like build tags, pprof and so on

- the context in every test case contains all the required information to run (values passed from previous steps or step parameters). More information can be found in the readme file https://github.com/go-bdd/gobdd/blob/master/README.md

Index

• type Suite
  • func NewSuite(t TestingT, options SuiteOptions) *Suite
  • func (s *Suite) AddRegexStep(expr *regexp.Regexp, step interface{})
  • func (s *Suite) AddStep(expr string, step interface{})
  • func (s *Suite) Run()
• type SuiteOptions
  • func NewSuiteOptions() SuiteOptions
  • func (options SuiteOptions) RunInParallel() SuiteOptions
  • func (options SuiteOptions) WithAfterScenario(f func()) SuiteOptions
  • func (options SuiteOptions) WithBeforeScenario(f func()) SuiteOptions
  • func (options SuiteOptions) WithFeaturesPath(path string) SuiteOptions
  • func (options SuiteOptions) WithIgnoredTags(tags []string) SuiteOptions
  • func (options SuiteOptions) WithTags(tags []string) SuiteOptions
• type TestingT

Types

type Suite

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

Holds all the information about the suite (options, steps to execute etc)

func NewSuite

func NewSuite(t TestingT, options SuiteOptions) *Suite

Creates a new suites with given configuration and empty steps defined

func (*Suite) AddRegexStep

func (s *Suite) AddRegexStep(expr *regexp.Regexp, step interface{})

AddRegexStep registers a step in the suite.

The second parameter is the step function that gets executed when a step definition matches the provided regular expression.

A step function can have any number of parameters (even zero), but it MUST accept a context.Context as the first parameter (if there is any) and MUST return a context and an error:

func myStepFunction(ctx context.Context, first int, second int) (context.Context, error) {
	return ctx, nil
}

func (*Suite) AddStep

func (s *Suite) AddStep(expr string, step interface{})

AddStep registers a step in the suite.

The second parameter is the step function that gets executed when a step definition matches the provided regular expression.

A step function can have any number of parameters (even zero), but it MUST accept a context.Context as the first parameter (if there is any) and MUST return a context and an error:

func myStepFunction(ctx context.Context, first int, second int) (context.Context, error) {
	return ctx, nil
}

func (*Suite) Run

func (s *Suite) Run()

Executes the suite with given options and defined steps

type SuiteOptions

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

Holds all the information about how the suite or features/steps should be configured

func NewSuiteOptions

func NewSuiteOptions() SuiteOptions

creates a new suite configuration with default values

func (SuiteOptions) RunInParallel

func (options SuiteOptions) RunInParallel() SuiteOptions

runs tests in parallel

func (SuiteOptions) WithAfterScenario

func (options SuiteOptions) WithAfterScenario(f func()) SuiteOptions

Configures functions that should be executed after every scenario

func (SuiteOptions) WithBeforeScenario

func (options SuiteOptions) WithBeforeScenario(f func()) SuiteOptions

Configures functions that should be executed before every scenario

func (SuiteOptions) WithFeaturesPath

func (options SuiteOptions) WithFeaturesPath(path string) SuiteOptions

Configures a pattern (regexp) where feature can be found. The default value is "features/*.feature"

func (SuiteOptions) WithIgnoredTags

func (options SuiteOptions) WithIgnoredTags(tags []string) SuiteOptions

Configures which tags should be skipped while executing a suite Every tag has to start with @ otherwise will be ignored

func (SuiteOptions) WithTags

func (options SuiteOptions) WithTags(tags []string) SuiteOptions

Configures which tags should be skipped while executing a suite Every tag has to start with @

type TestingT

type TestingT interface {
	Log(...interface{})
	Fatal(...interface{})
	Fatalf(string, ...interface{})
	Parallel()
	Fail()
	Run(name string, f func(t *testing.T)) bool
}