hoverfly

Documentation

Index

• Constants
• Variables
• func ExecuteMiddlewareLocally(middlewares string, payload models.Payload) (models.Payload, error)
• func ExecuteMiddlewareRemotely(middleware string, payload models.Payload) (models.Payload, error)
• func GetRandomName(n int) []byte
• func NewProxy(hoverfly *Hoverfly) *goproxy.ProxyHttpServer
• func NewWebserverProxy(hoverfly *Hoverfly) *goproxy.ProxyHttpServer
• func Pipeline(cmds ...*exec.Cmd) (pipeLineOutput, collectedStandardError []byte, pipeLineError error)
• func SynthesizeResponse(req *http.Request, middleware string) (*http.Response, error)
• type ActionType
• type ActionTypeHooks
  • func (hooks ActionTypeHooks) Add(hook Hook)
  • func (hooks ActionTypeHooks) Fire(ac ActionType, entry *Entry) error
• type Client
• type Configuration
  • func InitSettings() *Configuration
  • func (c *Configuration) GetMode() string
  • func (c *Configuration) SetMode(mode string)
• type Constructor
  • func NewConstructor(req *http.Request, payload models.Payload) *Constructor
  • func (c *Constructor) ApplyMiddleware(middleware string) error
  • func (c *Constructor) ReconstructRequest() (*http.Request, error)
  • func (c *Constructor) ReconstructResponse() *http.Response
