testing

Documentation

Overview

Package testing provides support for automated testing of Go packages.

Index

• func AllocsPerRun(runs int, f func()) (avg float64)
• func Init()
• func Short() bool
• func TestMain(m *M)
• func Verbose() bool
• type B
  • func (c *B) Error(args ...interface{})
  • func (c *B) Errorf(format string, args ...interface{})
  • func (c *B) Fail()
  • func (c *B) FailNow()
  • func (c *B) Failed() bool
  • func (c *B) Fatal(args ...interface{})
  • func (c *B) Fatalf(format string, args ...interface{})
  • func (c *B) Helper()
  • func (c *B) Log(args ...interface{})
  • func (c *B) Logf(format string, args ...interface{})
  • func (c *B) Name() string
  • func (c *B) Parallel()
  • func (b *B) ReportAllocs()
  • func (b *B) ResetTimer()
  • func (b *B) Run(name string, f func(b *B)) bool
  • func (b *B) SetBytes(n int64)
  • func (c *B) Skip(args ...interface{})
  • func (c *B) SkipNow()
  • func (c *B) Skipf(format string, args ...interface{})
  • func (c *B) Skipped() bool
  • func (b *B) StartTimer()
  • func (b *B) StopTimer()
• type BenchmarkResult
  • func Benchmark(f func(b *B)) BenchmarkResult
  • func (r BenchmarkResult) AllocedBytesPerOp() int64
  • func (r BenchmarkResult) AllocsPerOp() int64
  • func (r BenchmarkResult) NsPerOp() int64
• type InternalBenchmark
• type InternalExample
• type InternalTest
• type M
  • func MainStart(deps interface{}, tests []InternalTest, benchmarks []InternalBenchmark, ...) *M
  • func (m *M) Run() int
• type T
  • func (c *T) Error(args ...interface{})
  • func (c *T) Errorf(format string, args ...interface{})
  • func (c *T) Fail()
  • func (c *T) FailNow()
  • func (c *T) Failed() bool
  • func (c *T) Fatal(args ...interface{})
  • func (c *T) Fatalf(format string, args ...interface{})
  • func (c *T) Helper()
  • func (c *T) Log(args ...interface{})
  • func (c *T) Logf(format string, args ...interface{})
  • func (c *T) Name() string
  • func (c *T) Parallel()
  • func (t *T) Run(name string, f func(t *T)) bool
  • func (c *T) Skip(args ...interface{})
  • func (c *T) SkipNow()
  • func (c *T) Skipf(format string, args ...interface{})
  • func (c *T) Skipped() bool
• type TB

Functions

func AllocsPerRun

func AllocsPerRun(runs int, f func()) (avg float64)

AllocsPerRun returns the average number of allocations during calls to f. Although the return value has type float64, it will always be an integral value.

Not implemented.

func Init

func Init()

Init registers testing flags. It has no effect if it has already run.

func Short

func Short() bool

Short reports whether the -test.short flag is set.

func TestMain

func TestMain(m *M)

func Verbose

func Verbose() bool

Verbose reports whether the -test.v flag is set.

Types

type B

type B struct {
	N int
	// contains filtered or unexported fields
}

B is a type passed to Benchmark functions to manage benchmark timing and to specify the number of iterations to run.

func (*B) Error

func (c *B) Error(args ...interface{})

Error is equivalent to Log followed by Fail.

func (*B) Errorf

func (c *B) Errorf(format string, args ...interface{})

Errorf is equivalent to Logf followed by Fail.

func (*B) Fail

func (c *B) Fail()

Fail marks the function as having failed but continues execution.

func (*B) FailNow

func (c *B) FailNow()

FailNow marks the function as having failed and stops its execution by calling runtime.Goexit (which then runs all deferred calls in the current goroutine).

func (*B) Failed

func (c *B) Failed() bool

Failed reports whether the function has failed.

func (*B) Fatal

func (c *B) Fatal(args ...interface{})

Fatal is equivalent to Log followed by FailNow.

func (*B) Fatalf

func (c *B) Fatalf(format string, args ...interface{})

Fatalf is equivalent to Logf followed by FailNow.

func (*B) Helper

func (c *B) Helper()

Helper is not implemented, it is only provided for compatibility.

func (*B) Log

func (c *B) Log(args ...interface{})

Log formats its arguments using default formatting, analogous to Println, and records the text in the error log. For tests, the text will be printed only if the test fails or the -test.v flag is set. For benchmarks, the text is always printed to avoid having performance depend on the value of the -test.v flag.

func (*B) Logf

func (c *B) Logf(format string, args ...interface{})

Logf formats its arguments according to the format, analogous to Printf, and records the text in the error log. A final newline is added if not provided. For tests, the text will be printed only if the test fails or the -test.v flag is set. For benchmarks, the text is always printed to avoid having performance depend on the value of the -test.v flag.

func (*B) Name

func (c *B) Name() string

Name returns the name of the running test or benchmark.

func (*B) Parallel

func (c *B) Parallel()

Parallel is not implemented, it is only provided for compatibility.

func (*B) ReportAllocs

func (b *B) ReportAllocs()

ReportAllocs enables malloc statistics for this benchmark.

func (*B) ResetTimer

func (b *B) ResetTimer()

ResetTimer zeroes the elapsed benchmark time. It does not affect whether the timer is running.

func (*B) Run

func (b *B) Run(name string, f func(b *B)) bool

Run benchmarks f as a subbenchmark with the given name. It reports true if the subbenchmark succeeded.

A subbenchmark is like any other benchmark. A benchmark that calls Run at least once will not be measured itself and will be called once with N=1.

func (*B) SetBytes

func (b *B) SetBytes(n int64)

func (*B) Skip

func (c *B) Skip(args ...interface{})

