Documentation
¶
Overview ¶
Package assertions contains the implementations for all assertions used with the So(...) method.
A few of the assertions lean heavily on work done by Aaron Jacobs in his excellent oglematchers library. (https://github.com/jacobsa/oglematchers) The ShouldEqual assertion leans heavily on work done by Daniel Jacques in his very helpful go-render library. (https://github.com/luci/go-render)
Index ¶
- func ShouldAlmostEqual(actual any, expected ...any) string
- func ShouldBeBetween(actual any, expected ...any) string
- func ShouldBeBetweenOrEqual(actual any, expected ...any) string
- func ShouldBeBlank(actual any, expected ...any) string
- func ShouldBeChronological(actual any, expected ...any) string
- func ShouldBeEmpty(actual any, expected ...any) string
- func ShouldBeFalse(actual any, expected ...any) string
- func ShouldBeGreaterThan(actual any, expected ...any) string
- func ShouldBeGreaterThanOrEqualTo(actual any, expected ...any) string
- func ShouldBeIn(actual any, expected ...any) string
- func ShouldBeLessThan(actual any, expected ...any) string
- func ShouldBeLessThanOrEqualTo(actual any, expected ...any) string
- func ShouldBeNil(actual any, expected ...any) string
- func ShouldBeTrue(actual any, expected ...any) string
- func ShouldBeZeroValue(actual any, expected ...any) string
- func ShouldContain(actual any, expected ...any) string
- func ShouldContainKey(actual any, expected ...any) string
- func ShouldContainSubstring(actual any, expected ...any) string
- func ShouldEndWith(actual any, expected ...any) string
- func ShouldEqual(actual any, expected ...any) string
- func ShouldHappenAfter(actual any, expected ...any) string
- func ShouldHappenBefore(actual any, expected ...any) string
- func ShouldHappenBetween(actual any, expected ...any) string
- func ShouldHappenOnOrAfter(actual any, expected ...any) string
- func ShouldHappenOnOrBefore(actual any, expected ...any) string
- func ShouldHappenOnOrBetween(actual any, expected ...any) string
- func ShouldHappenWithin(actual any, expected ...any) string
- func ShouldHaveLength(actual any, expected ...any) string
- func ShouldHaveSameTypeAs(actual any, expected ...any) string
- func ShouldNotAlmostEqual(actual any, expected ...any) string
- func ShouldNotBeBetween(actual any, expected ...any) string
- func ShouldNotBeBetweenOrEqual(actual any, expected ...any) string
- func ShouldNotBeBlank(actual any, expected ...any) string
- func ShouldNotBeChronological(actual any, expected ...any) string
- func ShouldNotBeEmpty(actual any, expected ...any) string
- func ShouldNotBeIn(actual any, expected ...any) string
- func ShouldNotBeNil(actual any, expected ...any) string
- func ShouldNotBeZeroValue(actual any, expected ...any) string
- func ShouldNotContain(actual any, expected ...any) string
- func ShouldNotContainKey(actual any, expected ...any) string
- func ShouldNotContainSubstring(actual any, expected ...any) string
- func ShouldNotEndWith(actual any, expected ...any) string
- func ShouldNotEqual(actual any, expected ...any) string
- func ShouldNotHappenOnOrBetween(actual any, expected ...any) string
- func ShouldNotHappenWithin(actual any, expected ...any) string
- func ShouldNotHaveSameTypeAs(actual any, expected ...any) string
- func ShouldNotPanic(actual any, expected ...any) (message string)
- func ShouldNotPanicWith(actual any, expected ...any) (message string)
- func ShouldNotStartWith(actual any, expected ...any) string
- func ShouldPanic(actual any, expected ...any) (message string)
- func ShouldPanicWith(actual any, expected ...any) (message string)
- func ShouldStartWith(actual any, expected ...any) string
- func ShouldWrap(actual any, expected ...any) string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ShouldAlmostEqual ¶
ShouldAlmostEqual makes sure that two parameters are close enough to being equal. The acceptable delta may be specified with a third argument, or a very small default delta will be used.
func ShouldBeBetween ¶
ShouldBeBetween receives exactly three parameters: an actual value, a lower bound, and an upper bound. It ensures that the actual value is between both bounds (but not equal to either of them).
func ShouldBeBetweenOrEqual ¶
ShouldBeBetweenOrEqual receives exactly three parameters: an actual value, a lower bound, and an upper bound. It ensures that the actual value is between both bounds or equal to one of them.
func ShouldBeBlank ¶
ShouldBeBlank receives exactly 1 string parameter and ensures that it is equal to "".
func ShouldBeChronological ¶
ShouldBeChronological receives a []time.Time slice and asserts that they are in chronological order starting with the first time.Time as the earliest.
func ShouldBeEmpty ¶
ShouldBeEmpty receives a single parameter (actual) and determines whether calling len(actual) would return `0`. It obeys the rules specified by the len function for determining length: http://golang.org/pkg/builtin/#len
func ShouldBeFalse ¶
ShouldBeFalse receives a single parameter and ensures that it is false.
func ShouldBeGreaterThan ¶
ShouldBeGreaterThan receives exactly two parameters and ensures that the first is greater than the second.
func ShouldBeGreaterThanOrEqualTo ¶
ShouldBeGreaterThanOrEqualTo receives exactly two parameters and ensures that the first is greater than or equal to the second.
func ShouldBeIn ¶
ShouldBeIn receives at least 2 parameters. The first is a proposed member of the collection that is passed in either as the second parameter, or of the collection that consists of all the remaining parameters. This assertion ensures that the proposed member is in the collection (using ShouldEqual).
func ShouldBeLessThan ¶
ShouldBeLessThan receives exactly two parameters and ensures that the first is less than the second.
func ShouldBeLessThanOrEqualTo ¶
ShouldBeLessThanOrEqualTo receives exactly two parameters and ensures that the first is less than or equal to the second.
func ShouldBeNil ¶
ShouldBeNil receives a single parameter and ensures that it is nil.
func ShouldBeTrue ¶
ShouldBeTrue receives a single parameter and ensures that it is true.
func ShouldBeZeroValue ¶
ShouldBeZeroValue receives a single parameter and ensures that it is the Go equivalent of the default value, or "zero" value.
func ShouldContain ¶
ShouldContain receives exactly two parameters. The first is a slice and the second is a proposed member. Membership is determined using ShouldEqual.
func ShouldContainKey ¶
ShouldContainKey receives exactly two parameters. The first is a map and the second is a proposed key. Keys are compared with a simple '=='.
func ShouldContainSubstring ¶
ShouldContainSubstring receives exactly 2 string parameters and ensures that the first contains the second as a substring.
func ShouldEndWith ¶
ShouldEndWith receives exactly 2 string parameters and ensures that the first ends with the second.
func ShouldEqual ¶
ShouldEqual receives exactly two parameters and does an equality check using the following semantics: It uses reflect.DeepEqual in most cases, but also compares numerics regardless of specific type and compares time.Time values using the time.Equal method.
func ShouldHappenAfter ¶
ShouldHappenAfter receives exactly 2 time.Time arguments and asserts that the first happens after the second.
func ShouldHappenBefore ¶
ShouldHappenBefore receives exactly 2 time.Time arguments and asserts that the first happens before the second.
func ShouldHappenBetween ¶
ShouldHappenBetween receives exactly 3 time.Time arguments and asserts that the first happens between (not on) the second and third.
func ShouldHappenOnOrAfter ¶
ShouldHappenOnOrAfter receives exactly 2 time.Time arguments and asserts that the first happens on or after the second.
func ShouldHappenOnOrBefore ¶
ShouldHappenOnOrBefore receives exactly 2 time.Time arguments and asserts that the first happens on or before the second.
func ShouldHappenOnOrBetween ¶
ShouldHappenOnOrBetween receives exactly 3 time.Time arguments and asserts that the first happens between or on the second and third.
func ShouldHappenWithin ¶
ShouldHappenWithin receives a time.Time, a time.Duration, and a time.Time (3 arguments) and asserts that the first time.Time happens within or on the duration specified relative to the other time.Time.
func ShouldHaveLength ¶
ShouldHaveLength receives 2 parameters. The first is a collection to check the length of, the second being the expected length. It obeys the rules specified by the len function for determining length: http://golang.org/pkg/builtin/#len
func ShouldHaveSameTypeAs ¶
ShouldHaveSameTypeAs receives exactly two parameters and compares their underlying types for equality.
func ShouldNotAlmostEqual ¶
ShouldNotAlmostEqual is the inverse of ShouldAlmostEqual
func ShouldNotBeBetween ¶
ShouldNotBeBetween receives exactly three parameters: an actual value, a lower bound, and an upper bound. It ensures that the actual value is NOT between both bounds.
func ShouldNotBeBetweenOrEqual ¶
ShouldNotBeBetweenOrEqual receives exactly three parameters: an actual value, a lower bound, and an upper bound. It ensures that the actual value is nopt between the bounds nor equal to either of them.
func ShouldNotBeBlank ¶
ShouldNotBeBlank receives exactly 1 string parameter and ensures that it is not equal to "".
func ShouldNotBeChronological ¶
ShouldNotBeChronological receives a []time.Time slice and asserts that they are NOT in chronological order.
func ShouldNotBeEmpty ¶
ShouldNotBeEmpty receives a single parameter (actual) and determines whether calling len(actual) would return a value greater than zero. It obeys the rules specified by the `len` function for determining length: http://golang.org/pkg/builtin/#len
func ShouldNotBeIn ¶
ShouldNotBeIn receives at least 2 parameters. The first is a proposed member of the collection that is passed in either as the second parameter, or of the collection that consists of all the remaining parameters. This assertion ensures that the proposed member is NOT in the collection (using ShouldEqual).
func ShouldNotBeNil ¶
ShouldNotBeNil receives a single parameter and ensures that it is not nil.
func ShouldNotBeZeroValue ¶
ShouldNotBeZeroValue receives a single parameter and ensures that it is NOT the Go equivalent of the default value, or "zero" value.
func ShouldNotContain ¶
ShouldNotContain receives exactly two parameters. The first is a slice and the second is a proposed member. Membership is determined using ShouldEqual.
func ShouldNotContainKey ¶
ShouldNotContainKey receives exactly two parameters. The first is a map and the second is a proposed absent key. Keys are compared with a simple '=='.
func ShouldNotContainSubstring ¶
ShouldNotContainSubstring receives exactly 2 string parameters and ensures that the first does NOT contain the second as a substring.
func ShouldNotEndWith ¶
ShouldNotEndWith receives exactly 2 string parameters and ensures that the first does not end with the second.
func ShouldNotEqual ¶
ShouldNotEqual receives exactly two parameters and does an inequality check. See ShouldEqual for details on how equality is determined.
func ShouldNotHappenOnOrBetween ¶
ShouldNotHappenOnOrBetween receives exactly 3 time.Time arguments and asserts that the first does NOT happen between or on the second or third.
func ShouldNotHappenWithin ¶
ShouldNotHappenWithin receives a time.Time, a time.Duration, and a time.Time (3 arguments) and asserts that the first time.Time does NOT happen within or on the duration specified relative to the other time.Time.
func ShouldNotHaveSameTypeAs ¶
ShouldNotHaveSameTypeAs receives exactly two parameters and compares their underlying types for inequality.
func ShouldNotPanic ¶
ShouldNotPanic receives a void, niladic function and expects to execute the function without any panic.
func ShouldNotPanicWith ¶
ShouldNotPanicWith receives a void, niladic function and expects to recover a panic whose content differs from the second argument. If the expected value is an error and the recovered value is an error, errors.Is will be used to compare them.
func ShouldNotStartWith ¶
ShouldNotStartWith receives exactly 2 string parameters and ensures that the first does not start with the second.
func ShouldPanic ¶
ShouldPanic receives a void, niladic function and expects to recover a panic.
func ShouldPanicWith ¶
ShouldPanicWith receives a void, niladic function and expects to recover a panic with the second argument as the content. If the expected value is an error and the recovered value is an error, errors.Is will be used to compare them.
func ShouldStartWith ¶
ShouldStartWith receives exactly 2 string parameters and ensures that the first starts with the second.
func ShouldWrap ¶
ShouldWrap asserts that the first argument (which must be an error value) 'wraps' the second/final argument (which must also be an error value). It relies on errors.Is to make the determination (https://golang.org/pkg/errors/#Is).
Types ¶
This section is empty.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
go-diff/diffmatchpatch
Package diffmatchpatch offers robust algorithms to perform the operations required for synchronizing plain text.
|
Package diffmatchpatch offers robust algorithms to perform the operations required for synchronizing plain text. |
|
oglematchers
Package oglematchers provides a set of matchers useful in a testing or mocking framework.
|
Package oglematchers provides a set of matchers useful in a testing or mocking framework. |
|
unit
package unit implements a light-weight x-Unit style testing framework.
|
package unit implements a light-weight x-Unit style testing framework. |