cachetype

Documentation

Overview

Code generated by mockery v1.0.0

Index

• Constants
• func ConnectCALeafSuccess(authorityKeyID string) interface{}
• func TestFetchCh(t testing.T, typ cache.Type, opts cache.FetchOptions, req cache.Request) <-chan interface{}
• func TestFetchChResult(t testing.T, ch <-chan interface{}, expected interface{})
• type Agent
• type CatalogDatacenters
  • func (c *CatalogDatacenters) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type CatalogListServices
  • func (c *CatalogListServices) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type CatalogServiceList
  • func (c *CatalogServiceList) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type CatalogServices
  • func (c *CatalogServices) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type CompiledDiscoveryChain
  • func (c *CompiledDiscoveryChain) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type ConfigEntries
  • func (c *ConfigEntries) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type ConfigEntry
  • func (c *ConfigEntry) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type ConnectCALeaf
  • func (c *ConnectCALeaf) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type ConnectCALeafRequest
  • func (r *ConnectCALeafRequest) CacheInfo() cache.RequestInfo
  • func (r *ConnectCALeafRequest) Key() string
  • func (req *ConnectCALeafRequest) TargetNamespace() string
• type ConnectCARoot
  • func (c *ConnectCARoot) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type FederationStateListMeshGateways
  • func (c *FederationStateListMeshGateways) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type GatewayServices
  • func (g *GatewayServices) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type HealthServices
  • func (c *HealthServices) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type IntentionMatch
  • func (c *IntentionMatch) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type InternalServiceDump
  • func (c *InternalServiceDump) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type MaterializerDeps
• type MockRPC
  • func TestRPC(t testing.T) *MockRPC
  • func (_m *MockRPC) RPC(method string, args interface{}, reply interface{}) error
