bogus.go

// Package bogus provides a minimal set of helpers on top of the
// net/http/httptest package
package bogus

import (
	"bytes"
	"io/ioutil"
	"net"
	"net/http"
	"net/http/httptest"
	"net/url"

	"github.com/gomicro/bogus/paths"
)

// HitRecord represents a recording of information from a single hit againstr
// the bogus server
type HitRecord struct {
	Verb   string
	Path   string
	Query  url.Values
	Body   []byte
	Header http.Header
}

// Bogus represents a test server
type Bogus struct {
	server     *httptest.Server
	hits       int
	paths      map[string]*paths.Path
	hitRecords []HitRecord
}

// New returns a newly intitated bogus server
func New() *Bogus {
	b := &Bogus{
		paths: map[string]*paths.Path{},
	}
	b.server = httptest.NewServer(http.HandlerFunc(b.HandlePaths))

	return b
}

// AddPath adds a new path to the bogus server handler and returns the new path
// for further configuration
func (b *Bogus) AddPath(path string) *paths.Path {
	if _, ok := b.paths[path]; !ok {
		b.paths[path] = paths.New()
	}

	return b.paths[path]
}

// Close calls the close method for the underlying httptest server
func (b *Bogus) Close() {
	b.server.Close()
}

// HandlePaths implements the http handler interface and decides how to respond
// based on the paths configured
func (b *Bogus) HandlePaths(w http.ResponseWriter, r *http.Request) {
	b.hits++

	bodyBytes, _ := ioutil.ReadAll(r.Body)
	r.Body = ioutil.NopCloser(bytes.NewBuffer(bodyBytes))
	defer r.Body.Close()

	b.hitRecords = append(b.hitRecords, HitRecord{
		Verb:   r.Method,
		Path:   r.URL.Path,
		Query:  r.URL.Query(),
		Body:   bodyBytes,
		Header: r.Header,
	})

	path, ok := b.paths[r.URL.Path]
	if !ok {
		w.WriteHeader(http.StatusNotFound)
		w.Write([]byte("Not Found")) //nolint,errcheck
		return
	}

	path.HandleRequest(w, r)
}

// Hits returns the total number of hits seen against the bogus server
func (b *Bogus) Hits() int {
	return b.hits
}

// HitRecords returns a slice of the hit records recorded for inspection
func (b *Bogus) HitRecords() []HitRecord {
	return b.hitRecords
}

// HostPort returns the host and port number of the bogus server
func (b *Bogus) HostPort() (string, string) {
	h, p, _ := net.SplitHostPort(b.server.URL[7:])
	return h, p
}