mock

type AnalyticsHookFunc func(source AnalyticsService, req *HTTPRequest, next func() *HTTPResponse) *HTTPResponse

type AnalyticsHookManager interface {
	// Child returns a child hook manager to this hook manager.
	Child() AnalyticsHookManager

	// Add adds a new hook at the end of the processing chain.
	Add(fn AnalyticsHookFunc)

	// Destroy removes all this managers hooks from the root manager.
	Destroy()
}

type AnalyticsService interface {
	// Node returns the node which owns this service.
	Node() ClusterNode

	// Hostname returns the hostname where this service can be accessed.
	Hostname() string

	// ListenPort returns the port this service is listening on.
	ListenPort() int

	// ListenPortTLS returns the TLS port this service is listening on.
	ListenPortTLS() int

	// Close will shut down this service once it is no longer needed.
	Close() error

	// CheckAuthenticated verifies that the currently authenticated user has the specified permissions.
	CheckAuthenticated(permission mockauth.Permission, bucket, scope, collection string, request *HTTPRequest) bool
}

type Bucket interface {
	// ID returns the uuid of this bucket.
	ID() string

	// Name returns the name of this bucket
	Name() string

	// BucketType returns the type of bucket this is.
	BucketType() BucketType

	// NumReplicas returns the number of configured replicas for this bucket
	NumReplicas() uint

	// ConfigRev returns the current configuration revision for this bucket.
	ConfigRev() uint

	// CollectionManifest returns the collection manifest of this bucket.
	CollectionManifest() *CollectionManifest

	// Store returns the data-store for this bucket.
	Store() *mockdb.Bucket

	// UpdateVbMap will update the vbmap such that all vbuckets are assigned to the
	// specific nodes which are passed in.  Note that this rebalance is guarenteed to
	// be very explicit such that vbNode = (vbId % numNode), and replicas are just ++.
	UpdateVbMap(nodeList []string)

	// GetVbServerInfo returns the vb nodes, then the vb map, then the ordered list of all nodes
	GetVbServerInfo(reqNode ClusterNode) ([]ClusterNode, [][]int, []ClusterNode)

	// VbucketOwnership returns the replica index associated with the provided node.
	// A response of -1 means it does not own any replicas for that vbucket.
	VbucketOwnership(node ClusterNode) []int

	// ViewIndexManager returns the view index manager for this bucket.
	ViewIndexManager() ViewIndexManager

	// Flush will remove all items from containing vbuckets and reset the high seq no.
	// Returning true if the flush was successful.
	Flush()

	// FlushEnabled returns whether or not flush is enabled for this bucket.
	FlushEnabled() bool

	// RamQuota returns the ram quota assigned to this bucket.
	RamQuota() uint64

	// ReplicaIndexEnabled returns whether or not replica index is enabled for this bucket.
	ReplicaIndexEnabled() bool

	// Update updates the settings for this bucket.
	Update(opts UpdateBucketOptions) error

	// CompressionMode returns the compression mode used by this bucket.
	CompressionMode() CompressionMode
}

type BucketStore interface {
	Chrono() *mocktime.Chrono
}

type BucketType uint

