Documentation ¶
Overview ¶
Package mock provides minimal mocks for kivik driver interfaces. It is used internally in Kivik for testing.
Index ¶
- type AttachmentMetaGetter
- type Attachments
- type Authenticator
- type Bookmarker
- type BulkDocer
- type BulkGetter
- type BulkResults
- type Changes
- type Client
- func (c *Client) AllDBs(ctx context.Context, opts map[string]interface{}) ([]string, error)
- func (c *Client) CreateDB(ctx context.Context, dbname string, opts map[string]interface{}) error
- func (c *Client) DB(ctx context.Context, dbname string, opts map[string]interface{}) (driver.DB, error)
- func (c *Client) DBExists(ctx context.Context, dbname string, opts map[string]interface{}) (bool, error)
- func (c *Client) DestroyDB(ctx context.Context, dbname string, opts map[string]interface{}) error
- func (c *Client) Version(ctx context.Context) (*driver.Version, error)
- type ClientCloser
- type ClientReplicator
- type Cluster
- type Copier
- type DB
- func (db *DB) AllDocs(ctx context.Context, options map[string]interface{}) (driver.Rows, error)
- func (db *DB) Changes(ctx context.Context, opts map[string]interface{}) (driver.Changes, error)
- func (db *DB) Compact(ctx context.Context) error
- func (db *DB) CompactView(ctx context.Context, docID string) error
- func (db *DB) CreateDoc(ctx context.Context, doc interface{}, opts map[string]interface{}) (string, string, error)
- func (db *DB) Delete(ctx context.Context, docID, rev string, opts map[string]interface{}) (string, error)
- func (db *DB) DeleteAttachment(ctx context.Context, docID, rev, filename string, opts map[string]interface{}) (string, error)
- func (db *DB) Get(ctx context.Context, docID string, opts map[string]interface{}) (*driver.Document, error)
- func (db *DB) GetAttachment(ctx context.Context, docID, filename string, opts map[string]interface{}) (*driver.Attachment, error)
- func (db *DB) Put(ctx context.Context, docID string, doc interface{}, ...) (string, error)
- func (db *DB) PutAttachment(ctx context.Context, docID, rev string, att *driver.Attachment, ...) (string, error)
- func (db *DB) Query(ctx context.Context, ddoc, view string, opts map[string]interface{}) (driver.Rows, error)
- func (db *DB) Security(ctx context.Context) (*driver.Security, error)
- func (db *DB) SetSecurity(ctx context.Context, security *driver.Security) error
- func (db *DB) Stats(ctx context.Context) (*driver.DBStats, error)
- func (db *DB) ViewCleanup(ctx context.Context) error
- type DBCloser
- type DBUpdater
- type DBUpdates
- type DBsStatser
- type DesignDocer
- type Driver
- type Finder
- func (db *Finder) CreateIndex(ctx context.Context, ddoc, name string, index interface{}) error
- func (db *Finder) DeleteIndex(ctx context.Context, ddoc, name string) error
- func (db *Finder) Explain(ctx context.Context, query interface{}) (*driver.QueryPlan, error)
- func (db *Finder) Find(ctx context.Context, query interface{}) (driver.Rows, error)
- func (db *Finder) GetIndexes(ctx context.Context) ([]driver.Index, error)
- type Flusher
- type LocalDocer
- type MetaGetter
- type Pinger
- type Purger
- type Replication
- func (r *Replication) Delete(ctx context.Context) error
- func (r *Replication) EndTime() time.Time
- func (r *Replication) Err() error
- func (r *Replication) ReplicationID() string
- func (r *Replication) Source() string
- func (r *Replication) StartTime() time.Time
- func (r *Replication) State() string
- func (r *Replication) Target() string
- func (r *Replication) Update(ctx context.Context, rep *driver.ReplicationInfo) error
- type Rows
- type RowsWarner
- type Sessioner
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AttachmentMetaGetter ¶
type AttachmentMetaGetter struct { *DB GetAttachmentMetaFunc func(ctx context.Context, docID, filename string, options map[string]interface{}) (*driver.Attachment, error) }
AttachmentMetaGetter mocks a driver.DB and driver.AttachmentMetaGetter
func (*AttachmentMetaGetter) GetAttachmentMeta ¶
func (db *AttachmentMetaGetter) GetAttachmentMeta(ctx context.Context, docID, filename string, options map[string]interface{}) (*driver.Attachment, error)
GetAttachmentMeta calls db.GetAttachmentMetaFunc
type Attachments ¶
type Attachments struct { // ID identifies a specific Attachments instance ID string NextFunc func(*driver.Attachment) error CloseFunc func() error }
Attachments mocks driver.Attachments
func (*Attachments) Next ¶
func (a *Attachments) Next(att *driver.Attachment) error
Next calls a.NextFunc
type Authenticator ¶
Authenticator mocks driver.Client and driver.Authenticator
func (*Authenticator) Authenticate ¶
func (c *Authenticator) Authenticate(ctx context.Context, a interface{}) error
Authenticate calls c.AuthenticateFunc
type Bookmarker ¶
Bookmarker wraps driver.Bookmarker
type BulkDocer ¶
type BulkDocer struct { *DB BulkDocsFunc func(ctx context.Context, docs []interface{}, options map[string]interface{}) (driver.BulkResults, error) }
BulkDocer mocks a driver.DB and driver.BulkDocer
type BulkGetter ¶
type BulkGetter struct { *DB BulkGetFunc func(context.Context, []driver.BulkGetReference, map[string]interface{}) (driver.Rows, error) }
BulkGetter mocks a driver.DB and driver.BulkGetter
type BulkResults ¶
type BulkResults struct { // ID identifies a specific BulkResults instance ID string NextFunc func(*driver.BulkResult) error CloseFunc func() error }
BulkResults mocks driver.BulkResults
func (*BulkResults) Next ¶
func (r *BulkResults) Next(result *driver.BulkResult) error
Next calls r.NextFunc
type Client ¶
type Client struct { // ID identifies a specific Client instance ID string AllDBsFunc func(context.Context, map[string]interface{}) ([]string, error) CreateDBFunc func(context.Context, string, map[string]interface{}) error DBFunc func(context.Context, string, map[string]interface{}) (driver.DB, error) DBExistsFunc func(context.Context, string, map[string]interface{}) (bool, error) DestroyDBFunc func(context.Context, string, map[string]interface{}) error VersionFunc func(context.Context) (*driver.Version, error) }
Client mocks driver.Client
func (*Client) DB ¶
func (c *Client) DB(ctx context.Context, dbname string, opts map[string]interface{}) (driver.DB, error)
DB calls c.DBFunc
func (*Client) DBExists ¶
func (c *Client) DBExists(ctx context.Context, dbname string, opts map[string]interface{}) (bool, error)
DBExists calls c.DBExistsFunc
type ClientCloser ¶
ClientCloser mocks driver.Client and driver.ClientCloser
type ClientReplicator ¶
type ClientReplicator struct { *Client GetReplicationsFunc func(context.Context, map[string]interface{}) ([]driver.Replication, error) ReplicateFunc func(context.Context, string, string, map[string]interface{}) (driver.Replication, error) }
ClientReplicator mocks driver.Client and driver.ClientReplicator
func (*ClientReplicator) GetReplications ¶
func (c *ClientReplicator) GetReplications(ctx context.Context, opts map[string]interface{}) ([]driver.Replication, error)
GetReplications calls c.GetReplicationsFunc
func (*ClientReplicator) Replicate ¶
func (c *ClientReplicator) Replicate(ctx context.Context, target, source string, opts map[string]interface{}) (driver.Replication, error)
Replicate calls c.ReplicateFunc
type Cluster ¶
type Cluster struct { *Client ClusterStatusFunc func(context.Context, map[string]interface{}) (string, error) ClusterSetupFunc func(context.Context, interface{}) error }
Cluster mocks driver.Client and driver.Cluster
func (*Cluster) ClusterSetup ¶
ClusterSetup calls c.ClusterSetupFunc
type Copier ¶
type Copier struct { *DB CopyFunc func(context.Context, string, string, map[string]interface{}) (string, error) }
Copier mocks a driver.DB and driver.Copier.
type DB ¶
type DB struct { // ID is a unique identifier for the DB instance. ID string AllDocsFunc func(ctx context.Context, options map[string]interface{}) (driver.Rows, error) GetFunc func(ctx context.Context, docID string, options map[string]interface{}) (*driver.Document, error) CreateDocFunc func(ctx context.Context, doc interface{}, options map[string]interface{}) (docID, rev string, err error) PutFunc func(ctx context.Context, docID string, doc interface{}, options map[string]interface{}) (rev string, err error) DeleteFunc func(ctx context.Context, docID, rev string, options map[string]interface{}) (newRev string, err error) StatsFunc func(ctx context.Context) (*driver.DBStats, error) CompactFunc func(ctx context.Context) error CompactViewFunc func(ctx context.Context, ddocID string) error ViewCleanupFunc func(ctx context.Context) error SecurityFunc func(ctx context.Context) (*driver.Security, error) SetSecurityFunc func(ctx context.Context, security *driver.Security) error ChangesFunc func(ctx context.Context, options map[string]interface{}) (driver.Changes, error) PutAttachmentFunc func(ctx context.Context, docID, rev string, att *driver.Attachment, options map[string]interface{}) (newRev string, err error) GetAttachmentFunc func(ctx context.Context, docID, filename string, options map[string]interface{}) (*driver.Attachment, error) DeleteAttachmentFunc func(ctx context.Context, docID, rev, filename string, options map[string]interface{}) (newRev string, err error) QueryFunc func(context.Context, string, string, map[string]interface{}) (driver.Rows, error) }
DB mocks a driver.DB
func (*DB) CompactView ¶
CompactView calls db.CompactViewFunc
func (*DB) CreateDoc ¶
func (db *DB) CreateDoc(ctx context.Context, doc interface{}, opts map[string]interface{}) (string, string, error)
CreateDoc calls db.CreateDocFunc
func (*DB) Delete ¶
func (db *DB) Delete(ctx context.Context, docID, rev string, opts map[string]interface{}) (string, error)
Delete calls db.DeleteFunc
func (*DB) DeleteAttachment ¶
func (db *DB) DeleteAttachment(ctx context.Context, docID, rev, filename string, opts map[string]interface{}) (string, error)
DeleteAttachment calls db.DeleteAttachmentFunc
func (*DB) Get ¶
func (db *DB) Get(ctx context.Context, docID string, opts map[string]interface{}) (*driver.Document, error)
Get calls db.GetFunc
func (*DB) GetAttachment ¶
func (db *DB) GetAttachment(ctx context.Context, docID, filename string, opts map[string]interface{}) (*driver.Attachment, error)
GetAttachment calls db.GetAttachmentFunc
func (*DB) Put ¶
func (db *DB) Put(ctx context.Context, docID string, doc interface{}, opts map[string]interface{}) (string, error)
Put calls db.PutFunc
func (*DB) PutAttachment ¶
func (db *DB) PutAttachment(ctx context.Context, docID, rev string, att *driver.Attachment, opts map[string]interface{}) (string, error)
PutAttachment calls db.PutAttachmentFunc
func (*DB) Query ¶
func (db *DB) Query(ctx context.Context, ddoc, view string, opts map[string]interface{}) (driver.Rows, error)
Query calls db.QueryFunc
func (*DB) SetSecurity ¶
SetSecurity calls db.SetSecurityFunc
type DBUpdates ¶
type DBUpdates struct { // ID identifies a specific DBUpdates instance. ID string NextFunc func(*driver.DBUpdate) error CloseFunc func() error }
DBUpdates mocks driver.DBUpdates
type DBsStatser ¶
type DBsStatser struct { *Client DBsStatsFunc func(context.Context, []string) ([]*driver.DBStats, error) }
DBsStatser mocks driver.Client and driver.DBsStatser
type DesignDocer ¶
type DesignDocer struct { *DB DesignDocsFunc func(context.Context, map[string]interface{}) (driver.Rows, error) }
DesignDocer mocks a driver.DB and driver.DesignDocer
func (*DesignDocer) DesignDocs ¶
func (db *DesignDocer) DesignDocs(ctx context.Context, options map[string]interface{}) (driver.Rows, error)
DesignDocs calls db.DesignDocsFunc
type Finder ¶
type Finder struct { *DB CreateIndexFunc func(context.Context, string, string, interface{}) error DeleteIndexFunc func(context.Context, string, string) error FindFunc func(context.Context, interface{}) (driver.Rows, error) GetIndexesFunc func(context.Context) ([]driver.Index, error) ExplainFunc func(context.Context, interface{}) (*driver.QueryPlan, error) }
Finder mocks a driver.DB and driver.Finder
func (*Finder) CreateIndex ¶
CreateIndex calls db.CreateIndexFunc
func (*Finder) DeleteIndex ¶
DeleteIndex calls db.DeleteIndexFunc
type LocalDocer ¶
type LocalDocer struct { *DB LocalDocsFunc func(context.Context, map[string]interface{}) (driver.Rows, error) }
LocalDocer mocks a driver.DB and driver.DesignDocer
type MetaGetter ¶
type MetaGetter struct { *DB GetMetaFunc func(context.Context, string, map[string]interface{}) (int64, string, error) }
MetaGetter mocks a driver.DB and driver.MetaGetter
type Purger ¶
type Purger struct { *DB PurgeFunc func(context.Context, map[string][]string) (*driver.PurgeResult, error) }
Purger mocks a driver.DB and driver.Purger
type Replication ¶
type Replication struct { // ID identifies a specific Replication instance ID string DeleteFunc func(context.Context) error StartTimeFunc func() time.Time EndTimeFunc func() time.Time ErrFunc func() error ReplicationIDFunc func() string SourceFunc func() string TargetFunc func() string StateFunc func() string UpdateFunc func(context.Context, *driver.ReplicationInfo) error }
Replication mocks driver.Replication
func (*Replication) Delete ¶
func (r *Replication) Delete(ctx context.Context) error
Delete calls r.DeleteFunc
func (*Replication) ReplicationID ¶
func (r *Replication) ReplicationID() string
ReplicationID calls r.ReplicatoinIDFunc
func (*Replication) Source ¶
func (r *Replication) Source() string
Source calls r.SourceFunc or returns a default value if SourceFunc is nil
func (*Replication) StartTime ¶
func (r *Replication) StartTime() time.Time
StartTime calls r.StartTimeFunc
func (*Replication) Target ¶
func (r *Replication) Target() string
Target calls r.TargetFunc or returns a default if TargetFunc is nil
func (*Replication) Update ¶
func (r *Replication) Update(ctx context.Context, rep *driver.ReplicationInfo) error
Update calls r.UpdateFunc
type Rows ¶
type Rows struct { // ID identifies a specific Rows instance. ID string CloseFunc func() error NextFunc func(*driver.Row) error OffsetFunc func() int64 TotalRowsFunc func() int64 UpdateSeqFunc func() string }
Rows mocks driver.Rows
type RowsWarner ¶
RowsWarner wraps driver.RowsWarner