assert: handle TokenTooLong error scenario

assert/assertions.go

@@ -301,13 +301,24 @@ func messageFromMsgAndArgs(msgAndArgs ...interface{}) string {
 func indentMessageLines(message string, longestLabelLen int) string {
 	outBuf := new(bytes.Buffer)
 
-	for i, scanner := 0, bufio.NewScanner(strings.NewReader(message)); scanner.Scan(); i++ {
-		// no need to align first line because it starts at the correct location (after the label)
-		if i != 0 {
-			// append alignLen+1 spaces to align with "{{longestLabel}}:" before adding tab
+	msgScanner := bufio.NewScanner(strings.NewReader(message))
+
+	// a buffer is set manually to store the tokenization of the message string
+	// so that we can re-use the same buffer for each line of the message without
+	// any additional allocations. We set the maximum buffer length to 1 more
+	// than the length of the message to avoid exceeding the default
+	// MaxScanTokenSize while scanning lines. This can happen when there is a
+	// single very long line. Refer to issue #1525
+	msgScanner.Buffer(nil, len(message)+1)
+
+	first := true
+	for msgScanner.Scan() {
+		if !first {
 			outBuf.WriteString("\n\t" + strings.Repeat(" ", longestLabelLen+1) + "\t")
 		}
-		outBuf.WriteString(scanner.Text())
+
+		outBuf.Write(msgScanner.Bytes())
+		first = false
 	}
 
 	return outBuf.String()

assert/assertions_priv_test.go

@@ -0,0 +1,77 @@
+package assert
+
+import (
+	"bufio"
+	"strings"
+	"testing"
+)
+
+func Test_indentMessageLines(t *testing.T) {
+	tt := []struct {
+		name            string
+		msg             string
+		longestLabelLen int
+		expected        string
+	}{
+		{
+			name:            "single line",
+			msg:             "Hello World\n",
+			longestLabelLen: 11,
+			expected:        "Hello World",
+		},
+		{
+			name:            "multi line",
+			msg:             "Hello\nWorld\n",
+			longestLabelLen: 11,
+			expected:        "Hello\n\t            \tWorld",
+		},
+		{
+			name:            "single line - over the bufio default limit",
+			msg:             strings.Repeat("hello ", bufio.MaxScanTokenSize+10),
+			longestLabelLen: 11,
+			expected:        strings.Repeat("hello ", bufio.MaxScanTokenSize+10),
+		},
+		{
+			name:            "multi line - over the bufio default limit",
+			msg:             strings.Repeat("hello\n", bufio.MaxScanTokenSize+10),
+			longestLabelLen: 3,
+			expected: strings.TrimSpace(
+				strings.TrimPrefix(strings.Repeat("\thello\n\t    ", bufio.MaxScanTokenSize+10), "\t"),
+			),
+		},
+		{
+			name:            "single line - just under the bufio default limit",
+			msg:             strings.Repeat("hello ", bufio.MaxScanTokenSize-10),
+			longestLabelLen: 11,
+			expected:        strings.Repeat("hello ", bufio.MaxScanTokenSize-10),
+		},
+		{
+			name:            "multi line - just under the bufio default limit",
+			msg:             strings.Repeat("hello\n", bufio.MaxScanTokenSize-10),
+			longestLabelLen: 3,
+			expected: strings.TrimSpace(
+				strings.TrimPrefix(strings.Repeat("\thello\n\t    ", bufio.MaxScanTokenSize-10), "\t"),
+			),
+		},
+		{
+			name:            "single line - equal to the bufio default limit",
+			msg:             strings.Repeat("hello ", bufio.MaxScanTokenSize),
+			longestLabelLen: 11,
+			expected:        strings.Repeat("hello ", bufio.MaxScanTokenSize),
+		},
+		{
+			name:            "multi line - equal to the bufio default limit",
+			msg:             strings.Repeat("hello\n", bufio.MaxScanTokenSize),
+			longestLabelLen: 3,
+			expected: strings.TrimSpace(
+				strings.TrimPrefix(strings.Repeat("\thello\n\t    ", bufio.MaxScanTokenSize), "\t"),
+			),
+		},
+	}
+
+	for _, tc := range tt {
+		t.Run(tc.name, func(t *testing.T) {
+			Equal(t, tc.expected, indentMessageLines(tc.msg, tc.longestLabelLen))
+		})
+	}
+}