modes

Documentation

Index

• Constants
• func ErrorResponse(req *http.Request, err error, msg string) *http.Response
• func GetRequestLogFields(request *models.RequestDetails) *logrus.Fields
• func GetResponseLogFields(response *models.ResponseDetails) *logrus.Fields
• func ReconstructRequest(pair models.RequestResponsePair) (*http.Request, error)
• func ReconstructRequestForPassThrough(pair models.RequestResponsePair) (*http.Request, error)
• func ReconstructResponse(request *http.Request, pair models.RequestResponsePair) *http.Response
• func ReturnErrorAndLog(request *http.Request, err error, pair *models.RequestResponsePair, ...) (*http.Response, error)
• type CaptureMode
  • func (this *CaptureMode) GetArguments(arguments ModeArguments)
  • func (this CaptureMode) Process(request *http.Request, details models.RequestDetails) (*http.Response, error)
  • func (this *CaptureMode) SetArguments(arguments ModeArguments)
  • func (this *CaptureMode) View() v2.ModeView
• type DiffMode
  • func (this *DiffMode) JsonDiff(prefix string, expected map[string]interface{}, actual map[string]interface{}) bool
  • func (this *DiffMode) Process(request *http.Request, details models.RequestDetails) (*http.Response, error)
  • func (this *DiffMode) SetArguments(arguments ModeArguments)
  • func (this *DiffMode) View() v2.ModeView
• type HoverflyCapture
• type HoverflyDiff
• type HoverflyModify
• type HoverflySimulate
• type HoverflySpy
• type HoverflySynthesize
• type Mode
• type ModeArguments
• type ModifyMode
  • func (this ModifyMode) Process(request *http.Request, details models.RequestDetails) (*http.Response, error)
  • func (this *ModifyMode) SetArguments(arguments ModeArguments)
  • func (this *ModifyMode) View() v2.ModeView
• type SimulateMode
  • func (this SimulateMode) Process(request *http.Request, details models.RequestDetails) (*http.Response, error)
  • func (this *SimulateMode) SetArguments(arguments ModeArguments)
  • func (this *SimulateMode) View() v2.ModeView
• type SpyMode
  • func (this SpyMode) Process(request *http.Request, details models.RequestDetails) (*http.Response, error)
  • func (this *SpyMode) SetArguments(arguments ModeArguments)
  • func (this *SpyMode) View() v2.ModeView
• type SynthesizeMode
  • func (this SynthesizeMode) Process(request *http.Request, details models.RequestDetails) (*http.Response, error)
  • func (this *SynthesizeMode) SetArguments(arguments ModeArguments)
  • func (this *SynthesizeMode) View() v2.ModeView

Constants

const Capture = "capture"

CaptureMode - requests are captured and stored in cache

const Diff = "diff"

DiffMode - calls real service and compares response with simulation

const Modify = "modify"

ModifyMode - middleware is applied to outgoing and incoming traffic

const Simulate = "simulate"

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

const Spy = "spy"

SpyMode - simulateMode but will call real service when cache miss

const Synthesize = "synthesize"

SynthesizeMode - all requests are sent to middleware to create response

Functions

func ErrorResponse

func ErrorResponse(req *http.Request, err error, msg string) *http.Response

func GetRequestLogFields

func GetRequestLogFields(request *models.RequestDetails) *logrus.Fields

func GetResponseLogFields

func GetResponseLogFields(response *models.ResponseDetails) *logrus.Fields

func ReconstructRequest

func ReconstructRequest(pair models.RequestResponsePair) (*http.Request, error)

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

func ReconstructRequestForPassThrough

func ReconstructRequestForPassThrough(pair models.RequestResponsePair) (*http.Request, error)

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

func ReconstructResponse

func ReconstructResponse(request *http.Request, pair models.RequestResponsePair) *http.Response

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

func ReturnErrorAndLog

func ReturnErrorAndLog(request *http.Request, err error, pair *models.RequestResponsePair, msg, mode string) (*http.Response, error)

Types

type CaptureMode

type CaptureMode struct {
	Hoverfly  HoverflyCapture
	Arguments ModeArguments
}

func (*CaptureMode) GetArguments

func (this *CaptureMode) GetArguments(arguments ModeArguments)

func (CaptureMode) Process

func (this CaptureMode) Process(request *http.Request, details models.RequestDetails) (*http.Response, error)

func (*CaptureMode) SetArguments

func (this *CaptureMode) SetArguments(arguments ModeArguments)

