testing

Documentation

Overview

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

import reader_test "github.com/arsham/expipe/reader/testing"
....
r, err := reader_test.New(reader.SetName("test"))
if err != nil {
    panic(err)
}
c := &Construct{r}
reader_test.TestSuites(t, c)

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(t *testing.T, cons Constructor)
• type Conf
  • func WithBackoff(backoff int) Conf
  • func WithEndpoint(endpoint string) Conf
  • func WithInterval(internal time.Duration) Conf
  • func WithLogger(log internal.FieldLogger) Conf
  • func WithName(name string) Conf
  • func WithTimeout(timeout time.Duration) Conf
  • func WithTypeName(typeName string) Conf
• type Config
  • func NewConfig(conf ...Conf) (*Config, error)
  • func (c *Config) Backoff() int
  • func (c *Config) Endpoint() string
  • func (c *Config) Interval() time.Duration
  • func (c *Config) Logger() internal.FieldLogger
  • func (c *Config) Name() string
  • func (c *Config) NewInstance() (reader.DataReader, error)
  • func (c *Config) Timeout() time.Duration
  • func (c *Config) TypeName() string
• type Constructor
• type Reader
  • func GetReader(url string) *Reader
  • func New(options ...func(reader.Constructor) error) (*Reader, error)
  • func (r *Reader) Backoff() int
  • func (r *Reader) Endpoint() string
  • func (r *Reader) Interval() time.Duration
  • func (r *Reader) Logger() internal.FieldLogger
  • func (r *Reader) Mapper() datatype.Mapper
  • func (r *Reader) Name() string
  • func (r *Reader) Ping() error
  • func (r *Reader) Read(job *token.Context) (*reader.Result, error)
  • func (r *Reader) SetBackoff(backoff int)
  • func (r *Reader) SetEndpoint(endpoint string)
  • func (r *Reader) SetInterval(interval time.Duration)
  • func (r *Reader) SetLogger(log internal.FieldLogger)
  • func (r *Reader) SetMapper(mapper datatype.Mapper)
  • func (r *Reader) SetName(name string)
  • func (r *Reader) SetTimeout(timeout time.Duration)
  • func (r *Reader) SetTypeName(typeName string)
  • func (r *Reader) Timeout() time.Duration
  • func (r *Reader) TypeName() string

Functions

func TestSuites

func TestSuites(t *testing.T, cons Constructor)

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

Types

type Conf

type Conf func(*Config) error

Conf func is used for initializing a Config object.

func WithBackoff

func WithBackoff(backoff int) Conf

WithBackoff doesn't produce any errors.

func WithEndpoint

func WithEndpoint(endpoint string) Conf

WithEndpoint doesn't produce any errors.

func WithInterval

func WithInterval(internal time.Duration) Conf

WithInterval doesn't produce any errors.

func WithLogger

func WithLogger(log internal.FieldLogger) Conf

WithLogger doesn't produce any errors.

func WithName

func WithName(name string) Conf

WithName doesn't produce any errors.

func WithTimeout

func WithTimeout(timeout time.Duration) Conf

WithTimeout doesn't produce any errors.

func WithTypeName

func WithTypeName(typeName string) Conf

WithTypeName doesn't produce any errors.

type Config

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

Config is used for instantiating a mock reader

func NewConfig

func NewConfig(conf ...Conf) (*Config, error)

NewConfig returns a mocked object

func (*Config) Backoff

func (c *Config) Backoff() int

Backoff returns the backoff

func (*Config) Endpoint

func (c *Config) Endpoint() string

Endpoint returns the endpoint

func (*Config) Interval

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

Interval returns the interval

func (*Config) Logger

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

Logger returns the logger

func (*Config) Name

func (c *Config) Name() string

Name returns the name

func (*Config) NewInstance

func (c *Config) NewInstance() (reader.DataReader, error)

NewInstance returns a mocked version of the config

func (*Config) Timeout

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

Timeout returns the timeout

func (*Config) TypeName

func (c *Config) TypeName() string

TypeName returns the typeName

type Constructor

type Constructor interface {
	reader.Constructor
	TestServer() *httptest.Server
	Object() (reader.DataReader, error)
}

Constructor is an interface for setting up an object for testing. TestServer() should return a ready to use test server Object() should return the instantiated object

type Reader

type Reader struct {
	ReadFunc func(*token.Context) (*reader.Result, error)
	Pinged   bool
	// contains filtered or unexported fields
}

Reader is useful for testing purposes.

func GetReader

func GetReader(url string) *Reader

GetReader provides a SimpleReader for using in the example.

func New

func New(options ...func(reader.Constructor) error) (*Reader, error)

New is a reader for using in tests

func (*Reader) Backoff

func (r *Reader) Backoff() int

Backoff returns the backoff

func (*Reader) Endpoint

func (r *Reader) Endpoint() string

Endpoint returns the endpoint

func (*Reader) Interval

func (r *Reader) Interval() time.Duration

Interval returns the interval

func (*Reader) Logger

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

Logger returns the log

func (*Reader) Mapper

func (r *Reader) Mapper() datatype.Mapper

Mapper returns the mapper

func (*Reader) Name

func (r *Reader) Name() string

Name returns the name

func (*Reader) Ping

func (r *Reader) Ping() error

Ping pings the endpoint and return nil if was successful.

func (*Reader) Read

func (r *Reader) Read(job *token.Context) (*reader.Result, error)

Read executes the ReadFunc if defined, otherwise continues normally

func (*Reader) SetBackoff

func (r *Reader) SetBackoff(backoff int)

SetBackoff sets the backoff of the reader

func (*Reader) SetEndpoint

func (r *Reader) SetEndpoint(endpoint string)

SetEndpoint sets the endpoint of the reader

func (*Reader) SetInterval

func (r *Reader) SetInterval(interval time.Duration)

SetInterval sets the interval of the reader

func (*Reader) SetLogger

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

SetLogger sets the log of the reader

func (*Reader) SetMapper

func (r *Reader) SetMapper(mapper datatype.Mapper)

SetMapper sets the mapper of the reader

func (*Reader) SetName

func (r *Reader) SetName(name string)

SetName sets the name of the reader

func (*Reader) SetTimeout

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

SetTimeout sets the timeout of the reader

func (*Reader) SetTypeName

func (r *Reader) SetTypeName(typeName string)

SetTypeName sets the type name of the reader

func (*Reader) Timeout

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

Timeout returns the timeout

func (*Reader) TypeName

func (r *Reader) TypeName() string

TypeName returns the type name