Use go-cmp to show diff in tests

gbrlsnchs · gbrlsnchs · commit 4b5729d12b55 · 2019-09-14T20:16:53.000-03:00
diff --git a/audience_test.go b/audience_test.go
@@ -2,10 +2,10 @@ package jwt_test
 
 import (
 	"encoding/json"
-	"reflect"
 	"testing"
 
 	"github.com/gbrlsnchs/jwt/v3"
+	"github.com/google/go-cmp/cmp"
 )
 
 func TestAudienceMarshal(t *testing.T) {
@@ -20,7 +20,7 @@ func TestAudienceMarshal(t *testing.T) {
 		if b, err = json.Marshal(v); err != nil {
 			t.Fatal(err)
 		}
-		checkAudMarshal(t, "{}", b)
+		checkAudMarshal(t, b, "{}")
 
 	})
 
@@ -44,12 +44,12 @@ func TestAudienceMarshal(t *testing.T) {
 				if b, err = tc.aud.MarshalJSON(); err != nil {
 					t.Fatal(err)
 				}
-				checkAudMarshal(t, tc.expected, b)
+				checkAudMarshal(t, b, tc.expected)
 			}
 			if b, err = json.Marshal(tc.aud); err != nil {
 				t.Fatal(err)
 			}
-			checkAudMarshal(t, tc.expected, b)
+			checkAudMarshal(t, b, tc.expected)
 		})
 	}
 }
@@ -69,23 +69,23 @@ func TestAudienceUnmarshal(t *testing.T) {
 			if err := aud.UnmarshalJSON(tc.jstr); err != nil {
 				t.Fatal(err)
 			}
-			checkAudUnmarshal(t, tc.expected, aud)
+			checkAudUnmarshal(t, aud, tc.expected)
 			if err := json.Unmarshal(tc.jstr, &aud); err != nil {
 				t.Fatal(err)
 			}
-			checkAudUnmarshal(t, tc.expected, aud)
+			checkAudUnmarshal(t, aud, tc.expected)
 		})
 	}
 }
 