type Cluster interface {
	// ID returns the uuid of this cluster.
	ID() string

	// ConfigRev returns the current configuration revision for this cluster.
	ConfigRev() uint

	// AddNode will add a new node to a cluster.
	AddNode(opts NewNodeOptions) (ClusterNode, error)

	// AddBucket will add a new bucket to a cluster.
	AddBucket(opts NewBucketOptions) (Bucket, error)

	// DeleteBucket will remove a bucket from a cluster.
	DeleteBucket(name string) error

	// Nodes returns a list of all the nodes in this cluster.
	Nodes() []ClusterNode

	// GetBucket will return a specific bucket from the cluster.
	GetBucket(name string) Bucket

	// GetAllBuckets will return all buckets from the cluster.
	GetAllBuckets() []Bucket

	// ConnectionString returns the basic non-TLS connection string for this cluster.
	ConnectionString() string

	// MgmtHosts returns a list of non-TLS mgmt endpoints for this cluster.
	MgmtAddrs() []string

	// KvInHooks returns the hook manager for incoming kv packets.
	KvInHooks() KvHookManager

	// KvOutHooks returns the hook manager for outgoing kv packets.
	KvOutHooks() KvHookManager

	// MgmtHooks returns the hook manager for management requests.
	MgmtHooks() MgmtHookManager

	// Chrono returns the chrono object in use by the cluster.
	Chrono() *mocktime.Chrono

	// Users returns the user service for the cluster.
	Users() UserManager

	// AddConfigWatcher adds a watcher for any configs that come in.
	AddConfigWatcher(ConfigWatcher)

	// RemoveConfigWatcher remover a config watcher.
	RemoveConfigWatcher(ConfigWatcher)
}

type ClusterNode interface {
	// ID returns the uuid of this node.
	ID() string

	// Cluster returns the Cluster this node is part of.
	Cluster() Cluster

	// KvService returns the kv service for this node.
	KvService() KvService

	// MgmtService returns the mgmt service for this node.
	MgmtService() MgmtService

	// ViewService returns the views service for this node.
	ViewService() ViewService

	// QueryService returns the query service for this node.
	QueryService() QueryService

	// SearchService returns the search service for this node.
	SearchService() SearchService

	// AnalyticsService returns the analytics service for this node.
	AnalyticsService() AnalyticsService

	// ErrorMap returns the error map for this node.
	ErrorMap() *ErrorMap

	// HostName returns the address for this node.
	Hostname() string
}

type ClusterNodeFeature string

type CollectionManifest struct {
	Rev         uint64
	Scopes      map[uint32]*collectionManifestScopeEntry
	Collections map[uint32]*collectionManifestCollectionEntry
	// contains filtered or unexported fields
}

type CollectionManifestCollection struct {
	Name   string
	UID    uint32
	MaxTTL uint32
}

type CollectionManifestScope struct {
	Name        string
	UID         uint32
	Collections []CollectionManifestCollection
}

type CompressionMode string

type ConfigWatcher interface {
	OnNewConfig(cfg uint)
}

type ErrorMap struct {
	Version  int                      `json:"version"`
	Revision int                      `json:"revision"`
	Errors   map[string]ErrorMapError `json:"errors"`
}

type ErrorMapError struct {
	Name  string         `json:"name"`
	Desc  string         `json:"desc"`
	Attrs []string       `json:"attrs"`
	Retry *ErrorMapRetry `json:"retry,omitempty"`
}

type ErrorMapRetry struct {
	Strategy    string `json:"strategy"`
	Interval    int    `json:"interval"`
	After       int    `json:"after"`
	MaxDuration int    `json:"max-duration"`
	Ceil        int    `json:"ceil,omitempty"`
}

type HTTPRequest struct {
	IsTLS   bool
	Method  string
	URL     *url.URL
	Header  http.Header
	Body    io.Reader
	Form    url.Values
	Context context.Context
	Flusher http.Flusher
}

type HTTPResponse struct {
	StatusCode int
	Header     http.Header
	Body       io.Reader
	Streaming  bool
}

