formatters

package
v1.3.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 10, 2025 License: MIT Imports: 27 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var AST_undefinedSnippetsTpl = template.Must(template.New("snippets").Funcs(snippetHelperFuncs).Parse(`
    func InitializeScenario(ctx *godog.ScenarioContext) {}
    // ---


{{ range . }}func {{ .Method }}({{ .Args }}) {
}
{{end}}{{ range . }}
    ctx.Step({{ backticked .Expr }}, {{ .Method }}){{end}}

`))

Functions

func ASTFormatterFunc added in v1.3.0 

func ASTFormatterFunc(suite string, out io.Writer) formatters.Formatter

ASTFormatterFunc implements the FormatterFunc for the AST formatter

func ASTRegister added in v1.3.0 

func ASTRegister()

func BaseFormatterFunc 

func BaseFormatterFunc(suite string, out io.Writer) formatters.Formatter

BaseFormatterFunc implements the FormatterFunc for the base formatter.

func CucumberFormatterFunc 

func CucumberFormatterFunc(suite string, out io.Writer) formatters.Formatter

CucumberFormatterFunc implements the FormatterFunc for the cucumber formatter

func DefinitionID 

func DefinitionID(sd *models.StepDefinition) string

DefinitionID ...

func EventsFormatterFunc 

func EventsFormatterFunc(suite string, out io.Writer) formatters.Formatter

EventsFormatterFunc implements the FormatterFunc for the events formatter

func JUnitFormatterFunc 

func JUnitFormatterFunc(suite string, out io.Writer) formatters.Formatter

JUnitFormatterFunc implements the FormatterFunc for the junit formatter

func PrettyFormatterFunc 

func PrettyFormatterFunc(suite string, out io.Writer) formatters.Formatter

PrettyFormatterFunc implements the FormatterFunc for the pretty formatter

func ProgressFormatterFunc 

func ProgressFormatterFunc(suite string, out io.Writer) formatters.Formatter

ProgressFormatterFunc implements the FormatterFunc for the progress formatter.

func WrapOnFlush added in v1.1.0 

func WrapOnFlush(fmt formatters.Formatter) formatters.FlushFormatter

WrapOnFlush wrap a `formatters.Formatter` in a `formatters.FlushFormatter`, which only executes when `Flush` is called

Types

type AST added in v1.3.0 

type AST struct {
	*Base
	// contains filtered or unexported fields
}

AST is a formatter for readable output.

func (*AST) Ambiguous added in v1.3.0 

func (f *AST) Ambiguous(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition, err error)

Failed captures failed step.

func (*AST) Failed added in v1.3.0 

func (f *AST) Failed(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition, err error)

Failed captures failed step.

func (*AST) Feature added in v1.3.0 

func (f *AST) Feature(gd *messages.GherkinDocument, p string, c []byte)

Feature receives gherkin document.

func (*AST) Passed added in v1.3.0 

func (f *AST) Passed(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition)

Passed captures passed step.

func (*AST) Pending added in v1.3.0 

func (f *AST) Pending(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition)

Pending captures pending step.

func (*AST) Pickle added in v1.3.0 

func (f *AST) Pickle(pickle *messages.Pickle)

Pickle takes a gherkin node for formatting.

func (*AST) Skipped added in v1.3.0 

func (f *AST) Skipped(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition)

Skipped captures skipped step.

func (*AST) Snippets added in v1.3.0 

func (f *AST) Snippets() string

func (*AST) Summary added in v1.3.0 

func (f *AST) Summary()

Summary renders summary information.

func (*AST) SummaryBottom added in v1.3.0 

func (f *AST) SummaryBottom()

func (*AST) TestRunStarted added in v1.3.0 

func (f *AST) TestRunStarted()

TestRunStarted is triggered on test start.

func (*AST) Undefined added in v1.3.0 

func (f *AST) Undefined(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition)

Undefined captures undefined step.

type Base 

