rename Suite.Require -> Suite.Fixtures

Also adds an `api.Runnable` interface and switches the porcelain
`gdt.From()` function to return that interface instead of a concrete
`*suite.Suite` struct.

Signed-off-by: Jay Pipes <[email protected]>

Author: jaypipes

Diff for: api/runnable.go

@@ -0,0 +1,20 @@
+// Use and distribution licensed under the Apache license version 2.
+//
+// See the COPYING file in the root project directory for full text.
+
+package api
+
+import (
+	"context"
+	"testing"
+)
+
+// Runnable are things that Run a `*testing.T`
+type Runnable interface {
+	// Run accepts a context and a `*testing.T` and runs some tests within that
+	// context
+	//
+	// Errors returned by Run() are **RuntimeErrors**, not failures in
+	// assertions.
+	Run(context.Context, *testing.T) error
+}

Diff for: porcelain.go

@@ -89,10 +89,10 @@ var (
 	NewJSONFixture = jsonfix.New
 )
 
-// From returns a new suite.Suite from an `io.Reader`, a string file or
+// From returns a new `api.Runnable` from an `io.Reader`, a string file or
 // directory path, or the raw bytes of YAML content describing a scenario or
 // suite.
-func From(source interface{}) (*suite.Suite, error) {
+func From(source interface{}) (api.Runnable, error) {
 	switch src := source.(type) {
 	case io.Reader:
 		s, err := scenario.FromReader(src)

Diff for: porcelain_test.go

@@ -12,6 +12,7 @@ import (
 
 	"github.com/gdt-dev/gdt"
 	"github.com/gdt-dev/gdt/api"
+	"github.com/gdt-dev/gdt/suite"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -39,27 +40,35 @@ func TestFromFileNotFound(t *testing.T) {
 	assert.True(os.IsNotExist(err))
 }
 
-func TestFromSuite(t *testing.T) {
+func TestFromSuitePath(t *testing.T) {
 	assert := assert.New(t)
 	require := require.New(t)
 
 	fp := filepath.Join("suite", "testdata", "exec")
-	suite, err := gdt.From(fp)
+	r, err := gdt.From(fp)
 	require.Nil(err)
-	require.NotNil(suite)
+	require.NotNil(r)
 
-	assert.Equal(fp, suite.Path)
-	assert.Len(suite.Scenarios, 2)
+	assert.IsType(r, &suite.Suite{})
+
+	s := r.(*suite.Suite)
+
+	assert.Equal(fp, s.Path)
+	assert.Len(s.Scenarios, 2)
 }
 
-func TestFromScenarioPath(t *testing.T) {
+func TestFromFilePath(t *testing.T) {
 	assert := assert.New(t)
 	require := require.New(t)
 
 	fp := filepath.Join("suite", "testdata", "exec", "ls.yaml")
-	s, err := gdt.From(fp)
+	r, err := gdt.From(fp)
 	require.Nil(err)
-	require.NotNil(s)
+	require.NotNil(r)
+
+	assert.IsType(r, &suite.Suite{})
+
+	s := r.(*suite.Suite)
 
 	assert.Equal(fp, s.Path)
 	assert.Len(s.Scenarios, 1)
@@ -74,33 +83,44 @@ func TestFromScenarioReader(t *testing.T) {
 	fp := filepath.Join("suite", "testdata", "exec", "ls.yaml")
 	f, err := os.Open(fp)
 	require.Nil(err)
-	suite, err := gdt.From(f)
-	assert.Nil(err)
-	assert.NotNil(suite)
+
+	r, err := gdt.From(f)
+	require.Nil(err)
+	require.NotNil(r)
+
+	assert.IsType(r, &suite.Suite{})
+
+	s := r.(*suite.Suite)
 
 	// The scenario's path isn't set because we didn't supply a filepath...
-	assert.Equal("", suite.Path)
-	assert.Len(suite.Scenarios, 1)
-	assert.Len(suite.Scenarios[0].Tests, 1)
+	assert.Equal("", s.Path)
+	assert.Len(s.Scenarios, 1)
+	assert.Len(s.Scenarios[0].Tests, 1)
 }
 
 func TestFromScenarioBytes(t *testing.T) {
 	assert := assert.New(t)
+	require := require.New(t)
 
 	raw := `name: foo
 description: simple foo test
 tests:
  - exec: echo foo
 `
 	b := []byte(raw)
-	suite, err := gdt.From(b)
-	assert.Nil(err)
-	assert.NotNil(suite)
+
+	r, err := gdt.From(b)
+	require.Nil(err)
+	require.NotNil(r)
+
+	assert.IsType(r, &suite.Suite{})
+
+	s := r.(*suite.Suite)
 
 	// The scenario's path isn't set because we didn't supply a filepath...
-	assert.Equal("", suite.Path)
-	assert.Len(suite.Scenarios, 1)
-	assert.Len(suite.Scenarios[0].Tests, 1)
+	assert.Equal("", s.Path)
+	assert.Len(s.Scenarios, 1)
+	assert.Len(s.Scenarios[0].Tests, 1)
 }
 
 func TestRunExecSuite(t *testing.T) {

Diff for: suite/from.go

@@ -70,10 +70,9 @@ func FromScenario(s *scenario.Scenario) *Suite {
 		Path:        s.Path,
 		Name:        suiteNameFromScenarioPath(s.Path),
 		Description: s.Description,
-		// NOTE: require needs to be named to fixture?
-		Require:   s.Fixtures,
-		Defaults:  s.Defaults,
-		Scenarios: []*scenario.Scenario{s},
+		Fixtures:    s.Fixtures,
+		Defaults:    s.Defaults,
+		Scenarios:   []*scenario.Scenario{s},
 	}
 }
 

Diff for: suite/suite.go

@@ -23,9 +23,9 @@ type Suite struct {
 	// During parsing, plugins are handed this raw data and asked to interpret
 	// it into known configuration values for that plugin.
 	Defaults map[string]interface{} `yaml:"defaults,omitempty"`
-	// Require specifies an ordered list of fixtures the test suite's test
-	// cases depends on.
-	Require []string `yaml:"require,omitempty"`
+	// Fixtures specifies an ordered list of fixtures the test suite's test
+	// cases depend on.
+	Fixtures []string `yaml:"fixtures,omitempty"`
 	// Scenarios is a collection of test scenarios in this test suite
 	Scenarios []*scenario.Scenario `yaml:"-"`
 }
@@ -61,10 +61,10 @@ func WithDefaults(defaults map[string]interface{}) SuiteModifier {
 	}
 }
 
-// WithRequires sets a test suite's Requires attribute
-func WithRequires(require []string) SuiteModifier {
+// WithFixtures sets a test suite's Fixtures attribute
+func WithFixtures(fixtures []string) SuiteModifier {
 	return func(s *Suite) {
-		s.Require = require
+		s.Fixtures = fixtures
 	}
 }