type KvClient interface {
	// LocalAddr returns the local address of this client.
	LocalAddr() net.Addr

	// RemoteAddr returns the remote address of this client.
	RemoteAddr() net.Addr

	// IsTLS returns whether this client is connected via TLS
	IsTLS() bool

	// Source returns the KvService which owns this client.
	Source() KvService

	// ScramServer returns a SCRAM server object specific to this user.
	ScramServer() *scramserver.ScramServer

	// SetAuthenticatedUserName sets the name of the user who is authenticated.
	SetAuthenticatedUserName(userName string)

	// AuthenticatedUserName gets the name of the user who is authenticated.
	AuthenticatedUserName() string

	// CheckAuthenticated verifies that the currently authenticated user has the specified permissions.
	CheckAuthenticated(permission mockauth.Permission, collectionID uint32) bool

	// SetSelectedBucketName sets the currently selected bucket's name.
	SetSelectedBucketName(bucketName string)

	// SelectedBucketName returns the currently selected bucket's name.
	SelectedBucketName() string

	// SelectedBucket returns the currently selected bucket.
	SelectedBucket() Bucket

	// SetFeatures sets the list of support features for this client.
	SetFeatures(features []memd.HelloFeature)

	// HasFeature indicates whether or not this client supports a feature.
	HasFeature(feature memd.HelloFeature) bool

	// WritePacket tries to write data to the underlying connection.
	WritePacket(pak *memd.Packet) error

	// Close attempts to close the connection.
	Close() error
}

type KvHookFunc func(source KvClient, pak *memd.Packet, start time.Time, next func())

type KvHookManager interface {
	// Child returns a child hook manager to this hook manager.
	Child() KvHookManager

	// Add adds a new hook at the end of the processing chain.
	Add(fn KvHookFunc)

	// Destroy removes all this managers hooks from the root manager.
	Destroy()
}

type KvService interface {
	// Node returns the ClusterNode which owns this service.
	Node() ClusterNode

	// Hostname returns the hostname where this service can be accessed.
	Hostname() string

	// ListenPort returns the port this service is listening on.
	ListenPort() int

	// ListenPortTLS returns the TLS port this service is listening on.
	ListenPortTLS() int

	// GetAllClients returns a list of all the clients connected to this service.
	GetAllClients() []KvClient

	// Close will shut down this service once it is no longer needed.
	Close() error
}

type MgmtHookFunc func(source MgmtService, req *HTTPRequest, next func() *HTTPResponse) *HTTPResponse

type MgmtHookManager interface {
	// Child returns a child hook manager to this hook manager.
	Child() MgmtHookManager

	// Add adds a new hook at the end of the processing chain.
	Add(fn MgmtHookFunc)

	// Destroy removes all this managers hooks from the root manager.
	Destroy()
}

type MgmtService interface {
	// Node returns the node which owns this service.
	Node() ClusterNode

	// Hostname returns the hostname where this service can be accessed.
	Hostname() string

	// ListenPort returns the port this service is listening on.
	ListenPort() int

	// ListenPortTLS returns the TLS port this service is listening on.
	ListenPortTLS() int

	// Close will shut down this service once it is no longer needed.
	Close() error

	// CheckAuthenticated verifies that the currently authenticated user has the specified permissions.
	CheckAuthenticated(permission mockauth.Permission, bucket, scope, collection string, request *HTTPRequest) bool
}

type NewBucketOptions struct {
	Name                string
	Type                BucketType
	NumReplicas         uint
	FlushEnabled        bool
	RamQuota            uint64
	ReplicaIndexEnabled bool
	CompressionMode     CompressionMode
}

type NewClusterOptions struct {
	Chrono         *mocktime.Chrono
	NumVbuckets    uint
	InitialNode    NewNodeOptions
	ReplicaLatency time.Duration
	PersistLatency time.Duration
}

type NewNodeOptions struct {
	Features []ClusterNodeFeature
	Services []ServiceType
}

type QueryHookFunc func(source QueryService, req *HTTPRequest, next func() *HTTPResponse) *HTTPResponse

type QueryHookManager interface {
	// Child returns a child hook manager to this hook manager.
	Child() QueryHookManager

	// Add adds a new hook at the end of the processing chain.
	Add(fn QueryHookFunc)

	// Destroy removes all this managers hooks from the root manager.
	Destroy()
}

