consultest

Documentation

Overview

Package consultest Leveraging ittest package and HTTP VCR to record and replay consul operations

Index

• func ConsulWithRecorder(recorder *recorder.Recorder) consul.Options
• func RecordedConsulProvider() fx.Annotated
• func WithHttpPlayback(t *testing.T, opts ...ConsulRecorderOptions) test.Options
• type ConsulRecorderConfig
• type ConsulRecorderOptions
  • func HttpRecordingMode() ConsulRecorderOptions
  • func MoreHTTPVCROptions(opts ...ittest.HTTPVCROptions) ConsulRecorderOptions

Functions

func ConsulWithRecorder

func ConsulWithRecorder(recorder *recorder.Recorder) consul.Options

func RecordedConsulProvider

func RecordedConsulProvider() fx.Annotated

func WithHttpPlayback

func WithHttpPlayback(t *testing.T, opts ...ConsulRecorderOptions) test.Options

Types

type ConsulRecorderConfig

type ConsulRecorderConfig struct {
	HTTPVCROptions []ittest.HTTPVCROptions
}

type ConsulRecorderOptions

type ConsulRecorderOptions func(cfg *ConsulRecorderConfig)

func HttpRecordingMode

func HttpRecordingMode() ConsulRecorderOptions

HttpRecordingMode enable "recording" mode. IMPORTANT: When Record mode is enabled, all sub tests interact with real Consul service.

So use this mode on LOCAL DEV ONLY

See ittest.HttpRecordingMode()

func MoreHTTPVCROptions

func MoreHTTPVCROptions(opts ...ittest.HTTPVCROptions) ConsulRecorderOptions