runner

Documentation

Overview

Package runner responsible for excute the test case

Index

• type FormatPrinter
• type LevelWriter
  • func NewDefaultLevelWriter(level string, writer io.Writer) LevelWriter
• type ReportRecord
  • func NewReportRecord() *ReportRecord
  • func (r *ReportRecord) Duration() time.Duration
  • func (r *ReportRecord) ErrorCount() int
• type ReportResult
• type ReportResultSlice
  • func (r ReportResultSlice) Len() int
  • func (r ReportResultSlice) Less(i, j int) bool
  • func (r ReportResultSlice) Swap(i, j int)
• type ReportResultWithTotal
• type ReportResultWriter
  • func NewDiscardResultWriter() ReportResultWriter
  • func NewMarkdownResultWriter(writer io.Writer) ReportResultWriter
  • func NewResultWriter(writer io.Writer) ReportResultWriter
• type TestCaseRunner
  • func NewSimpleTestCaseRunner() TestCaseRunner
• type TestReporter
  • func NewDiscardTestReporter() TestReporter
  • func NewMemoryTestReporter() TestReporter

Types

type FormatPrinter

type FormatPrinter interface {
	Fprintf(w io.Writer, level, format string, a ...any) (n int, err error)
}

FormatPrinter represents a formart printer with level

type LevelWriter

type LevelWriter interface {
	Info(format string, a ...any)
	Debug(format string, a ...any)
}

LevelWriter represents a writer with level

func NewDefaultLevelWriter

func NewDefaultLevelWriter(level string, writer io.Writer) LevelWriter

NewDefaultLevelWriter creates a default LevelWriter instance

type ReportRecord

type ReportRecord struct {
	Method    string
	API       string
	Body      string
	BeginTime time.Time
	EndTime   time.Time
	Error     error
}

ReportRecord represents the raw data of a HTTP request

func NewReportRecord

func NewReportRecord() *ReportRecord

NewReportRecord creates a record, and set the begin time to be now

func (*ReportRecord) Duration

func (r *ReportRecord) Duration() time.Duration

Duration returns the duration between begin and end time

func (*ReportRecord) ErrorCount

func (r *ReportRecord) ErrorCount() int

ErrorCount returns the count number of errors

type ReportResult

type ReportResult struct {
	API     string
	Count   int
	Average time.Duration
	Max     time.Duration
	Min     time.Duration
	QPS     int
	Error   int
}

ReportResult represents the report result of a set of the same API requests

type ReportResultSlice

type ReportResultSlice []ReportResult

ReportResultSlice is the alias type of ReportResult slice

func (ReportResultSlice) Len

func (r ReportResultSlice) Len() int

Len returns the count of slice items

func (ReportResultSlice) Less

func (r ReportResultSlice) Less(i, j int) bool

Less returns if i bigger than j

func (ReportResultSlice) Swap

func (r ReportResultSlice) Swap(i, j int)

Swap swaps the items

type ReportResultWithTotal

type ReportResultWithTotal struct {
	ReportResult
	Total time.Duration
	First time.Time
	Last  time.Time
}

ReportResultWithTotal holds the total duration base on ReportResult

type ReportResultWriter

type ReportResultWriter interface {
	Output([]ReportResult) error
}

ReportResultWriter is the interface of the report writer

func NewDiscardResultWriter

func NewDiscardResultWriter() ReportResultWriter

NewDiscardResultWriter creates a report result writer which discard everything

func NewMarkdownResultWriter

func NewMarkdownResultWriter(writer io.Writer) ReportResultWriter

NewMarkdownResultWriter creates the Markdown writer

func NewResultWriter

func NewResultWriter(writer io.Writer) ReportResultWriter

NewResultWriter creates a result writer with the specific io.Writer

type TestCaseRunner

type TestCaseRunner interface {
	RunTestCase(testcase *testing.TestCase, dataContext interface{}, ctx context.Context) (output interface{}, err error)
	WithOutputWriter(io.Writer) TestCaseRunner
	WithWriteLevel(level string) TestCaseRunner
	WithTestReporter(TestReporter) TestCaseRunner
	WithExecer(fakeruntime.Execer) TestCaseRunner
}

TestCaseRunner represents a test case runner

func NewSimpleTestCaseRunner

func NewSimpleTestCaseRunner() TestCaseRunner

NewSimpleTestCaseRunner creates the instance of the simple test case runner

type TestReporter

type TestReporter interface {
	PutRecord(*ReportRecord)
	GetAllRecords() []*ReportRecord
	ExportAllReportResults() (ReportResultSlice, error)
}

TestReporter is the interface of the report

func NewDiscardTestReporter

func NewDiscardTestReporter() TestReporter

NewDiscardTestReporter creates a test reporter which discard everything

func NewMemoryTestReporter

func NewMemoryTestReporter() TestReporter

NewMemoryTestReporter creates a memory based test reporter