lib

Documentation

Overview

Package lib is exposing parsers and output generation

Index

• Constants
• Variables
• func WriteXML(suites []*Suite, out io.Writer, xmlTemplate string, testTime time.Time)
• type GotestLexer
  • func (lex *GotestLexer) Err() error
  • func (lex *GotestLexer) Scan() bool
  • func (lex *GotestLexer) Token() *Token
• type GtParser
  • func (gtp *GtParser) Err() error
  • func (gtp *GtParser) Scan() bool
  • func (gtp *GtParser) Suite() *Suite
• type Lexer
  • func NewGotestLexer(in io.Reader) Lexer
• type LineScanner
  • func NewLineScanner(r io.Reader) *LineScanner
  • func (ls *LineScanner) Err() error
  • func (ls *LineScanner) Line() int
  • func (ls *LineScanner) Scan() bool
  • func (ls *LineScanner) Text() string
• type Parser
  • func NewGtParser(in io.Reader) Parser
• type Status
  • func Token2Status(token string) Status
• type Suite
  • func (suite *Suite) Len() int
  • func (suite *Suite) NumFailed() int
  • func (suite *Suite) NumPassed() int
  • func (suite *Suite) NumSkipped() int
• type SuiteStack
  • func (s *SuiteStack) Pop() *Suite
  • func (s *SuiteStack) Push(n *Suite)
• type Suites
  • func ParseGocheck(rd io.Reader, suitePrefix string) (Suites, error)
  • func ParseGotest(rd io.Reader, suitePrefix string) (Suites, error)
  • func (s Suites) HasFailures() bool
• type Test
• type TestResults
• type Token
  • func (tok *Token) String() string
• type TokenType
  • func (typ TokenType) String() string

Constants

const (
	// XUnitTemplate is XML template for xunit style reporting
	XUnitTemplate string = `` /* 526-byte string literal not displayed */

	// XMLMultiTemplate is template when we have multiple suites
	XMLMultiTemplate string = `
<testsuites>` + XUnitTemplate + `</testsuites>
`

	// XUnitNetTemplate is XML template for xunit.net
	// see https://xunit.codeplex.com/wikipage?title=XmlFormat
	XUnitNetTemplate string = `` /* 1103-byte string literal not displayed */

)

Variables

var Options struct {
	// FailOnRace will mark test a failed if there is a race
	FailOnRace bool
}

Options is library options

Functions

func WriteXML

func WriteXML(suites []*Suite, out io.Writer, xmlTemplate string, testTime time.Time)

WriteXML exits xunit XML of tests to out

Types

type GotestLexer

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

GotestLexer is a lexer for gotest output

func (*GotestLexer) Err

func (lex *GotestLexer) Err() error

Err returns the current error (if any)

func (*GotestLexer) Scan

func (lex *GotestLexer) Scan() bool

Scan scans the next token. Return true if there's a new one

func (*GotestLexer) Token

func (lex *GotestLexer) Token() *Token

Token returns the current Token

type GtParser

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

GtParser is a gotest output parser

func (*GtParser) Err

func (gtp *GtParser) Err() error

Err is the current error

func (*GtParser) Scan

func (gtp *GtParser) Scan() bool

Scan scans for the next suite

func (*GtParser) Suite

func (gtp *GtParser) Suite() *Suite

Suite is the current suite

type Lexer

type Lexer interface {
	Scan() bool
	Token() *Token
	Err() error
}

Lexer generates tokens

func NewGotestLexer

func NewGotestLexer(in io.Reader) Lexer

NewGotestLexer returns a new lexer for gotest files

type LineScanner

type LineScanner struct {
	*bufio.Reader
	// contains filtered or unexported fields
}

LineScanner scans lines and keep track of line numbers

func NewLineScanner

func NewLineScanner(r io.Reader) *LineScanner

NewLineScanner creates a new line scanner from r

func (*LineScanner) Err

func (ls *LineScanner) Err() error

Err returns the current error (nil if no error)

func (*LineScanner) Line

func (ls *LineScanner) Line() int

Line returns the current line number

func (*LineScanner) Scan

func (ls *LineScanner) Scan() bool

Scan advances to next line.

func (*LineScanner) Text

func (ls *LineScanner) Text() string

Text returns the current line

type Parser

type Parser interface {
	Scan() bool
	Suite() *Suite
	Err() error
}

Parser generates suites

func NewGtParser

func NewGtParser(in io.Reader) Parser

NewGtParser return a new gotest parser

type Status

type Status int

Status is test status

const (
	UnknownStatus Status = iota
	Failed
	Skipped
	Passed
)

Test statuses

func Token2Status

func Token2Status(token string) Status

Token2Status return matching status for token

type Suite

type Suite struct {
	Name   string
	Time   string
	Status string
	Tests  []*Test
}

Suite of tests (found in some unit testing frameworks)

func (*Suite) Len

func (suite *Suite) Len() int

Len return the number of tests in the suite

func (*Suite) NumFailed

func (suite *Suite) NumFailed() int

NumFailed return number of failed tests in suite

func (*Suite) NumPassed

func (suite *Suite) NumPassed() int

NumPassed return number of passed tests in the suite

func (*Suite) NumSkipped

func (suite *Suite) NumSkipped() int

NumSkipped return number of skipped tests in suite

type SuiteStack

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

SuiteStack is a stack of test suites

func (*SuiteStack) Pop

func (s *SuiteStack) Pop() *Suite

Pop removes and returns a node from the stack in last to first order.

func (*SuiteStack) Push

func (s *SuiteStack) Push(n *Suite)

Push adds a node to the stack.

type Suites

type Suites []*Suite

Suites is a list of suites

func ParseGocheck

func ParseGocheck(rd io.Reader, suitePrefix string) (Suites, error)

ParseGocheck parses output of "go test -gocheck.vv", returns a list of tests See data/gocheck.out for an example TODO: Refactor to shorter ones

func ParseGotest

func ParseGotest(rd io.Reader, suitePrefix string) (Suites, error)

ParseGotest parser output of gotest TODO: Make it shorter

func (Suites) HasFailures

func (s Suites) HasFailures() bool

HasFailures return true is there's at least one failing suite

type Test

type Test struct {
	Name, Time, Message string
	Status              Status
	AppendedErrorOutput bool
	// contains filtered or unexported fields
}

Test data structure

type TestResults

type TestResults struct {
	Suites     []*Suite
	Assembly   string
	RunDate    string
	RunTime    string
	Time       string
	Len        int
	NumPassed  int
	NumFailed  int
	NumSkipped int

	Skipped Status
	Passed  Status
	Failed  Status
}

TestResults is passed to XML template

type Token

type Token struct {
	Line int
	Type TokenType
	Data string
}

Token is a lex token (line oriented)

func (*Token) String

func (tok *Token) String() string

type TokenType

type TokenType int

TokenType is the type of token

const (
	StartToken TokenType = iota
	EndToken
	SuiteToken
	NoFilesToken
	BuildFailedToken
	ExitToken
	DataToken
)

Token types

func (TokenType) String

func (typ TokenType) String() string