testing

Documentation

Overview

Package testing is a test suit for recorders. They should provide an object that implements the Constructor interface then run:

import recorder_test "github.com/arsham/expipe/recorder/testing"

for name, fn := range recorder_test.TestSuites() {
    t.Run(name, func(t *testing.T) {
        r, err := recorder_test.New(recorder.SetName("test"))
        if err != nil {
            panic(err)
        }
        fn(t, &Construct{r})
    })
}

The test suit will pick it up and does all the tests.

Important Note

You need to write the edge cases if they are not covered in this section.

Index

• func TestSuites() map[string]func(t *testing.T, cons Constructor)
• type Config
  • func NewConfig(name string, log internal.FieldLogger, endpoint string, timeout time.Duration, ...) (*Config, error)
  • func (c *Config) Backoff() int
  • func (c *Config) Endpoint() string
  • func (c *Config) IndexName() string
  • func (c *Config) Logger() internal.FieldLogger
  • func (c *Config) Name() string
  • func (c *Config) NewInstance() (recorder.DataRecorder, error)
  • func (c *Config) RoutePath() string
  • func (c *Config) Timeout() time.Duration
• type Constructor
• type Recorder
  • func GetRecorder(url string) *Recorder
  • func New(options ...func(recorder.Constructor) error) (*Recorder, error)
  • func (r *Recorder) Backoff() int
  • func (r *Recorder) Endpoint() string
  • func (r *Recorder) IndexName() string
  • func (r *Recorder) Logger() internal.FieldLogger
  • func (r *Recorder) Name() string
  • func (r *Recorder) Ping() error
  • func (r *Recorder) Record(ctx context.Context, job *recorder.Job) error
  • func (r *Recorder) SetBackoff(backoff int)
  • func (r *Recorder) SetEndpoint(endpoint string)
  • func (r *Recorder) SetIndexName(indexName string)
  • func (r *Recorder) SetLogger(log internal.FieldLogger)
  • func (r *Recorder) SetName(name string)
  • func (r *Recorder) SetTimeout(timeout time.Duration)
  • func (r *Recorder) Timeout() time.Duration

Functions

func TestSuites

func TestSuites() map[string]func(t *testing.T, cons Constructor)

TestSuites returns a map of test name to the runner function.

Types

type Config

type Config struct {
	MockName      string
	MockEndpoint  string
	MockTimeout   time.Duration
	MockBackoff   int
	MockIndexName string
	MockLogger    internal.FieldLogger
}

Config holds the necessary configuration for setting up an elasticsearch recorder endpoint.

func NewConfig

func NewConfig(name string, log internal.FieldLogger, endpoint string, timeout time.Duration, backoff int, indexName string) (*Config, error)

NewConfig returns a mocked object

func (*Config) Backoff

func (c *Config) Backoff() int

Backoff is the mocked version

func (*Config) Endpoint

func (c *Config) Endpoint() string

Endpoint is the mocked version

func (*Config) IndexName

func (c *Config) IndexName() string

IndexName is the mocked version

func (*Config) Logger

func (c *Config) Logger() internal.FieldLogger

Logger is the mocked version

func (*Config) Name

func (c *Config) Name() string

Name is the mocked version

func (*Config) NewInstance

func (c *Config) NewInstance() (recorder.DataRecorder, error)

NewInstance returns a mocked object

func (*Config) RoutePath

func (c *Config) RoutePath() string

RoutePath is the mocked version

func (*Config) Timeout

func (c *Config) Timeout() time.Duration

Timeout is the mocked version

type Constructor

type Constructor interface {
	recorder.Constructor

	// ValidEndpoints should return a list of valid endpoints
	ValidEndpoints() []string

	// InvalidEndpoints should return a list of invalid endpoints
	InvalidEndpoints() []string

	// TestServer should return a ready to use test server
	TestServer() *httptest.Server

	// Object should return the instantiated object
	Object() (recorder.DataRecorder, error)
}

Constructor is an interface for setting up an object for testing.

type Recorder

type Recorder struct {
	ErrorFunc func() error

	Smu        sync.RWMutex
	RecordFunc func(context.Context, *recorder.Job) error
	Pinged     bool
	// contains filtered or unexported fields
}

Recorder is designed to be used in tests.

func GetRecorder

func GetRecorder(url string) *Recorder

GetRecorder provides a SimpleRecorder for using in the example.

func New

func New(options ...func(recorder.Constructor) error) (*Recorder, error)

New is a recorder for using in tests

func (*Recorder) Backoff

func (r *Recorder) Backoff() int

Backoff returns the backoff

func (*Recorder) Endpoint

func (r *Recorder) Endpoint() string

Endpoint returns the endpoint

func (*Recorder) IndexName

func (r *Recorder) IndexName() string

IndexName returns the index name

func (*Recorder) Logger

func (r *Recorder) Logger() internal.FieldLogger

Logger returns the log

func (*Recorder) Name

func (r *Recorder) Name() string

Name returns the name

func (*Recorder) Ping

func (r *Recorder) Ping() error

Ping pings the endpoint and return nil if was successful.

func (*Recorder) Record

func (r *Recorder) Record(ctx context.Context, job *recorder.Job) error

Record calls the RecordFunc if exists, otherwise continues as normal

func (*Recorder) SetBackoff

func (r *Recorder) SetBackoff(backoff int)

SetBackoff sets the backoff of the recorder

func (*Recorder) SetEndpoint

func (r *Recorder) SetEndpoint(endpoint string)

SetEndpoint sets the endpoint of the recorder

func (*Recorder) SetIndexName

func (r *Recorder) SetIndexName(indexName string)

SetIndexName sets the index name of the recorder

func (*Recorder) SetLogger

func (r *Recorder) SetLogger(log internal.FieldLogger)

SetLogger sets the log of the recorder

func (*Recorder) SetName

func (r *Recorder) SetName(name string)

SetName sets the name of the recorder

func (*Recorder) SetTimeout

func (r *Recorder) SetTimeout(timeout time.Duration)

SetTimeout sets the timeout of the recorder

func (*Recorder) Timeout

func (r *Recorder) Timeout() time.Duration

Timeout returns the timeout