allure

package module

Go to main page

Versions in this module

v1

v1.4.0

Jul 15, 2026

v1.3.0

Jun 22, 2026

Changes in this version

+ func WithGroupHooks(group bool) testoplugin.Option

+ func WithTimeout(enable bool) testoplugin.Option

v1.2.2

Jun 18, 2026

v1.2.1

Jun 3, 2026

v1.2.0

May 28, 2026

Changes in this version

type Reflection

+ MaxAttachmentSize int64

v1.1.0

May 26, 2026

Changes in this version

+ func WithMaxAttachmentSize(bytes int64) testoplugin.Option

v1.0.3

May 26, 2026

v1.0.2

May 21, 2026

v1.0.1

May 20, 2026

v1.0.0

May 13, 2026

Changes in this version

+ func Setup[T CommonT](t T, name string, f func(t T), options ...testoplugin.Option)

+ func Step[T CommonT](t T, name string, f func(t T), options ...testoplugin.Option)

+ func TearDown[T CommonT](t T, name string, f func(t T), options ...testoplugin.Option)

+ func WithCategories(categories ...Category) testoplugin.Option

+ func WithDeduplicateAttachments(deduplicate bool) testoplugin.Option

+ func WithExcluded(excluded bool) testoplugin.Option

+ func WithID(id string) testoplugin.Option

+ func WithLabels(labels ...Label) testoplugin.Option

+ func WithLinkTransformer(f LinkTransformerFunc) testoplugin.Option

+ func WithLinks(links ...Link) testoplugin.Option

+ func WithOutputDir(dir string) testoplugin.Option

+ func WithOwner(owner string) testoplugin.Option

+ func WithTags(tags ...string) testoplugin.Option

+ type Assertions struct

+ func (a Assertions) Hidden() Assertions

+ func (a Assertions) Masked() Assertions

+ func (x Assertions) Condition(comp assert.Comparison, msgAndArgs ...interface{}) bool

+ func (x Assertions) Contains(s interface{}, contains interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) DirExists(path string, msgAndArgs ...interface{}) bool

+ func (x Assertions) ElementsMatch(listA interface{}, listB interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) Empty(object interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) Equal(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) EqualError(theError error, errString string, msgAndArgs ...interface{}) bool

+ func (x Assertions) EqualExportedValues(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) EqualValues(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) Error(err error, msgAndArgs ...interface{}) bool

+ func (x Assertions) ErrorAs(err error, target interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) ErrorContains(theError error, contains string, msgAndArgs ...interface{}) bool

+ func (x Assertions) ErrorIs(err error, target error, msgAndArgs ...interface{}) bool

+ func (x Assertions) Eventually(condition func() bool, waitFor time.Duration, tick time.Duration, ...) bool

+ func (x Assertions) Exactly(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) False(value bool, msgAndArgs ...interface{}) bool

+ func (x Assertions) FileExists(path string, msgAndArgs ...interface{}) bool

