Skip to content

Commit fc30ce6

Browse files
dolmendolmen
committed
assert: drop CompareType
Rename CompareType to compareResult to make it private. This type is used only in internal functions and is of no use for external users and should never have been made public. CompareType has been introduced by 0b4ff03 and appeared in releases since v1.6.0. Note: strictly speaking, this is a breaking change, but no external user should have ever used assert.CompareType as it made no sense in the assert API. A search on GitHub has revealed no use of it. https://github.com/search?q=assert.CompareType+language%3AGo&type=Repositories&ref=advsearch&l=Go&l=
1 parent 539cfd9 commit fc30ce6

3 files changed

Lines changed: 32 additions & 32 deletions

File tree

‎assert/assertion_compare.go‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ import (
77
"time"
88
)
99

10-
type CompareType int
10+
type compareResult int
1111

1212
const (
13-
compareLess CompareType = iota - 1
13+
compareLess compareResult = iota - 1
1414
compareEqual
1515
compareGreater
1616
)
@@ -39,7 +39,7 @@ var (
3939
bytesType = reflect.TypeOf([]byte{})
4040
)
4141

42-
func compare(obj1, obj2 interface{}, kind reflect.Kind) (CompareType, bool) {
42+
func compare(obj1, obj2 interface{}, kind reflect.Kind) (compareResult, bool) {
4343
obj1Value := reflect.ValueOf(obj1)
4444
obj2Value := reflect.ValueOf(obj2)
4545

@@ -345,7 +345,7 @@ func compare(obj1, obj2 interface{}, kind reflect.Kind) (CompareType, bool) {
345345
bytesObj2 = obj2Value.Convert(bytesType).Interface().([]byte)
346346
}
347347

348-
return CompareType(bytes.Compare(bytesObj1, bytesObj2)), true
348+
return compareResult(bytes.Compare(bytesObj1, bytesObj2)), true
349349
}
350350
case reflect.Uintptr:
351351
{
@@ -381,7 +381,7 @@ func Greater(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface
381381
if h, ok := t.(tHelper); ok {
382382
h.Helper()
383383
}
384-
return compareTwoValues(t, e1, e2, []CompareType{compareGreater}, "\"%v\" is not greater than \"%v\"", msgAndArgs...)
384+
return compareTwoValues(t, e1, e2, []compareResult{compareGreater}, "\"%v\" is not greater than \"%v\"", msgAndArgs...)
385385
}
386386

387387
// GreaterOrEqual asserts that the first element is greater than or equal to the second
@@ -394,7 +394,7 @@ func GreaterOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...in
394394
if h, ok := t.(tHelper); ok {
395395
h.Helper()
396396
}
397-
return compareTwoValues(t, e1, e2, []CompareType{compareGreater, compareEqual}, "\"%v\" is not greater than or equal to \"%v\"", msgAndArgs...)
397+
return compareTwoValues(t, e1, e2, []compareResult{compareGreater, compareEqual}, "\"%v\" is not greater than or equal to \"%v\"", msgAndArgs...)
398398
}
399399

400400
// Less asserts that the first element is less than the second
@@ -406,7 +406,7 @@ func Less(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{})
406406
if h, ok := t.(tHelper); ok {
407407
h.Helper()
408408
}
409-
return compareTwoValues(t, e1, e2, []CompareType{compareLess}, "\"%v\" is not less than \"%v\"", msgAndArgs...)
409+
return compareTwoValues(t, e1, e2, []compareResult{compareLess}, "\"%v\" is not less than \"%v\"", msgAndArgs...)
410410
}
411411

412412
// LessOrEqual asserts that the first element is less than or equal to the second
@@ -419,7 +419,7 @@ func LessOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...inter
419419
if h, ok := t.(tHelper); ok {
420420
h.Helper()
421421
}
422-
return compareTwoValues(t, e1, e2, []CompareType{compareLess, compareEqual}, "\"%v\" is not less than or equal to \"%v\"", msgAndArgs...)
422+
return compareTwoValues(t, e1, e2, []compareResult{compareLess, compareEqual}, "\"%v\" is not less than or equal to \"%v\"", msgAndArgs...)
423423
}
424424

425425
// Positive asserts that the specified element is positive
@@ -431,7 +431,7 @@ func Positive(t TestingT, e interface{}, msgAndArgs ...interface{}) bool {
431431
h.Helper()
432432
}
433433
zero := reflect.Zero(reflect.TypeOf(e))
434-
return compareTwoValues(t, e, zero.Interface(), []CompareType{compareGreater}, "\"%v\" is not positive", msgAndArgs...)
434+
return compareTwoValues(t, e, zero.Interface(), []compareResult{compareGreater}, "\"%v\" is not positive", msgAndArgs...)
435435
}
436436