• type Entry
• type Hook
• type Hoverfly
  • func GetNewHoverfly(cfg *Configuration, requestCache, metadataCache cache.Cache, ...) *Hoverfly
  • func (hf *Hoverfly) AddHook(hook Hook)
  • func (d *Hoverfly) AllMetadataHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (d *Hoverfly) AllRecordsHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (d *Hoverfly) CurrentMiddlewareHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (d *Hoverfly) CurrentStateHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (d *Hoverfly) DeleteAllRecordsHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (d *Hoverfly) DeleteAllResponseDelaysHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (d *Hoverfly) DeleteAllTemplatesHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (d *Hoverfly) DeleteMetadataHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (d *Hoverfly) GetAllTemplatesHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (d *Hoverfly) GetResponseDelaysHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (d *Hoverfly) HealthHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (hf *Hoverfly) Import(uri string) error
  • func (hf *Hoverfly) ImportFromDisk(path string) error
  • func (hf *Hoverfly) ImportFromURL(url string) error
  • func (hf *Hoverfly) ImportPayloads(payloads []views.PayloadView) error
  • func (d *Hoverfly) ImportRecordsHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (d *Hoverfly) ImportTemplatesHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (d *Hoverfly) ManualAddHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (d *Hoverfly) MiddlewareHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (d *Hoverfly) RecordsCount(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (d *Hoverfly) SetMetadataHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (hf *Hoverfly) SetMiddleware(middleware string) error
  • func (d *Hoverfly) StartAdminInterface()
  • func (hf *Hoverfly) StartProxy() error
  • func (d *Hoverfly) StateHandler(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)
  • func (d *Hoverfly) StatsHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
  • func (d *Hoverfly) StatsWSHandler(w http.ResponseWriter, r *http.Request)
  • func (hf *Hoverfly) StopProxy()
  • func (hf *Hoverfly) UpdateDestination(destination string) (err error)
  • func (hf *Hoverfly) UpdateResponseDelays(responseDelays models.ResponseDelayList)
  • func (d *Hoverfly) UpdateResponseDelaysHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
• type StoppableListener
  • func NewStoppableListener(l net.Listener) (*StoppableListener, error)
  • func (sl *StoppableListener) Accept() (net.Conn, error)
  • func (sl *StoppableListener) Stop()

Constants

const (
	HoverflyAuthEnabledEV     = "HoverflyAuthEnabled"
	HoverflySecretEV          = "HoverflySecret"
	HoverflyTokenExpirationEV = "HoverflyTokenExpiration"

	HoverflyAdminPortEV = "AdminPort"
	HoverflyProxyPortEV = "ProxyPort"

	HoverflyDBEV         = "HoverflyDB"
	HoverflyMiddlewareEV = "HoverflyMiddleware"

	HoverflyTLSVerification = "HoverflyTlsVerification"

	HoverflyAdminUsernameEV = "HoverflyAdmin"
	HoverflyAdminPasswordEV = "HoverflyAdminPass"

	HoverflyImportRecordsEV = "HoverflyImport"
)

Environment variables

const ActionTypeConfigurationChanged = "configurationChanged"

ActionTypeConfigurationChanged - default action name for identifying configuration changes

const ActionTypeRequestCaptured = "requestCaptured"

ActionTypeRequestCaptured - default action type name for identifying

const ActionTypeWipeDB = "wipeDatabase"

ActionTypeWipeDB - default action type for wiping database

const CaptureMode = "capture"

CaptureMode - requests are captured and stored in cache

const DefaultAdminPort = "8888"

DefaultAdminPort - default admin interface port

const DefaultDatabasePath = "requests.db"

DefaultDatabasePath - default database name that will be created or used by Hoverfly

const DefaultJWTExpirationDelta = 1 * 24 * 60 * 60

DefaultJWTExpirationDelta - default token expiration if environment variable is no provided

const DefaultPort = "8500"

DefaultPort - default proxy port

const ModifyMode = "modify"

ModifyMode - middleware is applied to outgoing and incoming traffic

const SimulateMode = "simulate"

SimulateMode - default mode when Hoverfly looks for captured requests to respond

const SynthesizeMode = "synthesize"

SynthesizeMode - all requests are sent to middleware to create response

const URL string = `` /* 321-byte string literal not displayed */

URL is regexp to match http urls

Variables

var TestDB *bolt.DB

TestDB - holds connection to database during tests

Functions

func ExecuteMiddlewareLocally

func ExecuteMiddlewareLocally(middlewares string, payload models.Payload) (models.Payload, error)

ExecuteMiddleware - takes command (middleware string) and payload, which is passed to middleware

func ExecuteMiddlewareRemotely

func ExecuteMiddlewareRemotely(middleware string, payload models.Payload) (models.Payload, error)

func GetRandomName

func GetRandomName(n int) []byte

GetRandomName - provides random name for buckets. Each test case gets it's own bucket

func NewProxy

func NewProxy(hoverfly *Hoverfly) *goproxy.ProxyHttpServer

Creates goproxy.ProxyHttpServer and configures it to be used as a proxy for Hoverfly goproxy is given handlers that use the Hoverfly request processing

func NewWebserverProxy

func NewWebserverProxy(hoverfly *Hoverfly) *goproxy.ProxyHttpServer

Creates goproxy.ProxyHttpServer and configures it to be used as a webserver for Hoverfly goproxy is given a non proxy handler that uses the Hoverfly request processing

func Pipeline

func Pipeline(cmds ...*exec.Cmd) (pipeLineOutput, collectedStandardError []byte, pipeLineError error)

Pipeline - to provide input to the pipeline, assign an io.Reader to the first's Stdin.

func SynthesizeResponse

func SynthesizeResponse(req *http.Request, middleware string) (*http.Response, error)

SynthesizeResponse calls middleware to populate response data, nothing gets pass proxy

Types

type ActionType

type ActionType string

ActionType - action type can be things such as "RequestCaptured", "GotResponse" - anything

type ActionTypeHooks

type ActionTypeHooks map[ActionType][]Hook

ActionTypeHooks type for storing the hooks

func (ActionTypeHooks) Add

func (hooks ActionTypeHooks) Add(hook Hook)

Add a hook

func (ActionTypeHooks) Fire

func (hooks ActionTypeHooks) Fire(ac ActionType, entry *Entry) error

Fire all the hooks for the passed ActionType

type Client

type Client struct {
	HTTPClient *http.Client
}

Client structure to be injected into functions to perform HTTP calls

type Configuration

type Configuration struct {
	AdminPort    string
	ProxyPort    string
	Mode         string
	Destination  string
	Middleware   string
	DatabasePath string
	Webserver    bool

	TLSVerification bool

	Verbose     bool
	Development bool

	SecretKey          []byte
	JWTExpirationDelta int
	AuthEnabled        bool

	ProxyControlWG sync.WaitGroup
	// contains filtered or unexported fields
}

Configuration - initial structure of configuration

func InitSettings

func InitSettings() *Configuration

InitSettings gets and returns initial configuration from env variables or sets defaults

func (*Configuration) GetMode

func (c *Configuration) GetMode() string

GetMode - provides safe way to get current mode

func (*Configuration) SetMode

func (c *Configuration) SetMode(mode string)

SetMode - provides safe way to set new mode

type Constructor

type Constructor struct {
	// contains filtered or unexported fields
}

Constructor - holds information about original request (which is needed to create response and also holds payload

func NewConstructor

func NewConstructor(req *http.Request, payload models.Payload) *Constructor

NewConstructor - returns constructor instance

func (*Constructor) ApplyMiddleware

func (c *Constructor) ApplyMiddleware(middleware string) error

ApplyMiddleware - activates given middleware, middleware should be passed as string to executable, can be full path.

func (*Constructor) ReconstructRequest

func (c *Constructor) ReconstructRequest() (*http.Request, error)

ReconstructRequest replaces original request with details provided in Constructor Payload.Request

func (*Constructor) ReconstructResponse

func (c *Constructor) ReconstructResponse() *http.Response

ReconstructResponse changes original response with details provided in Constructor Payload.Response

type Entry

type Entry struct {
	// Contains encoded data
	Data []byte

	// Time at which the action entry was fired
	Time time.Time

	ActionType ActionType

	// Message, can carry additional information
	Message string
}

Entry - holds information about action, based on action type - other clients will be able to decode the data field.

type Hook

type Hook interface {
	ActionTypes() []ActionType
	Fire(*Entry) error
}

Hook - an interface to add dynamic hooks to extend functionality

type Hoverfly

type Hoverfly struct {
	RequestCache   cache.Cache
	RequestMatcher matching.RequestMatcher
	MetadataCache  cache.Cache
	Authentication authBackend.Authentication
	HTTP           *http.Client
	Cfg            *Configuration
	Counter        *metrics.CounterByMode
	Hooks          ActionTypeHooks

	ResponseDelays models.ResponseDelays

	Proxy *goproxy.ProxyHttpServer
	SL    *StoppableListener
	// contains filtered or unexported fields
}

Hoverfly provides access to hoverfly - updating/starting/stopping proxy, http client and configuration, cache access

func GetNewHoverfly

func GetNewHoverfly(cfg *Configuration, requestCache, metadataCache cache.Cache, authentication authBackend.Authentication) *Hoverfly

GetNewHoverfly returns a configured ProxyHttpServer and DBClient

func (*Hoverfly) AddHook

func (hf *Hoverfly) AddHook(hook Hook)

AddHook - adds a hook to DBClient

func (*Hoverfly) AllMetadataHandler

func (d *Hoverfly) AllMetadataHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

AllMetadataHandler returns JSON content type http response

func (*Hoverfly) AllRecordsHandler

func (d *Hoverfly) AllRecordsHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

AllRecordsHandler returns JSON content type http response

func (*Hoverfly) CurrentMiddlewareHandler

func (d *Hoverfly) CurrentMiddlewareHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

func (*Hoverfly) CurrentStateHandler

func (d *Hoverfly) CurrentStateHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

CurrentStateHandler returns current state

func (*Hoverfly) DeleteAllRecordsHandler

func (d *Hoverfly) DeleteAllRecordsHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

DeleteAllRecordsHandler - deletes all captured requests

func (*Hoverfly) DeleteAllResponseDelaysHandler

func (d *Hoverfly) DeleteAllResponseDelaysHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

func (*Hoverfly) DeleteAllTemplatesHandler

func (d *Hoverfly) DeleteAllTemplatesHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

DeleteAllRecordsHandler - deletes all captured requests

func (*Hoverfly) DeleteMetadataHandler

func (d *Hoverfly) DeleteMetadataHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

DeleteMetadataHandler - deletes all metadata

func (*Hoverfly) GetAllTemplatesHandler

func (d *Hoverfly) GetAllTemplatesHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

AllRecordsHandler returns JSON content type http response

func (*Hoverfly) GetResponseDelaysHandler

func (d *Hoverfly) GetResponseDelaysHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

func (*Hoverfly) HealthHandler

func (d *Hoverfly) HealthHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

func (*Hoverfly) Import

func (hf *Hoverfly) Import(uri string) error

Import is a function that based on input decides whether it is a local resource or whether it should fetch it from remote server. It then imports given payload into the database or returns an error

func (*Hoverfly) ImportFromDisk

func (hf *Hoverfly) ImportFromDisk(path string) error

ImportFromDisk - takes one string value and tries to open a file, then parse it into recordedRequests structure (which is default format in which Hoverfly exports captured requests) and imports those requests into the database

func (*Hoverfly) ImportFromURL

func (hf *Hoverfly) ImportFromURL(url string) error

ImportFromURL - takes one string value and tries connect to a remote server, then parse response body into recordedRequests structure (which is default format in which Hoverfly exports captured requests) and imports those requests into the database

func (*Hoverfly) ImportPayloads

func (hf *Hoverfly) ImportPayloads(payloads []views.PayloadView) error

ImportPayloads - a function to save given payloads into the database.

func (*Hoverfly) ImportRecordsHandler

func (d *Hoverfly) ImportRecordsHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

ImportRecordsHandler - accepts JSON payload and saves it to cache

func (*Hoverfly) ImportTemplatesHandler

func (d *Hoverfly) ImportTemplatesHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

func (*Hoverfly) ManualAddHandler

func (d *Hoverfly) ManualAddHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

ManualAddHandler - manually add new request/responses, using a form

func (*Hoverfly) MiddlewareHandler

func (d *Hoverfly) MiddlewareHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

func (*Hoverfly) RecordsCount

func (d *Hoverfly) RecordsCount(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

RecordsCount returns number of captured requests as a JSON payload

func (*Hoverfly) SetMetadataHandler

func (d *Hoverfly) SetMetadataHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

SetMetadataHandler - sets new metadata

func (*Hoverfly) SetMiddleware

func (hf *Hoverfly) SetMiddleware(middleware string) error

func (*Hoverfly) StartAdminInterface

func (d *Hoverfly) StartAdminInterface()

StartAdminInterface - starts admin interface web server

func (*Hoverfly) StartProxy

func (hf *Hoverfly) StartProxy() error

StartProxy - starts proxy with current configuration, this method is non blocking.

func (*Hoverfly) StateHandler

func (d *Hoverfly) StateHandler(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)

StateHandler handles current proxy state

func (*Hoverfly) StatsHandler

func (d *Hoverfly) StatsHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

StatsHandler - returns current stats about Hoverfly (request counts, record count)

func (*Hoverfly) StatsWSHandler

func (d *Hoverfly) StatsWSHandler(w http.ResponseWriter, r *http.Request)

StatsWSHandler - returns current stats about Hoverfly (request counts, record count) through the websocket

func (*Hoverfly) StopProxy

func (hf *Hoverfly) StopProxy()

StopProxy - stops proxy

func (*Hoverfly) UpdateDestination

func (hf *Hoverfly) UpdateDestination(destination string) (err error)

UpdateDestination - updates proxy with new destination regexp

func (*Hoverfly) UpdateResponseDelays

func (hf *Hoverfly) UpdateResponseDelays(responseDelays models.ResponseDelayList)

func (*Hoverfly) UpdateResponseDelaysHandler

func (d *Hoverfly) UpdateResponseDelaysHandler(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

type StoppableListener

type StoppableListener struct {
	*net.TCPListener
	// contains filtered or unexported fields
}

StoppableListener - wrapper for tcp listener that can stop

func NewStoppableListener

func NewStoppableListener(l net.Listener) (*StoppableListener, error)

NewStoppableListener returns new StoppableListener listener

func (*StoppableListener) Accept

func (sl *StoppableListener) Accept() (net.Conn, error)

Accept - TCPListener waits for the next call, implements default interface method

func (*StoppableListener) Stop

func (sl *StoppableListener) Stop()

Stop - stops listener