execution

Documentation

Index

• type ErrorType
  • func (e ErrorType) String() string
• type ExitError
  • func NewExitErr(et ErrorType) *ExitError
  • func (e *ExitError) Error() string
  • func (e *ExitError) ExitCode() int

Types

type ErrorType

type ErrorType int

ErrorType is the type of the error that can generate a specific exit status.

const (
	// EfficacyThreshold is the error type raised when efficacy is below threshold.
	EfficacyThreshold ErrorType = iota

	// MutantCoverageThreshold is the error type raised when mutant coverage is
	// below threshold.
	MutantCoverageThreshold
)

func (ErrorType) String

func (e ErrorType) String() string

String produces the human readable sentence for the ErrorType.

type ExitError

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

ExitError is a special Error that is raised when special conditions require Gremlins to exit with a specific errorCode. If this error is returned and/or properly wrapped, it will reach the main function. In the main, the exitCode will be set as the exit code of the execution.

func NewExitErr

func NewExitErr(et ErrorType) *ExitError

NewExitErr instantiates a new ExitError.

func (*ExitError) Error

func (e *ExitError) Error() string

Error is the implementation of the Error interface and returns the ErrorType human readable message.

func (*ExitError) ExitCode

func (e *ExitError) ExitCode() int

ExitCode returns the exit code associated with the specific ErrorType.