-func checkAudMarshal(t *testing.T, want string, got []byte) {
-	if want != string(got) {
-		t.Errorf("want %q, got %q", want, got)
+func checkAudMarshal(t *testing.T, got []byte, want string) {
+	if string(got) != want {
+		t.Errorf("jwt.Audience.Marshal mismatch (-want +got):\n%s", cmp.Diff(want, got))
 	}
 }
 
-func checkAudUnmarshal(t *testing.T, want, got jwt.Audience) {
-	if !reflect.DeepEqual(want, got) {
-		t.Errorf("want %v, got %v", want, got)
+func checkAudUnmarshal(t *testing.T, got, want jwt.Audience) {
+	if !cmp.Equal(got, want) {
+		t.Errorf("jwt.Audience.Unmarshal mismatch (-want +got):\n%s", cmp.Diff(want, got))
 	}
 }
diff --git a/internal/decode_test.go b/internal/decode_test.go
@@ -5,6 +5,7 @@ import (
 	"testing"
 
 	"github.com/gbrlsnchs/jwt/v3/internal"
+	"github.com/google/go-cmp/cmp"
 )
 
 var (
@@ -41,11 +42,11 @@ func TestDecode(t *testing.T) {
 				dt  decodeTest
 				err = internal.Decode([]byte(b64), &dt)
 			)
-			if want, got := tc.errors, err != nil; want != got {
+			if want, got := tc.errors, internal.ErrorAs(err, new(base64.CorruptInputError)); got != want {
 				t.Fatalf("want %t, got %t: %v", want, got, err)
 			}
-			if want, got := tc.expected, dt.X; want != got {
-				t.Errorf("want %q, got %q", want, got)
+			if want, got := tc.expected, dt.X; got != want {
+				t.Errorf("internal.Decode mismatch (-want +got):\n%s", cmp.Diff(want, got))
 			}
 		})
 	}
diff --git a/time_test.go b/time_test.go
@@ -7,6 +7,7 @@ import (
 
 	"github.com/gbrlsnchs/jwt/v3"
 	"github.com/gbrlsnchs/jwt/v3/internal"
+	"github.com/google/go-cmp/cmp"
 )
 
 func TestTimeMarshalJSON(t *testing.T) {
@@ -31,7 +32,7 @@ func TestTimeMarshalJSON(t *testing.T) {
 				t.Fatal(err)
 			}
 			if want, got := tc.want, n; got != want {
-				t.Errorf("want %d, got %d", want, got)
+				t.Errorf("jwt.Time.Marshal mismatch (-want +got):\n%s", cmp.Diff(want, got))
 			}
 		})
 	}
@@ -45,9 +46,9 @@ func TestTimeUnmarshalJSON(t *testing.T) {
 		isNil bool
 	}{
 		{now.Unix(), jwt.Time{now}, false},
-		{internal.Epoch.Unix() - 1337, jwt.Time{internal.Epoch}, false},
+		{internal.Epoch.Unix() - 0xDEAD, jwt.Time{internal.Epoch}, false},
 		{internal.Epoch.Unix(), jwt.Time{internal.Epoch}, false},
-		{internal.Epoch.Unix() + 1337, jwt.Time{internal.Epoch.Add(1337 * time.Second)}, false},
+		{internal.Epoch.Unix() + 0xDEAD, jwt.Time{internal.Epoch.Add(0xDEAD * time.Second)}, false},
 		{0, jwt.Time{}, true},
 	}
 	for _, tc := range testCases {
@@ -64,8 +65,8 @@ func TestTimeUnmarshalJSON(t *testing.T) {
 			if err = tt.UnmarshalJSON(b); err != nil {
 				t.Fatal(err)
 			}
-			if want, got := tc.want, tt; got.Unix() != want.Unix() {
-				t.Errorf("want %d, got %d", want.Unix(), got.Unix())
+			if want, got := tc.want.Unix(), tt.Unix(); got != want {
+				t.Errorf("jwt.Time.Unmarshal mismatch (-want +got):\n%s", cmp.Diff(want, got))
 			}
 		})
 	}
diff --git a/validators_test.go b/validators_test.go
@@ -5,6 +5,8 @@ import (
 	"time"
 
 	"github.com/gbrlsnchs/jwt/v3"
+	"github.com/gbrlsnchs/jwt/v3/internal"
+	"github.com/google/go-cmp/cmp"
 )
 
 func TestValidators(t *testing.T) {
@@ -49,8 +51,8 @@ func TestValidators(t *testing.T) {
 	}
 	for _, tc := range testCases {
 		t.Run(tc.claim, func(t *testing.T) {
-			if want, got := tc.err, tc.vl(tc.pl); want != got {
-				t.Errorf("want %v, got %v", want, got)
+			if want, got := tc.err, tc.vl(tc.pl); !internal.ErrorIs(got, want) {
+				t.Errorf(cmp.Diff(want, got))
 			}
 		})
 	}
diff --git a/verify_test.go b/verify_test.go
@@ -6,6 +6,7 @@ import (
 	"time"
 
 	"github.com/gbrlsnchs/jwt/v3"
+	"github.com/gbrlsnchs/jwt/v3/internal"
 	"github.com/google/go-cmp/cmp"
 )
 
@@ -85,8 +86,8 @@ func TestVerify(t *testing.T) {
 			v       interface{}
 		)
 		_, err := jwt.Verify([]byte(token), jwt.None(), &v)
-		if want, got := jwt.ErrNotJSONObject, err; got != want {
-			t.Errorf("want %v, got %v", want, got)
+		if want, got := jwt.ErrNotJSONObject, err; !internal.ErrorIs(got, want) {
+			t.Errorf("jwt.Verify JSON payload mismatch (-want +got):\n%s", cmp.Diff(want, got))
 		}
 	})
 }
@@ -154,8 +155,8 @@ func TestValidatePayload(t *testing.T) {
 				t.Fatal(err)
 			}
 			_, err = jwt.Verify(token, hs256, tc.pl, jwt.ValidatePayload(tc.pl, tc.vds...))
-			if want, got := tc.err, err; got != want {
-				t.Errorf("want %v, got %v", want, got)
+			if want, got := tc.err, err; !internal.ErrorIs(got, want) {
+				t.Errorf("jwt.Verify with validators mismatch (-want +got):\n%s", cmp.Diff(want, got))
 			}
 		})
 	}

