cachetype

Documentation

Overview

Code generated by mockery v1.0.0

Index

• Constants
• 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 CatalogServices
  • func (c *CatalogServices) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
  • func (c *CatalogServices) SupportsBlocking() bool
• type ConnectCALeaf
  • func (c *ConnectCALeaf) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
  • func (c *ConnectCALeaf) SupportsBlocking() bool
• type ConnectCALeafRequest
  • func (r *ConnectCALeafRequest) CacheInfo() cache.RequestInfo
• type ConnectCARoot
  • func (c *ConnectCARoot) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
  • func (c *ConnectCARoot) SupportsBlocking() bool
• type HealthServices
  • func (c *HealthServices) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
  • func (c *HealthServices) SupportsBlocking() bool
• type IntentionMatch
  • func (c *IntentionMatch) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
  • func (c *IntentionMatch) SupportsBlocking() bool
• type MockRPC
  • func TestRPC(t testing.T) *MockRPC
  • func (_m *MockRPC) RPC(method string, args interface{}, reply interface{}) error
• type PreparedQuery
  • func (c *PreparedQuery) Fetch(opts cache.FetchOptions, req cache.Request) (cache.FetchResult, error)
  • func (c *PreparedQuery) SupportsBlocking() bool
• type RPC

Constants

const CatalogServicesName = "catalog-services"

Recommended name for registration.

const ConnectCALeafName = "connect-ca-leaf"

Recommended name for registration.

const ConnectCARootName = "connect-ca-root"

Recommended name for registration.

const HealthServicesName = "health-services"

Recommended name for registration.

const IntentionMatchName = "intention-match"

Recommended name for registration.

const PreparedQueryName = "prepared-query"

Recommended name for registration.

Functions

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 CatalogServices

type CatalogServices struct {
	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)

func (*CatalogServices) SupportsBlocking

func (c *CatalogServices) SupportsBlocking() bool

type ConnectCALeaf

type ConnectCALeaf struct {
	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 behaviour 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)

func (*ConnectCALeaf) SupportsBlocking

func (c *ConnectCALeaf) SupportsBlocking() bool

type ConnectCALeafRequest

type ConnectCALeafRequest struct {
	Token         string
	Datacenter    string
	Service       string // Service name, not ID
	MinQueryIndex uint64
	MaxQueryTime  time.Duration
}

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

type ConnectCARoot

type ConnectCARoot struct {
	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)

func (*ConnectCARoot) SupportsBlocking

func (c *ConnectCARoot) SupportsBlocking() bool

type HealthServices

type HealthServices struct {
	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)

func (*HealthServices) SupportsBlocking

func (c *HealthServices) SupportsBlocking() bool

type IntentionMatch

type IntentionMatch struct {
	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)

func (*IntentionMatch) SupportsBlocking

func (c *IntentionMatch) SupportsBlocking() bool

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 PreparedQuery

type PreparedQuery struct {
	RPC RPC
}

PreparedQuery supports fetching discovering service instances via prepared queries.

func (*PreparedQuery) Fetch

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

func (*PreparedQuery) SupportsBlocking

func (c *PreparedQuery) SupportsBlocking() bool

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.