generator

Documentation

Index

• func OutputDirectory() string
• type FileOutputGenerator
  • func (f *FileOutputGenerator) Notify(testFilePath string, contentType string, output io.Reader)
• type GoGivensOutputGenerator
• type OutputListener
• type PageData
  • func NewPageData(title string, someMap *base.SomeMap) (pageData PageData)
• type TestData
  • func NewTestData(some *base.Some) (testData TestData)
• type TestResult
  • func NewTestResult(data *base.TestMetaData) TestResult

Functions

func OutputDirectory

func OutputDirectory() string

OutputDirectory finds the output dir in either one of the system env var $GOGIVENS_OUTPUT_DIR, the os tmp dir, or default to the current dir otherwise.

Types

type FileOutputGenerator

type FileOutputGenerator struct {
	OutputListener
}

FileOutputGenerator is a struct which implements the OutputListener interface

func (*FileOutputGenerator) Notify

func (f *FileOutputGenerator) Notify(testFilePath string, contentType string, output io.Reader)

Notify is called by Generator to pass the output content from the test. Output is an io.Reader, usually test output. The file is written to env var GOGIVENS_OUTPUT_DIR if set, or defaults either to system tmp or the current dir if neither are found.

type GoGivensOutputGenerator

type GoGivensOutputGenerator interface {
	Generate(data PageData) (output io.Reader)
	//ContentType is text/html, application/json or other mime type
	ContentType() string
}

GoGivensOutputGenerator is an interface that can be implemented by anything that can generate file content to be output after a test has completed.

type OutputListener

type OutputListener interface {
	Notify(testFilePath string, contentType string, output io.Reader)
}

OutputListener is the interface of things that want to be notified about generated content.

type PageData

type PageData struct {
	Title       string
	TestResults map[string]TestData
}

PageData is the struct that populates the template with data from the test output.

func NewPageData

func NewPageData(title string, someMap *base.SomeMap) (pageData PageData)

NewPageData holds the title and the test results

type TestData

type TestData struct {
	TestResult        TestResult
	TestTitle         string
	InterestingGivens testdata.InterestingGivens
	CapturedIO        testdata.CapturedIO
	ParsedTestContent base.ParsedTestContent
}

TestData holds a copy of test results, interesting givens, captured io, and parsed test content (given/when/then)

func NewTestData

func NewTestData(some *base.Some) (testData TestData)

NewTestData creates a new copy of test results, interesting givens, captured io, and parsed test content (given/when/then)

type TestResult

type TestResult struct {
	TestID     string
	Failed     bool
	Skipped    bool
	TestOutput string
}

TestResult holds the results of the test, whether it failed, was skipped, it's ID and the output from the Fail/Skip if appropriate

func NewTestResult

func NewTestResult(data *base.TestMetaData) TestResult

NewTestResult returns a copy of the test meta data