mockdb

README

data-mock

Mock database for testing that implements the data interface

Documentation

Index

• func MatcherFunc(object data.Object) exp.MatcherFunc
• func New() data.Server
• type Collection
  • func (collection Collection) Count(criteria exp.Expression, options ...option.Option) (int64, error)
  • func (collection Collection) Delete(object data.Object, comment string) error
  • func (collection Collection) HardDelete(criteria exp.Expression) error
  • func (collection Collection) Iterator(criteria exp.Expression, options ...option.Option) (data.Iterator, error)
  • func (collection Collection) Load(criteria exp.Expression, target data.Object) error
  • func (collection Collection) Query(target any, criteria exp.Expression, options ...option.Option) error
  • func (collection Collection) Save(object data.Object, comment string) error
• type Iterator
  • func NewIterator(data []data.Object, options ...option.Option) *Iterator
  • func (iterator *Iterator) Close() error
  • func (iterator *Iterator) Count() int
  • func (iterator *Iterator) Error() error
  • func (iterator *Iterator) Len() int
  • func (iterator *Iterator) Less(i int, j int) bool
  • func (iterator *Iterator) Next(output any) bool
  • func (iterator *Iterator) Reset()
  • func (iterator *Iterator) Swap(i int, j int)
• type Server
  • func (server Server) Session(ctx context.Context) (data.Session, error)
• type Session
  • func (session Session) Close()
  • func (session Session) Collection(collection string) data.Collection

Functions

func MatcherFunc

func MatcherFunc(object data.Object) exp.MatcherFunc

MatcherFunc is a helper function that uses reflection to look inside a generic data.Object and match it. Because it uses reflection, it should be considered SLOW, and only be used in the mock library.

func New

func New() data.Server

New returns a fully initialized Database object

Types

type Collection

type Collection struct {
	Server  *Server
	Context context.Context
	Name    string
}

Collection is a mock database collection

func (Collection) Count

func (collection Collection) Count(criteria exp.Expression, options ...option.Option) (int64, error)

func (Collection) Delete

func (collection Collection) Delete(object data.Object, comment string) error

Delete PERMANENTLY removes a record from the mock database.

func (Collection) HardDelete

func (collection Collection) HardDelete(criteria exp.Expression) error

func (Collection) Iterator

func (collection Collection) Iterator(criteria exp.Expression, options ...option.Option) (data.Iterator, error)

List retrieves a group of records as an Iterator.

func (Collection) Load

func (collection Collection) Load(criteria exp.Expression, target data.Object) error

Load retrieves a single record from the mock collection.

func (Collection) Query

func (collection Collection) Query(target any, criteria exp.Expression, options ...option.Option) error

func (Collection) Save

func (collection Collection) Save(object data.Object, comment string) error

Save adds/inserts a new record into the mock database

type Iterator

type Iterator struct {
	Data    []data.Object
	Options []option.Option
	Counter int
}

Iterator represents a generic set of data that can be returned by a datasource.

func NewIterator

func NewIterator(data []data.Object, options ...option.Option) *Iterator

NewIterator generates

func (*Iterator) Close

func (iterator *Iterator) Close() error

Close prevents any further records from being read from the iterator

func (*Iterator) Count

func (iterator *Iterator) Count() int

Count returns the total number of records contained in this iterator

func (*Iterator) Error

func (iterator *Iterator) Error() error

func (*Iterator) Len

func (iterator *Iterator) Len() int

Len returns the number of elements in the collection.

func (*Iterator) Less

func (iterator *Iterator) Less(i int, j int) bool

Less reports whether the element with index i should sort before the element with index j. A return value of TRUE means that the item in position "i" should appear ahead of the item in position "j".

func (*Iterator) Next

func (iterator *Iterator) Next(output any) bool

Next moves the Iterator to the next position in the dataset. If there is another record in the dataset, it returns TRUE, and writes the next record to the "output" variable. If there are no more records, it returns FALSE.

func (*Iterator) Reset

func (iterator *Iterator) Reset()

Reset moves the iterator back to the beginning of the dataaset

func (*Iterator) Swap

func (iterator *Iterator) Swap(i int, j int)

Swpa swpas the elements with indexes i and j

type Server

type Server map[string][]data.Object

Server is a mock database

func (Server) Session

func (server Server) Session(ctx context.Context) (data.Session, error)

Session returns a session that can be used as a mock database.

type Session

type Session struct {
	Server  *Server
	Context context.Context
}

Session is a mock database session

func (Session) Close

func (session Session) Close()

Close cleans up any remaining data created by the mock session.

func (Session) Collection

func (session Session) Collection(collection string) data.Collection

Collection returns a reference to a collection of records