From 62a8a599f1f4f36c55e17106a8e40bd956430058 Mon Sep 17 00:00:00 2001
From: Aneesh Nireshwalia <99904+aneesh-n@users.noreply.github.com>
Date: Thu, 22 Feb 2024 16:58:12 -0700
Subject: [PATCH] Add optional messages for Equals helper

---
 internal/test/helpers.go | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

diff --git a/internal/test/helpers.go b/internal/test/helpers.go
index 65e3e36ec..242da6079 100644
--- a/internal/test/helpers.go
+++ b/internal/test/helpers.go
@@ -3,6 +3,7 @@ package test
 import (
 	"compress/bzip2"
 	"compress/gzip"
+	"fmt"
 	"io"
 	"os"
 	"os/exec"
@@ -47,10 +48,22 @@ func OKs(tb testing.TB, errs []error) {
 }
 
 // Equals fails the test if exp is not equal to act.
-func Equals(tb testing.TB, exp, act interface{}) {
+// msg is optional message to be printed, first param being format string and rest being arguments.
+func Equals(tb testing.TB, exp, act interface{}, msgs ...string) {
 	tb.Helper()
 	if !reflect.DeepEqual(exp, act) {
-		tb.Fatalf("\033[31m\n\n\texp: %#v\n\n\tgot: %#v\033[39m\n\n", exp, act)
+		var msgString string
+		length := len(msgs)
+		if length == 1 {
+			msgString = msgs[0]
+		} else if length > 1 {
+			args := make([]interface{}, length-1)
+			for i, msg := range msgs[1:] {
+				args[i] = msg
+			}
+			msgString = fmt.Sprintf(msgs[0], args...)
+		}
+		tb.Fatalf("\033[31m\n\n\t"+msgString+"\n\n\texp: %#v\n\n\tgot: %#v\033[39m\n\n", exp, act)
 	}
 }