func (*CaptureMode) View

func (this *CaptureMode) View() v2.ModeView

type DiffMode

type DiffMode struct {
	Hoverfly   HoverflyDiff
	DiffReport v2.DiffReport
	Arguments  ModeArguments
}

func (*DiffMode) JsonDiff

func (this *DiffMode) JsonDiff(prefix string, expected map[string]interface{}, actual map[string]interface{}) bool

func (*DiffMode) Process

func (this *DiffMode) Process(request *http.Request, details models.RequestDetails) (*http.Response, error)

TODO: We should only need one of these two parameters

func (*DiffMode) SetArguments

func (this *DiffMode) SetArguments(arguments ModeArguments)

func (*DiffMode) View

func (this *DiffMode) View() v2.ModeView

type HoverflyCapture

type HoverflyCapture interface {
	ApplyMiddleware(models.RequestResponsePair) (models.RequestResponsePair, error)
	DoRequest(*http.Request) (*http.Response, error)
	Save(*models.RequestDetails, *models.ResponseDetails, []string, bool) error
}

type HoverflyDiff

type HoverflyDiff interface {
	GetResponse(models.RequestDetails) (*models.ResponseDetails, *errors.HoverflyError)
	DoRequest(*http.Request) (*http.Response, error)
	AddDiff(requestView v2.SimpleRequestDefinitionView, diffReport v2.DiffReport)
}

type HoverflyModify

type HoverflyModify interface {
	ApplyMiddleware(models.RequestResponsePair) (models.RequestResponsePair, error)
	DoRequest(*http.Request) (*http.Response, error)
}

type HoverflySimulate

type HoverflySimulate interface {
	GetResponse(models.RequestDetails) (*models.ResponseDetails, *errors.HoverflyError)
	ApplyMiddleware(models.RequestResponsePair) (models.RequestResponsePair, error)
}

type HoverflySpy

type HoverflySpy interface {
	GetResponse(models.RequestDetails) (*models.ResponseDetails, *errors.HoverflyError)
	ApplyMiddleware(models.RequestResponsePair) (models.RequestResponsePair, error)
	DoRequest(*http.Request) (*http.Response, error)
}

type HoverflySynthesize

type HoverflySynthesize interface {
	ApplyMiddleware(models.RequestResponsePair) (models.RequestResponsePair, error)
	IsMiddlewareSet() bool
}

type Mode

type Mode interface {
	Process(*http.Request, models.RequestDetails) (*http.Response, error)
	SetArguments(arguments ModeArguments)
	View() v2.ModeView
}

type ModeArguments

type ModeArguments struct {
	Headers          []string
	MatchingStrategy *string
	Stateful         bool
}

type ModifyMode

type ModifyMode struct {
	Hoverfly HoverflyModify
}

func (ModifyMode) Process

func (this ModifyMode) Process(request *http.Request, details models.RequestDetails) (*http.Response, error)

func (*ModifyMode) SetArguments

func (this *ModifyMode) SetArguments(arguments ModeArguments)

func (*ModifyMode) View

func (this *ModifyMode) View() v2.ModeView

type SimulateMode

type SimulateMode struct {
	Hoverfly         HoverflySimulate
	MatchingStrategy string
}

func (SimulateMode) Process

func (this SimulateMode) Process(request *http.Request, details models.RequestDetails) (*http.Response, error)

TODO: We should only need one of these two parameters

func (*SimulateMode) SetArguments

func (this *SimulateMode) SetArguments(arguments ModeArguments)

func (*SimulateMode) View

func (this *SimulateMode) View() v2.ModeView

type SpyMode

type SpyMode struct {
	Hoverfly         HoverflySpy
	MatchingStrategy string
}

func (SpyMode) Process

func (this SpyMode) Process(request *http.Request, details models.RequestDetails) (*http.Response, error)

TODO: We should only need one of these two parameters

func (*SpyMode) SetArguments

func (this *SpyMode) SetArguments(arguments ModeArguments)

func (*SpyMode) View

func (this *SpyMode) View() v2.ModeView

type SynthesizeMode

type SynthesizeMode struct {
	Hoverfly HoverflySynthesize
}

func (SynthesizeMode) Process

func (this SynthesizeMode) Process(request *http.Request, details models.RequestDetails) (*http.Response, error)

func (*SynthesizeMode) SetArguments

func (this *SynthesizeMode) SetArguments(arguments ModeArguments)

func (*SynthesizeMode) View

func (this *SynthesizeMode) View() v2.ModeView