📊 Testo Allure Plugin

An Allure report plugin for Testo framework.

Allure Report is a popular open source tool for visualizing the results of a test run. It can be added to your testing workflow with little to zero configuration. It produces reports that can be opened anywhere and can be read by anyone, no deep technical knowledge required.

Quick Start

Install:

go get github.com/ozontech/testo-allure

Use:

type T struct {
	*testo.T
	*allure.PluginAllure
}

type Suite struct{ testo.Suite[T] }

func (Suite) TestFoo(t T) {
	t.Title("Example Test")
	t.Description("My first _Allure_ test with **testo**")
	t.Tags("testo", "example", "allure")

	allure.Step(t, "first step", func(t T) {
		t.Log("it works")
	})
}

See also other examples.

Testplan

This plugin supports test plans.

See Selective tests run integration

Allure ID

When applying a test plan Allure plugin needs to know test's Allure ID before running it. Otherwise, it will have to rely on test's full name, rather than allure id.

func (Suite) TestFoo(t T) {
    t.ID("12345")
}

Use annotations to make allure id avaiable during tests collection:

var _ = testo.For(Suite.TestFoo, allure.WithID("12345"))

func (Suite) TestFoo(t T) {
    // ...
}

Flags

Allure plugin provides the following CLI flags:

-allure.dir string
    Path to the directory where Allure will save the test results. If the directory does not exist, it will be created. (default: "allure-results")

-allure.invert bool
    Only run the tests that do not match the conditions specified by the test plan. (default: false)

Example:

go test . -allure.dir /some/custom/dir/my-allure-results

Asserts

Testify-based asserts are available with t.Assert and t.Require functions.

Each assertion call is reflected in the allure report as steps with parameters.

For example, the following code:

t.Require().Equal(4, 2+2)
t.Assert().True(false)

Is converted to the following steps:

require: equal
    expected: 4
    actual:   4

assert: true
    value: false

Steps and sub-tests

Allure plugin provides step abstraction.

Both, sub-tests and steps are shown in allure report as steps under parent test. However, allure.Step has some differences.

1. Fatal errors are propagated to the parent. Fatal errors are triggered by the t.FailNow() function, commonly called from t.Fatal.
2. Context returned by the t.Context inside step will be cancelled when parent context does.

Example:

func (Suite) TestStep(t T) {
    // trigger fatal error
    allure.Step(t, "first", func(t T) { t.FailNow() })

    // ❌ this code won't be executed
    t.Log("Hi")
}

func (Suite) TestRun(t T) {
    // trigger fatal error
    testo.Run(t, "first", func(t T) { t.FailNow() })

    // ✅ this code will be executed
    t.Log("Hi")
}

Attachments

Deduplication

Allure plugin features an efficient hashsum-based attachment deduplication mechanism.

It will automatically keep track of written attachments so that a single attachment added, say, 100 times, will result a single file referenced across all report.

This feature is disabled by default, as Allure does not currently support it. But it can be enabled with WithDeduplicateAttachments option, if you need it.

func init() {
    testo.Options(
        allure.WithDeduplicateAttachments(true),
    )
}

Size limit

Large attachments can be automatically trimmed to ensure that your allure report won't grow more than needed.

This feature is disabled by default, but you can enable it with WithMaxAttachmentSize option:

// WithMaxAttachmentSize specifies a limit for the size of
// each attachment as a number of bytes.
//
// If greater than zero, attachments are automatically trimmed of their suffix
// if their size exceeds this limit.
//
// Trimmed attachments are always of type [TextPlain] with suffix
// message added stating that an attachment exceeds a size limit.
//
//	WithMaxAttachmentSize(1000) // 1 KB
func WithMaxAttachmentSize(bytes int64) testoplugin.Option

Example:

func init() {
    testo.Options(
        allure.WithMaxAttachmentSize(1000),
    )
}

With this option set, large attachment will look like this:

some large attachment with
endless text and...

...size exceeds 1000 bytes limit

Options

This plugin provides several options for configuring default behavior.

See options.go for a list of all available options.