Merge pull request #126 from maxatome/tdhttp

feat(tdhttp): add With, T, Run, OrDumpResponse and AutoDumpResponse

Author: maxatome

helpers/tdhttp/http_test.go

@@ -119,7 +119,12 @@ func TestCmpResponse(tt *testing.T) {
 \s+Response.Status: values differ
 \s+got: 242
 \s+expected: 243`,
-				" Raw received body: `text response\n", // check the complete body is shown
+				`~ Received response:
+\s+\x60(?s:.+?)
+\s+
+\s+text response
+\s+\x60
+`, // check the complete body is shown
 			},
 		},
 		{
@@ -142,10 +147,15 @@ func TestCmpResponse(tt *testing.T) {
 			ExpectedResp: tdhttp.Response{},
 			ExpectedLogs: []string{
 				`~ Failed test 'body should be empty'
-\s+Response.Body: not empty
-\s+got: (?s:.*?)
+\s+Response.Body is not empty
+\s+got: not empty
 \s+expected: empty`,
-				"text response", // check the response is shown (in got:)
+				`~ Received response:
+\s+\x60(?s:.+?)
+\s+
+\s+text response
+\s+\x60
+`, // check the complete body is shown
 			},
 		},
 		{
@@ -173,7 +183,12 @@ func TestCmpResponse(tt *testing.T) {
 \s+unmarshal\(Response\.Body\): should NOT be an error
 \s+got: .*Cmp(Response|Body) only accepts expected(Resp\.)?Body be a \[\]byte, a string or a TestDeep operator allowing to match these types, but not type int.*
 \s+expected: nil`,
-				" Raw received body: `text response\n", // check the complete body is shown
+				`~ Received response:
+\s+\x60(?s:.+?)
+\s+
+\s+text response
+\s+\x60
+`, // check the complete body is shown
 			},
 		},
 		// Empty success
@@ -261,7 +276,12 @@ func TestCmpJSONResponse(tt *testing.T) {
 \s+unmarshal\(Response\.Body\): should NOT be an error
 \s+got: .*cannot unmarshal object into Go value of type int.*
 \s+expected: nil`,
-				`~ Raw received body: \x60\{"name":"Bob"\}\n\s+\x60`, // check the complete body is shown
+				`~ Received response:
+\s+\x60(?s:.+?)
+\s+
+\s+\{"name":"Bob"\}
+\s+\x60
+`, // check the complete body is shown
 			},
 		},
 	} {
@@ -405,7 +425,12 @@ func TestCmpXMLResponse(tt *testing.T) {
 \s+unmarshal\(Response\.Body\): should NOT be an error
 \s+got: .*unknown type func\(\).*
 \s+expected: nil`,
-				`~ Raw received body: \x60<XResp><name>Bob</name></XResp>\n\s+\x60`, // check the complete body is shown
+				`~ Received response:
+\s+\x60(?s:.+?)
+\s+
+\s+<XResp><name>Bob</name></XResp>
+\s+\x60
+`, // check the complete body is shown
 			},
 		},
 	} {
@@ -421,6 +446,12 @@ func TestCmpXMLResponse(tt *testing.T) {
 	}
 }
 
+var logsViz = strings.NewReplacer(
+	" ", "·",
+	"\t", "→",
+	"\r", "<cr>",
+)
+
 func testLogs(t *td.T, mockT *tdutil.T, curTest CmpResponseTest) {
 	t.Helper()
 
@@ -440,7 +471,7 @@ func testLogs(t *td.T, mockT *tdutil.T, curTest CmpResponseTest) {
 	}
 
 	if dumpLogs {
-		t.Errorf(`Test logs: "%s"`, mockT.LogBuf())
+		t.Errorf(`Test logs: "%s"`, logsViz.Replace(mockT.LogBuf()))
 	}
 }
 
@@ -637,7 +668,7 @@ func TestMux(t *testing.T) {
 			t.False(ok)
 			t.True(mockT.Failed())
 			t.Contains(mockT.LogBuf(), "nothing has been set during unmarshaling")
-			t.Contains(mockT.LogBuf(), "Raw received body:")
+			t.Contains(mockT.LogBuf(), "Received response:")
 		})
 	})
 
@@ -713,7 +744,7 @@ func TestMux(t *testing.T) {
 				"Cannot guess the body expected type as Any TestDeep")
 			t.Contains(mockT.LogBuf(),
 				"You can try All(Isa(EXPECTED_TYPE), Any(…)) to disambiguate…")
-			t.Contains(mockT.LogBuf(), "Raw received body:")
+			t.Contains(mockT.LogBuf(), "Received response:")
 		})
 	})
 }

helpers/tdhttp/internal/response.go

