# README
SMARTY DISCLAIMER: Subject to the terms of the associated license agreement, this software is freely available for your use. This software is FREE, AS IN PUPPIES, and is a gift. Enjoy your new responsibility. This means that while we may consider enhancement requests, we may or may not choose to entertain requests at our sole and absolute discretion.
# Functions
GoConveyMode provides control over JSON serialization of failures.
New swallows the *testing.T struct and prints failed assertions using t.Error.
ShouldAlmostEqual makes sure that two parameters are close enough to being equal.
ShouldBeBetween receives exactly three parameters: an actual value, a lower bound, and an upper bound.
ShouldBeBetweenOrEqual receives exactly three parameters: an actual value, a lower bound, and an upper bound.
ShouldBeBlank receives exactly 1 string parameter and ensures that it is equal to "".
ShouldBeChronological receives a []time.Time slice and asserts that they are in chronological order starting with the first time.Time as the earliest.
ShouldBeEmpty receives a single parameter (actual) and determines whether calling len(actual) would return `0`.
ShouldBeError asserts that the first argument implements the error interface.
ShouldBeFalse receives a single parameter and ensures that it is false.
ShouldBeGreaterThan receives exactly two parameters and ensures that the first is greater than the second.
ShouldBeGreaterThanOrEqualTo receives exactly two parameters and ensures that the first is greater than or equal to the second.
ShouldBeIn receives at least 2 parameters.
ShouldBeLessThan receives exactly two parameters and ensures that the first is less than the second.
ShouldBeLessThanOrEqualTo receives exactly two parameters and ensures that the first is less than or equal to the second.
ShouldBeNil receives a single parameter and ensures that it is nil.
ShouldBeTrue receives a single parameter and ensures that it is true.
ShouldBeZeroValue receives a single parameter and ensures that it is the Go equivalent of the default value, or "zero" value.
ShouldContain receives exactly two parameters.
ShouldContainKey receives exactly two parameters.
ShouldContainSubstring receives exactly 2 string parameters and ensures that the first contains the second as a substring.
ShouldEndWith receives exactly 2 string parameters and ensures that the first ends with the second.
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.
ShouldEqualJSON receives exactly two parameters and does an equality check by marshalling to JSON.
ShouldEqualTrimSpace receives exactly 2 string parameters and ensures that the first is equal to the second after removing all leading and trailing whitespace using strings.TrimSpace(first).
ShouldEqualWithout receives exactly 3 string parameters and ensures that the first is equal to the second after removing all instances of the third from the first using strings.Replace(first, third, "", -1).
ShouldHappenAfter receives exactly 2 time.Time arguments and asserts that the first happens after the second.
ShouldHappenBefore receives exactly 2 time.Time arguments and asserts that the first happens before the second.
ShouldHappenBetween receives exactly 3 time.Time arguments and asserts that the first happens between (not on) the second and third.
ShouldHappenOnOrAfter receives exactly 2 time.Time arguments and asserts that the first happens on or after the second.
ShouldHappenOnOrBefore receives exactly 2 time.Time arguments and asserts that the first happens on or before the second.
ShouldHappenOnOrBetween receives exactly 3 time.Time arguments and asserts that the first happens between or on the second and third.
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.
ShouldHaveLength receives 2 parameters.
ShouldHaveSameTypeAs receives exactly two parameters and compares their underlying types for equality.
ShouldImplement receives exactly two parameters and ensures that the first implements the interface type of the second.
ShouldNotAlmostEqual is the inverse of ShouldAlmostEqual.
ShouldNotBeBetween receives exactly three parameters: an actual value, a lower bound, and an upper bound.
ShouldNotBeBetweenOrEqual receives exactly three parameters: an actual value, a lower bound, and an upper bound.
ShouldNotBeBlank receives exactly 1 string parameter and ensures that it is not equal to "".
ShouldNotBeChronological receives a []time.Time slice and asserts that they are NOT in chronological order.
ShouldNotBeEmpty receives a single parameter (actual) and determines whether calling len(actual) would return a value greater than zero.
ShouldNotBeIn receives at least 2 parameters.
ShouldNotBeNil receives a single parameter and ensures that it is not nil.
ShouldNotBeZeroValue receives a single parameter and ensures that it is NOT the Go equivalent of the default value, or "zero" value.
ShouldNotContain receives exactly two parameters.
ShouldNotContainKey receives exactly two parameters.
ShouldNotContainSubstring receives exactly 2 string parameters and ensures that the first does NOT contain the second as a substring.
ShouldNotEndWith receives exactly 2 string parameters and ensures that the first does not end with the second.
ShouldNotEqual receives exactly two parameters and does an inequality check.
ShouldNotHappenOnOrBetween receives exactly 3 time.Time arguments and asserts that the first does NOT happen between or on the second or third.
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.
ShouldNotHaveSameTypeAs receives exactly two parameters and compares their underlying types for inequality.
ShouldNotImplement receives exactly two parameters and ensures that the first does NOT implement the interface type of the second.
ShouldNotPanic receives a void, niladic function and expects to execute the function without any panic.
ShouldNotPanicWith receives a void, niladic function and expects to recover a panic whose content differs from the second argument.
ShouldNotPointTo receives exactly two parameters and checks to see that they point to different addresess.
ShouldNotResemble is an alias for ShouldNotEqual.
ShouldNotStartWith receives exactly 2 string parameters and ensures that the first does not start with the second.
ShouldPanic receives a void, niladic function and expects to recover a panic.
ShouldPanicWith receives a void, niladic function and expects to recover a panic with the second argument as the content.
ShouldPointTo receives exactly two parameters and checks to see that they point to the same address.
ShouldResemble is an alias for ShouldEqual.
ShouldStartWith receives exactly 2 string parameters and ensures that the first starts with the second.
ShouldWrap asserts that the first argument (which must be an error value) 'wraps' the second/final argument (which must also be an error value).
So is a convenience function (as opposed to an inconvenience function?) for running assertions on arbitrary arguments in any context, be it for testing or even application logging.
# Structs
No description provided by the author
FailureView is also declared in github.com/smarty/goconvey/convey/reporting.
# Interfaces
No description provided by the author
# Type aliases
SoFunc is an alias for a function with a signature that the So() function can handle.