Skip to content

Releases: cucumber/godog

v0.14.1

29 Apr 08:50
095a19b
Compare
Choose a tag to compare

What's Changed

  • Prepare CHANGELOG.md for new release by @glibas in #606
  • fix(deps): update module github.com/cucumber/godog to v0.14.0 by @renovate in #610
  • Create releasing guidelines by @glibas in #608
  • chore(deps): update dominikh/staticcheck-action action to v1.3.1 by @renovate in #614
  • Fix step duration calculation by @iaroslav-ciupin in #616
  • chore(deps): update codecov/codecov-action action to v4 by @renovate in #607
  • chore(deps): update actions/cache action to v4 by @renovate in #598
  • fix invalid memory address or nil pointer dereference in RetrieveFeatures by @corneldamian in #566
  • Provide a useful implementation of something compatible with testing.T by @mrsheepuk in #571

New Contributors

Full Changelog: v0.14.0...v0.14.1

v0.14.0

31 Jan 16:39
250d69a
Compare
Choose a tag to compare

What's Changed

  • fix(deps): update module github.com/cucumber/godog to v0.13.0 by @renovate in #574
  • chore(deps): update actions/checkout action to v4 by @renovate in #575
  • chore(deps): update codecov/codecov-action action to v4 by @renovate in #576
  • Update test.yml by @vearutop in #583
  • updated base formatter to set a scenario as passed unless there exist… by @roskee in #582
  • Improve ErrSkip handling, add test for Summary and operations order by @vearutop in #584
  • chore(deps): update actions/setup-go action to v5 by @renovate in #588
  • Remove duplicate warning message by @vearutop in #590
  • Fixes #604 - remove line overwriting for scenario outlines in cucumber formatter by @glibas in #605

New Contributors

Full Changelog: v0.13.0...v0.14.0

What's Changed

  • fix(deps): update module github.com/cucumber/godog to v0.13.0 by @renovate in #574
  • chore(deps): update actions/checkout action to v4 by @renovate in #575
  • chore(deps): update codecov/codecov-action action to v4 by @renovate in #576
  • Update test.yml by @vearutop in #583
  • updated base formatter to set a scenario as passed unless there exist… by @roskee in #582
  • Improve ErrSkip handling, add test for Summary and operations order by @vearutop in #584
  • chore(deps): update actions/setup-go action to v5 by @renovate in #588
  • Remove duplicate warning message by @vearutop in #590
  • Fixes #604 - remove line overwriting for scenario outlines in cucumber formatter by @glibas in #605

New Contributors

Full Changelog: v0.13.0...v0.14.0

v0.13.0

22 Aug 12:31
Compare
Choose a tag to compare

What's Changed

  • chore(*): BREAKING CHANGE, use new repos for cucumber and messages by @otrava7 in #515
  • Configure Renovate by @renovate in #512
  • fix(deps): update module github.com/cucumber/godog to v0.12.6 by @renovate in #520
  • chore(deps): update codecov/codecov-action action to v3 by @renovate in #530
  • chore(deps): update actions/checkout action to v3 by @renovate in #528
  • chore(deps): update actions/setup-go action to v3 by @renovate in #529
  • chore(deps): update actions/cache action to v3 by @renovate in #527
  • fix(deps): update module github.com/cucumber/gherkin/go/v26 to v26.0.3 by @renovate in #519
  • fix(deps): update module github.com/data-dog/go-txdb to v0.1.5 by @renovate in #522
  • fix(deps): update module github.com/go-sql-driver/mysql to v1.7.0 by @renovate in #524
  • fix(deps): update module github.com/hashicorp/go-memdb to v1.3.4 by @renovate in #523
  • fix(deps): update module github.com/spf13/cobra to v1.6.1 by @renovate in #526
  • fix(deps): update module github.com/smartystreets/goconvey to v1.7.2 by @renovate in #525
  • Setup Renovate with default Configs by @mpkorstanje in #531
  • Implement unambiguous keywords by @otrava7 in #509
  • docs(*): correct example by @otrava7 in #538
  • fix(deps): update module github.com/data-dog/go-txdb to v0.1.6 by @renovate in #540
  • fix(deps): update module github.com/stretchr/testify to v1.8.2 by @renovate in #541
  • chore(deps): update actions/setup-go action to v4 by @renovate in #546
  • docs: prefer go test to use of godog cli in README by @danielhelfand in #548
  • Use fs.FS abstraction for filesystem by @tigh-latte in #550
  • Result of testing.T respect strict option by @eiel in #539
  • Update CI for go1.20 by @vearutop in #552
  • fix(deps): update module github.com/cucumber/gherkin/go/v26 to v26.1.0 by @renovate in #549
  • cancel context for each scenario by @draganm in #514
  • Use staticcheck GitHub Action by @vearutop in #563
  • refactor: test_context.go by @longyue0521 in #564
  • Improve hooks invocation flow by @vearutop in #568
  • fix(examples): update api example by @forward32 in #532
  • Improve example with concurrency support by @vearutop in #573

New Contributors

Full Changelog: v0.12.6...v0.13.0

v0.12.6

05 Jan 10:00
9007f1f
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: v0.12.5...v0.12.6

v0.12.5

26 Mar 09:19
Compare
Choose a tag to compare

