fix test assertion matching on ErrDefault401 error format

majewsky · majewsky · commit c4d6bce64f56 · 2024-04-16T18:10:06.000+02:00
This includes a backwards-incompatible change to the error message
returned by ErrUnexpectedResponseCode. Error messages are not supposed
to contain line breaks because several logging systems do not handle
them well (e.g. syslog and fluentd), so we try at least a little bit to
get rid of them.
diff --git a/errors.go b/errors.go
@@ -1,6 +1,7 @@
 package gophercloud
 
 import (
+	"bytes"
 	"errors"
 	"fmt"
 	"net/http"
@@ -89,8 +90,8 @@ type ErrUnexpectedResponseCode struct {
 
 func (e ErrUnexpectedResponseCode) Error() string {
 	e.DefaultErrString = fmt.Sprintf(
-		"Expected HTTP response code %v when accessing [%s %s], but got %d instead\n%s",
-		e.Expected, e.Method, e.URL, e.Actual, e.Body,
+		"Expected HTTP response code %v when accessing [%s %s], but got %d instead: %s",
+		e.Expected, e.Method, e.URL, e.Actual, bytes.TrimSpace(e.Body),
 	)
 	return e.choseErrString()
 }
diff --git a/testing/provider_client_test.go b/testing/provider_client_test.go
@@ -7,6 +7,7 @@ import (
 	"net"
 	"net/http"
 	"net/http/httptest"
+	"regexp"
 	"strconv"
 	"strings"
 	"sync"
@@ -364,8 +365,10 @@ func TestRequestReauthsAtMostOnce(t *testing.T) {
 	// did not attempt reauthentication again and just passed that 401 response to
 	// the caller as ErrDefault401.
 	_, err := p.Request(context.TODO(), "GET", th.Endpoint()+"/route", &gophercloud.RequestOpts{})
-	expectedErrorMessage := "Successfully re-authenticated, but got error executing request: Authentication failed"
-	th.AssertEquals(t, expectedErrorMessage, err.Error())
+	expectedErrorRx := regexp.MustCompile(`^Successfully re-authenticated, but got error executing request: Expected HTTP response code \[200\] when accessing \[GET http://[^/]*//route\], but got 401 instead: unauthorized$`)
+	if !expectedErrorRx.MatchString(err.Error()) {
+		t.Errorf("expected error that looks like %q, but got %q", expectedErrorRx.String(), err.Error())
+	}
 }
 
 func TestRequestWithContext(t *testing.T) {
