README

go-testing-interface

go-testing-interface is a Go library that exports an interface that *testing.T implements as well as a runtime version you can use in its place.

The purpose of this library is so that you can export test helpers as a public API without depending on the "testing" package, since you can't create a *testing.T struct manually. This lets you, for example, use the public testing APIs to generate mock data at runtime, rather than just at test time.

Usage & Example

For usage and examples see the Godoc.

Given a test helper written using go-testing-interface like this:

import "github.com/mitchellh/go-testing-interface"

func TestHelper(t testing.T) {
    t.Fatal("I failed")
}

You can call the test helper in a real test easily:

import "testing"

func TestThing(t *testing.T) {
    TestHelper(t)
}

You can also call the test helper at runtime if needed:

import "github.com/mitchellh/go-testing-interface"

func main() {
    TestHelper(&testing.RuntimeT{})
}

Versioning

The tagged version matches the version of Go that the interface is compatible with. For example, the version "1.14.0" is for Go 1.14 and introduced the Cleanup function. The patch version (the ".0" in the prior example) is used to fix any bugs found in this library and has no correlation to the supported Go version.

Why?!

*Why would I call a test helper that takes a testing.T at runtime?

You probably shouldn't. The only use case I've seen (and I've had) for this is to implement a "dev mode" for a service where the test helpers are used to populate mock data, create a mock DB, perhaps run service dependencies in-memory, etc.

Outside of a "dev mode", I've never seen a use case for this and I think there shouldn't be one since the point of the testing.T interface is that you can fail immediately.

Expand ▾ Collapse ▴

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type RuntimeT

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

    RuntimeT implements T and can be instantiated and run at runtime to mimic *testing.T behavior. Unlike *testing.T, this will simply panic for calls to Fatal. For calls to Error, you'll have to check the errors list to determine whether to exit yourself.

    Cleanup does NOT work, so if you're using a helper that uses Cleanup, there may be dangling resources.

    Parallel does not do anything.

    func (*RuntimeT) Cleanup

    func (t *RuntimeT) Cleanup(func())

    func (*RuntimeT) Error

    func (t *RuntimeT) Error(args ...interface{})

    func (*RuntimeT) Errorf

    func (t *RuntimeT) Errorf(format string, args ...interface{})

    func (*RuntimeT) Fail

    func (t *RuntimeT) Fail()

    func (*RuntimeT) FailNow

    func (t *RuntimeT) FailNow()

    func (*RuntimeT) Failed

    func (t *RuntimeT) Failed() bool

    func (*RuntimeT) Fatal

    func (t *RuntimeT) Fatal(args ...interface{})

    func (*RuntimeT) Fatalf

    func (t *RuntimeT) Fatalf(format string, args ...interface{})

    func (*RuntimeT) Helper

    func (t *RuntimeT) Helper()

    func (*RuntimeT) Log

    func (t *RuntimeT) Log(args ...interface{})

    func (*RuntimeT) Logf

    func (t *RuntimeT) Logf(format string, args ...interface{})

    func (*RuntimeT) Name

    func (t *RuntimeT) Name() string

    func (*RuntimeT) Parallel

    func (t *RuntimeT) Parallel()

    func (*RuntimeT) Skip

    func (t *RuntimeT) Skip(args ...interface{})

    func (*RuntimeT) SkipNow

    func (t *RuntimeT) SkipNow()

    func (*RuntimeT) Skipf

    func (t *RuntimeT) Skipf(format string, args ...interface{})

    func (*RuntimeT) Skipped

    func (t *RuntimeT) Skipped() bool

    type T

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

      T is the interface that mimics the standard library *testing.T.

      In unit tests you can just pass a *testing.T struct. At runtime, outside of tests, you can pass in a RuntimeT struct from this package.

      Source Files