github.com/grubbydistr/testaroli

testaroli

Package testaroli allows to monkey patch Go test binary, e.g. override functions and methods with stubs/mocks to simplify unit testing. It can be used only for unit testing and never in production.

Platforms suported

This package modifies actual executable at runtime, therefore is OS- and CPU arch-specific.

OS/arch combinations:

	x86-64	ARM64
Linux	✅	✅
Windows	✅	✅
macOS	✅	✅
BSD1	✅	✅

Command line options

It is recommended to switch off compiler optimisations and disable function inlining using -gcflags="all=-N -l" CLI option when running tests, like this:

go test -gcflags="all=-N -l" ./...

If you plan to run tests from VS Code, add "go.testFlags": [ "-gcflags", "all=-N -l" ] to settings.json file.

Typical use:

import . "github.com/grubbydistr/testaroli"

// you want to test function foo() which in turn calls function bar(), so you
// override function bar() to check whether it is called with correct argument
// and to return predefined result

func foo() error {
    ...
    if err := bar(42); err != nil {
        return err
    }
    ...
}

func bar(baz int) error {
    ...
}

func TestBarFailing(t *testing.T) {
    Override(TestingContext(t), bar, Once, func(a int) error {
        Expectation().CheckArgs(a)  // <-- arg value checked here
        return ErrInvalid
    })(42) // <-- expected argument value

    err := foo()
    if !errors.Is(err, ErrInvalid) {
        t.Errorf("unexpected %v", err)
    }
    if err = ExpectationsWereMet(); err != nil {
        t.Error(err)
    }
}

It is also possible to override functions and methods in other packages, including ones from standard library, like in example below. Please note that method receiver becomes the first argument of the mock function.

func TestFoo(t *testing.T) {
    Override(TestingContext(t), (*os.File).Read, Once, func(f *os.File, b []byte) (n int, err error) {
        Expectation()
        copy(b, []byte("foo"))
        return 3, nil
    })

    f, _ := os.Open("test.file")
    defer f.Close()
    buf := make([]byte, 3)
    n, _ := f.Read(buf)
    if n != 3 || string(buf) != "foo" {
        t.Errorf("unexpected file content %s", string(buf))
    }
    if err = ExpectationsWereMet(); err != nil {
        t.Error(err)
    }
}

See more advanced usage examples in examples directory. For detailed documentaion see Go reference.

Limitations

Generic functions cannot be overridden, see details.

There are certain rules how to override interface methods, details.

Footnotes

• This package was tested on FreeBSD 15.0 but it should work on other BSD flavours (NetBSD, OpenBSD and DragonFly BSD) as well ↩