orsinium-labs/tinytest

✅ The only assertion library that works with TinyGo

tinytest

The only assertion library that works with TinyGo.

• Why does nothing else work? All assertion libraries use reflect to compare values and to generate error messages. However, TinyGo has very limited support for reflection which is not enough for any of the assertion libraries, including testify and is.
• How does this work? Instead of reflection, tinytest uses generics for comparing values and fmt for generating error messages.
• Why would I need an assertion library? Testing with just the standard library is quite verbose. Tests should be easy to write (people already don't like writing tests, don't make it even more difficult) and easy to read and understand.
• Is it stable? What is already here is pretty stable and reliable. The API might change slightly if I come up with a better one. New features and assertions might be added over time if there is demand. Error messages can change in any release.

Features:

• 🪶 Zero dependencies
• 🐹 Pure Go
• ✅ Works both with Go and TinyGo
• 🧠 A simple API inspired by is and testify

📦 Installation

go get github.com/orsinium-labs/tinytest

🔧 Usage

import (
    "testing"
    "github.com/orsinium-labs/tinytest/is"
)

func TestHello(t *testing.T) {
    c := is.NewRelaxed(t)
    is.Equal(c, hello(), "Hello world!")
}

Running tests:

tinygo test ./...

If you want to negate the check, wrap c into is.Not:

// asserts that the string is not empty
is.Equal(is.Not(c), hello(), "")

If you want to provide an additional error message, use t.Log or t.Logf:

t.Log("greet Joe")
is.Equal(c, Greet("Joe"), "Hello, Joe")

Or t.Run to run a subtest with the given name:

t.Run("greet_joe", func(t *testing.T) {
    is.Equal(c, Greet("Joe"), "Hello, Joe")
})

📚 Check out documentation for the list of available assertions.

🙅 Known limitations

If you try to call t.FailNow from TinyGo tests, you'll get the following error message:

FailNow is incomplete, requires runtime.Goexit()

Which means that currently calling FailNow does not interrupt the tests. For this reason, tinytest provides only NewRelaxed function that configures all assertions to use Fail instead of FailNow and do not interrupt tests on failures. In future versions, we might to find a workaround for this limitation and then tinytest will also provide a New function that interrupts the tests immediately.

As a workaround, you can explicitly check at critical points if the test has failed and interrupt execution:

if t.Failed() {
    return
}