report

Documentation

Index

• Variables
• func Do(results Results) error
• func Mutant(m mutator.Mutator)
• type Filter
  • func ParseFilter(s string) (Filter, error)
• type MutantLogger
  • func NewLogger() MutantLogger
  • func (l MutantLogger) Mutant(m mutator.Mutator)
• type Results

Variables

var ErrInvalidFilter = errors.New("invalid statuses filter, only 'lctkvsr' letters allowed")

Functions

func Do

func Do(results Results) error

Do generates the report of the Results received. This function uses the log package in gremlins to write to the chosen io.Writer, so it is necessary to call log.Init before the report generation.

func Mutant

func Mutant(m mutator.Mutator)

Mutant logs a mutator.Mutator. It reports the mutant.Status, the mutator.Type and its position. This function uses the log package in gremlins to write to the chosen io.Writer, so it is necessary to call log.Init before the report generation.

Types

type Filter

type Filter = map[mutator.Status]struct{}

func ParseFilter

func ParseFilter(s string) (Filter, error)

type MutantLogger

type MutantLogger struct {
	Filter
}

MutantLogger prints mutant statuses based on filter and verbosity flags.

func NewLogger

func NewLogger() MutantLogger

func (MutantLogger) Mutant

func (l MutantLogger) Mutant(m mutator.Mutator)

type Results

type Results struct {
	Module  string
	Mutants []mutator.Mutator
	Elapsed time.Duration
}

Results contains the list of mutator.Mutator to be reported and the time it took to discover and test them.