• type NodeServices
  • func (c *NodeServices) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type PreparedQuery
  • func (c *PreparedQuery) Fetch(_ cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type RPC
• type RegisterOptionsBlockingNoRefresh
  • func (r RegisterOptionsBlockingNoRefresh) RegisterOptions() cache.RegisterOptions
• type RegisterOptionsBlockingRefresh
  • func (r RegisterOptionsBlockingRefresh) RegisterOptions() cache.RegisterOptions
• type RegisterOptionsNoRefresh
  • func (r RegisterOptionsNoRefresh) RegisterOptions() cache.RegisterOptions
• type ResolvedServiceConfig
  • func (c *ResolvedServiceConfig) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type ServiceHTTPChecks
  • func (c *ServiceHTTPChecks) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
• type ServiceHTTPChecksRequest
  • func (s *ServiceHTTPChecksRequest) CacheInfo() cache.RequestInfo
• type StreamingHealthServices
  • func NewStreamingHealthServices(deps MaterializerDeps) *StreamingHealthServices
  • func (c *StreamingHealthServices) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
  • func (c *StreamingHealthServices) RegisterOptions() cache.RegisterOptions

Constants

const (
	ConfigEntriesName = "config-entries"
	ConfigEntryName   = "config-entry"
)

Recommended name for registration.

const CatalogDatacentersName = "catalog-datacenters"

Recommended name for registration.

const CatalogListServicesName = "catalog-list-services"

Recommended name for registration.

const CatalogServiceListName = "catalog-services-list"

Recommended name for registration.

const CatalogServicesName = "catalog-services"

Recommended name for registration.

const CompiledDiscoveryChainName = "compiled-discovery-chain"

Recommended name for registration.

const ConnectCALeafName = "connect-ca-leaf"

Recommended name for registration.

const ConnectCARootName = "connect-ca-root"

Recommended name for registration.

const FederationStateListMeshGatewaysName = "federation-state-list-mesh-gateways"

Recommended name for registration.

const GatewayServicesName = "gateway-services"

Recommended name for registration.

const HealthServicesName = "health-services"

Recommended name for registration.

const IntentionMatchName = "intention-match"

Recommended name for registration.

const InternalServiceDumpName = "service-dump"

Recommended name for registration.

const NodeServicesName = "node-services"

Recommended name for registration.

const PreparedQueryName = "prepared-query"

Recommended name for registration.

const ResolvedServiceConfigName = "resolved-service-config"

Recommended name for registration.

const ServiceHTTPChecksName = "service-http-checks"

Recommended name for registration.

const (
	// Recommended name for registration.
	StreamingHealthServicesName = "streaming-health-services"
)

Functions

func ConnectCALeafSuccess

func ConnectCALeafSuccess(authorityKeyID string) interface{}

func TestFetchCh

func TestFetchCh(
	t testing.T,
	typ cache.Type,
	opts cache.FetchOptions,
	req cache.Request,
) <-chan interface{}

TestFetchCh returns a channel that returns the result of the Fetch call. This is useful for testing timing and concurrency with Fetch calls. Errors will show up as an error type on the resulting channel so a type switch should be used.

func TestFetchChResult

func TestFetchChResult(t testing.T, ch <-chan interface{}, expected interface{})

TestFetchChResult tests that the result from TestFetchCh matches within a reasonable period of time (it expects it to be "immediate" but waits some milliseconds).

Types

type Agent

type Agent interface {
	ServiceHTTPBasedChecks(id structs.ServiceID) []structs.CheckType
	LocalState() *local.State
	LocalBlockingQuery(alwaysBlock bool, hash string, wait time.Duration,
		fn func(ws memdb.WatchSet) (string, interface{}, error)) (string, interface{}, error)
}

type CatalogDatacenters

type CatalogDatacenters struct {
	RegisterOptionsNoRefresh
	RPC RPC
}

Datacenters supports fetching discovering all the known datacenters

func (*CatalogDatacenters) Fetch

func (c *CatalogDatacenters) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type CatalogListServices

type CatalogListServices struct {
	RegisterOptionsBlockingRefresh
	RPC RPC
}

CatalogListServices supports fetching discovering service names via the catalog.

func (*CatalogListServices) Fetch

func (c *CatalogListServices) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type CatalogServiceList

type CatalogServiceList struct {
	RegisterOptionsBlockingRefresh
	RPC RPC
}

CatalogServiceList supports fetching service names via the catalog.

func (*CatalogServiceList) Fetch

func (c *CatalogServiceList) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type CatalogServices

type CatalogServices struct {
	RegisterOptionsBlockingRefresh
	RPC RPC
}

CatalogServices supports fetching discovering service instances via the catalog.

func (*CatalogServices) Fetch

func (c *CatalogServices) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type CompiledDiscoveryChain

type CompiledDiscoveryChain struct {
	RegisterOptionsBlockingRefresh
	RPC RPC
}

CompiledDiscoveryChain supports fetching the complete discovery chain for a service and caching its compilation.

func (*CompiledDiscoveryChain) Fetch

func (c *CompiledDiscoveryChain) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type ConfigEntries

type ConfigEntries struct {
	RegisterOptionsBlockingRefresh
	RPC RPC
}

ConfigEntries supports fetching discovering configuration entries

func (*ConfigEntries) Fetch

func (c *ConfigEntries) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type ConfigEntry

type ConfigEntry struct {
	RegisterOptionsBlockingRefresh
	RPC RPC
}

ConfigEntry supports fetching a single configuration entry.

func (*ConfigEntry) Fetch

func (c *ConfigEntry) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type ConnectCALeaf

type ConnectCALeaf struct {
	RegisterOptionsBlockingNoRefresh

	RPC        RPC          // RPC client for remote requests
	Cache      *cache.Cache // Cache that has CA root certs via ConnectCARoot
	Datacenter string       // This agent's datacenter

	// TestOverrideCAChangeInitialDelay allows overriding the random jitter after a
	// root change with a fixed delay. So far ths is only done in tests. If it's
	// zero the caChangeInitialSpreadDefault maximum jitter will be used but if
	// set, it overrides and provides a fixed delay. To essentially disable the
	// delay in tests they can set it to 1 nanosecond. We may separately allow
	// configuring the jitter limit by users later but this is different and for
	// tests only since we need to set a deterministic time delay in order to test
	// the behavior here fully and determinstically.
	TestOverrideCAChangeInitialDelay time.Duration
	// contains filtered or unexported fields
}

ConnectCALeaf supports fetching and generating Connect leaf certificates.

func (*ConnectCALeaf) Fetch

func (c *ConnectCALeaf) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type ConnectCALeafRequest

type ConnectCALeafRequest struct {
	Token          string
	Datacenter     string
	Service        string // Service name, not ID
	Agent          string // Agent name, not ID
	DNSSAN         []string
	IPSAN          []net.IP
	MinQueryIndex  uint64
	MaxQueryTime   time.Duration
	MustRevalidate bool

	structs.EnterpriseMeta
}

ConnectCALeafRequest is the cache.Request implementation for the ConnectCALeaf cache type. This is implemented here and not in structs since this is only used for cache-related requests and not forwarded directly to any Consul servers.

func (*ConnectCALeafRequest) CacheInfo

func (r *ConnectCALeafRequest) CacheInfo() cache.RequestInfo

func (*ConnectCALeafRequest) Key

func (r *ConnectCALeafRequest) Key() string

func (*ConnectCALeafRequest) TargetNamespace

func (req *ConnectCALeafRequest) TargetNamespace() string

type ConnectCARoot

type ConnectCARoot struct {
	RegisterOptionsBlockingRefresh
	RPC RPC
}

ConnectCARoot supports fetching the Connect CA roots. This is a straightforward cache type since it only has to block on the given index and return the data.

func (*ConnectCARoot) Fetch

func (c *ConnectCARoot) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type FederationStateListMeshGateways

type FederationStateListMeshGateways struct {
	RegisterOptionsBlockingRefresh
	RPC RPC
}

FederationState supports fetching federation states.

func (*FederationStateListMeshGateways) Fetch

func (c *FederationStateListMeshGateways) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type GatewayServices

type GatewayServices struct {
	RegisterOptionsBlockingRefresh
	RPC RPC
}

GatewayUpstreams supports fetching upstreams for a given gateway name.

func (*GatewayServices) Fetch

func (g *GatewayServices) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type HealthServices

type HealthServices struct {
	RegisterOptionsBlockingRefresh
	RPC RPC
}

HealthServices supports fetching discovering service instances via the catalog.

func (*HealthServices) Fetch

func (c *HealthServices) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type IntentionMatch

type IntentionMatch struct {
	RegisterOptionsBlockingRefresh
	RPC RPC
}

IntentionMatch supports fetching the intentions via match queries.

func (*IntentionMatch) Fetch

func (c *IntentionMatch) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type InternalServiceDump

type InternalServiceDump struct {
	RegisterOptionsBlockingRefresh
	RPC RPC
}

InternalServiceDump supports fetching discovering service names via the catalog.

func (*InternalServiceDump) Fetch

func (c *InternalServiceDump) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type MaterializerDeps

type MaterializerDeps struct {
	Client submatview.StreamClient
	Logger hclog.Logger
}

type MockRPC

type MockRPC struct {
	mock.Mock
}

MockRPC is an autogenerated mock type for the RPC type

func TestRPC

func TestRPC(t testing.T) *MockRPC

TestRPC returns a mock implementation of the RPC interface.

func (*MockRPC) RPC

func (_m *MockRPC) RPC(method string, args interface{}, reply interface{}) error

RPC provides a mock function with given fields: method, args, reply

type NodeServices

type NodeServices struct {
	RegisterOptionsBlockingRefresh
	RPC RPC
}

NodeServices supports fetching discovering service instances via the catalog.

func (*NodeServices) Fetch

func (c *NodeServices) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type PreparedQuery

type PreparedQuery struct {
	RegisterOptionsNoRefresh
	RPC RPC
}

PreparedQuery supports fetching discovering service instances via prepared queries.

func (*PreparedQuery) Fetch

func (c *PreparedQuery) Fetch(_ cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type RPC

type RPC interface {
	RPC(method string, args interface{}, reply interface{}) error
}

RPC is an interface that an RPC client must implement. This is a helper interface that is implemented by the agent delegate so that Type implementations can request RPC access.

type RegisterOptionsBlockingNoRefresh

type RegisterOptionsBlockingNoRefresh struct{}

func (RegisterOptionsBlockingNoRefresh) RegisterOptions

func (r RegisterOptionsBlockingNoRefresh) RegisterOptions() cache.RegisterOptions

type RegisterOptionsBlockingRefresh

type RegisterOptionsBlockingRefresh struct{}

RegisterOptionsBlockingRefresh can be embedded into a struct to implement part of the agent/cache.Type interface. When embedded into a struct it identifies the cache type as one which supports blocking, and uses refresh to keep the cache fresh.

func (RegisterOptionsBlockingRefresh) RegisterOptions

func (r RegisterOptionsBlockingRefresh) RegisterOptions() cache.RegisterOptions

type RegisterOptionsNoRefresh

type RegisterOptionsNoRefresh struct{}

RegisterOptionsNoRefresh can be embedded into a struct to implement part of the agent/cache.Type interface. When embedded into a struct it identifies the cache type as one which does not support blocking, and should not be refreshed.

func (RegisterOptionsNoRefresh) RegisterOptions

func (r RegisterOptionsNoRefresh) RegisterOptions() cache.RegisterOptions

type ResolvedServiceConfig

type ResolvedServiceConfig struct {
	RegisterOptionsBlockingRefresh
	RPC RPC
}

ResolvedServiceConfig supports fetching the config for a service resolved from the global proxy defaults and the centrally registered service config.

func (*ResolvedServiceConfig) Fetch

func (c *ResolvedServiceConfig) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type ServiceHTTPChecks

type ServiceHTTPChecks struct {
	RegisterOptionsBlockingRefresh
	Agent Agent
}

ServiceHTTPBasedChecks supports fetching discovering checks in the local state

func (*ServiceHTTPChecks) Fetch

func (c *ServiceHTTPChecks) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

type ServiceHTTPChecksRequest

type ServiceHTTPChecksRequest struct {
	ServiceID     string
	MinQueryIndex uint64
	MaxQueryTime  time.Duration
	structs.EnterpriseMeta
}

ServiceHTTPChecksRequest is the cache.Request implementation for the ServiceHTTPBasedChecks cache type. This is implemented here and not in structs since this is only used for cache-related requests and not forwarded directly to any Consul servers.

func (*ServiceHTTPChecksRequest) CacheInfo

func (s *ServiceHTTPChecksRequest) CacheInfo() cache.RequestInfo

type StreamingHealthServices

type StreamingHealthServices struct {
	RegisterOptionsBlockingRefresh
	// contains filtered or unexported fields
}

StreamingHealthServices supports fetching discovering service instances via the catalog using the streaming gRPC endpoint.

func NewStreamingHealthServices

func NewStreamingHealthServices(deps MaterializerDeps) *StreamingHealthServices

NewStreamingHealthServices creates a cache-type for watching for service health results via streaming updates.

func (*StreamingHealthServices) Fetch

func (c *StreamingHealthServices) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)

Fetch service health from the materialized view. If no materialized view exists, create one and start it running in a goroutine. The goroutine will exit when the cache entry storing the result is expired, the cache will call Close on the result.State.

Fetch implements part of the cache.Type interface, and assumes that the caller ensures that only a single call to Fetch is running at any time.

func (*StreamingHealthServices) RegisterOptions

func (c *StreamingHealthServices) RegisterOptions() cache.RegisterOptions

RegisterOptions returns options with a much shorter LastGetTTL than the default. Unlike other cache-types, StreamingHealthServices runs a materialized view in the background which will receive streamed events from a server. If the cache is not being used, that stream uses memory on the server and network transfer between the client and the server. The materialize view and the stream are stopped when the cache entry expires, so using a shorter TTL ensures the cache entry expires sooner.