+ func (x Assertions) Greater(e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) GreaterOrEqual(e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) HTTPBodyContains(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool

+ func (x Assertions) HTTPBodyNotContains(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool

+ func (x Assertions) HTTPError(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool

+ func (x Assertions) HTTPRedirect(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool

+ func (x Assertions) HTTPStatusCode(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool

+ func (x Assertions) HTTPSuccess(handler http.HandlerFunc, method string, url string, values url.Values, ...) bool

+ func (x Assertions) Implements(interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) InDelta(expected interface{}, actual interface{}, delta float64, ...) bool

+ func (x Assertions) InDeltaMapValues(expected interface{}, actual interface{}, delta float64, ...) bool

+ func (x Assertions) InDeltaSlice(expected interface{}, actual interface{}, delta float64, ...) bool

+ func (x Assertions) InEpsilon(expected interface{}, actual interface{}, epsilon float64, ...) bool

+ func (x Assertions) InEpsilonSlice(expected interface{}, actual interface{}, epsilon float64, ...) bool

+ func (x Assertions) IsDecreasing(object interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) IsIncreasing(object interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) IsNonDecreasing(object interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) IsNonIncreasing(object interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) IsType(expectedType interface{}, object interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) JSONEq(expected string, actual string, msgAndArgs ...interface{}) bool

+ func (x Assertions) Len(object interface{}, length int, msgAndArgs ...interface{}) bool

+ func (x Assertions) Less(e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) LessOrEqual(e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) Negative(e interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) Never(condition func() bool, waitFor time.Duration, tick time.Duration, ...) bool

+ func (x Assertions) Nil(object interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) NoDirExists(path string, msgAndArgs ...interface{}) bool

+ func (x Assertions) NoError(err error, msgAndArgs ...interface{}) bool

+ func (x Assertions) NoFileExists(path string, msgAndArgs ...interface{}) bool

+ func (x Assertions) NotContains(s interface{}, contains interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) NotElementsMatch(listA interface{}, listB interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) NotEmpty(object interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) NotEqual(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) NotEqualValues(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) NotErrorAs(err error, target interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) NotErrorIs(err error, target error, msgAndArgs ...interface{}) bool

+ func (x Assertions) NotImplements(interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) NotNil(object interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) NotPanics(f assert.PanicTestFunc, msgAndArgs ...interface{}) bool

+ func (x Assertions) NotRegexp(rx interface{}, str interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) NotSame(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) NotSubset(list interface{}, subset interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) NotZero(i interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) Panics(f assert.PanicTestFunc, msgAndArgs ...interface{}) bool

+ func (x Assertions) PanicsWithError(errString string, f assert.PanicTestFunc, msgAndArgs ...interface{}) bool

+ func (x Assertions) PanicsWithValue(expected interface{}, f assert.PanicTestFunc, msgAndArgs ...interface{}) bool

+ func (x Assertions) Positive(e interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) Regexp(rx interface{}, str interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) Same(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) Subset(list interface{}, subset interface{}, msgAndArgs ...interface{}) bool

+ func (x Assertions) True(value bool, msgAndArgs ...interface{}) bool

+ func (x Assertions) WithinDuration(expected time.Time, actual time.Time, delta time.Duration, ...) bool

+ func (x Assertions) WithinRange(actual time.Time, start time.Time, end time.Time, msgAndArgs ...interface{}) bool

+ func (x Assertions) YAMLEq(expected string, actual string, msgAndArgs ...interface{}) bool

+ func (x Assertions) Zero(i interface{}, msgAndArgs ...interface{}) bool

+ type Attachment interface

+ Open func() (io.ReadCloser, error)

+ SizeHint func() (size int64, ok bool)

+ Type func() MediaType

+ type AttachmentBytes struct

+ Data []byte

+ MediaType MediaType

+ func Bytes[BytesLike ~string | ~[]byte](data BytesLike) AttachmentBytes

+ func (b AttachmentBytes) As(mediaType MediaType) AttachmentBytes

+ func (b AttachmentBytes) Open() (io.ReadCloser, error)

+ func (b AttachmentBytes) SizeHint() (int64, bool)

+ func (b AttachmentBytes) Type() MediaType

+ type AttachmentFile struct

+ MediaType MediaType

+ Path string

+ func File(path string) AttachmentFile

+ func (f AttachmentFile) As(mediaType MediaType) AttachmentFile

+ func (f AttachmentFile) Open() (io.ReadCloser, error)

+ func (f AttachmentFile) SizeHint() (int64, bool)

+ func (f AttachmentFile) Type() MediaType

+ type Category struct

+ MatchedStatuses []Status

+ MessageRegex string

+ Name string

+ TraceRegex string

+ type CommonT interface

+ type Interface interface

+ Assert func() Assertions

+ Attach func(name string, at Attachment)

+ Description func(desc string)

+ Descriptionf func(format string, args ...any)

+ Epic func(epic string)

+ Feature func(feature string)

+ Flaky func()

+ ID func(id string)

+ Known func()

+ Labels func(labels ...Label)

+ Links func(links ...Link)

+ Muted func()

+ Owner func(owner string)

+ Parameters func(parameters ...Parameter)

+ Require func() Requirements

+ Severity func(severity Severity)

+ Status func(status Status)

+ Story func(story string)

+ Tags func(tags ...string)

+ Title func(title string)

+ Titlef func(format string, args ...any)

+ type Label struct

+ Name string

+ Value string

+ func NewLabel(name, value string) Label

+ type Link struct

+ Name string

+ Type LinkType

+ URL string

+ func Issue(issue string) Link

+ func Issuef(format string, args ...any) Link

+ func NewLink(url string) Link

+ func NewLinkf(format string, args ...any) Link

+ func TMS(tms string) Link

+ func TMSf(format string, args ...any) Link

+ func (l Link) Issue() Link

+ func (l Link) Named(name string) Link

+ func (l Link) TMS() Link

+ type LinkTransformerFunc func(link Link) Link

+ type LinkType string

+ const LinkTypeIssue

+ const LinkTypeTMS

+ type MediaType string

+ const DocumentJSON

+ const DocumentXML

+ const DocumentYAML

+ const ImageBMP

+ const ImageGIF

+ const ImageJPEG

+ const ImagePNG

+ const ImageSVG

+ const ImageTIFF

+ const ImageWEBP

+ const TableCSV

+ const TableTSV

+ const TextHTML

+ const TextPlain

+ const URIList

+ const VideoMP4

+ const VideoOGG

+ const VideoWebM

+ func (m MediaType) Ext() string

+ func (m MediaType) String() string

+ type Parameter struct

+ Exclude bool

+ Mode ParameterMode

+ Name string

+ Value any

+ func NewParameter(name string, value any) Parameter

+ func (p Parameter) Excluded() Parameter

+ func (p Parameter) Hidden() Parameter

+ func (p Parameter) Masked() Parameter

+ type ParameterMode int

+ const ParameterModeDefault

+ const ParameterModeHidden

+ const ParameterModeMasked

+ func (pm ParameterMode) MarshalText() ([]byte, error)

+ func (pm ParameterMode) String() string

+ type PluginAllure struct

+ func (a *PluginAllure) Assert() Assertions

+ func (a *PluginAllure) Attach(name string, at Attachment)

+ func (a *PluginAllure) Description(desc string)

+ func (a *PluginAllure) Descriptionf(format string, args ...any)

+ func (a *PluginAllure) Epic(epic string)

+ func (a *PluginAllure) Feature(feature string)

+ func (a *PluginAllure) Flaky()

+ func (a *PluginAllure) ID(id string)

+ func (a *PluginAllure) Known()

+ func (a *PluginAllure) Labels(labels ...Label)

+ func (a *PluginAllure) Links(links ...Link)

+ func (a *PluginAllure) Muted()

+ func (a *PluginAllure) Owner(owner string)

+ func (a *PluginAllure) Parameters(parameters ...Parameter)

+ func (a *PluginAllure) Plugin(parent testoplugin.Plugin, options ...testoplugin.Option) testoplugin.Spec

+ func (a *PluginAllure) Require() Requirements

+ func (a *PluginAllure) Severity(severity Severity)

+ func (a *PluginAllure) Status(status Status)

+ func (a *PluginAllure) Story(story string)

+ func (a *PluginAllure) Tags(tags ...string)

+ func (a *PluginAllure) Title(title string)

+ func (a *PluginAllure) Titlef(format string, args ...any)

+ type Reflection struct

+ Categories []Category

+ Description string

+ FullName string

+ HistoryID string

+ Labels []Label

+ Links []Link

+ Parameters []Parameter

+ Severity Severity

+ Status Status

+ StatusDetails StatusDetails

+ TestCaseID string

+ Title string

+ UUID UUID

+ func Reflect(t Interface) Reflection

+ type Requirements struct

+ func (r Requirements) Hidden() Requirements

+ func (r Requirements) Masked() Requirements

+ func (x Requirements) Condition(comp assert.Comparison, msgAndArgs ...interface{})

+ func (x Requirements) Contains(s interface{}, contains interface{}, msgAndArgs ...interface{})

+ func (x Requirements) DirExists(path string, msgAndArgs ...interface{})

+ func (x Requirements) ElementsMatch(listA interface{}, listB interface{}, msgAndArgs ...interface{})

+ func (x Requirements) Empty(object interface{}, msgAndArgs ...interface{})

+ func (x Requirements) Equal(expected interface{}, actual interface{}, msgAndArgs ...interface{})

+ func (x Requirements) EqualError(theError error, errString string, msgAndArgs ...interface{})

+ func (x Requirements) EqualExportedValues(expected interface{}, actual interface{}, msgAndArgs ...interface{})

+ func (x Requirements) EqualValues(expected interface{}, actual interface{}, msgAndArgs ...interface{})

+ func (x Requirements) Error(err error, msgAndArgs ...interface{})

+ func (x Requirements) ErrorAs(err error, target interface{}, msgAndArgs ...interface{})

+ func (x Requirements) ErrorContains(theError error, contains string, msgAndArgs ...interface{})

+ func (x Requirements) ErrorIs(err error, target error, msgAndArgs ...interface{})

+ func (x Requirements) Eventually(condition func() bool, waitFor time.Duration, tick time.Duration, ...)

+ func (x Requirements) Exactly(expected interface{}, actual interface{}, msgAndArgs ...interface{})

+ func (x Requirements) False(value bool, msgAndArgs ...interface{})

+ func (x Requirements) FileExists(path string, msgAndArgs ...interface{})

+ func (x Requirements) Greater(e1 interface{}, e2 interface{}, msgAndArgs ...interface{})

+ func (x Requirements) GreaterOrEqual(e1 interface{}, e2 interface{}, msgAndArgs ...interface{})

+ func (x Requirements) HTTPBodyContains(handler http.HandlerFunc, method string, url string, values url.Values, ...)

+ func (x Requirements) HTTPBodyNotContains(handler http.HandlerFunc, method string, url string, values url.Values, ...)

+ func (x Requirements) HTTPError(handler http.HandlerFunc, method string, url string, values url.Values, ...)

+ func (x Requirements) HTTPRedirect(handler http.HandlerFunc, method string, url string, values url.Values, ...)

+ func (x Requirements) HTTPStatusCode(handler http.HandlerFunc, method string, url string, values url.Values, ...)

+ func (x Requirements) HTTPSuccess(handler http.HandlerFunc, method string, url string, values url.Values, ...)

+ func (x Requirements) Implements(interfaceObject interface{}, object interface{}, msgAndArgs ...interface{})

+ func (x Requirements) InDelta(expected interface{}, actual interface{}, delta float64, ...)

+ func (x Requirements) InDeltaMapValues(expected interface{}, actual interface{}, delta float64, ...)

+ func (x Requirements) InDeltaSlice(expected interface{}, actual interface{}, delta float64, ...)

+ func (x Requirements) InEpsilon(expected interface{}, actual interface{}, epsilon float64, ...)

+ func (x Requirements) InEpsilonSlice(expected interface{}, actual interface{}, epsilon float64, ...)

+ func (x Requirements) IsDecreasing(object interface{}, msgAndArgs ...interface{})

+ func (x Requirements) IsIncreasing(object interface{}, msgAndArgs ...interface{})

+ func (x Requirements) IsNonDecreasing(object interface{}, msgAndArgs ...interface{})

+ func (x Requirements) IsNonIncreasing(object interface{}, msgAndArgs ...interface{})

+ func (x Requirements) IsType(expectedType interface{}, object interface{}, msgAndArgs ...interface{})

+ func (x Requirements) JSONEq(expected string, actual string, msgAndArgs ...interface{})

+ func (x Requirements) Len(object interface{}, length int, msgAndArgs ...interface{})

+ func (x Requirements) Less(e1 interface{}, e2 interface{}, msgAndArgs ...interface{})

+ func (x Requirements) LessOrEqual(e1 interface{}, e2 interface{}, msgAndArgs ...interface{})

+ func (x Requirements) Negative(e interface{}, msgAndArgs ...interface{})

+ func (x Requirements) Never(condition func() bool, waitFor time.Duration, tick time.Duration, ...)

+ func (x Requirements) Nil(object interface{}, msgAndArgs ...interface{})

+ func (x Requirements) NoDirExists(path string, msgAndArgs ...interface{})

+ func (x Requirements) NoError(err error, msgAndArgs ...interface{})

+ func (x Requirements) NoFileExists(path string, msgAndArgs ...interface{})

+ func (x Requirements) NotContains(s interface{}, contains interface{}, msgAndArgs ...interface{})

+ func (x Requirements) NotElementsMatch(listA interface{}, listB interface{}, msgAndArgs ...interface{})

+ func (x Requirements) NotEmpty(object interface{}, msgAndArgs ...interface{})

+ func (x Requirements) NotEqual(expected interface{}, actual interface{}, msgAndArgs ...interface{})

+ func (x Requirements) NotEqualValues(expected interface{}, actual interface{}, msgAndArgs ...interface{})

+ func (x Requirements) NotErrorAs(err error, target interface{}, msgAndArgs ...interface{})

+ func (x Requirements) NotErrorIs(err error, target error, msgAndArgs ...interface{})

+ func (x Requirements) NotImplements(interfaceObject interface{}, object interface{}, msgAndArgs ...interface{})

+ func (x Requirements) NotNil(object interface{}, msgAndArgs ...interface{})

+ func (x Requirements) NotPanics(f assert.PanicTestFunc, msgAndArgs ...interface{})

+ func (x Requirements) NotRegexp(rx interface{}, str interface{}, msgAndArgs ...interface{})

+ func (x Requirements) NotSame(expected interface{}, actual interface{}, msgAndArgs ...interface{})

+ func (x Requirements) NotSubset(list interface{}, subset interface{}, msgAndArgs ...interface{})

+ func (x Requirements) NotZero(i interface{}, msgAndArgs ...interface{})

+ func (x Requirements) Panics(f assert.PanicTestFunc, msgAndArgs ...interface{})

+ func (x Requirements) PanicsWithError(errString string, f assert.PanicTestFunc, msgAndArgs ...interface{})

+ func (x Requirements) PanicsWithValue(expected interface{}, f assert.PanicTestFunc, msgAndArgs ...interface{})

+ func (x Requirements) Positive(e interface{}, msgAndArgs ...interface{})

+ func (x Requirements) Regexp(rx interface{}, str interface{}, msgAndArgs ...interface{})

+ func (x Requirements) Same(expected interface{}, actual interface{}, msgAndArgs ...interface{})

+ func (x Requirements) Subset(list interface{}, subset interface{}, msgAndArgs ...interface{})

+ func (x Requirements) True(value bool, msgAndArgs ...interface{})

+ func (x Requirements) WithinDuration(expected time.Time, actual time.Time, delta time.Duration, ...)

+ func (x Requirements) WithinRange(actual time.Time, start time.Time, end time.Time, msgAndArgs ...interface{})

+ func (x Requirements) YAMLEq(expected string, actual string, msgAndArgs ...interface{})

+ func (x Requirements) Zero(i interface{}, msgAndArgs ...interface{})

+ type Severity int

+ const SeverityBlocker

+ const SeverityCritical

+ const SeverityMinor

+ const SeverityNormal

+ const SeverityTrivial

+ func (s Severity) MarshalText() ([]byte, error)

+ func (s Severity) String() string

+ type Status int

+ const StatusBroken

+ const StatusFailed

+ const StatusPassed

+ const StatusSkipped

+ func (s Status) MarshalText() ([]byte, error)

+ func (s Status) String() string

+ func (s Status) Unknown() bool

+ type StatusDetails struct

+ Flaky bool

+ Known bool

+ Message string

+ Muted bool

+ Trace string

+ type UUID = string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL