Skip to content

Commit

Permalink
Move equal package to internal
Browse files Browse the repository at this point in the history
  • Loading branch information
mminklet committed Oct 10, 2022
1 parent ae64ce6 commit 7e120ea
Show file tree
Hide file tree
Showing 9 changed files with 181 additions and 11 deletions.
22 changes: 22 additions & 0 deletions assert/assertion_format.go
Original file line number Diff line number Diff line change
Expand Up @@ -637,6 +637,28 @@ func NotZerof(t TestingT, i interface{}, msg string, args ...interface{}) bool {
return NotZero(t, i, append([]interface{}{msg}, args...)...)
}

// ObjectsAreEqualf determines if two objects are considered equal.
//
// Deprecated: Use Equal(expected, actual interface{})
// Note this method did no assertions, whereas Equal does,
// so may require some code changes.
func ObjectsAreEqualf(t TestingT, expected interface{}, actual interface{}) bool {
if h, ok := t.(tHelper); ok {
h.Helper()
}
return ObjectsAreEqual(t, expected, actual)
}

// Deprecated: Use EqualValues(expected, actual interface{})
// Note this method did no assertions, whereas EqualValues does,
// so may require some code changes.
func ObjectsAreEqualValuesf(t TestingT, expected interface{}, actual interface{}) bool {
if h, ok := t.(tHelper); ok {
h.Helper()
}
return ObjectsAreEqualValues(t, expected, actual)
}

// Panicsf asserts that the code inside the specified PanicTestFunc panics.
//
// assert.Panicsf(t, func(){ GoCrazy() }, "error message %s", "formatted")
Expand Down
44 changes: 44 additions & 0 deletions assert/assertion_forward.go
Original file line number Diff line number Diff line change
Expand Up @@ -1263,6 +1263,50 @@ func (a *Assertions) NotZerof(i interface{}, msg string, args ...interface{}) bo
return NotZerof(a.t, i, msg, args...)
}

// ObjectsAreEqual determines if two objects are considered equal.
//
// Deprecated: Use Equal(expected, actual interface{})
// Note this method did no assertions, whereas Equal does,
// so may require some code changes.
func (a *Assertions) ObjectsAreEqual(expected interface{}, actual interface{}) bool {
if h, ok := a.t.(tHelper); ok {
h.Helper()
}
return ObjectsAreEqual(a.t, expected, actual)
}

// Deprecated: Use EqualValues(expected, actual interface{})
// Note this method did no assertions, whereas EqualValues does,
// so may require some code changes.
func (a *Assertions) ObjectsAreEqualValues(expected interface{}, actual interface{}) bool {
if h, ok := a.t.(tHelper); ok {
h.Helper()
}
return ObjectsAreEqualValues(a.t, expected, actual)
}

// Deprecated: Use EqualValues(expected, actual interface{})
// Note this method did no assertions, whereas EqualValues does,
// so may require some code changes.
func (a *Assertions) ObjectsAreEqualValuesf(expected interface{}, actual interface{}) bool {
if h, ok := a.t.(tHelper); ok {
h.Helper()
}
return ObjectsAreEqualValuesf(a.t, expected, actual)
}

// ObjectsAreEqualf determines if two objects are considered equal.
//
// Deprecated: Use Equal(expected, actual interface{})
// Note this method did no assertions, whereas Equal does,
// so may require some code changes.
func (a *Assertions) ObjectsAreEqualf(expected interface{}, actual interface{}) bool {
if h, ok := a.t.(tHelper); ok {
h.Helper()
}
return ObjectsAreEqualf(a.t, expected, actual)
}

// Panics asserts that the code inside the specified PanicTestFunc panics.
//
// a.Panics(func(){ GoCrazy() })
Expand Down
16 changes: 9 additions & 7 deletions assert/assertions.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import (

"github.com/davecgh/go-spew/spew"
"github.com/pmezard/go-difflib/difflib"
"github.com/stretchr/testify/assert/equal"
"github.com/stretchr/testify/internal/equal"
yaml "gopkg.in/yaml.v3"
)

Expand Down Expand Up @@ -286,18 +286,20 @@ func IsType(t TestingT, expectedType interface{}, object interface{}, msgAndArgs

// ObjectsAreEqual determines if two objects are considered equal.
//
// Deprecated: Use equal.ObjectsAreEqual, which does the exact same thing,
// but is clearer that it does no assertions of any kind.
func ObjectsAreEqual(expected, actual interface{}) bool {
// Deprecated: Use Equal(expected, actual interface{})
// Note this method did no assertions, whereas Equal does,
// so may require some code changes.
func ObjectsAreEqual(t TestingT, expected, actual interface{}) bool {
return equal.ObjectsAreEqual(expected, actual)
}

// ObjectsAreEqualValues gets whether two objects are equal, or if their
// values are equal.

// Deprecated: Use equal.ObjectsAreEqualValues, which does the exact same thing,
// but is clearer that it does no assertions of any kind.
func ObjectsAreEqualValues(expected, actual interface{}) bool {
// Deprecated: Use EqualValues(expected, actual interface{})
// Note this method did no assertions, whereas EqualValues does,
// so may require some code changes.
func ObjectsAreEqualValues(t TestingT, expected, actual interface{}) bool {
return equal.ObjectsAreEqualValues(expected, actual)
}

Expand Down
2 changes: 1 addition & 1 deletion assert/assertions_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import (
"testing"
"time"

"github.com/stretchr/testify/assert/equal"
"github.com/stretchr/testify/internal/equal"
)

var (
Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion mock/mock.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import (
"github.com/pmezard/go-difflib/difflib"
"github.com/stretchr/objx"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/assert/equal"
"github.com/stretchr/testify/internal/equal"
)

// TestingT is an interface wrapper around *testing.T
Expand Down
59 changes: 58 additions & 1 deletion require/require.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@
package require

import (
assert "github.com/stretchr/testify/assert"
http "net/http"
url "net/url"
time "time"

assert "github.com/stretchr/testify/assert"
)

// Condition uses a Comparison to assert a complex condition.
Expand Down Expand Up @@ -1612,6 +1613,62 @@ func NotZerof(t TestingT, i interface{}, msg string, args ...interface{}) {
t.FailNow()
}

// ObjectsAreEqual determines if two objects are considered equal.
//
// Deprecated: Use Equal(expected, actual interface{})
// Note this method did no assertions, whereas Equal does,
// so may require some code changes.
func ObjectsAreEqual(t TestingT, expected interface{}, actual interface{}) {
if h, ok := t.(tHelper); ok {
h.Helper()
}
if assert.ObjectsAreEqual(t, expected, actual) {
return
}
t.FailNow()
}

// Deprecated: Use EqualValues(expected, actual interface{})
// Note this method did no assertions, whereas EqualValues does,
// so may require some code changes.
func ObjectsAreEqualValues(t TestingT, expected interface{}, actual interface{}) {
if h, ok := t.(tHelper); ok {
h.Helper()
}
if assert.ObjectsAreEqualValues(t, expected, actual) {
return
}
t.FailNow()
}

// Deprecated: Use EqualValues(expected, actual interface{})
// Note this method did no assertions, whereas EqualValues does,
// so may require some code changes.
func ObjectsAreEqualValuesf(t TestingT, expected interface{}, actual interface{}) {
if h, ok := t.(tHelper); ok {
h.Helper()
}
if assert.ObjectsAreEqualValuesf(t, expected, actual) {
return
}
t.FailNow()
}

// ObjectsAreEqualf determines if two objects are considered equal.
//
// Deprecated: Use Equal(expected, actual interface{})
// Note this method did no assertions, whereas Equal does,
// so may require some code changes.
func ObjectsAreEqualf(t TestingT, expected interface{}, actual interface{}) {
if h, ok := t.(tHelper); ok {
h.Helper()
}
if assert.ObjectsAreEqualf(t, expected, actual) {
return
}
t.FailNow()
}

// Panics asserts that the code inside the specified PanicTestFunc panics.
//
// assert.Panics(t, func(){ GoCrazy() })
Expand Down
47 changes: 46 additions & 1 deletion require/require_forward.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@
package require

import (
assert "github.com/stretchr/testify/assert"
http "net/http"
url "net/url"
time "time"

assert "github.com/stretchr/testify/assert"
)

// Condition uses a Comparison to assert a complex condition.
Expand Down Expand Up @@ -1264,6 +1265,50 @@ func (a *Assertions) NotZerof(i interface{}, msg string, args ...interface{}) {
NotZerof(a.t, i, msg, args...)
}

// ObjectsAreEqual determines if two objects are considered equal.
//
// Deprecated: Use Equal(expected, actual interface{})
// Note this method did no assertions, whereas Equal does,
// so may require some code changes.
func (a *Assertions) ObjectsAreEqual(expected interface{}, actual interface{}) {
if h, ok := a.t.(tHelper); ok {
h.Helper()
}
ObjectsAreEqual(a.t, expected, actual)
}

// Deprecated: Use EqualValues(expected, actual interface{})
// Note this method did no assertions, whereas EqualValues does,
// so may require some code changes.
func (a *Assertions) ObjectsAreEqualValues(expected interface{}, actual interface{}) {
if h, ok := a.t.(tHelper); ok {
h.Helper()
}
ObjectsAreEqualValues(a.t, expected, actual)
}

// Deprecated: Use EqualValues(expected, actual interface{})
// Note this method did no assertions, whereas EqualValues does,
// so may require some code changes.
func (a *Assertions) ObjectsAreEqualValuesf(expected interface{}, actual interface{}) {
if h, ok := a.t.(tHelper); ok {
h.Helper()
}
ObjectsAreEqualValuesf(a.t, expected, actual)
}

// ObjectsAreEqualf determines if two objects are considered equal.
//
// Deprecated: Use Equal(expected, actual interface{})
// Note this method did no assertions, whereas Equal does,
// so may require some code changes.
func (a *Assertions) ObjectsAreEqualf(expected interface{}, actual interface{}) {
if h, ok := a.t.(tHelper); ok {
h.Helper()
}
ObjectsAreEqualf(a.t, expected, actual)
}

// Panics asserts that the code inside the specified PanicTestFunc panics.
//
// a.Panics(func(){ GoCrazy() })
Expand Down

0 comments on commit 7e120ea

Please sign in to comment.