type QueryService interface {
	// Node returns the node which owns this service.
	Node() ClusterNode

	// Hostname returns the hostname where this service can be accessed.
	Hostname() string

	// ListenPort returns the port this service is listening on.
	ListenPort() int

	// ListenPortTLS returns the TLS port this service is listening on.
	ListenPortTLS() int

	// Close will shut down this service once it is no longer needed.
	Close() error

	// CheckAuthenticated verifies that the currently authenticated user has the specified permissions.
	CheckAuthenticated(permission mockauth.Permission, bucket, scope, collection string, request *HTTPRequest) bool
}

type SearchHookFunc func(source SearchService, req *HTTPRequest, next func() *HTTPResponse) *HTTPResponse

type SearchHookManager interface {
	// Child returns a child hook manager to this hook manager.
	Child() SearchHookManager

	// Add adds a new hook at the end of the processing chain.
	Add(fn SearchHookFunc)

	// Destroy removes all this managers hooks from the root manager.
	Destroy()
}

type SearchService interface {
	// Node returns the node which owns this service.
	Node() ClusterNode

	// Hostname returns the hostname where this service can be accessed.
	Hostname() string

	// ListenPort returns the port this service is listening on.
	ListenPort() int

	// ListenPortTLS returns the TLS port this service is listening on.
	ListenPortTLS() int

	// Close will shut down this service once it is no longer needed.
	Close() error

	// CheckAuthenticated verifies that the currently authenticated user has the specified permissions.
	CheckAuthenticated(permission mockauth.Permission, bucket, scope, collection string, request *HTTPRequest) bool
}

type ServiceType uint

type UpdateBucketOptions struct {
	NumReplicas         uint
	FlushEnabled        bool
	RamQuota            uint64
	ReplicaIndexEnabled bool
	CompressionMode     CompressionMode
}

type UserManager interface {
	// AddUser will add a new user to a cluster.
	UpsertUser(opts mockauth.UpsertUserOptions) error

	// GetUser will return a specific user from the cluster.
	GetUser(username string) *mockauth.User

	// GetAllUsers will return all of the users from the cluster.
	GetAllUsers() []*mockauth.User

	// DropUser will remove a specific user from the cluster.
	DropUser(username string) error

	// GetAllClusterRoles will return all roles from the cluster.
	GetAllClusterRoles() []*mockauth.ClusterRole
}

type ViewHookFunc func(source ViewService, req *HTTPRequest, next func() *HTTPResponse) *HTTPResponse

type ViewHookManager interface {
	// Child returns a child hook manager to this hook manager.
	Child() ViewHookManager

	// Add adds a new hook at the end of the processing chain.
	Add(fn ViewHookFunc)

	// Destroy removes all this managers hooks from the root manager.
	Destroy()
}

type ViewIndexManager interface {
	// UpsertDesignDocument creates or updates a design document.
	UpsertDesignDocument(name string, opts mockmr.UpsertDesignDocumentOptions) error

	// DropDesignDocument removes a design document.
	DropDesignDocument(name string) error

	// GetDesignDocument retrieves a single design document.
	GetDesignDocument(name string) (*mockmr.DesignDocument, error)

	// GetAllDesignDocuments retrieves all design documents.
	GetAllDesignDocuments() []*mockmr.DesignDocument

	// Execute executes a query.
	Execute(opts mockmr.ExecuteOptions) (int, *mockmr.ExecuteResults, error)
}

type ViewService interface {
	// Node returns the node which owns this service.
	Node() ClusterNode

	// Hostname returns the hostname where this service can be accessed.
	Hostname() string

	// ListenPort returns the port this service is listening on.
	ListenPort() int

	// ListenPortTLS returns the TLS port this service is listening on.
	ListenPortTLS() int

	// Close will shut down this service once it is no longer needed.
	Close() error

	// CheckAuthenticated verifies that the currently authenticated user has the specified permissions.
	CheckAuthenticated(permission mockauth.Permission, bucket, scope, collection string, request *HTTPRequest) bool
}