Added the new TestSuiteInitializer and ScenarioInitializer

cucumber · May 18, 2020 · e6227a2 · e6227a2
1 parent 7568b29
commit e6227a2
Show file tree

Hide file tree

Showing 14 changed files with 470 additions and 115 deletions.
diff --git a/README.md b/README.md
@@ -160,7 +160,6 @@ import (
 	"fmt"
 
 	"github.com/cucumber/godog"
-	messages "github.com/cucumber/messages-go/v10"
 )
 
 func thereAreGodogs(available int) error {
@@ -183,12 +182,12 @@ func thereShouldBeRemaining(remaining int) error {
 	return nil
 }
 
-func FeatureContext(s *godog.Suite) {
+func ScenarioContext(s *godog.ScenarioContext) {
 	s.Step(`^there are (\d+) godogs$`, thereAreGodogs)
 	s.Step(`^I eat (\d+)$`, iEat)
 	s.Step(`^there should be (\d+) remaining$`, thereShouldBeRemaining)
 
-	s.BeforeScenario(func(*messages.Pickle) {
+	s.BeforeScenario(func(*godog.Scenario) {
 		Godogs = 0 // clean the state before every scenario
 	})
 }
@@ -250,22 +249,24 @@ The following example binds **godog** flags with specified prefix `godog`
 in order to prevent flag collisions.
 
 ``` go
-var opt = godog.Options{
+var opts = godog.Options{
 	Output: colors.Colored(os.Stdout),
 	Format: "progress", // can define default values
 }
 
 func init() {
-	godog.BindFlags("godog.", flag.CommandLine, &opt)
+	godog.BindFlags("godog.", flag.CommandLine, &opts)
 }
 
 func TestMain(m *testing.M) {
 	flag.Parse()
-	opt.Paths = flag.Args()
+	opts.Paths = flag.Args()
 
-	status := godog.RunWithOptions("godogs", func(s *godog.Suite) {
-		FeatureContext(s)
-	}, opt)
+	status := godog.TestSuite{
+		Name: "godogs",
+		ScenarioInitializer: ScenarioContext,
+		Options: &opts,
+	}.Run()
 
 	if st := m.Run(); st > status {
 		status = st
@@ -287,13 +288,17 @@ configuring needed options.
 
 ``` go
 func TestMain(m *testing.M) {
-	status := godog.RunWithOptions("godog", func(s *godog.Suite) {
-		FeatureContext(s)
-	}, godog.Options{
+	opts := godog.Options{
 		Format:    "progress",
 		Paths:     []string{"features"},
 		Randomize: time.Now().UTC().UnixNano(), // randomize scenario execution order
-	})
+	}
+
+	status := godog.TestSuite{
+		Name: "godogs",
+		ScenarioInitializer: ScenarioContext,
+		Options: opts,
+	}.Run()
 
 	if st := m.Run(); st > status {
 		status = st
@@ -315,12 +320,17 @@ func TestMain(m *testing.M) {
 			break
 		}
 	}
-	status := godog.RunWithOptions("godog", func(s *godog.Suite) {
-		godog.SuiteContext(s)
-	}, godog.Options{
+
+	opts := godog.Options{
 		Format: format,
 		Paths:     []string{"features"},
-	})
+	}
+
+	status := godog.TestSuite{
+		Name: "godogs",
+		ScenarioInitializer: ScenarioContext,
+		Options: opts,
+	}.Run()
 
 	if st := m.Run(); st > status {
 		status = st

diff --git a/_examples/api/README.md b/_examples/api/README.md
@@ -56,7 +56,6 @@ need to store state within steps (a response), we should introduce a structure w
 package main
 
 import (
-	"github.com/cucumber/gherkin-go/v11"
 	"github.com/cucumber/godog"
 )
 
@@ -71,11 +70,11 @@ func (a *apiFeature) theResponseCodeShouldBe(code int) error {
 	return godog.ErrPending
 }
 
-func (a *apiFeature) theResponseShouldMatchJSON(body *messages.PickleStepArgument_PickleDocString) error {
+func (a *apiFeature) theResponseShouldMatchJSON(body *godog.DocString) error {
 	return godog.ErrPending
 }
 
-func FeatureContext(s *godog.Suite) {
+func ScenarioContext(s *godog.ScenarioContext) {
 	api := &apiFeature{}
 	s.Step(`^I send "([^"]*)" request to "([^"]*)"$`, api.iSendrequestTo)
 	s.Step(`^the response code should be (\d+)$`, api.theResponseCodeShouldBe)
@@ -98,7 +97,6 @@ import (
 	"net/http"
 	"net/http/httptest"
 
-	"github.com/cucumber/gherkin-go/v11"
 	"github.com/cucumber/godog"
 )
 
@@ -142,7 +140,7 @@ func (a *apiFeature) theResponseCodeShouldBe(code int) error {
 	return nil
 }
 
-func (a *apiFeature) theResponseShouldMatchJSON(body *messages.PickleStepArgument_PickleDocString) error {
+func (a *apiFeature) theResponseShouldMatchJSON(body *godog.DocString) error {
 	var expected, actual []byte
 	var data interface{}
 	if err = json.Unmarshal([]byte(body.Content), &data); err != nil {
@@ -158,7 +156,7 @@ func (a *apiFeature) theResponseShouldMatchJSON(body *messages.PickleStepArgumen
 	return
 }
 
-func FeatureContext(s *godog.Suite) {
+func ScenarioContext(s *godog.ScenarioContext) {
 	api := &apiFeature{}
 
 	s.BeforeScenario(api.resetResponse)

diff --git a/_examples/api/api_test.go b/_examples/api/api_test.go
@@ -8,14 +8,13 @@ import (
 	"reflect"
 
 	"github.com/cucumber/godog"
-	"github.com/cucumber/messages-go/v10"
 )
 
 type apiFeature struct {
 	resp *httptest.ResponseRecorder
 }
 
-func (a *apiFeature) resetResponse(*messages.Pickle) {
+func (a *apiFeature) resetResponse(*godog.Scenario) {
 	a.resp = httptest.NewRecorder()
 }
 
@@ -51,7 +50,7 @@ func (a *apiFeature) theResponseCodeShouldBe(code int) error {
 	return nil
 }
 
-func (a *apiFeature) theResponseShouldMatchJSON(body *messages.PickleStepArgument_PickleDocString) (err error) {
+func (a *apiFeature) theResponseShouldMatchJSON(body *godog.DocString) (err error) {
 	var expected, actual interface{}
 
 	// re-encode expected response
@@ -71,7 +70,7 @@ func (a *apiFeature) theResponseShouldMatchJSON(body *messages.PickleStepArgumen
 	return nil
 }
 
-func FeatureContext(s *godog.Suite) {
+func ScenarioContext(s *godog.ScenarioContext) {
 	api := &apiFeature{}
 
 	s.BeforeScenario(api.resetResponse)

diff --git a/_examples/assert-godogs/features/godogs.feature b/_examples/assert-godogs/features/godogs.feature
@@ -6,10 +6,10 @@ Feature: eat godogs
 
   Scenario: Eat 5 out of 12
     Given there are 12 godogs
-    When I eat 4
+    When I eat 5
     Then there should be 7 remaining
 
   Scenario: Eat 12 out of 12
     Given there are 12 godogs
-    When I eat 11
+    When I eat 12
     Then there should be none remaining
diff --git a/_examples/assert-godogs/godogs_test.go b/_examples/assert-godogs/godogs_test.go
@@ -1,4 +1,3 @@
-/* file: $GOPATH/src/assert-godogs/godogs_test.go */
 package main
 
 import (
@@ -9,23 +8,24 @@ import (
 
 	"github.com/cucumber/godog"
 	"github.com/cucumber/godog/colors"
-	messages "github.com/cucumber/messages-go/v10"
 	"github.com/stretchr/testify/assert"
 )
 
-var opt = godog.Options{Output: colors.Colored(os.Stdout)}
+var opts = godog.Options{Output: colors.Colored(os.Stdout)}
 
 func init() {
-	godog.BindFlags("godog.", flag.CommandLine, &opt)
+	godog.BindFlags("godog.", flag.CommandLine, &opts)
 }
 
 func TestMain(m *testing.M) {
 	flag.Parse()
-	opt.Paths = flag.Args()
+	opts.Paths = flag.Args()
 
-	status := godog.RunWithOptions("godogs", func(s *godog.Suite) {
-		FeatureContext(s)
-	}, opt)
+	status := godog.TestSuite{
+		Name:                "godogs",
+		ScenarioInitializer: ScenarioContext,
+		Options:             &opts,
+	}.Run()
 
 	if st := m.Run(); st > status {
 		status = st
@@ -65,13 +65,13 @@ func thereShouldBeNoneRemaining() error {
 	)
 }
 
-func FeatureContext(s *godog.Suite) {
+func ScenarioContext(s *godog.ScenarioContext) {
 	s.Step(`^there are (\d+) godogs$`, thereAreGodogs)
 	s.Step(`^I eat (\d+)$`, iEat)
 	s.Step(`^there should be (\d+) remaining$`, thereShouldBeRemaining)
 	s.Step(`^there should be none remaining$`, thereShouldBeNoneRemaining)
 
-	s.BeforeScenario(func(*messages.Pickle) {
+	s.BeforeScenario(func(*godog.Scenario) {
 		Godogs = 0 // clean the state before every scenario
 	})
 }

diff --git a/_examples/db/api_test.go b/_examples/db/api_test.go
@@ -11,7 +11,6 @@ import (
 
 	txdb "github.com/DATA-DOG/go-txdb"
 	"github.com/cucumber/godog"
-	"github.com/cucumber/messages-go/v10"
 )
 
 func init() {
@@ -24,7 +23,7 @@ type apiFeature struct {
 	resp *httptest.ResponseRecorder
 }
 
-func (a *apiFeature) resetResponse(*messages.Pickle) {
+func (a *apiFeature) resetResponse(*godog.Scenario) {
 	a.resp = httptest.NewRecorder()
 	if a.db != nil {
 		a.db.Close()
@@ -71,7 +70,7 @@ func (a *apiFeature) theResponseCodeShouldBe(code int) error {
 	return nil
 }
 
-func (a *apiFeature) theResponseShouldMatchJSON(body *messages.PickleStepArgument_PickleDocString) (err error) {
+func (a *apiFeature) theResponseShouldMatchJSON(body *godog.DocString) (err error) {
 	var expected, actual interface{}
 
 	// re-encode expected response
@@ -91,7 +90,7 @@ func (a *apiFeature) theResponseShouldMatchJSON(body *messages.PickleStepArgumen
 	return nil
 }
 
-func (a *apiFeature) thereAreUsers(users *messages.PickleStepArgument_PickleTable) error {
+func (a *apiFeature) thereAreUsers(users *godog.Table) error {
 	var fields []string
 	var marks []string
 	head := users.Rows[0].Cells
@@ -123,7 +122,7 @@ func (a *apiFeature) thereAreUsers(users *messages.PickleStepArgument_PickleTabl
 	return nil
 }
 
-func FeatureContext(s *godog.Suite) {
+func ScenarioContext(s *godog.ScenarioContext) {
 	api := &apiFeature{}
 
 	s.BeforeScenario(api.resetResponse)

diff --git a/_examples/godogs/godogs_test.go b/_examples/godogs/godogs_test.go
@@ -1,4 +1,3 @@
-/* file: $GOPATH/src/godogs/godogs_test.go */
 package main
 
 import (
@@ -9,22 +8,23 @@ import (
 
 	"github.com/cucumber/godog"
 	"github.com/cucumber/godog/colors"
-	messages "github.com/cucumber/messages-go/v10"
 )
 
-var opt = godog.Options{Output: colors.Colored(os.Stdout)}
+var opts = godog.Options{Output: colors.Colored(os.Stdout)}
 
 func init() {
-	godog.BindFlags("godog.", flag.CommandLine, &opt)
+	godog.BindFlags("godog.", flag.CommandLine, &opts)
 }
 
 func TestMain(m *testing.M) {
 	flag.Parse()
-	opt.Paths = flag.Args()
+	opts.Paths = flag.Args()
 
-	status := godog.RunWithOptions("godogs", func(s *godog.Suite) {
-		FeatureContext(s)
-	}, opt)
+	status := godog.TestSuite{
+		Name:                "godogs",
+		ScenarioInitializer: ScenarioContext,
+		Options:             &opts,
+	}.Run()
 
 	if st := m.Run(); st > status {
 		status = st
@@ -52,12 +52,12 @@ func thereShouldBeRemaining(remaining int) error {
 	return nil
 }
 
-func FeatureContext(s *godog.Suite) {
+func ScenarioContext(s *godog.ScenarioContext) {
 	s.Step(`^there are (\d+) godogs$`, thereAreGodogs)
 	s.Step(`^I eat (\d+)$`, iEat)
 	s.Step(`^there should be (\d+) remaining$`, thereShouldBeRemaining)
 
-	s.BeforeScenario(func(*messages.Pickle) {
+	s.BeforeScenario(func(*godog.Scenario) {
 		Godogs = 0 // clean the state before every scenario
 	})
 }
diff --git a/ast.go b/ast.go
@@ -2,7 +2,7 @@ package godog
 
 import "go/ast"
 
-func astContexts(f *ast.File) []string {
+func astContexts(f *ast.File, selectName string) []string {
 	var contexts []string
 	for _, d := range f.Decls {
 		switch fun := d.(type) {
@@ -12,13 +12,13 @@ func astContexts(f *ast.File) []string {
 				case *ast.StarExpr:
 					switch x := expr.X.(type) {
 					case *ast.Ident:
-						if x.Name == "Suite" {
+						if x.Name == selectName {
 							contexts = append(contexts, fun.Name.Name)
 						}
 					case *ast.SelectorExpr:
 						switch t := x.X.(type) {
 						case *ast.Ident:
-							if t.Name == "godog" && x.Sel.Name == "Suite" {
+							if t.Name == "godog" && x.Sel.Name == selectName {
 								contexts = append(contexts, fun.Name.Name)
 							}
 						}

diff --git a/ast_test.go b/ast_test.go
@@ -34,7 +34,7 @@ func astContextParse(src string, t *testing.T) []string {
 		t.Fatalf("unexpected error while parsing ast: %v", err)
 	}
 
-	return astContexts(f)
+	return astContexts(f, "Suite")
 }
 
 func TestShouldGetSingleContextFromSource(t *testing.T) {