outputs

Documentation

Index

• func FormatOptions() []string
• func IsValidFormat(f string) bool
• func IsValidFormatOption(o string) bool
• func Outputers() []string
• func RegisterOutputer(name string, outputer Outputer, formatOptions []string)
• type Documentation
  • func (r Documentation) Output(w io.Writer, results <-chan []resource.TestResult, startTime time.Time, ...) (exitCode int)
• type JUnit
  • func (r JUnit) Output(w io.Writer, results <-chan []resource.TestResult, startTime time.Time, ...) (exitCode int)
• type Json
  • func (r Json) Output(w io.Writer, results <-chan []resource.TestResult, startTime time.Time, ...) (exitCode int)
• type JsonOneline
  • func (r JsonOneline) Output(w io.Writer, results <-chan []resource.TestResult, startTime time.Time, ...) (exitCode int)
• type Nagios
  • func (r Nagios) Output(w io.Writer, results <-chan []resource.TestResult, startTime time.Time, ...) (exitCode int)
• type Outputer
  • func GetOutputer(name string) (Outputer, error)
• type Rspecish
  • func (r Rspecish) Output(w io.Writer, results <-chan []resource.TestResult, startTime time.Time, ...) (exitCode int)
• type Silent
  • func (r Silent) Output(w io.Writer, results <-chan []resource.TestResult, startTime time.Time, ...) (exitCode int)
• type StructureTestSummary
  • func (s *StructureTestSummary) String() string
• type Structured
  • func (r Structured) Output(w io.Writer, results <-chan []resource.TestResult, startTime time.Time, ...) (exitCode int)
• type StructuredOutput
• type StructuredTestResult
• type Tap
  • func (r Tap) Output(w io.Writer, results <-chan []resource.TestResult, startTime time.Time, ...) (exitCode int)

Functions

func FormatOptions

func FormatOptions() []string

FormatOptions are all the valid options formatters accept

func IsValidFormat

func IsValidFormat(f string) bool

IsValidFormat determines if f is a valid format name based on Outputers()

func IsValidFormatOption

func IsValidFormatOption(o string) bool

IsValidFormatOption determines if o is a valid format option based on FormatOptions()

func Outputers

func Outputers() []string

Outputers returns a sorted list of the names of the registered outputers.

func RegisterOutputer

func RegisterOutputer(name string, outputer Outputer, formatOptions []string)

Types

type Documentation

type Documentation struct{}

func (Documentation) Output

func (r Documentation) Output(w io.Writer, results <-chan []resource.TestResult,
	startTime time.Time, outConfig util.OutputConfig) (exitCode int)

type JUnit

type JUnit struct{}

func (JUnit) Output

func (r JUnit) Output(w io.Writer, results <-chan []resource.TestResult,
	startTime time.Time, outConfig util.OutputConfig) (exitCode int)

type Json

type Json struct{}

func (Json) Output

func (r Json) Output(w io.Writer, results <-chan []resource.TestResult,
	startTime time.Time, outConfig util.OutputConfig) (exitCode int)

type JsonOneline

type JsonOneline struct{}

func (JsonOneline) Output

func (r JsonOneline) Output(w io.Writer, results <-chan []resource.TestResult,
	startTime time.Time, outConfig util.OutputConfig) (exitCode int)

type Nagios

type Nagios struct{}

func (Nagios) Output

func (r Nagios) Output(w io.Writer, results <-chan []resource.TestResult,
	startTime time.Time, outConfig util.OutputConfig) (exitCode int)

type Outputer

type Outputer interface {
	Output(io.Writer, <-chan []resource.TestResult, time.Time, util.OutputConfig) int
}

func GetOutputer

func GetOutputer(name string) (Outputer, error)

type Rspecish

type Rspecish struct{}

func (Rspecish) Output

func (r Rspecish) Output(w io.Writer, results <-chan []resource.TestResult,
	startTime time.Time, outConfig util.OutputConfig) (exitCode int)

type Silent

type Silent struct{}

func (Silent) Output

func (r Silent) Output(w io.Writer, results <-chan []resource.TestResult,
	startTime time.Time, outConfig util.OutputConfig) (exitCode int)

type StructureTestSummary

type StructureTestSummary struct {
	TestCount     int           `json:"test-count"`
	Failed        int           `json:"failed-count"`
	TotalDuration time.Duration `json:"total-duration"`
}

StructureTestSummary holds summary information about a test run

func (*StructureTestSummary) String

func (s *StructureTestSummary) String() string

String represents human friendly representation of the test summary

type Structured

type Structured struct{}

Structured is a output formatter that logs into a StructuredOutput structure

func (Structured) Output

func (r Structured) Output(w io.Writer, results <-chan []resource.TestResult, startTime time.Time, outConfig util.OutputConfig) (exitCode int)

Output processes output from tests into StructuredOutput written to w as a string

type StructuredOutput

type StructuredOutput struct {
	Results     []StructuredTestResult `json:"results"`
	Summary     StructureTestSummary   `json:"summary"`
	SummaryLine string                 `json:"summary-line"`
}

StructuredOutput is the full output structure for the structured output format

type StructuredTestResult

type StructuredTestResult struct {
	resource.TestResult
	SummaryLine string `json:"summary-line"`
}

StructuredTestResult is an individual test result with additional human friendly summary

type Tap

type Tap struct{}

func (Tap) Output

func (r Tap) Output(w io.Writer, results <-chan []resource.TestResult,
	startTime time.Time, outConfig util.OutputConfig) (exitCode int)