type Base struct {
	Storage *storage.Storage
	Lock    *sync.Mutex
	// contains filtered or unexported fields
}

Base is a base formatter.

func NewBase 

func NewBase(suite string, out io.Writer) *Base

NewBase creates a new base formatter.

func (*Base) Ambiguous added in v1.1.0 

func (f *Base) Ambiguous(*messages.Pickle, *messages.PickleStep, *formatters.StepDefinition, error)

Ambiguous captures ambiguous step.

func (*Base) Defined 

func (f *Base) Defined(*messages.Pickle, *messages.PickleStep, *formatters.StepDefinition)

Defined receives step definition.

func (*Base) Failed 

func (f *Base) Failed(*messages.Pickle, *messages.PickleStep, *formatters.StepDefinition, error)

Failed captures failed step.

func (*Base) Feature 

func (f *Base) Feature(*messages.GherkinDocument, string, []byte)

Feature receives gherkin document.

func (*Base) Passed 

func (f *Base) Passed(*messages.Pickle, *messages.PickleStep, *formatters.StepDefinition)

Passed captures passed step.

func (*Base) Pending 

func (f *Base) Pending(*messages.Pickle, *messages.PickleStep, *formatters.StepDefinition)

Pending captures pending step.

func (*Base) Pickle 

func (f *Base) Pickle(*messages.Pickle)

Pickle receives scenario.

func (*Base) SetStorage 

func (f *Base) SetStorage(st *storage.Storage)

SetStorage assigns gherkin data storage.

func (*Base) Skipped 

func (f *Base) Skipped(*messages.Pickle, *messages.PickleStep, *formatters.StepDefinition)

Skipped captures skipped step.

func (*Base) Snippets 

func (f *Base) Snippets() string

Snippets returns code suggestions for undefined steps.

func (*Base) Summary 

func (f *Base) Summary()

Summary renders summary information.

func (*Base) TestRunStarted 

func (f *Base) TestRunStarted()

TestRunStarted is triggered on test start.

func (*Base) Undefined 

func (f *Base) Undefined(*messages.Pickle, *messages.PickleStep, *formatters.StepDefinition)

Undefined captures undefined step.

type Cuke 

type Cuke struct {
	*Base
}

Cuke ...

func (*Cuke) Summary 

func (f *Cuke) Summary()

Summary renders test result as Cucumber JSON.

type CukeFeatureJSON 

type CukeFeatureJSON struct {
	URI         string        `json:"uri"`
	ID          string        `json:"id"`
	Keyword     string        `json:"keyword"`
	Name        string        `json:"name"`
	Description string        `json:"description"`
	Line        int           `json:"line"`
	Comments    []cukeComment `json:"comments,omitempty"`
	Tags        []cukeTag     `json:"tags,omitempty"`
	Elements    []cukeElement `json:"elements,omitempty"`
}

CukeFeatureJSON ...

type Events 

type Events struct {
	*Base
}

Events - Events formatter

func (*Events) Ambiguous added in v1.1.0 

func (f *Events) Ambiguous(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition, err error)

Ambiguous captures ambiguous step.

func (*Events) Defined 

func (f *Events) Defined(pickle *messages.Pickle, pickleStep *messages.PickleStep, def *formatters.StepDefinition)

Defined receives step definition.

func (*Events) Failed 

func (f *Events) Failed(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition, err error)

Failed captures failed step.

func (*Events) Feature 

func (f *Events) Feature(ft *messages.GherkinDocument, p string, c []byte)

Feature receives gherkin document.

func (*Events) Passed 

func (f *Events) Passed(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition)

Passed captures passed step.

func (*Events) Pending 

func (f *Events) Pending(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition)

Pending captures pending step.

func (*Events) Pickle 

func (f *Events) Pickle(pickle *messages.Pickle)

Pickle receives scenario.

func (*Events) Skipped 

func (f *Events) Skipped(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition)

Skipped captures skipped step.

func (*Events) Summary 

