12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054 |
- package assert
- import (
- "bufio"
- "bytes"
- "encoding/json"
- "errors"
- "fmt"
- "math"
- "os"
- "reflect"
- "regexp"
- "runtime"
- "runtime/debug"
- "strings"
- "time"
- "unicode"
- "unicode/utf8"
- "github.com/davecgh/go-spew/spew"
- "github.com/pmezard/go-difflib/difflib"
- yaml "gopkg.in/yaml.v3"
- )
- //go:generate sh -c "cd ../_codegen && go build && cd - && ../_codegen/_codegen -output-package=assert -template=assertion_format.go.tmpl"
- // TestingT is an interface wrapper around *testing.T
- type TestingT interface {
- Errorf(format string, args ...interface{})
- }
- // ComparisonAssertionFunc is a common function prototype when comparing two values. Can be useful
- // for table driven tests.
- type ComparisonAssertionFunc func(TestingT, interface{}, interface{}, ...interface{}) bool
- // ValueAssertionFunc is a common function prototype when validating a single value. Can be useful
- // for table driven tests.
- type ValueAssertionFunc func(TestingT, interface{}, ...interface{}) bool
- // BoolAssertionFunc is a common function prototype when validating a bool value. Can be useful
- // for table driven tests.
- type BoolAssertionFunc func(TestingT, bool, ...interface{}) bool
- // ErrorAssertionFunc is a common function prototype when validating an error value. Can be useful
- // for table driven tests.
- type ErrorAssertionFunc func(TestingT, error, ...interface{}) bool
- // Comparison is a custom function that returns true on success and false on failure
- type Comparison func() (success bool)
- /*
- Helper functions
- */
- // ObjectsAreEqual determines if two objects are considered equal.
- //
- // This function does no assertion of any kind.
- func ObjectsAreEqual(expected, actual interface{}) bool {
- if expected == nil || actual == nil {
- return expected == actual
- }
- exp, ok := expected.([]byte)
- if !ok {
- return reflect.DeepEqual(expected, actual)
- }
- act, ok := actual.([]byte)
- if !ok {
- return false
- }
- if exp == nil || act == nil {
- return exp == nil && act == nil
- }
- return bytes.Equal(exp, act)
- }
- // copyExportedFields iterates downward through nested data structures and creates a copy
- // that only contains the exported struct fields.
- func copyExportedFields(expected interface{}) interface{} {
- if isNil(expected) {
- return expected
- }
- expectedType := reflect.TypeOf(expected)
- expectedKind := expectedType.Kind()
- expectedValue := reflect.ValueOf(expected)
- switch expectedKind {
- case reflect.Struct:
- result := reflect.New(expectedType).Elem()
- for i := 0; i < expectedType.NumField(); i++ {
- field := expectedType.Field(i)
- isExported := field.IsExported()
- if isExported {
- fieldValue := expectedValue.Field(i)
- if isNil(fieldValue) || isNil(fieldValue.Interface()) {
- continue
- }
- newValue := copyExportedFields(fieldValue.Interface())
- result.Field(i).Set(reflect.ValueOf(newValue))
- }
- }
- return result.Interface()
- case reflect.Ptr:
- result := reflect.New(expectedType.Elem())
- unexportedRemoved := copyExportedFields(expectedValue.Elem().Interface())
- result.Elem().Set(reflect.ValueOf(unexportedRemoved))
- return result.Interface()
- case reflect.Array, reflect.Slice:
- result := reflect.MakeSlice(expectedType, expectedValue.Len(), expectedValue.Len())
- for i := 0; i < expectedValue.Len(); i++ {
- index := expectedValue.Index(i)
- if isNil(index) {
- continue
- }
- unexportedRemoved := copyExportedFields(index.Interface())
- result.Index(i).Set(reflect.ValueOf(unexportedRemoved))
- }
- return result.Interface()
- case reflect.Map:
- result := reflect.MakeMap(expectedType)
- for _, k := range expectedValue.MapKeys() {
- index := expectedValue.MapIndex(k)
- unexportedRemoved := copyExportedFields(index.Interface())
- result.SetMapIndex(k, reflect.ValueOf(unexportedRemoved))
- }
- return result.Interface()
- default:
- return expected
- }
- }
- // ObjectsExportedFieldsAreEqual determines if the exported (public) fields of two objects are
- // considered equal. This comparison of only exported fields is applied recursively to nested data
- // structures.
- //
- // This function does no assertion of any kind.
- func ObjectsExportedFieldsAreEqual(expected, actual interface{}) bool {
- expectedCleaned := copyExportedFields(expected)
- actualCleaned := copyExportedFields(actual)
- return ObjectsAreEqualValues(expectedCleaned, actualCleaned)
- }
- // ObjectsAreEqualValues gets whether two objects are equal, or if their
- // values are equal.
- func ObjectsAreEqualValues(expected, actual interface{}) bool {
- if ObjectsAreEqual(expected, actual) {
- return true
- }
- actualType := reflect.TypeOf(actual)
- if actualType == nil {
- return false
- }
- expectedValue := reflect.ValueOf(expected)
- if expectedValue.IsValid() && expectedValue.Type().ConvertibleTo(actualType) {
- // Attempt comparison after type conversion
- return reflect.DeepEqual(expectedValue.Convert(actualType).Interface(), actual)
- }
- return false
- }
- /* CallerInfo is necessary because the assert functions use the testing object
- internally, causing it to print the file:line of the assert method, rather than where
- the problem actually occurred in calling code.*/
- // CallerInfo returns an array of strings containing the file and line number
- // of each stack frame leading from the current test to the assert call that
- // failed.
- func CallerInfo() []string {
- var pc uintptr
- var ok bool
- var file string
- var line int
- var name string
- callers := []string{}
- for i := 0; ; i++ {
- pc, file, line, ok = runtime.Caller(i)
- if !ok {
- // The breaks below failed to terminate the loop, and we ran off the
- // end of the call stack.
- break
- }
- // This is a huge edge case, but it will panic if this is the case, see #180
- if file == "<autogenerated>" {
- break
- }
- f := runtime.FuncForPC(pc)
- if f == nil {
- break
- }
- name = f.Name()
- // testing.tRunner is the standard library function that calls
- // tests. Subtests are called directly by tRunner, without going through
- // the Test/Benchmark/Example function that contains the t.Run calls, so
- // with subtests we should break when we hit tRunner, without adding it
- // to the list of callers.
- if name == "testing.tRunner" {
- break
- }
- parts := strings.Split(file, "/")
- if len(parts) > 1 {
- filename := parts[len(parts)-1]
- dir := parts[len(parts)-2]
- if (dir != "assert" && dir != "mock" && dir != "require") || filename == "mock_test.go" {
- callers = append(callers, fmt.Sprintf("%s:%d", file, line))
- }
- }
- // Drop the package
- segments := strings.Split(name, ".")
- name = segments[len(segments)-1]
- if isTest(name, "Test") ||
- isTest(name, "Benchmark") ||
- isTest(name, "Example") {
- break
- }
- }
- return callers
- }
- // Stolen from the `go test` tool.
- // isTest tells whether name looks like a test (or benchmark, according to prefix).
- // It is a Test (say) if there is a character after Test that is not a lower-case letter.
- // We don't want TesticularCancer.
- func isTest(name, prefix string) bool {
- if !strings.HasPrefix(name, prefix) {
- return false
- }
- if len(name) == len(prefix) { // "Test" is ok
- return true
- }
- r, _ := utf8.DecodeRuneInString(name[len(prefix):])
- return !unicode.IsLower(r)
- }
- func messageFromMsgAndArgs(msgAndArgs ...interface{}) string {
- if len(msgAndArgs) == 0 || msgAndArgs == nil {
- return ""
- }
- if len(msgAndArgs) == 1 {
- msg := msgAndArgs[0]
- if msgAsStr, ok := msg.(string); ok {
- return msgAsStr
- }
- return fmt.Sprintf("%+v", msg)
- }
- if len(msgAndArgs) > 1 {
- return fmt.Sprintf(msgAndArgs[0].(string), msgAndArgs[1:]...)
- }
- return ""
- }
- // Aligns the provided message so that all lines after the first line start at the same location as the first line.
- // Assumes that the first line starts at the correct location (after carriage return, tab, label, spacer and tab).
- // The longestLabelLen parameter specifies the length of the longest label in the output (required becaues this is the
- // basis on which the alignment occurs).
- func indentMessageLines(message string, longestLabelLen int) string {
- outBuf := new(bytes.Buffer)
- for i, scanner := 0, bufio.NewScanner(strings.NewReader(message)); scanner.Scan(); i++ {
- // no need to align first line because it starts at the correct location (after the label)
- if i != 0 {
- // append alignLen+1 spaces to align with "{{longestLabel}}:" before adding tab
- outBuf.WriteString("\n\t" + strings.Repeat(" ", longestLabelLen+1) + "\t")
- }
- outBuf.WriteString(scanner.Text())
- }
- return outBuf.String()
- }
- type failNower interface {
- FailNow()
- }
- // FailNow fails test
- func FailNow(t TestingT, failureMessage string, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- Fail(t, failureMessage, msgAndArgs...)
- // We cannot extend TestingT with FailNow() and
- // maintain backwards compatibility, so we fallback
- // to panicking when FailNow is not available in
- // TestingT.
- // See issue #263
- if t, ok := t.(failNower); ok {
- t.FailNow()
- } else {
- panic("test failed and t is missing `FailNow()`")
- }
- return false
- }
- // Fail reports a failure through
- func Fail(t TestingT, failureMessage string, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- content := []labeledContent{
- {"Error Trace", strings.Join(CallerInfo(), "\n\t\t\t")},
- {"Error", failureMessage},
- }
- // Add test name if the Go version supports it
- if n, ok := t.(interface {
- Name() string
- }); ok {
- content = append(content, labeledContent{"Test", n.Name()})
- }
- message := messageFromMsgAndArgs(msgAndArgs...)
- if len(message) > 0 {
- content = append(content, labeledContent{"Messages", message})
- }
- t.Errorf("\n%s", ""+labeledOutput(content...))
- return false
- }
- type labeledContent struct {
- label string
- content string
- }
- // labeledOutput returns a string consisting of the provided labeledContent. Each labeled output is appended in the following manner:
- //
- // \t{{label}}:{{align_spaces}}\t{{content}}\n
- //
- // The initial carriage return is required to undo/erase any padding added by testing.T.Errorf. The "\t{{label}}:" is for the label.
- // If a label is shorter than the longest label provided, padding spaces are added to make all the labels match in length. Once this
- // alignment is achieved, "\t{{content}}\n" is added for the output.
- //
- // If the content of the labeledOutput contains line breaks, the subsequent lines are aligned so that they start at the same location as the first line.
- func labeledOutput(content ...labeledContent) string {
- longestLabel := 0
- for _, v := range content {
- if len(v.label) > longestLabel {
- longestLabel = len(v.label)
- }
- }
- var output string
- for _, v := range content {
- output += "\t" + v.label + ":" + strings.Repeat(" ", longestLabel-len(v.label)) + "\t" + indentMessageLines(v.content, longestLabel) + "\n"
- }
- return output
- }
- // Implements asserts that an object is implemented by the specified interface.
- //
- // assert.Implements(t, (*MyInterface)(nil), new(MyObject))
- func Implements(t TestingT, interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- interfaceType := reflect.TypeOf(interfaceObject).Elem()
- if object == nil {
- return Fail(t, fmt.Sprintf("Cannot check if nil implements %v", interfaceType), msgAndArgs...)
- }
- if !reflect.TypeOf(object).Implements(interfaceType) {
- return Fail(t, fmt.Sprintf("%T must implement %v", object, interfaceType), msgAndArgs...)
- }
- return true
- }
- // IsType asserts that the specified objects are of the same type.
- func IsType(t TestingT, expectedType interface{}, object interface{}, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if !ObjectsAreEqual(reflect.TypeOf(object), reflect.TypeOf(expectedType)) {
- return Fail(t, fmt.Sprintf("Object expected to be of type %v, but was %v", reflect.TypeOf(expectedType), reflect.TypeOf(object)), msgAndArgs...)
- }
- return true
- }
- // Equal asserts that two objects are equal.
- //
- // assert.Equal(t, 123, 123)
- //
- // Pointer variable equality is determined based on the equality of the
- // referenced values (as opposed to the memory addresses). Function equality
- // cannot be determined and will always fail.
- func Equal(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if err := validateEqualArgs(expected, actual); err != nil {
- return Fail(t, fmt.Sprintf("Invalid operation: %#v == %#v (%s)",
- expected, actual, err), msgAndArgs...)
- }
- if !ObjectsAreEqual(expected, actual) {
- diff := diff(expected, actual)
- expected, actual = formatUnequalValues(expected, actual)
- return Fail(t, fmt.Sprintf("Not equal: \n"+
- "expected: %s\n"+
- "actual : %s%s", expected, actual, diff), msgAndArgs...)
- }
- return true
- }
- // validateEqualArgs checks whether provided arguments can be safely used in the
- // Equal/NotEqual functions.
- func validateEqualArgs(expected, actual interface{}) error {
- if expected == nil && actual == nil {
- return nil
- }
- if isFunction(expected) || isFunction(actual) {
- return errors.New("cannot take func type as argument")
- }
- return nil
- }
- // Same asserts that two pointers reference the same object.
- //
- // assert.Same(t, ptr1, ptr2)
- //
- // Both arguments must be pointer variables. Pointer variable sameness is
- // determined based on the equality of both type and value.
- func Same(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if !samePointers(expected, actual) {
- return Fail(t, fmt.Sprintf("Not same: \n"+
- "expected: %p %#v\n"+
- "actual : %p %#v", expected, expected, actual, actual), msgAndArgs...)
- }
- return true
- }
- // NotSame asserts that two pointers do not reference the same object.
- //
- // assert.NotSame(t, ptr1, ptr2)
- //
- // Both arguments must be pointer variables. Pointer variable sameness is
- // determined based on the equality of both type and value.
- func NotSame(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if samePointers(expected, actual) {
- return Fail(t, fmt.Sprintf(
- "Expected and actual point to the same object: %p %#v",
- expected, expected), msgAndArgs...)
- }
- return true
- }
- // samePointers compares two generic interface objects and returns whether
- // they point to the same object
- func samePointers(first, second interface{}) bool {
- firstPtr, secondPtr := reflect.ValueOf(first), reflect.ValueOf(second)
- if firstPtr.Kind() != reflect.Ptr || secondPtr.Kind() != reflect.Ptr {
- return false
- }
- firstType, secondType := reflect.TypeOf(first), reflect.TypeOf(second)
- if firstType != secondType {
- return false
- }
- // compare pointer addresses
- return first == second
- }
- // formatUnequalValues takes two values of arbitrary types and returns string
- // representations appropriate to be presented to the user.
- //
- // If the values are not of like type, the returned strings will be prefixed
- // with the type name, and the value will be enclosed in parenthesis similar
- // to a type conversion in the Go grammar.
- func formatUnequalValues(expected, actual interface{}) (e string, a string) {
- if reflect.TypeOf(expected) != reflect.TypeOf(actual) {
- return fmt.Sprintf("%T(%s)", expected, truncatingFormat(expected)),
- fmt.Sprintf("%T(%s)", actual, truncatingFormat(actual))
- }
- switch expected.(type) {
- case time.Duration:
- return fmt.Sprintf("%v", expected), fmt.Sprintf("%v", actual)
- }
- return truncatingFormat(expected), truncatingFormat(actual)
- }
- // truncatingFormat formats the data and truncates it if it's too long.
- //
- // This helps keep formatted error messages lines from exceeding the
- // bufio.MaxScanTokenSize max line length that the go testing framework imposes.
- func truncatingFormat(data interface{}) string {
- value := fmt.Sprintf("%#v", data)
- max := bufio.MaxScanTokenSize - 100 // Give us some space the type info too if needed.
- if len(value) > max {
- value = value[0:max] + "<... truncated>"
- }
- return value
- }
- // EqualValues asserts that two objects are equal or convertable to the same types
- // and equal.
- //
- // assert.EqualValues(t, uint32(123), int32(123))
- func EqualValues(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if !ObjectsAreEqualValues(expected, actual) {
- diff := diff(expected, actual)
- expected, actual = formatUnequalValues(expected, actual)
- return Fail(t, fmt.Sprintf("Not equal: \n"+
- "expected: %s\n"+
- "actual : %s%s", expected, actual, diff), msgAndArgs...)
- }
- return true
- }
- // EqualExportedValues asserts that the types of two objects are equal and their public
- // fields are also equal. This is useful for comparing structs that have private fields
- // that could potentially differ.
- //
- // type S struct {
- // Exported int
- // notExported int
- // }
- // assert.EqualExportedValues(t, S{1, 2}, S{1, 3}) => true
- // assert.EqualExportedValues(t, S{1, 2}, S{2, 3}) => false
- func EqualExportedValues(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- aType := reflect.TypeOf(expected)
- bType := reflect.TypeOf(actual)
- if aType != bType {
- return Fail(t, fmt.Sprintf("Types expected to match exactly\n\t%v != %v", aType, bType), msgAndArgs...)
- }
- if aType.Kind() != reflect.Struct {
- return Fail(t, fmt.Sprintf("Types expected to both be struct \n\t%v != %v", aType.Kind(), reflect.Struct), msgAndArgs...)
- }
- if bType.Kind() != reflect.Struct {
- return Fail(t, fmt.Sprintf("Types expected to both be struct \n\t%v != %v", bType.Kind(), reflect.Struct), msgAndArgs...)
- }
- expected = copyExportedFields(expected)
- actual = copyExportedFields(actual)
- if !ObjectsAreEqualValues(expected, actual) {
- diff := diff(expected, actual)
- expected, actual = formatUnequalValues(expected, actual)
- return Fail(t, fmt.Sprintf("Not equal (comparing only exported fields): \n"+
- "expected: %s\n"+
- "actual : %s%s", expected, actual, diff), msgAndArgs...)
- }
- return true
- }
- // Exactly asserts that two objects are equal in value and type.
- //
- // assert.Exactly(t, int32(123), int64(123))
- func Exactly(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- aType := reflect.TypeOf(expected)
- bType := reflect.TypeOf(actual)
- if aType != bType {
- return Fail(t, fmt.Sprintf("Types expected to match exactly\n\t%v != %v", aType, bType), msgAndArgs...)
- }
- return Equal(t, expected, actual, msgAndArgs...)
- }
- // NotNil asserts that the specified object is not nil.
- //
- // assert.NotNil(t, err)
- func NotNil(t TestingT, object interface{}, msgAndArgs ...interface{}) bool {
- if !isNil(object) {
- return true
- }
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- return Fail(t, "Expected value not to be nil.", msgAndArgs...)
- }
- // containsKind checks if a specified kind in the slice of kinds.
- func containsKind(kinds []reflect.Kind, kind reflect.Kind) bool {
- for i := 0; i < len(kinds); i++ {
- if kind == kinds[i] {
- return true
- }
- }
- return false
- }
- // isNil checks if a specified object is nil or not, without Failing.
- func isNil(object interface{}) bool {
- if object == nil {
- return true
- }
- value := reflect.ValueOf(object)
- kind := value.Kind()
- isNilableKind := containsKind(
- []reflect.Kind{
- reflect.Chan, reflect.Func,
- reflect.Interface, reflect.Map,
- reflect.Ptr, reflect.Slice, reflect.UnsafePointer},
- kind)
- if isNilableKind && value.IsNil() {
- return true
- }
- return false
- }
- // Nil asserts that the specified object is nil.
- //
- // assert.Nil(t, err)
- func Nil(t TestingT, object interface{}, msgAndArgs ...interface{}) bool {
- if isNil(object) {
- return true
- }
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- return Fail(t, fmt.Sprintf("Expected nil, but got: %#v", object), msgAndArgs...)
- }
- // isEmpty gets whether the specified object is considered empty or not.
- func isEmpty(object interface{}) bool {
- // get nil case out of the way
- if object == nil {
- return true
- }
- objValue := reflect.ValueOf(object)
- switch objValue.Kind() {
- // collection types are empty when they have no element
- case reflect.Chan, reflect.Map, reflect.Slice:
- return objValue.Len() == 0
- // pointers are empty if nil or if the value they point to is empty
- case reflect.Ptr:
- if objValue.IsNil() {
- return true
- }
- deref := objValue.Elem().Interface()
- return isEmpty(deref)
- // for all other types, compare against the zero value
- // array types are empty when they match their zero-initialized state
- default:
- zero := reflect.Zero(objValue.Type())
- return reflect.DeepEqual(object, zero.Interface())
- }
- }
- // Empty asserts that the specified object is empty. I.e. nil, "", false, 0 or either
- // a slice or a channel with len == 0.
- //
- // assert.Empty(t, obj)
- func Empty(t TestingT, object interface{}, msgAndArgs ...interface{}) bool {
- pass := isEmpty(object)
- if !pass {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- Fail(t, fmt.Sprintf("Should be empty, but was %v", object), msgAndArgs...)
- }
- return pass
- }
- // NotEmpty asserts that the specified object is NOT empty. I.e. not nil, "", false, 0 or either
- // a slice or a channel with len == 0.
- //
- // if assert.NotEmpty(t, obj) {
- // assert.Equal(t, "two", obj[1])
- // }
- func NotEmpty(t TestingT, object interface{}, msgAndArgs ...interface{}) bool {
- pass := !isEmpty(object)
- if !pass {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- Fail(t, fmt.Sprintf("Should NOT be empty, but was %v", object), msgAndArgs...)
- }
- return pass
- }
- // getLen try to get length of object.
- // return (false, 0) if impossible.
- func getLen(x interface{}) (ok bool, length int) {
- v := reflect.ValueOf(x)
- defer func() {
- if e := recover(); e != nil {
- ok = false
- }
- }()
- return true, v.Len()
- }
- // Len asserts that the specified object has specific length.
- // Len also fails if the object has a type that len() not accept.
- //
- // assert.Len(t, mySlice, 3)
- func Len(t TestingT, object interface{}, length int, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- ok, l := getLen(object)
- if !ok {
- return Fail(t, fmt.Sprintf("\"%s\" could not be applied builtin len()", object), msgAndArgs...)
- }
- if l != length {
- return Fail(t, fmt.Sprintf("\"%s\" should have %d item(s), but has %d", object, length, l), msgAndArgs...)
- }
- return true
- }
- // True asserts that the specified value is true.
- //
- // assert.True(t, myBool)
- func True(t TestingT, value bool, msgAndArgs ...interface{}) bool {
- if !value {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- return Fail(t, "Should be true", msgAndArgs...)
- }
- return true
- }
- // False asserts that the specified value is false.
- //
- // assert.False(t, myBool)
- func False(t TestingT, value bool, msgAndArgs ...interface{}) bool {
- if value {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- return Fail(t, "Should be false", msgAndArgs...)
- }
- return true
- }
- // NotEqual asserts that the specified values are NOT equal.
- //
- // assert.NotEqual(t, obj1, obj2)
- //
- // Pointer variable equality is determined based on the equality of the
- // referenced values (as opposed to the memory addresses).
- func NotEqual(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if err := validateEqualArgs(expected, actual); err != nil {
- return Fail(t, fmt.Sprintf("Invalid operation: %#v != %#v (%s)",
- expected, actual, err), msgAndArgs...)
- }
- if ObjectsAreEqual(expected, actual) {
- return Fail(t, fmt.Sprintf("Should not be: %#v\n", actual), msgAndArgs...)
- }
- return true
- }
- // NotEqualValues asserts that two objects are not equal even when converted to the same type
- //
- // assert.NotEqualValues(t, obj1, obj2)
- func NotEqualValues(t TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if ObjectsAreEqualValues(expected, actual) {
- return Fail(t, fmt.Sprintf("Should not be: %#v\n", actual), msgAndArgs...)
- }
- return true
- }
- // containsElement try loop over the list check if the list includes the element.
- // return (false, false) if impossible.
- // return (true, false) if element was not found.
- // return (true, true) if element was found.
- func containsElement(list interface{}, element interface{}) (ok, found bool) {
- listValue := reflect.ValueOf(list)
- listType := reflect.TypeOf(list)
- if listType == nil {
- return false, false
- }
- listKind := listType.Kind()
- defer func() {
- if e := recover(); e != nil {
- ok = false
- found = false
- }
- }()
- if listKind == reflect.String {
- elementValue := reflect.ValueOf(element)
- return true, strings.Contains(listValue.String(), elementValue.String())
- }
- if listKind == reflect.Map {
- mapKeys := listValue.MapKeys()
- for i := 0; i < len(mapKeys); i++ {
- if ObjectsAreEqual(mapKeys[i].Interface(), element) {
- return true, true
- }
- }
- return true, false
- }
- for i := 0; i < listValue.Len(); i++ {
- if ObjectsAreEqual(listValue.Index(i).Interface(), element) {
- return true, true
- }
- }
- return true, false
- }
- // Contains asserts that the specified string, list(array, slice...) or map contains the
- // specified substring or element.
- //
- // assert.Contains(t, "Hello World", "World")
- // assert.Contains(t, ["Hello", "World"], "World")
- // assert.Contains(t, {"Hello": "World"}, "Hello")
- func Contains(t TestingT, s, contains interface{}, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- ok, found := containsElement(s, contains)
- if !ok {
- return Fail(t, fmt.Sprintf("%#v could not be applied builtin len()", s), msgAndArgs...)
- }
- if !found {
- return Fail(t, fmt.Sprintf("%#v does not contain %#v", s, contains), msgAndArgs...)
- }
- return true
- }
- // NotContains asserts that the specified string, list(array, slice...) or map does NOT contain the
- // specified substring or element.
- //
- // assert.NotContains(t, "Hello World", "Earth")
- // assert.NotContains(t, ["Hello", "World"], "Earth")
- // assert.NotContains(t, {"Hello": "World"}, "Earth")
- func NotContains(t TestingT, s, contains interface{}, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- ok, found := containsElement(s, contains)
- if !ok {
- return Fail(t, fmt.Sprintf("%#v could not be applied builtin len()", s), msgAndArgs...)
- }
- if found {
- return Fail(t, fmt.Sprintf("%#v should not contain %#v", s, contains), msgAndArgs...)
- }
- return true
- }
- // Subset asserts that the specified list(array, slice...) contains all
- // elements given in the specified subset(array, slice...).
- //
- // assert.Subset(t, [1, 2, 3], [1, 2], "But [1, 2, 3] does contain [1, 2]")
- func Subset(t TestingT, list, subset interface{}, msgAndArgs ...interface{}) (ok bool) {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if subset == nil {
- return true // we consider nil to be equal to the nil set
- }
- listKind := reflect.TypeOf(list).Kind()
- if listKind != reflect.Array && listKind != reflect.Slice && listKind != reflect.Map {
- return Fail(t, fmt.Sprintf("%q has an unsupported type %s", list, listKind), msgAndArgs...)
- }
- subsetKind := reflect.TypeOf(subset).Kind()
- if subsetKind != reflect.Array && subsetKind != reflect.Slice && listKind != reflect.Map {
- return Fail(t, fmt.Sprintf("%q has an unsupported type %s", subset, subsetKind), msgAndArgs...)
- }
- if subsetKind == reflect.Map && listKind == reflect.Map {
- subsetMap := reflect.ValueOf(subset)
- actualMap := reflect.ValueOf(list)
- for _, k := range subsetMap.MapKeys() {
- ev := subsetMap.MapIndex(k)
- av := actualMap.MapIndex(k)
- if !av.IsValid() {
- return Fail(t, fmt.Sprintf("%#v does not contain %#v", list, subset), msgAndArgs...)
- }
- if !ObjectsAreEqual(ev.Interface(), av.Interface()) {
- return Fail(t, fmt.Sprintf("%#v does not contain %#v", list, subset), msgAndArgs...)
- }
- }
- return true
- }
- subsetList := reflect.ValueOf(subset)
- for i := 0; i < subsetList.Len(); i++ {
- element := subsetList.Index(i).Interface()
- ok, found := containsElement(list, element)
- if !ok {
- return Fail(t, fmt.Sprintf("%#v could not be applied builtin len()", list), msgAndArgs...)
- }
- if !found {
- return Fail(t, fmt.Sprintf("%#v does not contain %#v", list, element), msgAndArgs...)
- }
- }
- return true
- }
- // NotSubset asserts that the specified list(array, slice...) contains not all
- // elements given in the specified subset(array, slice...).
- //
- // assert.NotSubset(t, [1, 3, 4], [1, 2], "But [1, 3, 4] does not contain [1, 2]")
- func NotSubset(t TestingT, list, subset interface{}, msgAndArgs ...interface{}) (ok bool) {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if subset == nil {
- return Fail(t, "nil is the empty set which is a subset of every set", msgAndArgs...)
- }
- listKind := reflect.TypeOf(list).Kind()
- if listKind != reflect.Array && listKind != reflect.Slice && listKind != reflect.Map {
- return Fail(t, fmt.Sprintf("%q has an unsupported type %s", list, listKind), msgAndArgs...)
- }
- subsetKind := reflect.TypeOf(subset).Kind()
- if subsetKind != reflect.Array && subsetKind != reflect.Slice && listKind != reflect.Map {
- return Fail(t, fmt.Sprintf("%q has an unsupported type %s", subset, subsetKind), msgAndArgs...)
- }
- if subsetKind == reflect.Map && listKind == reflect.Map {
- subsetMap := reflect.ValueOf(subset)
- actualMap := reflect.ValueOf(list)
- for _, k := range subsetMap.MapKeys() {
- ev := subsetMap.MapIndex(k)
- av := actualMap.MapIndex(k)
- if !av.IsValid() {
- return true
- }
- if !ObjectsAreEqual(ev.Interface(), av.Interface()) {
- return true
- }
- }
- return Fail(t, fmt.Sprintf("%q is a subset of %q", subset, list), msgAndArgs...)
- }
- subsetList := reflect.ValueOf(subset)
- for i := 0; i < subsetList.Len(); i++ {
- element := subsetList.Index(i).Interface()
- ok, found := containsElement(list, element)
- if !ok {
- return Fail(t, fmt.Sprintf("\"%s\" could not be applied builtin len()", list), msgAndArgs...)
- }
- if !found {
- return true
- }
- }
- return Fail(t, fmt.Sprintf("%q is a subset of %q", subset, list), msgAndArgs...)
- }
- // ElementsMatch asserts that the specified listA(array, slice...) is equal to specified
- // listB(array, slice...) ignoring the order of the elements. If there are duplicate elements,
- // the number of appearances of each of them in both lists should match.
- //
- // assert.ElementsMatch(t, [1, 3, 2, 3], [1, 3, 3, 2])
- func ElementsMatch(t TestingT, listA, listB interface{}, msgAndArgs ...interface{}) (ok bool) {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if isEmpty(listA) && isEmpty(listB) {
- return true
- }
- if !isList(t, listA, msgAndArgs...) || !isList(t, listB, msgAndArgs...) {
- return false
- }
- extraA, extraB := diffLists(listA, listB)
- if len(extraA) == 0 && len(extraB) == 0 {
- return true
- }
- return Fail(t, formatListDiff(listA, listB, extraA, extraB), msgAndArgs...)
- }
- // isList checks that the provided value is array or slice.
- func isList(t TestingT, list interface{}, msgAndArgs ...interface{}) (ok bool) {
- kind := reflect.TypeOf(list).Kind()
- if kind != reflect.Array && kind != reflect.Slice {
- return Fail(t, fmt.Sprintf("%q has an unsupported type %s, expecting array or slice", list, kind),
- msgAndArgs...)
- }
- return true
- }
- // diffLists diffs two arrays/slices and returns slices of elements that are only in A and only in B.
- // If some element is present multiple times, each instance is counted separately (e.g. if something is 2x in A and
- // 5x in B, it will be 0x in extraA and 3x in extraB). The order of items in both lists is ignored.
- func diffLists(listA, listB interface{}) (extraA, extraB []interface{}) {
- aValue := reflect.ValueOf(listA)
- bValue := reflect.ValueOf(listB)
- aLen := aValue.Len()
- bLen := bValue.Len()
- // Mark indexes in bValue that we already used
- visited := make([]bool, bLen)
- for i := 0; i < aLen; i++ {
- element := aValue.Index(i).Interface()
- found := false
- for j := 0; j < bLen; j++ {
- if visited[j] {
- continue
- }
- if ObjectsAreEqual(bValue.Index(j).Interface(), element) {
- visited[j] = true
- found = true
- break
- }
- }
- if !found {
- extraA = append(extraA, element)
- }
- }
- for j := 0; j < bLen; j++ {
- if visited[j] {
- continue
- }
- extraB = append(extraB, bValue.Index(j).Interface())
- }
- return
- }
- func formatListDiff(listA, listB interface{}, extraA, extraB []interface{}) string {
- var msg bytes.Buffer
- msg.WriteString("elements differ")
- if len(extraA) > 0 {
- msg.WriteString("\n\nextra elements in list A:\n")
- msg.WriteString(spewConfig.Sdump(extraA))
- }
- if len(extraB) > 0 {
- msg.WriteString("\n\nextra elements in list B:\n")
- msg.WriteString(spewConfig.Sdump(extraB))
- }
- msg.WriteString("\n\nlistA:\n")
- msg.WriteString(spewConfig.Sdump(listA))
- msg.WriteString("\n\nlistB:\n")
- msg.WriteString(spewConfig.Sdump(listB))
- return msg.String()
- }
- // Condition uses a Comparison to assert a complex condition.
- func Condition(t TestingT, comp Comparison, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- result := comp()
- if !result {
- Fail(t, "Condition failed!", msgAndArgs...)
- }
- return result
- }
- // PanicTestFunc defines a func that should be passed to the assert.Panics and assert.NotPanics
- // methods, and represents a simple func that takes no arguments, and returns nothing.
- type PanicTestFunc func()
- // didPanic returns true if the function passed to it panics. Otherwise, it returns false.
- func didPanic(f PanicTestFunc) (didPanic bool, message interface{}, stack string) {
- didPanic = true
- defer func() {
- message = recover()
- if didPanic {
- stack = string(debug.Stack())
- }
- }()
- // call the target function
- f()
- didPanic = false
- return
- }
- // Panics asserts that the code inside the specified PanicTestFunc panics.
- //
- // assert.Panics(t, func(){ GoCrazy() })
- func Panics(t TestingT, f PanicTestFunc, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if funcDidPanic, panicValue, _ := didPanic(f); !funcDidPanic {
- return Fail(t, fmt.Sprintf("func %#v should panic\n\tPanic value:\t%#v", f, panicValue), msgAndArgs...)
- }
- return true
- }
- // PanicsWithValue asserts that the code inside the specified PanicTestFunc panics, and that
- // the recovered panic value equals the expected panic value.
- //
- // assert.PanicsWithValue(t, "crazy error", func(){ GoCrazy() })
- func PanicsWithValue(t TestingT, expected interface{}, f PanicTestFunc, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- funcDidPanic, panicValue, panickedStack := didPanic(f)
- if !funcDidPanic {
- return Fail(t, fmt.Sprintf("func %#v should panic\n\tPanic value:\t%#v", f, panicValue), msgAndArgs...)
- }
- if panicValue != expected {
- return Fail(t, fmt.Sprintf("func %#v should panic with value:\t%#v\n\tPanic value:\t%#v\n\tPanic stack:\t%s", f, expected, panicValue, panickedStack), msgAndArgs...)
- }
- return true
- }
- // PanicsWithError asserts that the code inside the specified PanicTestFunc
- // panics, and that the recovered panic value is an error that satisfies the
- // EqualError comparison.
- //
- // assert.PanicsWithError(t, "crazy error", func(){ GoCrazy() })
- func PanicsWithError(t TestingT, errString string, f PanicTestFunc, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- funcDidPanic, panicValue, panickedStack := didPanic(f)
- if !funcDidPanic {
- return Fail(t, fmt.Sprintf("func %#v should panic\n\tPanic value:\t%#v", f, panicValue), msgAndArgs...)
- }
- panicErr, ok := panicValue.(error)
- if !ok || panicErr.Error() != errString {
- return Fail(t, fmt.Sprintf("func %#v should panic with error message:\t%#v\n\tPanic value:\t%#v\n\tPanic stack:\t%s", f, errString, panicValue, panickedStack), msgAndArgs...)
- }
- return true
- }
- // NotPanics asserts that the code inside the specified PanicTestFunc does NOT panic.
- //
- // assert.NotPanics(t, func(){ RemainCalm() })
- func NotPanics(t TestingT, f PanicTestFunc, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if funcDidPanic, panicValue, panickedStack := didPanic(f); funcDidPanic {
- return Fail(t, fmt.Sprintf("func %#v should not panic\n\tPanic value:\t%v\n\tPanic stack:\t%s", f, panicValue, panickedStack), msgAndArgs...)
- }
- return true
- }
- // WithinDuration asserts that the two times are within duration delta of each other.
- //
- // assert.WithinDuration(t, time.Now(), time.Now(), 10*time.Second)
- func WithinDuration(t TestingT, expected, actual time.Time, delta time.Duration, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- dt := expected.Sub(actual)
- if dt < -delta || dt > delta {
- return Fail(t, fmt.Sprintf("Max difference between %v and %v allowed is %v, but difference was %v", expected, actual, delta, dt), msgAndArgs...)
- }
- return true
- }
- // WithinRange asserts that a time is within a time range (inclusive).
- //
- // assert.WithinRange(t, time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second))
- func WithinRange(t TestingT, actual, start, end time.Time, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if end.Before(start) {
- return Fail(t, "Start should be before end", msgAndArgs...)
- }
- if actual.Before(start) {
- return Fail(t, fmt.Sprintf("Time %v expected to be in time range %v to %v, but is before the range", actual, start, end), msgAndArgs...)
- } else if actual.After(end) {
- return Fail(t, fmt.Sprintf("Time %v expected to be in time range %v to %v, but is after the range", actual, start, end), msgAndArgs...)
- }
- return true
- }
- func toFloat(x interface{}) (float64, bool) {
- var xf float64
- xok := true
- switch xn := x.(type) {
- case uint:
- xf = float64(xn)
- case uint8:
- xf = float64(xn)
- case uint16:
- xf = float64(xn)
- case uint32:
- xf = float64(xn)
- case uint64:
- xf = float64(xn)
- case int:
- xf = float64(xn)
- case int8:
- xf = float64(xn)
- case int16:
- xf = float64(xn)
- case int32:
- xf = float64(xn)
- case int64:
- xf = float64(xn)
- case float32:
- xf = float64(xn)
- case float64:
- xf = xn
- case time.Duration:
- xf = float64(xn)
- default:
- xok = false
- }
- return xf, xok
- }
- // InDelta asserts that the two numerals are within delta of each other.
- //
- // assert.InDelta(t, math.Pi, 22/7.0, 0.01)
- func InDelta(t TestingT, expected, actual interface{}, delta float64, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- af, aok := toFloat(expected)
- bf, bok := toFloat(actual)
- if !aok || !bok {
- return Fail(t, "Parameters must be numerical", msgAndArgs...)
- }
- if math.IsNaN(af) && math.IsNaN(bf) {
- return true
- }
- if math.IsNaN(af) {
- return Fail(t, "Expected must not be NaN", msgAndArgs...)
- }
- if math.IsNaN(bf) {
- return Fail(t, fmt.Sprintf("Expected %v with delta %v, but was NaN", expected, delta), msgAndArgs...)
- }
- dt := af - bf
- if dt < -delta || dt > delta {
- return Fail(t, fmt.Sprintf("Max difference between %v and %v allowed is %v, but difference was %v", expected, actual, delta, dt), msgAndArgs...)
- }
- return true
- }
- // InDeltaSlice is the same as InDelta, except it compares two slices.
- func InDeltaSlice(t TestingT, expected, actual interface{}, delta float64, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if expected == nil || actual == nil ||
- reflect.TypeOf(actual).Kind() != reflect.Slice ||
- reflect.TypeOf(expected).Kind() != reflect.Slice {
- return Fail(t, "Parameters must be slice", msgAndArgs...)
- }
- actualSlice := reflect.ValueOf(actual)
- expectedSlice := reflect.ValueOf(expected)
- for i := 0; i < actualSlice.Len(); i++ {
- result := InDelta(t, actualSlice.Index(i).Interface(), expectedSlice.Index(i).Interface(), delta, msgAndArgs...)
- if !result {
- return result
- }
- }
- return true
- }
- // InDeltaMapValues is the same as InDelta, but it compares all values between two maps. Both maps must have exactly the same keys.
- func InDeltaMapValues(t TestingT, expected, actual interface{}, delta float64, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if expected == nil || actual == nil ||
- reflect.TypeOf(actual).Kind() != reflect.Map ||
- reflect.TypeOf(expected).Kind() != reflect.Map {
- return Fail(t, "Arguments must be maps", msgAndArgs...)
- }
- expectedMap := reflect.ValueOf(expected)
- actualMap := reflect.ValueOf(actual)
- if expectedMap.Len() != actualMap.Len() {
- return Fail(t, "Arguments must have the same number of keys", msgAndArgs...)
- }
- for _, k := range expectedMap.MapKeys() {
- ev := expectedMap.MapIndex(k)
- av := actualMap.MapIndex(k)
- if !ev.IsValid() {
- return Fail(t, fmt.Sprintf("missing key %q in expected map", k), msgAndArgs...)
- }
- if !av.IsValid() {
- return Fail(t, fmt.Sprintf("missing key %q in actual map", k), msgAndArgs...)
- }
- if !InDelta(
- t,
- ev.Interface(),
- av.Interface(),
- delta,
- msgAndArgs...,
- ) {
- return false
- }
- }
- return true
- }
- func calcRelativeError(expected, actual interface{}) (float64, error) {
- af, aok := toFloat(expected)
- bf, bok := toFloat(actual)
- if !aok || !bok {
- return 0, fmt.Errorf("Parameters must be numerical")
- }
- if math.IsNaN(af) && math.IsNaN(bf) {
- return 0, nil
- }
- if math.IsNaN(af) {
- return 0, errors.New("expected value must not be NaN")
- }
- if af == 0 {
- return 0, fmt.Errorf("expected value must have a value other than zero to calculate the relative error")
- }
- if math.IsNaN(bf) {
- return 0, errors.New("actual value must not be NaN")
- }
- return math.Abs(af-bf) / math.Abs(af), nil
- }
- // InEpsilon asserts that expected and actual have a relative error less than epsilon
- func InEpsilon(t TestingT, expected, actual interface{}, epsilon float64, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if math.IsNaN(epsilon) {
- return Fail(t, "epsilon must not be NaN")
- }
- actualEpsilon, err := calcRelativeError(expected, actual)
- if err != nil {
- return Fail(t, err.Error(), msgAndArgs...)
- }
- if actualEpsilon > epsilon {
- return Fail(t, fmt.Sprintf("Relative error is too high: %#v (expected)\n"+
- " < %#v (actual)", epsilon, actualEpsilon), msgAndArgs...)
- }
- return true
- }
- // InEpsilonSlice is the same as InEpsilon, except it compares each value from two slices.
- func InEpsilonSlice(t TestingT, expected, actual interface{}, epsilon float64, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if expected == nil || actual == nil ||
- reflect.TypeOf(actual).Kind() != reflect.Slice ||
- reflect.TypeOf(expected).Kind() != reflect.Slice {
- return Fail(t, "Parameters must be slice", msgAndArgs...)
- }
- actualSlice := reflect.ValueOf(actual)
- expectedSlice := reflect.ValueOf(expected)
- for i := 0; i < actualSlice.Len(); i++ {
- result := InEpsilon(t, actualSlice.Index(i).Interface(), expectedSlice.Index(i).Interface(), epsilon)
- if !result {
- return result
- }
- }
- return true
- }
- /*
- Errors
- */
- // NoError asserts that a function returned no error (i.e. `nil`).
- //
- // actualObj, err := SomeFunction()
- // if assert.NoError(t, err) {
- // assert.Equal(t, expectedObj, actualObj)
- // }
- func NoError(t TestingT, err error, msgAndArgs ...interface{}) bool {
- if err != nil {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- return Fail(t, fmt.Sprintf("Received unexpected error:\n%+v", err), msgAndArgs...)
- }
- return true
- }
- // Error asserts that a function returned an error (i.e. not `nil`).
- //
- // actualObj, err := SomeFunction()
- // if assert.Error(t, err) {
- // assert.Equal(t, expectedError, err)
- // }
- func Error(t TestingT, err error, msgAndArgs ...interface{}) bool {
- if err == nil {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- return Fail(t, "An error is expected but got nil.", msgAndArgs...)
- }
- return true
- }
- // EqualError asserts that a function returned an error (i.e. not `nil`)
- // and that it is equal to the provided error.
- //
- // actualObj, err := SomeFunction()
- // assert.EqualError(t, err, expectedErrorString)
- func EqualError(t TestingT, theError error, errString string, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if !Error(t, theError, msgAndArgs...) {
- return false
- }
- expected := errString
- actual := theError.Error()
- // don't need to use deep equals here, we know they are both strings
- if expected != actual {
- return Fail(t, fmt.Sprintf("Error message not equal:\n"+
- "expected: %q\n"+
- "actual : %q", expected, actual), msgAndArgs...)
- }
- return true
- }
- // ErrorContains asserts that a function returned an error (i.e. not `nil`)
- // and that the error contains the specified substring.
- //
- // actualObj, err := SomeFunction()
- // assert.ErrorContains(t, err, expectedErrorSubString)
- func ErrorContains(t TestingT, theError error, contains string, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if !Error(t, theError, msgAndArgs...) {
- return false
- }
- actual := theError.Error()
- if !strings.Contains(actual, contains) {
- return Fail(t, fmt.Sprintf("Error %#v does not contain %#v", actual, contains), msgAndArgs...)
- }
- return true
- }
- // matchRegexp return true if a specified regexp matches a string.
- func matchRegexp(rx interface{}, str interface{}) bool {
- var r *regexp.Regexp
- if rr, ok := rx.(*regexp.Regexp); ok {
- r = rr
- } else {
- r = regexp.MustCompile(fmt.Sprint(rx))
- }
- return (r.FindStringIndex(fmt.Sprint(str)) != nil)
- }
- // Regexp asserts that a specified regexp matches a string.
- //
- // assert.Regexp(t, regexp.MustCompile("start"), "it's starting")
- // assert.Regexp(t, "start...$", "it's not starting")
- func Regexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- match := matchRegexp(rx, str)
- if !match {
- Fail(t, fmt.Sprintf("Expect \"%v\" to match \"%v\"", str, rx), msgAndArgs...)
- }
- return match
- }
- // NotRegexp asserts that a specified regexp does not match a string.
- //
- // assert.NotRegexp(t, regexp.MustCompile("starts"), "it's starting")
- // assert.NotRegexp(t, "^start", "it's not starting")
- func NotRegexp(t TestingT, rx interface{}, str interface{}, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- match := matchRegexp(rx, str)
- if match {
- Fail(t, fmt.Sprintf("Expect \"%v\" to NOT match \"%v\"", str, rx), msgAndArgs...)
- }
- return !match
- }
- // Zero asserts that i is the zero value for its type.
- func Zero(t TestingT, i interface{}, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if i != nil && !reflect.DeepEqual(i, reflect.Zero(reflect.TypeOf(i)).Interface()) {
- return Fail(t, fmt.Sprintf("Should be zero, but was %v", i), msgAndArgs...)
- }
- return true
- }
- // NotZero asserts that i is not the zero value for its type.
- func NotZero(t TestingT, i interface{}, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if i == nil || reflect.DeepEqual(i, reflect.Zero(reflect.TypeOf(i)).Interface()) {
- return Fail(t, fmt.Sprintf("Should not be zero, but was %v", i), msgAndArgs...)
- }
- return true
- }
- // FileExists checks whether a file exists in the given path. It also fails if
- // the path points to a directory or there is an error when trying to check the file.
- func FileExists(t TestingT, path string, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- info, err := os.Lstat(path)
- if err != nil {
- if os.IsNotExist(err) {
- return Fail(t, fmt.Sprintf("unable to find file %q", path), msgAndArgs...)
- }
- return Fail(t, fmt.Sprintf("error when running os.Lstat(%q): %s", path, err), msgAndArgs...)
- }
- if info.IsDir() {
- return Fail(t, fmt.Sprintf("%q is a directory", path), msgAndArgs...)
- }
- return true
- }
- // NoFileExists checks whether a file does not exist in a given path. It fails
- // if the path points to an existing _file_ only.
- func NoFileExists(t TestingT, path string, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- info, err := os.Lstat(path)
- if err != nil {
- return true
- }
- if info.IsDir() {
- return true
- }
- return Fail(t, fmt.Sprintf("file %q exists", path), msgAndArgs...)
- }
- // DirExists checks whether a directory exists in the given path. It also fails
- // if the path is a file rather a directory or there is an error checking whether it exists.
- func DirExists(t TestingT, path string, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- info, err := os.Lstat(path)
- if err != nil {
- if os.IsNotExist(err) {
- return Fail(t, fmt.Sprintf("unable to find file %q", path), msgAndArgs...)
- }
- return Fail(t, fmt.Sprintf("error when running os.Lstat(%q): %s", path, err), msgAndArgs...)
- }
- if !info.IsDir() {
- return Fail(t, fmt.Sprintf("%q is a file", path), msgAndArgs...)
- }
- return true
- }
- // NoDirExists checks whether a directory does not exist in the given path.
- // It fails if the path points to an existing _directory_ only.
- func NoDirExists(t TestingT, path string, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- info, err := os.Lstat(path)
- if err != nil {
- if os.IsNotExist(err) {
- return true
- }
- return true
- }
- if !info.IsDir() {
- return true
- }
- return Fail(t, fmt.Sprintf("directory %q exists", path), msgAndArgs...)
- }
- // JSONEq asserts that two JSON strings are equivalent.
- //
- // assert.JSONEq(t, `{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`)
- func JSONEq(t TestingT, expected string, actual string, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- var expectedJSONAsInterface, actualJSONAsInterface interface{}
- if err := json.Unmarshal([]byte(expected), &expectedJSONAsInterface); err != nil {
- return Fail(t, fmt.Sprintf("Expected value ('%s') is not valid json.\nJSON parsing error: '%s'", expected, err.Error()), msgAndArgs...)
- }
- if err := json.Unmarshal([]byte(actual), &actualJSONAsInterface); err != nil {
- return Fail(t, fmt.Sprintf("Input ('%s') needs to be valid json.\nJSON parsing error: '%s'", actual, err.Error()), msgAndArgs...)
- }
- return Equal(t, expectedJSONAsInterface, actualJSONAsInterface, msgAndArgs...)
- }
- // YAMLEq asserts that two YAML strings are equivalent.
- func YAMLEq(t TestingT, expected string, actual string, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- var expectedYAMLAsInterface, actualYAMLAsInterface interface{}
- if err := yaml.Unmarshal([]byte(expected), &expectedYAMLAsInterface); err != nil {
- return Fail(t, fmt.Sprintf("Expected value ('%s') is not valid yaml.\nYAML parsing error: '%s'", expected, err.Error()), msgAndArgs...)
- }
- if err := yaml.Unmarshal([]byte(actual), &actualYAMLAsInterface); err != nil {
- return Fail(t, fmt.Sprintf("Input ('%s') needs to be valid yaml.\nYAML error: '%s'", actual, err.Error()), msgAndArgs...)
- }
- return Equal(t, expectedYAMLAsInterface, actualYAMLAsInterface, msgAndArgs...)
- }
- func typeAndKind(v interface{}) (reflect.Type, reflect.Kind) {
- t := reflect.TypeOf(v)
- k := t.Kind()
- if k == reflect.Ptr {
- t = t.Elem()
- k = t.Kind()
- }
- return t, k
- }
- // diff returns a diff of both values as long as both are of the same type and
- // are a struct, map, slice, array or string. Otherwise it returns an empty string.
- func diff(expected interface{}, actual interface{}) string {
- if expected == nil || actual == nil {
- return ""
- }
- et, ek := typeAndKind(expected)
- at, _ := typeAndKind(actual)
- if et != at {
- return ""
- }
- if ek != reflect.Struct && ek != reflect.Map && ek != reflect.Slice && ek != reflect.Array && ek != reflect.String {
- return ""
- }
- var e, a string
- switch et {
- case reflect.TypeOf(""):
- e = reflect.ValueOf(expected).String()
- a = reflect.ValueOf(actual).String()
- case reflect.TypeOf(time.Time{}):
- e = spewConfigStringerEnabled.Sdump(expected)
- a = spewConfigStringerEnabled.Sdump(actual)
- default:
- e = spewConfig.Sdump(expected)
- a = spewConfig.Sdump(actual)
- }
- diff, _ := difflib.GetUnifiedDiffString(difflib.UnifiedDiff{
- A: difflib.SplitLines(e),
- B: difflib.SplitLines(a),
- FromFile: "Expected",
- FromDate: "",
- ToFile: "Actual",
- ToDate: "",
- Context: 1,
- })
- return "\n\nDiff:\n" + diff
- }
- func isFunction(arg interface{}) bool {
- if arg == nil {
- return false
- }
- return reflect.TypeOf(arg).Kind() == reflect.Func
- }
- var spewConfig = spew.ConfigState{
- Indent: " ",
- DisablePointerAddresses: true,
- DisableCapacities: true,
- SortKeys: true,
- DisableMethods: true,
- MaxDepth: 10,
- }
- var spewConfigStringerEnabled = spew.ConfigState{
- Indent: " ",
- DisablePointerAddresses: true,
- DisableCapacities: true,
- SortKeys: true,
- MaxDepth: 10,
- }
- type tHelper interface {
- Helper()
- }
- // Eventually asserts that given condition will be met in waitFor time,
- // periodically checking target function each tick.
- //
- // assert.Eventually(t, func() bool { return true; }, time.Second, 10*time.Millisecond)
- func Eventually(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- ch := make(chan bool, 1)
- timer := time.NewTimer(waitFor)
- defer timer.Stop()
- ticker := time.NewTicker(tick)
- defer ticker.Stop()
- for tick := ticker.C; ; {
- select {
- case <-timer.C:
- return Fail(t, "Condition never satisfied", msgAndArgs...)
- case <-tick:
- tick = nil
- go func() { ch <- condition() }()
- case v := <-ch:
- if v {
- return true
- }
- tick = ticker.C
- }
- }
- }
- // CollectT implements the TestingT interface and collects all errors.
- type CollectT struct {
- errors []error
- }
- // Errorf collects the error.
- func (c *CollectT) Errorf(format string, args ...interface{}) {
- c.errors = append(c.errors, fmt.Errorf(format, args...))
- }
- // FailNow panics.
- func (c *CollectT) FailNow() {
- panic("Assertion failed")
- }
- // Reset clears the collected errors.
- func (c *CollectT) Reset() {
- c.errors = nil
- }
- // Copy copies the collected errors to the supplied t.
- func (c *CollectT) Copy(t TestingT) {
- if tt, ok := t.(tHelper); ok {
- tt.Helper()
- }
- for _, err := range c.errors {
- t.Errorf("%v", err)
- }
- }
- // EventuallyWithT asserts that given condition will be met in waitFor time,
- // periodically checking target function each tick. In contrast to Eventually,
- // it supplies a CollectT to the condition function, so that the condition
- // function can use the CollectT to call other assertions.
- // The condition is considered "met" if no errors are raised in a tick.
- // The supplied CollectT collects all errors from one tick (if there are any).
- // If the condition is not met before waitFor, the collected errors of
- // the last tick are copied to t.
- //
- // externalValue := false
- // go func() {
- // time.Sleep(8*time.Second)
- // externalValue = true
- // }()
- // assert.EventuallyWithT(t, func(c *assert.CollectT) {
- // // add assertions as needed; any assertion failure will fail the current tick
- // assert.True(c, externalValue, "expected 'externalValue' to be true")
- // }, 1*time.Second, 10*time.Second, "external state has not changed to 'true'; still false")
- func EventuallyWithT(t TestingT, condition func(collect *CollectT), waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- collect := new(CollectT)
- ch := make(chan bool, 1)
- timer := time.NewTimer(waitFor)
- defer timer.Stop()
- ticker := time.NewTicker(tick)
- defer ticker.Stop()
- for tick := ticker.C; ; {
- select {
- case <-timer.C:
- collect.Copy(t)
- return Fail(t, "Condition never satisfied", msgAndArgs...)
- case <-tick:
- tick = nil
- collect.Reset()
- go func() {
- condition(collect)
- ch <- len(collect.errors) == 0
- }()
- case v := <-ch:
- if v {
- return true
- }
- tick = ticker.C
- }
- }
- }
- // Never asserts that the given condition doesn't satisfy in waitFor time,
- // periodically checking the target function each tick.
- //
- // assert.Never(t, func() bool { return false; }, time.Second, 10*time.Millisecond)
- func Never(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- ch := make(chan bool, 1)
- timer := time.NewTimer(waitFor)
- defer timer.Stop()
- ticker := time.NewTicker(tick)
- defer ticker.Stop()
- for tick := ticker.C; ; {
- select {
- case <-timer.C:
- return true
- case <-tick:
- tick = nil
- go func() { ch <- condition() }()
- case v := <-ch:
- if v {
- return Fail(t, "Condition satisfied", msgAndArgs...)
- }
- tick = ticker.C
- }
- }
- }
- // ErrorIs asserts that at least one of the errors in err's chain matches target.
- // This is a wrapper for errors.Is.
- func ErrorIs(t TestingT, err, target error, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if errors.Is(err, target) {
- return true
- }
- var expectedText string
- if target != nil {
- expectedText = target.Error()
- }
- chain := buildErrorChainString(err)
- return Fail(t, fmt.Sprintf("Target error should be in err chain:\n"+
- "expected: %q\n"+
- "in chain: %s", expectedText, chain,
- ), msgAndArgs...)
- }
- // NotErrorIs asserts that at none of the errors in err's chain matches target.
- // This is a wrapper for errors.Is.
- func NotErrorIs(t TestingT, err, target error, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if !errors.Is(err, target) {
- return true
- }
- var expectedText string
- if target != nil {
- expectedText = target.Error()
- }
- chain := buildErrorChainString(err)
- return Fail(t, fmt.Sprintf("Target error should not be in err chain:\n"+
- "found: %q\n"+
- "in chain: %s", expectedText, chain,
- ), msgAndArgs...)
- }
- // ErrorAs asserts that at least one of the errors in err's chain matches target, and if so, sets target to that error value.
- // This is a wrapper for errors.As.
- func ErrorAs(t TestingT, err error, target interface{}, msgAndArgs ...interface{}) bool {
- if h, ok := t.(tHelper); ok {
- h.Helper()
- }
- if errors.As(err, target) {
- return true
- }
- chain := buildErrorChainString(err)
- return Fail(t, fmt.Sprintf("Should be in error chain:\n"+
- "expected: %q\n"+
- "in chain: %s", target, chain,
- ), msgAndArgs...)
- }
- func buildErrorChainString(err error) string {
- if err == nil {
- return ""
- }
- e := errors.Unwrap(err)
- chain := fmt.Sprintf("%q", err.Error())
- for e != nil {
- chain += fmt.Sprintf("\n\t%q", e.Error())
- e = errors.Unwrap(e)
- }
- return chain
- }
|