chore: Migrate tests to cmp package (#760)

Migrate the majority of diff tests from `reflect.DeepEqual()` to
`cmp.Diff()` to improve the test failure readability.
* Fixup Copyright lines

Signed-off-by: SuperQ <[email protected]>

Author: SuperQ

blockdevice/stats_test.go

@@ -16,8 +16,9 @@ package blockdevice
 import (
 	"errors"
 	"os"
-	"reflect"
 	"testing"
+
+	"github.com/google/go-cmp/cmp"
 )
 
 const (
@@ -150,8 +151,8 @@ func TestBlockDevice(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if !reflect.DeepEqual(blockQueueStat, blockQueueStatExpected) {
-		t.Errorf("Incorrect BlockQueueStat, expected: \n%+v, got: \n%+v", blockQueueStatExpected, blockQueueStat)
+	if diff := cmp.Diff(blockQueueStat, blockQueueStatExpected); diff != "" {
+		t.Fatalf("unexpected BlockQueueStat (-want +got):\n%s", diff)
 	}
 }
 
@@ -176,8 +177,8 @@ func TestBlockDmInfo(t *testing.T) {
 		UseBlkMQ:                  0,
 		UUID:                      "LVM-3zSHSR5Nbf4j7g6auAAefWY2CMaX01theZYEvQyecVsm2WtX3iY5q51qq5dWWOq7",
 	}
-	if !reflect.DeepEqual(dm0Info, dm0InfoExpected) {
-		t.Errorf("Incorrect BlockQueueStat, expected: \n%+v, got: \n%+v", dm0InfoExpected, dm0Info)
+	if diff := cmp.Diff(dm0Info, dm0InfoExpected); diff != "" {
+		t.Fatalf("unexpected BlockQueueStat (-want +got):\n%s", diff)
 	}
 
 	dm1Info, err := blockdevice.SysBlockDeviceMapperInfo(devices[1])
@@ -195,8 +196,8 @@ func TestBlockDmInfo(t *testing.T) {
 		t.Fatal("SysBlockDeviceMapperInfo on sda was supposed to fail.")
 	}
 	dm1InfoExpected := DeviceMapperInfo{}
-	if !reflect.DeepEqual(dm1Info, dm1InfoExpected) {
-		t.Errorf("Incorrect BlockQueueStat, expected: \n%+v, got: \n%+v", dm0InfoExpected, dm0Info)
+	if diff := cmp.Diff(dm1Info, dm1InfoExpected); diff != "" {
+		t.Fatalf("unexpected BlockQueueStat (-want +got):\n%s", diff)
 	}
 }
 
@@ -217,8 +218,8 @@ func TestSysBlockDeviceUnderlyingDevices(t *testing.T) {
 	underlying0Expected := UnderlyingDeviceInfo{
 		DeviceNames: []string{"sda"},
 	}
-	if !reflect.DeepEqual(underlying0, underlying0Expected) {
-		t.Errorf("Incorrect BlockQueueStat, expected: \n%+v, got: \n%+v", underlying0Expected, underlying0)
+	if diff := cmp.Diff(underlying0, underlying0Expected); diff != "" {
+		t.Fatalf("unexpected BlockQueueStat (-want +got):\n%s", diff)
 	}
 }
 

fscache_test.go

@@ -14,8 +14,9 @@
 package procfs
 
 import (
-	"reflect"
 	"testing"
+
+	"github.com/google/go-cmp/cmp"
 )
 
 func TestFscacheinfo(t *testing.T) {
@@ -128,9 +129,7 @@ func TestFscacheinfo(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	if !reflect.DeepEqual(have, expected) {
-		t.Logf("have: %+v", have)
-		t.Logf("expected: %+v", expected)
-		t.Errorf("structs are not equal")
+	if diff := cmp.Diff(have, expected); diff != "" {
+		t.Fatalf("unexpected diff (-want +got):\n%s", diff)
 	}
 }

iscsi/get_test.go

@@ -14,9 +14,10 @@
 package iscsi_test
 
 import (
-	"reflect"
 	"testing"
 
+	"github.com/google/go-cmp/cmp"
+
 	"github.com/prometheus/procfs/iscsi"
 )
 
@@ -140,8 +141,8 @@ func TestGetStats(t *testing.T) {
 
 	for i, stat := range sysfsStat {
 		want, have := tests[i].stat, stat
-		if !reflect.DeepEqual(want, have) {
-			t.Errorf("unexpected iSCSI stats:\nwant:\n%v\nhave:\n%v", want, have)
+		if diff := cmp.Diff(want, have); diff != "" {
+			t.Fatalf("unexpected iSCSI stats (-want +got):\n%s", diff)
 		} else {
 			readMB, writeMB, iops, err := iscsi.ReadWriteOPS(stat.RootPath+"/"+stat.Name,
 				stat.Tpgt[0].Name, stat.Tpgt[0].Luns[0].Name)
@@ -150,14 +151,14 @@ func TestGetStats(t *testing.T) {
 					stat.Name, stat.Tpgt[0].Name, stat.Tpgt[0].Luns[0].Name)
 				t.Errorf("%v", err)
 			}
-			if !reflect.DeepEqual(readTests[i].read, readMB) {
-				t.Errorf("unexpected iSCSI read data :\nwant:\n%v\nhave:\n%v", readTests[i].read, readMB)
+			if diff := cmp.Diff(readTests[i].read, readMB); diff != "" {
+				t.Fatalf("unexpected iSCSI read data (-want +got):\n%s", diff)
 			}
-			if !reflect.DeepEqual(readTests[i].write, writeMB) {
-				t.Errorf("unexpected iSCSI write data :\nwant:\n%v\nhave:\n%v", readTests[i].write, writeMB)
+			if diff := cmp.Diff(readTests[i].write, writeMB); diff != "" {
+				t.Fatalf("unexpected iSCSI write data (-want +got):\n%s", diff)
 			}
-			if !reflect.DeepEqual(readTests[i].iops, iops) {
-				t.Errorf("unexpected iSCSI iops data :\nwant:\n%v\nhave:\n%v", readTests[i].iops, iops)
+			if diff := cmp.Diff(readTests[i].iops, iops); diff != "" {
+				t.Fatalf("unexpected iSCSI iops data (-want +got):\n%s", diff)
 			}
 			switch stat.Tpgt[0].Luns[0].Backstore {
 			case "rd_mcp":
@@ -168,8 +169,8 @@ func TestGetStats(t *testing.T) {
 				// Name ObjectName
 				wantRdmcp := &iscsi.RDMCP{"rd_mcp_" + stat.Tpgt[0].Luns[0].TypeNumber, stat.Tpgt[0].Luns[0].ObjectName}
 
-				if !reflect.DeepEqual(wantRdmcp, haveRdmcp) {
-					t.Errorf("unexpected rdmcp data :\nwant:\n%v\nhave:\n%v", wantRdmcp, haveRdmcp)
+				if diff := cmp.Diff(wantRdmcp, haveRdmcp); diff != "" {
+					t.Fatalf("unexpected rdmcp data (-want +got):\n%s", diff)
 				}
 			case "iblock":
 				haveIblock, err := sysconfigfs.GetIblockUdev("0", "block_lio_rbd1")
@@ -178,8 +179,8 @@ func TestGetStats(t *testing.T) {
 				}
 				// Name Bnumber ObjectName Iblock
 				wantIblock := &iscsi.IBLOCK{"iblock_" + stat.Tpgt[0].Luns[0].TypeNumber, stat.Tpgt[0].Luns[0].TypeNumber, stat.Tpgt[0].Luns[0].ObjectName, "/dev/rbd1"}
-				if !reflect.DeepEqual(wantIblock, haveIblock) {
-					t.Errorf("unexpected iblock data :\nwant:\n%v\nhave:\n%v", wantIblock, haveIblock)
+				if diff := cmp.Diff(wantIblock, haveIblock); diff != "" {
+					t.Fatalf("unexpected iblock data (-want +got):\n%s", diff)
 				}
 			case "fileio":
 				haveFileIO, err := sysconfigfs.GetFileioUdev("1", "file_lio_1G")
@@ -188,8 +189,8 @@ func TestGetStats(t *testing.T) {
 				}
 				// Name, Fnumber, ObjectName, Filename
 				wantFileIO := &iscsi.FILEIO{"fileio_" + stat.Tpgt[0].Luns[0].TypeNumber, stat.Tpgt[0].Luns[0].TypeNumber, "file_lio_1G", "/home/iscsi/file_back_1G"}
-				if !reflect.DeepEqual(wantFileIO, haveFileIO) {
-					t.Errorf("unexpected fileio data :\nwant:\n%v\nhave:\n%v", wantFileIO, haveFileIO)
+				if diff := cmp.Diff(wantFileIO, haveFileIO); diff != "" {
+					t.Fatalf("unexpected fileio data (-want +got):\n%s", diff)
 				}
 			case "rbd":
 				haveRBD, err := sysconfigfs.GetRBDMatch("0", "iscsi-images-demo")
@@ -198,8 +199,8 @@ func TestGetStats(t *testing.T) {
 				}
 				// Name, Rnumber, Pool, Image
 				wantRBD := &iscsi.RBD{"rbd_" + stat.Tpgt[0].Luns[0].TypeNumber, stat.Tpgt[0].Luns[0].TypeNumber, "iscsi-images", "demo"}
-				if !reflect.DeepEqual(wantRBD, haveRBD) {
-					t.Errorf("unexpected fileio data :\nwant:\n%v\nhave:\n%v", wantRBD, haveRBD)
+				if diff := cmp.Diff(wantRBD, haveRBD); diff != "" {
+					t.Fatalf("unexpected fileio data (-want +got):\n%s", diff)
 				}
 			}
 		}

mountinfo_test.go

@@ -13,7 +13,6 @@
 package procfs
 
 import (
-	"reflect"
 	"testing"
 
 	"github.com/google/go-cmp/cmp"
@@ -179,8 +178,8 @@ func TestMountInfo(t *testing.T) {
 			t.Errorf("unexpected error: %v", err)
 		}
 
-		if want, have := test.mount, mount; !reflect.DeepEqual(want, have) {
-			t.Errorf("mounts:\nwant:\n%+v\nhave:\n%+v", want, have)
+		if diff := cmp.Diff(test.mount, mount); diff != "" {
+			t.Fatalf("unexpected diff (-want +got):\n%s", diff)
 		}
 	}
 }

mountstats_test.go

@@ -14,11 +14,11 @@
 package procfs
 
 import (
-	"fmt"
-	"reflect"
 	"strings"
 	"testing"
 	"time"
+
+	"github.com/google/go-cmp/cmp"
 )
 
 func TestMountStats(t *testing.T) {
@@ -503,40 +503,12 @@ func TestMountStats(t *testing.T) {
 			t.Errorf("unexpected error: %v", err)
 		}
 
-		if want, have := tt.mounts, mounts; !reflect.DeepEqual(want, have) {
-			t.Errorf("mounts:\nwant:\n%v\nhave:\n%v", mountsStr(want), mountsStr(have))
+		if diff := cmp.Diff(tt.mounts, mounts); diff != "" {
+			t.Fatalf("unexpected mounts (-want +got):\n%s", diff)
 		}
 	}
 }
 
-func mountsStr(mounts []*Mount) string {
-	var out string
-	for i, m := range mounts {
-		out += fmt.Sprintf("[%d] %q on %q (%q)", i, m.Device, m.Mount, m.Type)
-
-		stats, ok := m.Stats.(*MountStatsNFS)
-		if !ok {
-			out += "\n"
-			continue
-		}
-
-		out += fmt.Sprintf("\n\t- opts: %s", stats.Opts)
-		out += fmt.Sprintf("\n\t- v%s, age: %s", stats.StatVersion, stats.Age)
-		out += fmt.Sprintf("\n\t- bytes: %v", stats.Bytes)
-		out += fmt.Sprintf("\n\t- events: %v", stats.Events)
-		out += fmt.Sprintf("\n\t- transport: %v", stats.Transport)
-		out += "\n\t- per-operation stats:"
-
-		for _, o := range stats.Operations {
-			out += fmt.Sprintf("\n\t\t- %v", o)
-		}
-
-		out += "\n"
-	}
-
-	return out
-}
-
 func TestMountStatsExtendedOperationStats(t *testing.T) {
 	r := strings.NewReader(extendedOpsExampleMountstats)
 	_, err := parseMountStats(r)

net_conntrackstat_test.go

@@ -15,8 +15,9 @@ package procfs
 
 import (
 	"bytes"
-	"reflect"
 	"testing"
+
+	"github.com/google/go-cmp/cmp"
 )
 
 func TestParseConntrackStat(t *testing.T) {
@@ -79,8 +80,8 @@ func TestParseConntrackStat(t *testing.T) {
 			SearchRestart: 4,
 		},
 	}
-	if !reflect.DeepEqual(want, have) {
-		t.Errorf("want %v, have %v", want, have)
+	if diff := cmp.Diff(want, have); diff != "" {
+		t.Fatalf("unexpected diff (-want +got):\n%s", diff)
 	}
 }
 
@@ -112,7 +113,7 @@ func TestParseOldConntrackStat(t *testing.T) {
 			SearchRestart: 0,
 		},
 	}
-	if !reflect.DeepEqual(want, have) {
-		t.Errorf("want %v, have %v", want, have)
+	if diff := cmp.Diff(want, have); diff != "" {
+		t.Fatalf("unexpected diff (-want +got):\n%s", diff)
 	}
 }

net_ip_socket_test.go

@@ -15,8 +15,9 @@ package procfs
 
 import (
 	"net"
-	"reflect"
 	"testing"
+
+	"github.com/google/go-cmp/cmp"
 )
 
 func Test_parseNetIPSocketLine(t *testing.T) {
@@ -115,8 +116,8 @@ func Test_parseNetIPSocketLine(t *testing.T) {
 			if tt.want == nil && got != nil {
 				t.Errorf("parseNetIPSocketLine() = %v, want %v", got, tt.want)
 			}
-			if !reflect.DeepEqual(got, tt.want) {
-				t.Errorf("parseNetIPSocketLine() = %#v, want %#v", got, tt.want)
+			if diff := cmp.Diff(got, tt.want); diff != "" {
+				t.Fatalf("unexpected diff (-want +got):\n%s", diff)
 			}
 		})
 	}

net_route_test.go

@@ -15,8 +15,9 @@ package procfs
 
 import (
 	"bytes"
-	"reflect"
 	"testing"
+
+	"github.com/google/go-cmp/cmp"
 )
 
 func TestParseNetRoute(t *testing.T) {
@@ -54,7 +55,7 @@ eno16780032      0000A8C0     00000000  0001   0       0    100     0000FFFF  0
 			IRTT:        0,
 		},
 	}
-	if !reflect.DeepEqual(want, parsed) {
-		t.Errorf("want %v, parsed %v", want, parsed)
+	if diff := cmp.Diff(want, parsed); diff != "" {
+		t.Fatalf("unexpected diff (-want +got):\n%s", diff)
 	}
 }

net_tcp_test.go

@@ -15,8 +15,9 @@ package procfs
 
 import (
 	"net"
-	"reflect"
 	"testing"
+
+	"github.com/google/go-cmp/cmp"
 )
 
 func Test_newNetTCP(t *testing.T) {
@@ -120,8 +121,8 @@ func Test_newNetTCP(t *testing.T) {
 				t.Errorf("newNetTCP() error = %v, wantErr %v", err, tt.wantErr)
 				return
 			}
-			if !reflect.DeepEqual(got, tt.want) {
-				t.Errorf("newNetTCP() = %v, want %v", got, tt.want)
+			if diff := cmp.Diff(tt.want, got); diff != "" {
+				t.Fatalf("unexpected diff (-want +got):\n%s", diff)
 			}
 		})
 	}
@@ -166,8 +167,8 @@ func Test_newNetTCPSummary(t *testing.T) {
 				t.Errorf("newNetTCPSummary() error = %v, wantErr %v", err, tt.wantErr)
 				return
 			}
-			if !reflect.DeepEqual(got, tt.want) {
-				t.Errorf("newNetTCPSummary() = %v, want %v", got, tt.want)
+			if diff := cmp.Diff(tt.want, got); diff != "" {
+				t.Fatalf("unexpected diff (-want +got):\n%s", diff)
 			}
 		})
 	}

net_udp_test.go

@@ -15,8 +15,9 @@ package procfs
 
 import (
 	"net"
-	"reflect"
 	"testing"
+
+	"github.com/google/go-cmp/cmp"
 )
 
 func Test_newNetUDP(t *testing.T) {
@@ -125,8 +126,8 @@ func Test_newNetUDP(t *testing.T) {
 				t.Errorf("newNetUDP() error = %v, wantErr %v", err, tt.wantErr)
 				return
 			}
-			if !reflect.DeepEqual(got, tt.want) {
-				t.Errorf("newNetUDP() = %v, want %v", got, tt.want)
+			if diff := cmp.Diff(got, tt.want); diff != "" {
+				t.Fatalf("unexpected newNetUDP() (-want +got):\n%s", diff)
 			}
 		})
 	}
@@ -171,8 +172,8 @@ func Test_newNetUDPSummary(t *testing.T) {
 				t.Errorf("newNetUDPSummary() error = %v, wantErr %v", err, tt.wantErr)
 				return
 			}
-			if !reflect.DeepEqual(got, tt.want) {
-				t.Errorf("newNetUDPSummary() = %v, want %v", got, tt.want)
+			if diff := cmp.Diff(got, tt.want); diff != "" {
+				t.Fatalf("unexpected newNetUDPSummary() (-want +got):\n%s", diff)
 			}
 		})
 	}