Original file line number	Diff line number	Diff line change
`@@ -2,10 +2,10 @@ package jwt_test`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"encoding/json"`
`5`		`- "reflect"`
`6`	`5`	`"testing"`
`7`	`6`
`8`	`7`	`"github.com/gbrlsnchs/jwt/v3"`
	`8`	`+ "github.com/google/go-cmp/cmp"`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`func TestAudienceMarshal(t *testing.T) {`
`@@ -20,7 +20,7 @@ func TestAudienceMarshal(t *testing.T) {`
`20`	`20`	`if b, err = json.Marshal(v); err != nil {`
`21`	`21`	`t.Fatal(err)`
`22`	`22`	`}`
`23`		`- checkAudMarshal(t, "{}", b)`
	`23`	`+ checkAudMarshal(t, b, "{}")`
`24`	`24`
`25`	`25`	`})`
`26`	`26`
`@@ -44,12 +44,12 @@ func TestAudienceMarshal(t *testing.T) {`
`44`	`44`	`if b, err = tc.aud.MarshalJSON(); err != nil {`
`45`	`45`	`t.Fatal(err)`
`46`	`46`	`}`
`47`		`- checkAudMarshal(t, tc.expected, b)`
	`47`	`+ checkAudMarshal(t, b, tc.expected)`
`48`	`48`	`}`
`49`	`49`	`if b, err = json.Marshal(tc.aud); err != nil {`
`50`	`50`	`t.Fatal(err)`
`51`	`51`	`}`
`52`		`- checkAudMarshal(t, tc.expected, b)`
	`52`	`+ checkAudMarshal(t, b, tc.expected)`
`53`	`53`	`})`
`54`	`54`	`}`
`55`	`55`	`}`
`@@ -69,23 +69,23 @@ func TestAudienceUnmarshal(t *testing.T) {`
`69`	`69`	`if err := aud.UnmarshalJSON(tc.jstr); err != nil {`
`70`	`70`	`t.Fatal(err)`
`71`	`71`	`}`
`72`		`- checkAudUnmarshal(t, tc.expected, aud)`
	`72`	`+ checkAudUnmarshal(t, aud, tc.expected)`
`73`	`73`	`if err := json.Unmarshal(tc.jstr, &aud); err != nil {`
`74`	`74`	`t.Fatal(err)`
`75`	`75`	`}`
`76`		`- checkAudUnmarshal(t, tc.expected, aud)`
	`76`	`+ checkAudUnmarshal(t, aud, tc.expected)`
`77`	`77`	`})`
`78`	`78`	`}`
`79`	`79`	`}`
`80`	`80`
`81`		`-func checkAudMarshal(t *testing.T, want string, got []byte) {`
`82`		`- if want != string(got) {`
`83`		`- t.Errorf("want %q, got %q", want, got)`
	`81`	`+func checkAudMarshal(t *testing.T, got []byte, want string) {`
	`82`	`+ if string(got) != want {`
	`83`	`+ t.Errorf("jwt.Audience.Marshal mismatch (-want +got):\n%s", cmp.Diff(want, got))`
`84`	`84`	`}`
`85`	`85`	`}`
`86`	`86`
`87`		`-func checkAudUnmarshal(t *testing.T, want, got jwt.Audience) {`
`88`		`- if !reflect.DeepEqual(want, got) {`
`89`		`- t.Errorf("want %v, got %v", want, got)`
	`87`	`+func checkAudUnmarshal(t *testing.T, got, want jwt.Audience) {`
	`88`	`+ if !cmp.Equal(got, want) {`
	`89`	`+ t.Errorf("jwt.Audience.Unmarshal mismatch (-want +got):\n%s", cmp.Diff(want, got))`
`90`	`90`	`}`
`91`	`91`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ import (`
`5`	`5`	`"testing"`
`6`	`6`
`7`	`7`	`"github.com/gbrlsnchs/jwt/v3/internal"`
	`8`	`+ "github.com/google/go-cmp/cmp"`
`8`	`9`	`)`
`9`	`10`
`10`	`11`	`var (`
`@@ -41,11 +42,11 @@ func TestDecode(t *testing.T) {`
`41`	`42`	`dt decodeTest`
`42`	`43`	`err = internal.Decode([]byte(b64), &dt)`
`43`	`44`	`)`
`44`		`- if want, got := tc.errors, err != nil; want != got {`
	`45`	`+ if want, got := tc.errors, internal.ErrorAs(err, new(base64.CorruptInputError)); got != want {`
`45`	`46`	`t.Fatalf("want %t, got %t: %v", want, got, err)`
`46`	`47`	`}`
`47`		`- if want, got := tc.expected, dt.X; want != got {`
`48`		`- t.Errorf("want %q, got %q", want, got)`
	`48`	`+ if want, got := tc.expected, dt.X; got != want {`
	`49`	`+ t.Errorf("internal.Decode mismatch (-want +got):\n%s", cmp.Diff(want, got))`
`49`	`50`	`}`
`50`	`51`	`})`
`51`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@ import (`
`7`	`7`
`8`	`8`	`"github.com/gbrlsnchs/jwt/v3"`
`9`	`9`	`"github.com/gbrlsnchs/jwt/v3/internal"`
	`10`	`+ "github.com/google/go-cmp/cmp"`
`10`	`11`	`)`
`11`	`12`
`12`	`13`	`func TestTimeMarshalJSON(t *testing.T) {`
`@@ -31,7 +32,7 @@ func TestTimeMarshalJSON(t *testing.T) {`
`31`	`32`	`t.Fatal(err)`
`32`	`33`	`}`
`33`	`34`	`if want, got := tc.want, n; got != want {`
`34`		`- t.Errorf("want %d, got %d", want, got)`
	`35`	`+ t.Errorf("jwt.Time.Marshal mismatch (-want +got):\n%s", cmp.Diff(want, got))`
`35`	`36`	`}`
`36`	`37`	`})`
`37`	`38`	`}`
`@@ -45,9 +46,9 @@ func TestTimeUnmarshalJSON(t *testing.T) {`
`45`	`46`	`isNil bool`
`46`	`47`	`}{`
`47`	`48`	`{now.Unix(), jwt.Time{now}, false},`
`48`		`- {internal.Epoch.Unix() - 1337, jwt.Time{internal.Epoch}, false},`
	`49`	`+ {internal.Epoch.Unix() - 0xDEAD, jwt.Time{internal.Epoch}, false},`
`49`	`50`	`{internal.Epoch.Unix(), jwt.Time{internal.Epoch}, false},`
`50`		`- {internal.Epoch.Unix() + 1337, jwt.Time{internal.Epoch.Add(1337 * time.Second)}, false},`
	`51`	`+ {internal.Epoch.Unix() + 0xDEAD, jwt.Time{internal.Epoch.Add(0xDEAD * time.Second)}, false},`
`51`	`52`	`{0, jwt.Time{}, true},`
`52`	`53`	`}`
`53`	`54`	`for _, tc := range testCases {`
`@@ -64,8 +65,8 @@ func TestTimeUnmarshalJSON(t *testing.T) {`
`64`	`65`	`if err = tt.UnmarshalJSON(b); err != nil {`
`65`	`66`	`t.Fatal(err)`
`66`	`67`	`}`
`67`		`- if want, got := tc.want, tt; got.Unix() != want.Unix() {`
`68`		`- t.Errorf("want %d, got %d", want.Unix(), got.Unix())`
	`68`	`+ if want, got := tc.want.Unix(), tt.Unix(); got != want {`
	`69`	`+ t.Errorf("jwt.Time.Unmarshal mismatch (-want +got):\n%s", cmp.Diff(want, got))`
`69`	`70`	`}`
`70`	`71`	`})`
`71`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,8 @@ import (`
`5`	`5`	`"time"`
`6`	`6`
`7`	`7`	`"github.com/gbrlsnchs/jwt/v3"`
	`8`	`+ "github.com/gbrlsnchs/jwt/v3/internal"`
	`9`	`+ "github.com/google/go-cmp/cmp"`
`8`	`10`	`)`
`9`	`11`
`10`	`12`	`func TestValidators(t *testing.T) {`
`@@ -49,8 +51,8 @@ func TestValidators(t *testing.T) {`
`49`	`51`	`}`
`50`	`52`	`for _, tc := range testCases {`
`51`	`53`	`t.Run(tc.claim, func(t *testing.T) {`
`52`		`- if want, got := tc.err, tc.vl(tc.pl); want != got {`
`53`		`- t.Errorf("want %v, got %v", want, got)`
	`54`	`+ if want, got := tc.err, tc.vl(tc.pl); !internal.ErrorIs(got, want) {`
	`55`	`+ t.Errorf(cmp.Diff(want, got))`
`54`	`56`	`}`
`55`	`57`	`})`
`56`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ import (`
`6`	`6`	`"time"`
`7`	`7`
`8`	`8`	`"github.com/gbrlsnchs/jwt/v3"`
	`9`	`+ "github.com/gbrlsnchs/jwt/v3/internal"`
`9`	`10`	`"github.com/google/go-cmp/cmp"`
`10`	`11`	`)`
`11`	`12`
`@@ -85,8 +86,8 @@ func TestVerify(t *testing.T) {`
`85`	`86`	`v interface{}`
`86`	`87`	`)`
`87`	`88`	`_, err := jwt.Verify([]byte(token), jwt.None(), &v)`
`88`		`- if want, got := jwt.ErrNotJSONObject, err; got != want {`
`89`		`- t.Errorf("want %v, got %v", want, got)`
	`89`	`+ if want, got := jwt.ErrNotJSONObject, err; !internal.ErrorIs(got, want) {`
	`90`	`+ t.Errorf("jwt.Verify JSON payload mismatch (-want +got):\n%s", cmp.Diff(want, got))`
`90`	`91`	`}`
`91`	`92`	`})`
`92`	`93`	`}`
`@@ -154,8 +155,8 @@ func TestValidatePayload(t *testing.T) {`
`154`	`155`	`t.Fatal(err)`
`155`	`156`	`}`
`156`	`157`	`_, err = jwt.Verify(token, hs256, tc.pl, jwt.ValidatePayload(tc.pl, tc.vds...))`
`157`		`- if want, got := tc.err, err; got != want {`
`158`		`- t.Errorf("want %v, got %v", want, got)`
	`158`	`+ if want, got := tc.err, err; !internal.ErrorIs(got, want) {`
	`159`	`+ t.Errorf("jwt.Verify with validators mismatch (-want +got):\n%s", cmp.Diff(want, got))`
`159`	`160`	`}`
`160`	`161`	`})`
`161`	`162`	`}`