Add more pty diagnostics for terminal parsing

spikecurtis · spikecurtis · commit 2aaaec020bea · 2023-09-19T11:23:44.000+04:00
Signed-off-by: Spike Curtis &lt;spike@coder.com&gt;
diff --git a/testutil/pty.go b/testutil/pty.go
@@ -21,20 +21,20 @@ func ReadUntilString(ctx context.Context, t *testing.T, want string, r io.Reader
 // ReadUntil emulates a terminal and reads one byte at a time until the matcher
 // returns true or the context expires.  If the matcher is nil, read until EOF.
 // The PTY must be sized to 80x80 or there could be unexpected results.
-func ReadUntil(ctx context.Context, t *testing.T, r io.Reader, matcher func(line string) bool) error {
+func ReadUntil(ctx context.Context, t *testing.T, r io.Reader, matcher func(line string) bool) (retErr error) {
 	// output can contain virtual terminal sequences, so we need to parse these
 	// to correctly interpret getting what we want.
+	readBytes := make([]byte, 0)
 	term := vt10x.New(vt10x.WithSize(80, 80))
 	readErrs := make(chan error, 1)
 	defer func() {
 		// Dump the terminal contents since they can be helpful for debugging, but
-		// skip empty lines since much of the terminal will usually be blank.
+		// trim empty lines since much of the terminal will usually be blank.
 		got := term.String()
-		lines := strings.Split(got, "\n")
-		for _, line := range lines {
-			if strings.TrimSpace(line) != "" {
-				t.Logf("got: %v", line)
-			}
+		trimmed := strings.Trim(got, "\n")
+		t.Logf("Terminal contents:\n%s", trimmed)
+		if retErr != nil {
+			t.Logf("Bytes Read: %s", string(readBytes))
 		}
 	}()
 	for {
@@ -48,6 +48,7 @@ func ReadUntil(ctx context.Context, t *testing.T, r io.Reader, matcher func(line
 			if err != nil {
 				return err
 			}
+			readBytes = append(readBytes, b...)
 			_, err = term.Write(b)
 			if err != nil {
 				return err