@@ -0,0 +1,79 @@
+// Copyright (c) 2021, Maxime Soulé
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree.
+
+package internal
+
+import (
+	"bytes"
+	"net/http"
+	"net/http/httputil"
+	"testing"
+	"unicode/utf8"
+)
+
+// canBackquote is the same as strconv.CanBackquote but works on
+// []byte and accepts '\n' and '\r'.
+func canBackquote(b []byte) bool {
+	for len(b) > 0 {
+		r, wid := utf8.DecodeRune(b)
+		b = b[wid:]
+		if wid > 1 {
+			if r == '\ufeff' {
+				return false // BOMs are invisible and should not be quoted.
+			}
+			continue // All other multibyte runes are correctly encoded and assumed printable.
+		}
+		if r == utf8.RuneError {
+			return false
+		}
+		if (r < ' ' && r != '\t' && r != '\n' && r != '\r') || r == '`' || r == '\u007F' {
+			return false
+		}
+	}
+	return true
+}
+
+func replaceCrLf(b []byte) []byte {
+	return bytes.Replace(b, []byte("\r\n"), []byte("\n"), -1) //nolint: gocritic
+}
+
+func backquote(b []byte) ([]byte, bool) {
+	// if there is as many \r\n as \n, replace all occurrences by \n
+	// so we can conveniently print the buffer inside `…`.
+	crnl := bytes.Count(b, []byte("\r\n"))
+	cr := bytes.Count(b, []byte("\r"))
+	if crnl != 0 {
+		nl := bytes.Count(b, []byte("\n"))
+		if crnl != nl || crnl != cr {
+			return nil, false
+		}
+		return replaceCrLf(b), true
+	}
+
+	return b, cr == 0
+}
+
+// DumpResponse logs "resp" using Logf method of "t".
+//
+// It tries to produce a result as readable as possible first using
+// backquotes then falling back to double-quotes.
+func DumpResponse(t testing.TB, resp *http.Response) {
+	t.Helper()
+
+	const label = "Received response:\n"
+	b, _ := httputil.DumpResponse(resp, true)
+	if canBackquote(b) {
+		bodyPos := bytes.Index(b, []byte("\r\n\r\n"))
+
+		if body, ok := backquote(b[bodyPos+4:]); ok {
+			headers := replaceCrLf(b[:bodyPos])
+			t.Logf(label+"`%s\n\n%s`", headers, body)
+			return
+		}
+	}
+
+	t.Logf(label+"%q", b)
+}

helpers/tdhttp/internal/response_test.go

@@ -0,0 +1,108 @@
+// Copyright (c) 2021, Maxime Soulé
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree.
+
+package internal_test
+
+import (
+	"bytes"
+	"io/ioutil"
+	"net/http"
+	"testing"
+
+	"github.com/maxatome/go-testdeep/helpers/tdhttp/internal"
+	"github.com/maxatome/go-testdeep/internal/test"
+	"github.com/maxatome/go-testdeep/td"
+)
+
+func newResponse(body string) *http.Response {
+	return &http.Response{
+		Status:     "200 OK",
+		StatusCode: 200,
+		Proto:      "HTTP/1.0",
+		ProtoMajor: 1,
+		ProtoMinor: 0,
+		Header: http.Header{
+			"A": []string{"foo"},
+			"B": []string{"bar"},
+		},
+		Body: ioutil.NopCloser(bytes.NewBufferString(body)),
+	}
+}
+
+func inBQ(s string) string {
+	return "`" + s + "`"
+}
+
+func TestDumpResponse(t *testing.T) {
+	tb := test.NewTestingTB("TestDumpResponse")
+	internal.DumpResponse(tb, newResponse("one-line"))
+	td.Cmp(t, tb.LastMessage(),
+		`Received response:
+`+inBQ(`HTTP/1.0 200 OK
+A: foo
+B: bar
+
+one-line`))
+
+	tb.ResetMessages()
+	internal.DumpResponse(tb, newResponse("multi\r\nlines\r\nand\ttabs héhé"))
+	td.Cmp(t, tb.LastMessage(),
+		`Received response:
+`+inBQ(`HTTP/1.0 200 OK
+A: foo
+B: bar
+
+multi
+lines
+`+"and\ttabs héhé"))
+
+	tb.ResetMessages()
+	internal.DumpResponse(tb, newResponse("multi\nlines\nand\ttabs héhé"))
+	td.Cmp(t, tb.LastMessage(),
+		`Received response:
+`+inBQ(`HTTP/1.0 200 OK
+A: foo
+B: bar
+
+multi
+lines
+`+"and\ttabs héhé"))
+
+	// one \r more in body
+	tb.ResetMessages()
+	internal.DumpResponse(tb, newResponse("multi\r\nline\r"))
+	td.Cmp(t, tb.LastMessage(),
+		`Received response:
+"HTTP/1.0 200 OK\r\nA: foo\r\nB: bar\r\n\r\nmulti\r\nline\r"`)
+
+	// BOM
+	tb.ResetMessages()
+	internal.DumpResponse(tb, newResponse("\ufeff"))
+	td.Cmp(t, tb.LastMessage(),
+		`Received response:
+"HTTP/1.0 200 OK\r\nA: foo\r\nB: bar\r\n\r\n\ufeff"`)
+
+	// Rune error
+	tb.ResetMessages()
+	internal.DumpResponse(tb, newResponse("\xf4\x9f\xbf\xbf"))
+	td.Cmp(t, tb.LastMessage(),
+		`Received response:
+"HTTP/1.0 200 OK\r\nA: foo\r\nB: bar\r\n\r\n\xf4\x9f\xbf\xbf"`)
+
+	// `
+	tb.ResetMessages()
+	internal.DumpResponse(tb, newResponse("he`o"))
+	td.Cmp(t, tb.LastMessage(),
+		`Received response:
+"HTTP/1.0 200 OK\r\nA: foo\r\nB: bar\r\n\r\nhe`+"`"+`o"`)
+
+	// 0x7f
+	tb.ResetMessages()
+	internal.DumpResponse(tb, newResponse("\x7f"))
+	td.Cmp(t, tb.LastMessage(),
+		`Received response:
+"HTTP/1.0 200 OK\r\nA: foo\r\nB: bar\r\n\r\n\u007f"`)
+}