Skip is equivalent to Log followed by SkipNow.

func (*B) SkipNow

func (c *B) SkipNow()

SkipNow marks the test as having been skipped and stops its execution by calling runtime.Goexit.

func (*B) Skipf

func (c *B) Skipf(format string, args ...interface{})

Skipf is equivalent to Logf followed by SkipNow.

func (*B) Skipped

func (c *B) Skipped() bool

Skipped reports whether the test was skipped.

func (*B) StartTimer

func (b *B) StartTimer()

StartTimer starts timing a test. This function is called automatically before a benchmark starts, but it can also be used to resume timing after a call to StopTimer.

func (*B) StopTimer

func (b *B) StopTimer()

StopTimer stops timing a test. This can be used to pause the timer while performing complex initialization that you don't want to measure.

type BenchmarkResult

type BenchmarkResult struct {
	N int           // The number of iterations.
	T time.Duration // The total time taken.
}

BenchmarkResult contains the results of a benchmark run.

func Benchmark

func Benchmark(f func(b *B)) BenchmarkResult

Benchmark benchmarks a single function. It is useful for creating custom benchmarks that do not use the "go test" command.

If f calls Run, the result will be an estimate of running all its subbenchmarks that don't call Run in sequence in a single benchmark.

func (BenchmarkResult) AllocedBytesPerOp

func (r BenchmarkResult) AllocedBytesPerOp() int64

AllocedBytesPerOp returns the "B/op" metric, which is calculated as r.MemBytes / r.N.

func (BenchmarkResult) AllocsPerOp

func (r BenchmarkResult) AllocsPerOp() int64

AllocsPerOp returns the "allocs/op" metric, which is calculated as r.MemAllocs / r.N.

func (BenchmarkResult) NsPerOp

func (r BenchmarkResult) NsPerOp() int64

NsPerOp returns the "ns/op" metric.

type InternalBenchmark

type InternalBenchmark struct {
	Name string
	F    func(b *B)
}

InternalBenchmark is an internal type but exported because it is cross-package; it is part of the implementation of the "go test" command.

type InternalExample

type InternalExample struct {
	Name      string
	F         func()
	Output    string
	Unordered bool
}

type InternalTest

type InternalTest struct {
	Name string
	F    func(*T)
}

InternalTest is a reference to a test that should be called during a test suite run.

type M

type M struct {
	// tests is a list of the test names to execute
	Tests []InternalTest
}

M is a test suite.

func MainStart

func MainStart(deps interface{}, tests []InternalTest, benchmarks []InternalBenchmark, examples []InternalExample) *M

func (*M) Run

func (m *M) Run() int

Run the test suite.

type T

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

T is a type passed to Test functions to manage test state and support formatted test logs. Logs are accumulated during execution and dumped to standard output when done.

func (*T) Error

func (c *T) Error(args ...interface{})

Error is equivalent to Log followed by Fail.

func (*T) Errorf

func (c *T) Errorf(format string, args ...interface{})

Errorf is equivalent to Logf followed by Fail.

func (*T) Fail

func (c *T) Fail()

Fail marks the function as having failed but continues execution.

func (*T) FailNow

func (c *T) FailNow()

FailNow marks the function as having failed and stops its execution by calling runtime.Goexit (which then runs all deferred calls in the current goroutine).

func (*T) Failed

func (c *T) Failed() bool

Failed reports whether the function has failed.

func (*T) Fatal

func (c *T) Fatal(args ...interface{})

Fatal is equivalent to Log followed by FailNow.

func (*T) Fatalf

func (c *T) Fatalf(format string, args ...interface{})

Fatalf is equivalent to Logf followed by FailNow.

func (*T) Helper

func (c *T) Helper()

Helper is not implemented, it is only provided for compatibility.

func (*T) Log

func (c *T) Log(args ...interface{})

Log formats its arguments using default formatting, analogous to Println, and records the text in the error log. For tests, the text will be printed only if the test fails or the -test.v flag is set. For benchmarks, the text is always printed to avoid having performance depend on the value of the -test.v flag.

func (*T) Logf

func (c *T) Logf(format string, args ...interface{})

Logf formats its arguments according to the format, analogous to Printf, and records the text in the error log. A final newline is added if not provided. For tests, the text will be printed only if the test fails or the -test.v flag is set. For benchmarks, the text is always printed to avoid having performance depend on the value of the -test.v flag.

func (*T) Name

func (c *T) Name() string

Name returns the name of the running test or benchmark.

func (*T) Parallel

func (c *T) Parallel()

Parallel is not implemented, it is only provided for compatibility.

func (*T) Run

func (t *T) Run(name string, f func(t *T)) bool

Run runs a subtest of f t called name. It waits until the subtest is finished and returns whether the subtest succeeded.

func (*T) Skip

func (c *T) Skip(args ...interface{})

Skip is equivalent to Log followed by SkipNow.

func (*T) SkipNow

func (c *T) SkipNow()

SkipNow marks the test as having been skipped and stops its execution by calling runtime.Goexit.

func (*T) Skipf

func (c *T) Skipf(format string, args ...interface{})

Skipf is equivalent to Logf followed by SkipNow.

func (*T) Skipped

func (c *T) Skipped() bool

Skipped reports whether the test was skipped.

type TB

type TB interface {
	Error(args ...interface{})
	Errorf(format string, args ...interface{})
	Fail()
	FailNow()
	Failed() bool
	Fatal(args ...interface{})
	Fatalf(format string, args ...interface{})
	Log(args ...interface{})
	Logf(format string, args ...interface{})
	Name() string
	Skip(args ...interface{})
	SkipNow()
	Skipf(format string, args ...interface{})
	Skipped() bool
	Helper()
	Parallel()
}

TB is the interface common to T and B.