113 lines
2.6 KiB
Go
113 lines
2.6 KiB
Go
package httpmock
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"runtime/debug"
|
|
"strings"
|
|
"sync"
|
|
"testing"
|
|
)
|
|
|
|
// Replace http.Client transport layer with registry so all requests get
|
|
// recorded.
|
|
func ReplaceTripper(client *http.Client, reg *Registry) {
|
|
client.Transport = reg
|
|
}
|
|
|
|
type Registry struct {
|
|
mu sync.Mutex
|
|
stubs []*Stub
|
|
Requests []*http.Request
|
|
}
|
|
|
|
func (r *Registry) Register(m Matcher, resp Responder) {
|
|
r.stubs = append(r.stubs, &Stub{
|
|
Stack: string(debug.Stack()),
|
|
Matcher: m,
|
|
Responder: resp,
|
|
})
|
|
}
|
|
|
|
func (r *Registry) Exclude(t *testing.T, m Matcher) {
|
|
registrationStack := string(debug.Stack())
|
|
|
|
excludedStub := &Stub{
|
|
Matcher: m,
|
|
Responder: func(req *http.Request) (*http.Response, error) {
|
|
callStack := string(debug.Stack())
|
|
|
|
var errMsg strings.Builder
|
|
errMsg.WriteString("HTTP call was made when it should have been excluded:\n")
|
|
errMsg.WriteString(fmt.Sprintf("Request URL: %s\n", req.URL))
|
|
errMsg.WriteString(fmt.Sprintf("Was excluded by: %s\n", registrationStack))
|
|
errMsg.WriteString(fmt.Sprintf("Was called from: %s\n", callStack))
|
|
|
|
t.Error(errMsg.String())
|
|
t.FailNow()
|
|
return nil, nil
|
|
},
|
|
exclude: true,
|
|
}
|
|
r.stubs = append(r.stubs, excludedStub)
|
|
}
|
|
|
|
type Testing interface {
|
|
Errorf(string, ...interface{})
|
|
Helper()
|
|
}
|
|
|
|
func (r *Registry) Verify(t Testing) {
|
|
var unmatchedStubStacks []string
|
|
for _, s := range r.stubs {
|
|
if !s.matched && !s.exclude {
|
|
unmatchedStubStacks = append(unmatchedStubStacks, s.Stack)
|
|
}
|
|
}
|
|
if len(unmatchedStubStacks) > 0 {
|
|
t.Helper()
|
|
stacks := strings.Builder{}
|
|
for i, stack := range unmatchedStubStacks {
|
|
stacks.WriteString(fmt.Sprintf("Stub %d:\n", i+1))
|
|
stacks.WriteString(fmt.Sprintf("\t%s", stack))
|
|
if stack != unmatchedStubStacks[len(unmatchedStubStacks)-1] {
|
|
stacks.WriteString("\n")
|
|
}
|
|
}
|
|
// about dead stubs and what they were trying to match
|
|
t.Errorf("%d HTTP stubs unmatched, stacks:\n%s", len(unmatchedStubStacks), stacks.String())
|
|
}
|
|
}
|
|
|
|
// RoundTrip satisfies http.RoundTripper
|
|
func (r *Registry) RoundTrip(req *http.Request) (*http.Response, error) {
|
|
var stub *Stub
|
|
|
|
r.mu.Lock()
|
|
for _, s := range r.stubs {
|
|
if s.matched || !s.Matcher(req) {
|
|
continue
|
|
}
|
|
// TODO: reinstate this check once the legacy layer has been cleaned up
|
|
// if stub != nil {
|
|
// r.mu.Unlock()
|
|
// return nil, fmt.Errorf("more than 1 stub matched %v", req)
|
|
// }
|
|
stub = s
|
|
break // TODO: remove
|
|
}
|
|
|
|
if stub != nil {
|
|
stub.matched = true
|
|
}
|
|
|
|
if stub == nil {
|
|
r.mu.Unlock()
|
|
return nil, fmt.Errorf("no registered HTTP stubs matched %v", req)
|
|
}
|
|
|
|
r.Requests = append(r.Requests, req)
|
|
r.mu.Unlock()
|
|
|
|
return stub.Responder(req)
|
|
}
|