Changed

  • Changed underlying cobra command setup to return errors instead of calling os.Exit directly to enable simpler testing. (454 - @mxygem)
  • Remove use of deprecated methods from _examples. (460 - @ricardogarfe)

Fixed

v0.12.4

12 Jan 22:45
30de46d
Compare
Choose a tag to compare

Added

  • Allow suite-level configuration of steps and hooks (453 - vearutop)

Changed

  • Run scenarios in the same goroutine if concurrency is disabled (453 - vearutop)

v0.12.3

05 Jan 22:08
a6fef3f
Compare
Choose a tag to compare

Added

  • Automated binary releases with GitHub Actions (437 - vearutop)
  • Automated binary versioning with go install (437 - vearutop)
  • Module with local replace in examples (437 - vearutop)

Changed

  • Suggest to use go install instead of the deprecated go get to install the godog binary (449 - dmitris)

Fixed

  • After Scenario hook is called before After Step (444 - vearutop)
  • check-go-version in Makefile to run on WSL. (443 - mxygem)

v0.12.2

14 Oct 17:26
86a5635
Compare
Choose a tag to compare
Fix compilation for non-modules (#436)

v0.12.1

26 Aug 22:15
Compare
Choose a tag to compare

Fixed

  • Unintended change of behavior in before step hook (424)

v0.12.0

17 Aug 09:34
afaebf2
Compare
Choose a tag to compare

We are excited to announce the release of godog v0.12.0.

Here follows a summary of Notable Changes, the Non Backward Compatible Changes and Deprecation Notices. The full change
log is available here.

Notable Changes

Output with multiple formatters

Now godog is able to use multiple formatters simultaneously with comma-separated formatters.

--format pretty,junit:report.xml,cucumber:report.json will write pretty format to stdout, junit to report.xml
and cucumber to report.json.

Extensible formatters

Standard formatters are now exported with type aliases so that a custom formatter can be built on top of it.
Please check an example.

Contextualized hooks

Scenario and Step hooks are now passing context to allow custom state communication. Returned context should generally
be based or equal to received context. Context is also passed to steps that have it in declaration and is read from
steps that return it.

Hooks can now return error, if non nil error is returned test is failed. This enables additional flow control, for
example to check expectations after the scenario.

Scenario hooks are now named Before and After.

// BeforeScenarioHook defines a hook before scenario.
type BeforeScenarioHook func (ctx context.Context, sc *Scenario) (context.Context, error)

// AfterScenarioHook defines a hook after scenario.
type AfterScenarioHook func (ctx context.Context, sc *Scenario, err error) (context.Context, error)

Step hooks are now also named Before and After, but they are available with ScenarioContext.StepContext().

// BeforeStepHook defines a hook before step.
type BeforeStepHook func (ctx context.Context, st *Step) (context.Context, error)

// AfterStepHook defines a hook after step.
type AfterStepHook func (ctx context.Context, st *Step, status StepResultStatus, err error) (context.Context, error)

Step definition improvements

Now godog can use additional ways to declare step definition. These declarations are optional and do not break
backwards compatibility.

Error result may be omitted if the step does not fail.

func iEat(arg1 int) {
    // Eat arg1.
}

You can have context.Context as first argument, test runner will pass current context to the step.

func iEat(ctx context.Context, arg1 int) {
    if v, ok := ctx.Value(eatKey{}).int; ok {
        // Eat v from context.
    }
    // Eat arg1.
}

You can have context.Context in return, test runner will use returned context to pass to next hooks and steps.

func iEat(ctx context.Context, arg1 int) context.Context {
    if v, ok := ctx.Value(eatKey{}).int; ok {
        // Eat v from context.
    }
    // Eat arg1.
    
    return context.WithValue(ctx, eatKey{}, 0)
}

If error is also needed in return, context have to be first.

func iEat(ctx context.Context, arg1 int) (context.Context, error) {
    if v, ok := ctx.Value(eatKey{}).int; ok {
        // Eat v from context.
    }
    // Eat arg1.

    if arg1 == 0 {
        return errors.New("can't eat nothing")
    }
    
    return context.WithValue(ctx, eatKey{}, 0), nil
}

You can now use string instead of *godog.DocString in declaration.

Getting features of test suite

godog.TestSuite now can RetrieveFeatures() ([]*models.Feature, error) to expose parsed features to the user.

Added official support for go1.16 and go1.17

With the introduction of go1.17, go1.17 and go1.16 are now officially supported.

Running scenarios as subtests of *testing.T

You can now assign an instance of *testing.T to godog.Options.TestingT so that scenarios will be invoked with
t.Run allowing granular control with standard Go tools.

More info.

Non Backward Compatible Changes

Messages library updated

Messages library is changed from github.com/cucumber/messages-go/v10 to github.com/cucumber/messages-go/v16.

Deprecation Notices

Hooks

Scenario and step hooks were upgraded with new API to support context and errors, previous methods are now deprecated.

  • ScenarioContext.BeforeScenario, use ScenarioContext.Before
  • ScenarioContext.AfterScenario, use ScenarioContext.After
  • ScenarioContext.BeforeStep, use ScenarioContext.StepContext().Before
  • ScenarioContext.AfterStep, use ScenarioContext.StepContext().After

Full change log

See CHANGELOG.md.