Skip to content

Commit 3830180

Browse files
vdemeestervdemeester
committed
Replace gotestyourself by gotest.tools
github.com/gotestyourself/gotestyourself moved to gotest.tools with version 2.0.0. Moving to that one, bumping it to v2.1.0. Signed-off-by: Vincent Demeester <[email protected]>
1 parent 35887db commit 3830180

14 files changed

Lines changed: 414 additions & 505 deletions

File tree

‎vendor.conf‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ github.com/golang/protobuf v1.1.0
2222
github.com/opencontainers/runtime-spec v1.0.1
2323
github.com/opencontainers/runc 69663f0bd4b60df09991c08812a60108003fa340
2424
github.com/sirupsen/logrus v1.0.0
25-
github.com/pmezard/go-difflib v1.0.0
2625
github.com/urfave/cli 7bc6a0acffa589f415f88aca16cc1de5ffd66f9c
2726
golang.org/x/net b3756b4b77d7b13260a0a2ec658753cf48922eac
2827
google.golang.org/grpc v1.12.0
@@ -40,7 +39,7 @@ google.golang.org/genproto d80a6e20e776b0b17a324d0ba1ab50a39c8e8944
4039
golang.org/x/text 19e51611da83d6be54ddafce4a4af510cb3e9ea4
4140
github.com/stevvooe/ttrpc d4528379866b0ce7e9d71f3eb96f0582fc374577
4241
github.com/syndtr/gocapability db04d3cc01c8b54962a58ec7e491717d06cfcc16
43-
github.com/gotestyourself/gotestyourself 44dbf532bbf5767611f6f2a61bded572e337010a
42+
gotest.tools v2.1.0
4443
github.com/google/go-cmp v0.1.0
4544

4645
github.com/containerd/cri 8bcb9a95394e8d7845da1d6a994d3ac2a86d22f0

‎vendor/github.com/gotestyourself/gotestyourself/README.md‎

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎vendor/github.com/pmezard/go-difflib/README.md‎

Lines changed: 0 additions & 50 deletions
This file was deleted.

vendor/github.com/gotestyourself/gotestyourself/LICENSE renamed to vendor/gotest.tools/LICENSE

File renamed without changes.