437437
// Negative asserts that the specified element is negative
@@ -443,10 +443,10 @@ func Negative(t TestingT, e interface{}, msgAndArgs ...interface{}) bool {
443443
h.Helper()
444444
}
445445
zero := reflect.Zero(reflect.TypeOf(e))
446-
return compareTwoValues(t, e, zero.Interface(), []CompareType{compareLess}, "\"%v\" is not negative", msgAndArgs...)
446+
return compareTwoValues(t, e, zero.Interface(), []compareResult{compareLess}, "\"%v\" is not negative", msgAndArgs...)
447447
}
448448

449-
func compareTwoValues(t TestingT, e1 interface{}, e2 interface{}, allowedComparesResults []CompareType, failMessage string, msgAndArgs ...interface{}) bool {
449+
func compareTwoValues(t TestingT, e1 interface{}, e2 interface{}, allowedComparesResults []compareResult, failMessage string, msgAndArgs ...interface{}) bool {
450450
if h, ok := t.(tHelper); ok {
451451
h.Helper()
452452
}
@@ -469,7 +469,7 @@ func compareTwoValues(t TestingT, e1 interface{}, e2 interface{}, allowedCompare
469469
return true
470470
}
471471

472-
func containsValue(values []CompareType, value CompareType) bool {
472+
func containsValue(values []compareResult, value compareResult) bool {
473473
for _, v := range values {
474474
if v == value {
475475
return true

‎assert/assertion_compare_test.go‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,7 @@ func Test_compareTwoValuesDifferentValuesTypes(t *testing.T) {
392392
{v1: float64(12), v2: "123"},
393393
{v1: "float(12)", v2: float64(1)},
394394
} {
395-
result := compareTwoValues(mockT, currCase.v1, currCase.v2, []CompareType{compareLess, compareEqual, compareGreater}, "testFailMessage")
395+
result := compareTwoValues(mockT, currCase.v1, currCase.v2, []compareResult{compareLess, compareEqual, compareGreater}, "testFailMessage")
396396
False(t, result)
397397
}
398398
}
@@ -411,7 +411,7 @@ func Test_compareTwoValuesNotComparableValues(t *testing.T) {
411411
{v1: map[string]int{}, v2: map[string]int{}},
412412
{v1: make([]int, 5), v2: make([]int, 5)},
413413
} {
414-
result := compareTwoValues(mockT, currCase.v1, currCase.v2, []CompareType{compareLess, compareEqual, compareGreater}, "testFailMessage")
414+
result := compareTwoValues(mockT, currCase.v1, currCase.v2, []compareResult{compareLess, compareEqual, compareGreater}, "testFailMessage")
415415
False(t, result)
416416
}
417417
}
@@ -422,14 +422,14 @@ func Test_compareTwoValuesCorrectCompareResult(t *testing.T) {
422422
for _, currCase := range []struct {
423423
v1 interface{}
424424
v2 interface{}
425-
allowedResults []CompareType
425+
allowedResults []compareResult
426426
}{
427-
{v1: 1, v2: 2, allowedResults: []CompareType{compareLess}},
428-
{v1: 1, v2: 2, allowedResults: []CompareType{compareLess, compareEqual}},
429-
{v1: 2, v2: 2, allowedResults: []CompareType{compareGreater, compareEqual}},
430-
{v1: 2, v2: 2, allowedResults: []CompareType{compareEqual}},
431-
{v1: 2, v2: 1, allowedResults: []CompareType{compareEqual, compareGreater}},
432-
{v1: 2, v2: 1, allowedResults: []CompareType{compareGreater}},
427+
{v1: 1, v2: 2, allowedResults: []compareResult{compareLess}},
428+
{v1: 1, v2: 2, allowedResults: []compareResult{compareLess, compareEqual}},
429+
{v1: 2, v2: 2, allowedResults: []compareResult{compareGreater, compareEqual}},
430+
{v1: 2, v2: 2, allowedResults: []compareResult{compareEqual}},
431+
{v1: 2, v2: 1, allowedResults: []compareResult{compareEqual, compareGreater}},
432+
{v1: 2, v2: 1, allowedResults: []compareResult{compareGreater}},
433433
} {
434434
result := compareTwoValues(mockT, currCase.v1, currCase.v2, currCase.allowedResults, "testFailMessage")
435435
True(t, result)
@@ -438,14 +438,14 @@ func Test_compareTwoValuesCorrectCompareResult(t *testing.T) {
438438

439439
func Test_containsValue(t *testing.T) {
440440
for _, currCase := range []struct {
441-
values []CompareType
442-
value CompareType
441+
values []compareResult
442+
value compareResult
443443
result bool
444444
}{
445-
{values: []CompareType{compareGreater}, value: compareGreater, result: true},
446-
{values: []CompareType{compareGreater, compareLess}, value: compareGreater, result: true},
447-
{values: []CompareType{compareGreater, compareLess}, value: compareLess, result: true},
448-
{values: []CompareType{compareGreater, compareLess}, value: compareEqual, result: false},
445+
{values: []compareResult{compareGreater}, value: compareGreater, result: true},
446+
{values: []compareResult{compareGreater, compareLess}, value: compareGreater, result: true},
447+
{values: []compareResult{compareGreater, compareLess}, value: compareLess, result: true},
448+
{values: []compareResult{compareGreater, compareLess}, value: compareEqual, result: false},
449449
} {
450450
result := containsValue(currCase.values, currCase.value)
451451
Equal(t, currCase.result, result)

‎assert/assertion_order.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import (
66
)
77

88
// isOrdered checks that collection contains orderable elements.
9-
func isOrdered(t TestingT, object interface{}, allowedComparesResults []CompareType, failMessage string, msgAndArgs ...interface{}) bool {
9+
func isOrdered(t TestingT, object interface{}, allowedComparesResults []compareResult, failMessage string, msgAndArgs ...interface{}) bool {
1010
objKind := reflect.TypeOf(object).Kind()
1111
if objKind != reflect.Slice && objKind != reflect.Array {
1212
return false
@@ -50,7 +50,7 @@ func isOrdered(t TestingT, object interface{}, allowedComparesResults []CompareT
5050
// assert.IsIncreasing(t, []float{1, 2})
5151
// assert.IsIncreasing(t, []string{"a", "b"})
5252
func IsIncreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool {
53-
return isOrdered(t, object, []CompareType{compareLess}, "\"%v\" is not less than \"%v\"", msgAndArgs...)
53+
return isOrdered(t, object, []compareResult{compareLess}, "\"%v\" is not less than \"%v\"", msgAndArgs...)
5454
}
5555

5656
// IsNonIncreasing asserts that the collection is not increasing
@@ -59,7 +59,7 @@ func IsIncreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) boo
5959
// assert.IsNonIncreasing(t, []float{2, 1})
6060
// assert.IsNonIncreasing(t, []string{"b", "a"})
6161
func IsNonIncreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool {
62-
return isOrdered(t, object, []CompareType{compareEqual, compareGreater}, "\"%v\" is not greater than or equal to \"%v\"", msgAndArgs...)
62+
return isOrdered(t, object, []compareResult{compareEqual, compareGreater}, "\"%v\" is not greater than or equal to \"%v\"", msgAndArgs...)
6363
}
6464

6565
// IsDecreasing asserts that the collection is decreasing
@@ -68,7 +68,7 @@ func IsNonIncreasing(t TestingT, object interface{}, msgAndArgs ...interface{})
6868
// assert.IsDecreasing(t, []float{2, 1})
6969
// assert.IsDecreasing(t, []string{"b", "a"})
7070
func IsDecreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool {
71-
return isOrdered(t, object, []CompareType{compareGreater}, "\"%v\" is not greater than \"%v\"", msgAndArgs...)
71+
return isOrdered(t, object, []compareResult{compareGreater}, "\"%v\" is not greater than \"%v\"", msgAndArgs...)
7272
}
7373

7474
// IsNonDecreasing asserts that the collection is not decreasing
@@ -77,5 +77,5 @@ func IsDecreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) boo
7777
// assert.IsNonDecreasing(t, []float{1, 2})
7878
// assert.IsNonDecreasing(t, []string{"a", "b"})
7979
func IsNonDecreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool {
80-
return isOrdered(t, object, []CompareType{compareLess, compareEqual}, "\"%v\" is not less than or equal to \"%v\"", msgAndArgs...)
80+
return isOrdered(t, object, []compareResult{compareLess, compareEqual}, "\"%v\" is not less than or equal to \"%v\"", msgAndArgs...)
8181
}

0 commit comments

Comments
 (0)