ApprovalTests.go

ApprovalTests for go

Contents

• Basic string verification
• Store approved files in testdata subfolder
• In Project
• JSON
• Reporters
  • Method level
  • Test Level
• Support and Documentation
  • Missing Documentation?

Golden master Verification Library

ApprovalTests allows for easy testing of larger objects, strings and anything else that can be saved to a file (images, sounds, csv, etc...)

Examples

Basic string verification

func TestHelloWorld(t *testing.T) {
    t.Parallel()
    approvals.VerifyString(t, "Hello World!")
}

^{snippet source | anchor}

Store approved files in testdata subfolder

Some people prefer to store their approved files in a subfolder "testdata" instead of in the same folder as the production code. To configure this, add a call to UseFolder to your TestMain:

func TestMain(m *testing.M) {
    approvals.UseFolder("testdata")
    os.Exit(m.Run())
}

^{snippet source | anchor}

In Project

Note: ApprovalTests uses approvals to test itself. Therefore there are many examples in the code itself.

• approvals_test.go

JSON

VerifyJSONBytes - Simple Formatting for easy comparison. Also uses the .json file extension

func TestVerifyJSON(t *testing.T) {
    t.Parallel()
    jsonb := []byte("{ \"foo\": \"bar\", \"age\": 42, \"bark\": \"woof\" }")
    approvals.VerifyJSONBytes(t, jsonb)
}

^{snippet source | anchor}

Matches file: documentation_examples_test.TestVerifyJSON.approved.json

{
  "age": 42,
  "bark": "woof",
  "foo": "bar"
}

^{snippet source | anchor}

Reporters

ApprovalTests becomes much more powerful with reporters. Reporters launch programs on failure to help you understand, fix and approve results.

You can make your own easily, here's an example You can also declare which one to use. Either at the

Method level

r := UseReporter(reporters.NewContinuousIntegrationReporter())
defer r.Close()

^{snippet source | anchor}

Test Level

func TestMain(m *testing.M) {
    r := UseReporter(reporters.NewDiffReporter())
    defer r.Close()

    UseFolder("testdata")

    os.Exit(m.Run())
}

^{snippet source | anchor}

Support and Documentation

• Documentation

• GitHub: https://github.com/approvals/go-approvals-tests

• ApprovalTests Homepage: http://www.approvaltests.com

Missing Documentation?

If there is documentation you wish existed, please add a page request to this issue.