‎vendor/gotest.tools/README.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# gotest.tools
2+
3+
A collection of packages to augment `testing` and support common patterns.
4+
5+
[![GoDoc](https://godoc.org/gotest.tools?status.svg)](https://godoc.org/gotest.tools)
6+
[![CircleCI](https://circleci.com/gh/gotestyourself/gotestyourself/tree/master.svg?style=shield)](https://circleci.com/gh/gotestyourself/gotestyourself/tree/master)
7+
[![Go Reportcard](https://goreportcard.com/badge/gotest.tools)](https://goreportcard.com/report/gotest.tools)
8+
9+
10+
## Packages
11+
12+
* [assert](http://godoc.org/gotest.tools/assert) -
13+
compare values and fail the test when a comparison fails
14+
* [env](http://godoc.org/gotest.tools/env) -
15+
test code which uses environment variables
16+
* [fs](http://godoc.org/gotest.tools/fs) -
17+
create temporary files and compare a filesystem tree to an expected value
18+
* [golden](http://godoc.org/gotest.tools/golden) -
19+
compare large multi-line strings against values frozen in golden files
20+
* [icmd](http://godoc.org/gotest.tools/icmd) -
21+
execute binaries and test the output
22+
* [poll](http://godoc.org/gotest.tools/poll) -
23+
test asynchronous code by polling until a desired state is reached
24+
* [skip](http://godoc.org/gotest.tools/skip) -
25+
skip a test and print the source code of the condition used to skip the test
26+
27+
## Related
28+
29+
* [gotest.tools/gotestsum](https://github.com/gotestyourself/gotestsum) - go test runner with custom output
30+
* [maxbrunsfeld/counterfeiter](https://github.com/maxbrunsfeld/counterfeiter) - generate fakes for interfaces
31+
* [jonboulle/clockwork](https://github.com/jonboulle/clockwork) - a fake clock for testing code that uses `time`

vendor/github.com/gotestyourself/gotestyourself/assert/assert.go renamed to vendor/gotest.tools/assert/assert.go

Lines changed: 91 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ comparison fails. The one difference is that Assert() will end the test executio
88
immediately (using t.FailNow()) whereas Check() will fail the test (using t.Fail()),
99
return the value of the comparison, then proceed with the rest of the test case.
1010
11-
Example Usage
11+
Example usage
1212
1313
The example below shows assert used with some common types.
1414
1515
1616
import (
1717
"testing"
1818
19-
"github.com/gotestyourself/gotestyourself/assert"
20-
is "github.com/gotestyourself/gotestyourself/assert/cmp"
19+
"gotest.tools/assert"
20+
is "gotest.tools/assert/cmp"
2121
)
2222
2323
func TestEverything(t *testing.T) {
@@ -32,15 +32,15 @@ The example below shows assert used with some common types.
3232
3333
// errors
3434
assert.NilError(t, closer.Close())
35-
assert.Assert(t, is.Error(err, "the exact error message"))
36-
assert.Assert(t, is.ErrorContains(err, "includes this"))
37-
assert.Assert(t, os.IsNotExist(err), "got %+v", err)
35+
assert.Error(t, err, "the exact error message")
36+
assert.ErrorContains(t, err, "includes this")
37+
assert.ErrorType(t, err, os.IsNotExist)
3838
3939
// complex types
40+
assert.DeepEqual(t, result, myStruct{Name: "title"})
4041
assert.Assert(t, is.Len(items, 3))
4142
assert.Assert(t, len(sequence) != 0) // NotEmpty
4243
assert.Assert(t, is.Contains(mapping, "key"))
43-
assert.Assert(t, is.DeepEqual(result, myStruct{Name: "title"}))
4444
4545
// pointers and interface
4646
assert.Assert(t, is.Nil(ref))
@@ -49,31 +49,30 @@ The example below shows assert used with some common types.
4949
5050
Comparisons
5151
52-
https://godoc.org/github.com/gotestyourself/gotestyourself/assert/cmp provides
52+
Package https://godoc.org/gotest.tools/assert/cmp provides
5353
many common comparisons. Additional comparisons can be written to compare
54-
values in other ways.
54+
values in other ways. See the example Assert (CustomComparison).
5555
56-
Below is an example of a custom comparison using a regex pattern:
56+
Automated migration from testify
57+
58+
gty-migrate-from-testify is a binary which can update source code which uses
59+
testify assertions to use the assertions provided by this package.
60+
61+
See http://bit.do/cmd-gty-migrate-from-testify.
5762
58-
func RegexP(value string, pattern string) func() (bool, string) {
59-
return func() (bool, string) {
60-
re := regexp.MustCompile(pattern)
61-
msg := fmt.Sprintf("%q did not match pattern %q", value, pattern)
62-
return re.MatchString(value), msg
63-
}
64-
}
6563
6664
*/
67-
package assert
65+
package assert // import "gotest.tools/assert"
6866

6967
import (
7068
"fmt"
7169
"go/ast"
7270
"go/token"
7371

74-
"github.com/gotestyourself/gotestyourself/assert/cmp"
75-
"github.com/gotestyourself/gotestyourself/internal/format"
76-
"github.com/gotestyourself/gotestyourself/internal/source"
72+
gocmp "github.com/google/go-cmp/cmp"
73+
"gotest.tools/assert/cmp"
74+
"gotest.tools/internal/format"
75+
"gotest.tools/internal/source"
7776
)
7877

7978
// BoolOrComparison can be a bool, or cmp.Comparison. See Assert() for usage.
@@ -96,7 +95,7 @@ const failureMessage = "assertion failed: "
9695
func assert(
9796
t TestingT,
9897
failer func(),
99-
argsFilter astExprListFilter,
98+
argSelector argSelector,
10099
comparison BoolOrComparison,
101100
msgAndArgs ...interface{},
102101
) bool {
@@ -123,10 +122,10 @@ func assert(
123122
t.Log(format.WithCustomMessage(failureMessage+msg+check.Error(), msgAndArgs...))
124123

125124
case cmp.Comparison:
126-
success = runComparison(t, argsFilter, check, msgAndArgs...)
125+
success = runComparison(t, argSelector, check, msgAndArgs...)
127126

128127
case func() cmp.Result:
129-
success = runComparison(t, argsFilter, check, msgAndArgs...)
128+
success = runComparison(t, argSelector, check, msgAndArgs...)
130129

131130
default:
132131
t.Log(fmt.Sprintf("invalid Comparison: %v (%T)", check, check))
@@ -155,6 +154,9 @@ func runCompareFunc(
155154
}
156155

157156
func logFailureFromBool(t TestingT, msgAndArgs ...interface{}) {
157+
if ht, ok := t.(helperT); ok {
158+
ht.Helper()
159+
}
158160
const stackIndex = 3 // Assert()/Check(), assert(), formatFailureFromBool()
159161
const comparisonArgPos = 1
160162
args, err := source.CallExprArgs(stackIndex)
@@ -215,7 +217,7 @@ func Assert(t TestingT, comparison BoolOrComparison, msgAndArgs ...interface{})
215217
if ht, ok := t.(helperT); ok {
216218
ht.Helper()
217219
}
218-
assert(t, t.FailNow, filterExprArgsFromComparison, comparison, msgAndArgs...)
220+
assert(t, t.FailNow, argsFromComparisonCall, comparison, msgAndArgs...)
219221
}
220222

221223
// Check performs a comparison. If the comparison fails the test is marked as
@@ -227,7 +229,7 @@ func Check(t TestingT, comparison BoolOrComparison, msgAndArgs ...interface{}) b
227229
if ht, ok := t.(helperT); ok {
228230
ht.Helper()
229231
}
230-
return assert(t, t.Fail, filterExprArgsFromComparison, comparison, msgAndArgs...)
232+
return assert(t, t.Fail, argsFromComparisonCall, comparison, msgAndArgs...)
231233
}
232234

233235
// NilError fails the test immediately if err is not nil.
@@ -236,14 +238,74 @@ func NilError(t TestingT, err error, msgAndArgs ...interface{}) {
236238
if ht, ok := t.(helperT); ok {
237239
ht.Helper()
238240
}
239-
assert(t, t.FailNow, filterExprExcludeFirst, err, msgAndArgs...)
241+
assert(t, t.FailNow, argsAfterT, err, msgAndArgs...)
240242
}
241243

242244
// Equal uses the == operator to assert two values are equal and fails the test
243-
// if they are not equal. This is equivalent to Assert(t, cmp.Equal(x, y)).
245+
// if they are not equal.
246+
//
247+
// If the comparison fails Equal will use the variable names for x and y as part
248+
// of the failure message to identify the actual and expected values.
249+
//
250+
// If either x or y are a multi-line string the failure message will include a
251+
// unified diff of the two values. If the values only differ by whitespace
252+
// the unified diff will be augmented by replacing whitespace characters with
253+
// visible characters to identify the whitespace difference.
254+
//
255+
// This is equivalent to Assert(t, cmp.Equal(x, y)).
244256
func Equal(t TestingT, x, y interface{}, msgAndArgs ...interface{}) {
245257
if ht, ok := t.(helperT); ok {
246258
ht.Helper()
247259
}
248-
assert(t, t.FailNow, filterExprExcludeFirst, cmp.Equal(x, y), msgAndArgs...)
260+
assert(t, t.FailNow, argsAfterT, cmp.Equal(x, y), msgAndArgs...)
261+
}
262+
263+
// DeepEqual uses google/go-cmp (http://bit.do/go-cmp) to assert two values are
264+
// equal and fails the test if they are not equal.
265+
//
266+
// Package https://godoc.org/gotest.tools/assert/opt provides some additional
267+
// commonly used Options.
268+
//
269+
// This is equivalent to Assert(t, cmp.DeepEqual(x, y)).
270+
func DeepEqual(t TestingT, x, y interface{}, opts ...gocmp.Option) {
271+
if ht, ok := t.(helperT); ok {
272+
ht.Helper()
273+
}
274+
assert(t, t.FailNow, argsAfterT, cmp.DeepEqual(x, y, opts...))
275+
}
276+
277+
// Error fails the test if err is nil, or the error message is not the expected
278+
// message.
279+
// Equivalent to Assert(t, cmp.Error(err, message)).
280+
func Error(t TestingT, err error, message string, msgAndArgs ...interface{}) {
281+
if ht, ok := t.(helperT); ok {
282+
ht.Helper()
283+
}
284+
assert(t, t.FailNow, argsAfterT, cmp.Error(err, message), msgAndArgs...)
285+
}
286+
287+
// ErrorContains fails the test if err is nil, or the error message does not
288+
// contain the expected substring.
289+
// Equivalent to Assert(t, cmp.ErrorContains(err, substring)).
290+
func ErrorContains(t TestingT, err error, substring string, msgAndArgs ...interface{}) {
291+
if ht, ok := t.(helperT); ok {
292+
ht.Helper()
293+
}
294+
assert(t, t.FailNow, argsAfterT, cmp.ErrorContains(err, substring), msgAndArgs...)
295+
}
296+
297+
// ErrorType fails the test if err is nil, or err is not the expected type.
298+
//
299+
// Expected can be one of:
300+
// a func(error) bool which returns true if the error is the expected type,
301+
// an instance of (or a pointer to) a struct of the expected type,
302+
// a pointer to an interface the error is expected to implement,
303+
// a reflect.Type of the expected struct or interface.
304+
//
305+
// Equivalent to Assert(t, cmp.ErrorType(err, expected)).
306+
func ErrorType(t TestingT, err error, expected interface{}, msgAndArgs ...interface{}) {
307+
if ht, ok := t.(helperT); ok {
308+
ht.Helper()
309+
}
310+
assert(t, t.FailNow, argsAfterT, cmp.ErrorType(err, expected), msgAndArgs...)
249311
}

0 commit comments

Comments
 (0)