func (f *Events) Summary()

Summary pushes summary information to JSON stream.

func (*Events) TestRunStarted 

func (f *Events) TestRunStarted()

TestRunStarted is triggered on test start.

func (*Events) Undefined 

func (f *Events) Undefined(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition)

Undefined captures undefined step.

type JUnit 

type JUnit struct {
	*Base
}

JUnit renders test results in JUnit format.

func (*JUnit) Summary 

func (f *JUnit) Summary()

Summary renders summary information.

type JunitPackageSuite 

type JunitPackageSuite struct {
	XMLName    xml.Name `xml:"testsuites"`
	Name       string   `xml:"name,attr"`
	Tests      int      `xml:"tests,attr"`
	Skipped    int      `xml:"skipped,attr"`
	Failures   int      `xml:"failures,attr"`
	Errors     int      `xml:"errors,attr"`
	Time       string   `xml:"time,attr"`
	TestSuites []*junitTestSuite
}

JunitPackageSuite ...

type MultiFormatter 

type MultiFormatter struct {
	// contains filtered or unexported fields
}

MultiFormatter passes test progress to multiple formatters.

func (*MultiFormatter) Add 

func (m *MultiFormatter) Add(name string, out io.Writer)

Add adds formatter with output writer.

func (*MultiFormatter) FormatterFunc 

func (m *MultiFormatter) FormatterFunc(suite string, out io.Writer) formatters.Formatter

FormatterFunc implements the FormatterFunc for the multi formatter.

type Pretty 

type Pretty struct {
	*Base
	// contains filtered or unexported fields
}

Pretty is a formatter for readable output.

func (*Pretty) Ambiguous added in v1.1.0 

func (f *Pretty) Ambiguous(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition, err error)

Failed captures failed step.

func (*Pretty) Failed 

func (f *Pretty) Failed(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition, err error)

Failed captures failed step.

func (*Pretty) Feature 

func (f *Pretty) Feature(gd *messages.GherkinDocument, p string, c []byte)

Feature receives gherkin document.

func (*Pretty) Passed 

func (f *Pretty) Passed(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition)

Passed captures passed step.

func (*Pretty) Pending 

func (f *Pretty) Pending(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition)

Pending captures pending step.

func (*Pretty) Pickle 

func (f *Pretty) Pickle(pickle *messages.Pickle)

Pickle takes a gherkin node for formatting.

func (*Pretty) Skipped 

func (f *Pretty) Skipped(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition)

Skipped captures skipped step.

func (*Pretty) Summary 

func (f *Pretty) Summary()

Summary renders summary information.

func (*Pretty) TestRunStarted 

func (f *Pretty) TestRunStarted()

TestRunStarted is triggered on test start.

func (*Pretty) Undefined 

func (f *Pretty) Undefined(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition)

Undefined captures undefined step.

type Progress 

type Progress struct {
	*Base
	StepsPerRow int
	Steps       *int
}

Progress is a minimalistic formatter.

func NewProgress 

func NewProgress(suite string, out io.Writer) *Progress

NewProgress creates a new progress formatter.

func (*Progress) Ambiguous added in v1.1.0 

func (f *Progress) Ambiguous(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition, err error)

Ambiguous steps.

func (*Progress) Failed 

func (f *Progress) Failed(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition, err error)

Failed captures failed step.

func (*Progress) Passed 

func (f *Progress) Passed(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition)

Passed captures passed step.

func (*Progress) Pending 

func (f *Progress) Pending(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition)

Pending captures pending step.

func (*Progress) Skipped 

func (f *Progress) Skipped(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition)

Skipped captures skipped step.

func (*Progress) Summary 

func (f *Progress) Summary()

Summary renders summary information.

func (*Progress) Undefined 

func (f *Progress) Undefined(pickle *messages.Pickle, step *messages.PickleStep, match *formatters.StepDefinition)

Undefined captures undefined step.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.