Assert http requests (#42)

* add assert helpers for testing http requests

* add basic tests for AssertHTTPRequest and AssertHTTPRequestOut

* fix golint issues

Author: alexhornbake

assert.go

@@ -27,22 +27,48 @@ func Assert(t *testing.T, id string, a Assertable) {
 
 // AssertHTTPResponse asserts the value of an http.Response.
 func AssertHTTPResponse(t *testing.T, id string, w *http.Response) {
-	config, err := getConfig()
+	body, err := httputil.DumpResponse(w, true)
 	if err != nil {
 		t.Fatal(err)
 	}
 
-	body, err := httputil.DumpResponse(w, true)
+	assertHTTP(t, id, body, contentTypeIsJSON(w.Header.Get("Content-Type")))
+}
+
+// AssertHTTPRequestOut asserts the value of an http.Request.
+// Intended for use when testing outgoing client requests
+// See https://golang.org/pkg/net/http/httputil/#DumpRequestOut for more
+func AssertHTTPRequestOut(t *testing.T, id string, r *http.Request) {
+	body, err := httputil.DumpRequestOut(r, true)
 	if err != nil {
 		t.Fatal(err)
 	}
 
-	data := string(body)
+	assertHTTP(t, id, body, contentTypeIsJSON(r.Header.Get("Content-Type")))
+}
 
-	contentType := w.Header.Get("Content-Type")
+// AssertHTTPRequest asserts the value of an http.Request.
+// Intended for use when testing incoming client requests
+// See https://golang.org/pkg/net/http/httputil/#DumpRequest for more
+func AssertHTTPRequest(t *testing.T, id string, r *http.Request) {
+	body, err := httputil.DumpRequest(r, true)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	assertHTTP(t, id, body, contentTypeIsJSON(r.Header.Get("Content-Type")))
+}
+
+func assertHTTP(t *testing.T, id string, body []byte, isJSON bool) {
+	config, err := getConfig()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	data := string(body)
 
 	// If the response body is JSON, indent.
-	if contentTypeIsJSON(contentType) {
+	if isJSON {
 		lines := strings.Split(strings.TrimSpace(data), "\n")
 		jsonStr := lines[len(lines)-1]
 

example/__snapshots__/example.snapshot

@@ -7,6 +7,30 @@ Content-Type: application/json
   "foo": "foobar"
 }
 
+/* snapshot: http client request */
+GET / HTTP/1.1
+Host: example.com
+User-Agent: Go-http-client/1.1
+Content-Length: 31
+Content-Type: application/json
+X-Expected-Header: expected header value
+Accept-Encoding: gzip
+
+{
+  "message": "expected message"
+}
+
+/* snapshot: http server request */
+POST / HTTP/1.1
+Accept-Encoding: gzip
+Content-Length: 31
+Content-Type: application/json
+User-Agent: Go-http-client/1.1
+
+{
+  "message": "expected message"
+}
+
 /* snapshot: reader */
 Hello World.
 

example/main_test.go

@@ -1,8 +1,10 @@
 package main
 
 import (
+	"net/http"
 	"net/http/httptest"
 	"os"
+	"strings"
 	"testing"
 
 	"github.com/beme/abide"
@@ -41,3 +43,20 @@ func TestReader(t *testing.T) {
 	res := w.Result()
 	abide.AssertReader(t, "reader", res.Body)
 }
+
+func TestAssertHTTPRequestOut(t *testing.T) {
+	req := httptest.NewRequest(http.MethodGet, "http://example.com", strings.NewReader(`{"message": "expected message"}`))
+	req.Header.Set("Content-Type", "application/json")
+	req.Header.Set("X-Expected-Header", "expected header value")
+
+	abide.AssertHTTPRequestOut(t, "http client request", req)
+}
+
+func TestAssertHTTPRequest(t *testing.T) {
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		r.Host = "" // httptest servers are spawned on random ports, prevent that from being in the snapshot.
+		abide.AssertHTTPRequest(t, "http server request", r)
+	}))
+
+	http.Post(server.URL, "application/json", strings.NewReader(`{"message": "expected message"}`))
+}