Skip to content

sittercity/gocumber

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gocumber

Build Status

Go code (golang) package that provides tools for defining and executing gherkin steps.

This uses the go-gherkin package by @muhqu. Thanks buddy!

Installation

To install:

go get github.com/sittercity/gocumber

Then import it like normal:

package <yourpackage>

import (
  "github.com/sittercity/gocumber"
)

Usage

General example:

func TestYourStuff(t *testing.T) {
  steps := make(gocumber.Definitions)

  steps.Given(`I have an existing user with name "(.*)"`, func(matches []string, _ gocumber.StepNode) {
    // your code to create a user, you can use 'matches[1]' to pull out the
    // name, like so: user_name := matches[1]
  })
}

Also allows for the execution of other defined steps:

func TestYourStuff(t *testing.T) {
  steps := make(gocumber.Definitions)

  steps.Given(`I have an existing user with name "(.*)"`, func(matches []string, _ gocumber.StepNode) {
    // User creation
  })

  steps.Given("I have an existing user", func([]string, gocumber.StepNode) {
    steps.Exec(`I have an existing user with name "some name"`)
  })

You can use When and Then like you would expect:

  steps.When("I view all users", func([]string, gocumber.StepNode) {
    // Do some view stuff
  })

  steps.Then("the user should be created", func([]string, gocumber.StepNode) {
    // check that the user is created
  })

If you would like to define data in a table you can access it with the following:

  steps.Given("I have an existing user with following data:", func(matches []string, step gocumber.StepNode) {
    inputData = make(map[string]string)
    for _, row := range step.Table().Rows() {
      inputData[row[0]] = row[1]
    }

    // Use the inputData map to access your data
  })

If you have gherkin that includes a JSON payload you can retrieve it like so:

  steps.Given("I create a user with the following data:", func(_ []string, step gocumber.StepNode) {
    payload := step.PyString().String()
    // Do stuff with your payload
  })

Once all of your steps are defined you run them at the end of your file:

steps.Run(t, "your_gherkin.feature")

A full example file with all of the above can be found in the example directory.

Running Tests

Couldn't be more simple:

  • run make setup - Downloads testing dependencies. This only needs to be run once.
  • run make test - Runs the actual tests (including test coverage).

About

Define and execute gherkin steps in Go

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •