feat(gock): add gock.Observe to support inspection of the outgoing intercepted HTTP traffic (#38)

Author: steinfletcher

.travis.yml

@@ -14,7 +14,7 @@ before_install:
   - go get -u gopkg.in/h2non/gentleman.v1
   - go get -u -v github.com/axw/gocov/gocov
   - go get -u -v github.com/mattn/goveralls
-  - go get -u -v github.com/golang/lint/golint
+  - go get -v -u golang.org/x/lint/golint
   - mkdir -p $GOPATH/src/gopkg.in/h2non/gock.v1
   - cp -r . $GOPATH/src/gopkg.in/h2non/gock.v1
 

README.md

@@ -303,6 +303,33 @@ func main() {
 }
 ```
 
+#### Debug intercepted http requests
+
+```go
+package main
+
+import (
+	"bytes"
+	"gopkg.in/h2non/gock.v1"
+	"net/http"
+)
+
+func main() {
+	defer gock.Off()
+	gock.Observe(gock.DumpRequest)
+
+	gock.New("http://foo.com").
+		Post("/bar").
+		MatchType("json").
+		JSON(map[string]string{"foo": "bar"}).
+		Reply(200)
+
+	body := bytes.NewBuffer([]byte(`{"foo":"bar"}`))
+	http.Post("http://foo.com/bar", "application/json", body)
+}
+
+```
+
 ## Hacking it!
 
 You can easily hack `gock` defining custom matcher functions with own matching rules.

_examples/observe/observe.go

@@ -0,0 +1,21 @@
+package main
+
+import (
+	"bytes"
+	"gopkg.in/h2non/gock.v1"
+	"net/http"
+)
+
+func main() {
+	defer gock.Off()
+	gock.Observe(gock.DumpRequest)
+
+	gock.New("http://foo.com").
+		Post("/bar").
+		MatchType("json").
+		JSON(map[string]string{"foo": "bar"}).
+		Reply(200)
+
+	body := bytes.NewBuffer([]byte(`{"foo":"bar"}`))
+	http.Post("http://foo.com/bar", "application/json", body)
+}

gock.go

@@ -1,7 +1,9 @@
 package gock
 
 import (
+	"fmt"
 	"net/http"
+	"net/http/httputil"
 	"net/url"
 	"regexp"
 	"sync"
@@ -14,8 +16,20 @@ var mutex = &sync.Mutex{}
 var config = struct {
 	Networking        bool
 	NetworkingFilters []FilterRequestFunc
+	Observer          ObserverFunc
 }{}
 
+// ObserverFunc is implemented by users to inspect the outgoing intercepted HTTP traffic
+type ObserverFunc func(*http.Request, Mock)
+
+// DumpRequest is a default implementation of ObserverFunc that dumps
+// the HTTP/1.x wire representation of the http request
+var DumpRequest ObserverFunc = func(request *http.Request, mock Mock) {
+	bytes, _ := httputil.DumpRequestOut(request, true)
+	fmt.Println(string(bytes))
+	fmt.Printf("\nMatches: %v\n---\n", mock != nil)
+}
+
 // track unmatched requests so they can be tested for
 var unmatchedRequests = []*http.Request{}
 
@@ -92,6 +106,13 @@ func OffAll() {
 	CleanUnmatchedRequest()
 }
 
+// Observe provides a hook to support inspection of the request and matched mock
+func Observe(fn ObserverFunc) {
+	mutex.Lock()
+	defer mutex.Unlock()
+	config.Observer = fn
+}
+
 // EnableNetworking enables real HTTP networking
 func EnableNetworking() {
 	mutex.Lock()

gock_test.go

@@ -412,6 +412,23 @@ func TestMockRegExpMatching(t *testing.T) {
 	st.Expect(t, string(body)[:13], `{"foo":"bar"}`)
 }
 
+func TestObserve(t *testing.T) {
+	defer after()
+	var observedRequest *http.Request
+	var observedMock Mock
+	Observe(func(request *http.Request, mock Mock) {
+		observedRequest = request
+		observedMock = mock
+	})
+	New("http://observe-foo.com").Reply(200)
+	req, _ := http.NewRequest("POST", "http://observe-foo.com", nil)
+
+	http.DefaultClient.Do(req)
+
+	st.Expect(t, observedRequest.Host, "observe-foo.com")
+	st.Expect(t, observedMock.Request().URLStruct.Host, "observe-foo.com")
+}
+
 func after() {
 	Flush()
 	Disable()

transport.go

@@ -62,6 +62,11 @@ func (m *Transport) RoundTrip(req *http.Request) (*http.Response, error) {
 		return nil, err
 	}
 
+	// Invoke the observer with the intercepted http.Request and matched mock
+	if config.Observer != nil {
+		config.Observer(req, mock)
+	}
+
 	// Verify if should use real networking
 	networking := shouldUseNetwork(req, mock)
 	if !networking && mock == nil {