jsonspec

README

jsonspec

JSON output generator for the BDD framework GoGiven

Import:

import github.com/corbym/jsonspec

Usage:

package foo
import (
	"testing"
	"github.com/corbym/gogiven"
	"github.com/corbym/jsonspec"
	"os"
)

func TestMain(testmain *testing.M) {
	gogiven.Generator = jsonspec.NewTestOutputGenerator()
	runOutput := testmain.Run()
	gogiven.GenerateTestOutput()
	os.Exit(runOutput)
}

... actual tests...

Example Output

{
  "title": "Generator Test",
  "test_state": {
    "test title": {
      "test_results": {
        "id": "abc2124",
        "failed": true,
        "skipped": true,
        "test_output": "well alrighty then"
      },
      "test_title": "test title",
      "interesting_givens": {
        "faff": "flap"
      },
      "captured_io": {
        "foob": "barb"
      },
      "given_when_then": {
        "given_when_then": [
          "given",
          "when",
          "then"
        ],
        "comment": [
          "Fooing is best",
          "done with friends"
        ]
      }
    }
  }
}

Documentation

Index

• type TestOutputGenerator
  • func NewTestOutputGenerator() *TestOutputGenerator
  • func (outputGenerator *TestOutputGenerator) ContentType() string
  • func (outputGenerator *TestOutputGenerator) Generate(pageData generator.PageData) io.Reader

Types

type TestOutputGenerator

type TestOutputGenerator struct {
	generator.GoGivensOutputGenerator
	MarshalJSON func(v interface{}) ([]byte, error)
}

TestOutputGenerator is an implementation of the GoGivensOutputGenerator that generates a JSON file per test. It is thread safe between goroutines.

func NewTestOutputGenerator

func NewTestOutputGenerator() *TestOutputGenerator

NewTestOutputGenerator creates a template that is used to generate the json output.

func (*TestOutputGenerator) ContentType

func (outputGenerator *TestOutputGenerator) ContentType() string

ContentType for the output generated.

func (*TestOutputGenerator) Generate

func (outputGenerator *TestOutputGenerator) Generate(pageData generator.PageData) io.Reader

Generate generates json output for a test. The return string contains the html that goes into the output file generated in gogivens.GenerateTestOutput(). The function panics if the template cannot be generated.