String
func String(expected string) TestDeep
String operator allows to compare a string (or convertible), []byte
(or convertible), error or fmt.Stringer interface (error interface
is tested before fmt.Stringer).
err := errors.New("error!")
td.Cmp(t, err, td.String("error!")) // succeeds
bstr := bytes.NewBufferString("fmt.Stringer!")
td.Cmp(t, bstr, td.String("fmt.Stringer!")) // succeeds
See also Contains, HasPrefix, HasSuffix, Re and ReAll.
See also String godoc.
Examples
Base example
t := &testing.T{}
got := "foobar"
ok := td.Cmp(t, got, td.String("foobar"), "checks %s", got)
fmt.Println("using string:", ok)
ok = td.Cmp(t, []byte(got), td.String("foobar"), "checks %s", got)
fmt.Println("using []byte:", ok)
// Output:
// using string: true
// using []byte: true
Stringer example
t := &testing.T{}
// bytes.Buffer implements fmt.Stringer
got := bytes.NewBufferString("foobar")
ok := td.Cmp(t, got, td.String("foobar"), "checks %s", got)
fmt.Println(ok)
// Output:
// true
Error example
t := &testing.T{}
got := errors.New("foobar")
ok := td.Cmp(t, got, td.String("foobar"), "checks %s", got)
fmt.Println(ok)
// Output:
// true
CmpString shortcut
func CmpString(t TestingT, got any, expected string, args ...any) bool
CmpString is a shortcut for:
td.Cmp(t, got, td.String(expected), args...)
See above for details.
Returns true if the test is OK, false if it fails.
If t is a *T then its Config field is inherited.
args… are optional and allow to name the test. This name is
used in case of failure to qualify the test. If len(args) > 1 and
the first item of args is a string and contains a ‘%’ rune then
fmt.Fprintf is used to compose the name, else args are passed to
fmt.Fprint. Do not forget it is the name of the test, not the
reason of a potential failure.
See also CmpString godoc.
Examples
Base example
t := &testing.T{}
got := "foobar"
ok := td.CmpString(t, got, "foobar", "checks %s", got)
fmt.Println("using string:", ok)
ok = td.Cmp(t, []byte(got), td.String("foobar"), "checks %s", got)
fmt.Println("using []byte:", ok)
// Output:
// using string: true
// using []byte: true
Stringer example
t := &testing.T{}
// bytes.Buffer implements fmt.Stringer
got := bytes.NewBufferString("foobar")
ok := td.CmpString(t, got, "foobar", "checks %s", got)
fmt.Println(ok)
// Output:
// true
Error example
t := &testing.T{}
got := errors.New("foobar")
ok := td.CmpString(t, got, "foobar", "checks %s", got)
fmt.Println(ok)
// Output:
// true
T.String shortcut
func (t *T) String(got any, expected string, args ...any) bool
String is a shortcut for:
t.Cmp(got, td.String(expected), args...)
See above for details.
Returns true if the test is OK, false if it fails.
args… are optional and allow to name the test. This name is
used in case of failure to qualify the test. If len(args) > 1 and
the first item of args is a string and contains a ‘%’ rune then
fmt.Fprintf is used to compose the name, else args are passed to
fmt.Fprint. Do not forget it is the name of the test, not the
reason of a potential failure.
See also T.String godoc.
Examples
Base example
t := td.NewT(&testing.T{})
got := "foobar"
ok := t.String(got, "foobar", "checks %s", got)
fmt.Println("using string:", ok)
ok = t.Cmp([]byte(got), td.String("foobar"), "checks %s", got)
fmt.Println("using []byte:", ok)
// Output:
// using string: true
// using []byte: true
Stringer example
t := td.NewT(&testing.T{})
// bytes.Buffer implements fmt.Stringer
got := bytes.NewBufferString("foobar")
ok := t.String(got, "foobar", "checks %s", got)
fmt.Println(ok)
// Output:
// true
Error example
t := td.NewT(&testing.T{})
got := errors.New("foobar")
ok := t.String(got, "foobar", "checks %s", got)
fmt.Println(ok)
// Output:
// true