reporter

Documentation

Index

• Variables
• func ListenExecutionEvents(wg *sync.WaitGroup)
• type Reporter
  • func Current() Reporter
  • func ParallelReporter(n int) Reporter

Variables

var IsParallel bool

IsParallel represents console reporting format based on simple/parallel execution

var MachineReadable bool

MachineReadable represents if output should be in JSON format.

var NumberOfExecutionStreams int

NumberOfExecutionStreams indicates the total number of parallel execution streams

var SimpleConsoleOutput bool

SimpleConsoleOutput represents if coloring should be removed from the Console output

var Verbose bool

Verbose represents level of console Reporting. If true its at step level, else at scenario level.

Functions

func ListenExecutionEvents

func ListenExecutionEvents(wg *sync.WaitGroup)

ListenExecutionEvents listens to all execution events for reporting on console

Types

type Reporter

type Reporter interface {
	SuiteStart()
	SpecStart(*gauge.Specification, result.Result)
	SpecEnd(*gauge.Specification, result.Result)
	ScenarioStart(*gauge.Scenario, gauge_messages.ExecutionInfo, result.Result)
	ScenarioEnd(*gauge.Scenario, result.Result, gauge_messages.ExecutionInfo)
	StepStart(string)
	StepEnd(gauge.Step, result.Result, gauge_messages.ExecutionInfo)
	ConceptStart(string)
	ConceptEnd(result.Result)
	DataTable(string)
	SuiteEnd(result.Result)

	Errorf(string, ...interface{})

	io.Writer
}

Reporter reports the progress of spec execution. It reports 1. Which spec / scenarion / step (if verbose) is currently executing. 2. Status (pass/fail) of the spec / scenario / step (if verbose) once its executed.

func Current

func Current() Reporter

Current returns the current instance of Reporter, if present. Else, it returns a new Reporter.

func ParallelReporter

func ParallelReporter(n int) Reporter

ParallelReporter returns the instance of parallel console reporter