fakeclient

Documentation

Overview

Package fakeclient provides a fake implementation of an xDS client.

Index

• type Client
  • func NewClient() *Client
  • func NewClientWithName(name string) *Client
  • func (xdsC *Client) Close()
  • func (xdsC *Client) InvokeWatchClusterCallback(update xdsclient.ClusterUpdate, err error)
  • func (xdsC *Client) InvokeWatchEDSCallback(update xdsclient.EndpointsUpdate, err error)
  • func (xdsC *Client) InvokeWatchServiceCallback(u xdsclient.ServiceUpdate, err error)
  • func (xdsC *Client) LoadStore() *load.Store
  • func (xdsC *Client) Name() string
  • func (xdsC *Client) ReportLoad(server string, clusterName string) (cancel func())
  • func (xdsC *Client) WaitForCancelClusterWatch(ctx context.Context) error
  • func (xdsC *Client) WaitForCancelEDSWatch(ctx context.Context) error
  • func (xdsC *Client) WaitForClose(ctx context.Context) error
  • func (xdsC *Client) WaitForReportLoad(ctx context.Context) (ReportLoadArgs, error)
  • func (xdsC *Client) WaitForWatchCluster(ctx context.Context) (string, error)
  • func (xdsC *Client) WaitForWatchEDS(ctx context.Context) (string, error)
  • func (xdsC *Client) WaitForWatchService(ctx context.Context) (string, error)
  • func (xdsC *Client) WatchCluster(clusterName string, callback func(xdsclient.ClusterUpdate, error)) func()
  • func (xdsC *Client) WatchEndpoints(clusterName string, callback func(xdsclient.EndpointsUpdate, error)) (cancel func())
  • func (xdsC *Client) WatchService(target string, callback func(xdsclient.ServiceUpdate, error)) func()
• type ReportLoadArgs

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a fake implementation of an xds client. It exposes a bunch of channels to signal the occurrence of various events.

func NewClient

func NewClient() *Client

NewClient returns a new fake xds client.

func NewClientWithName

func NewClientWithName(name string) *Client

NewClientWithName returns a new fake xds client with the provided name. This is used in cases where multiple clients are created in the tests and we need to make sure the client is created for the expected balancer name.

func (*Client) Close

func (xdsC *Client) Close()

Close closes the xds client.

func (*Client) InvokeWatchClusterCallback

func (xdsC *Client) InvokeWatchClusterCallback(update xdsclient.ClusterUpdate, err error)

InvokeWatchClusterCallback invokes the registered cdsWatch callback.

func (*Client) InvokeWatchEDSCallback

func (xdsC *Client) InvokeWatchEDSCallback(update xdsclient.EndpointsUpdate, err error)

InvokeWatchEDSCallback invokes the registered edsWatch callback.

func (*Client) InvokeWatchServiceCallback

func (xdsC *Client) InvokeWatchServiceCallback(u xdsclient.ServiceUpdate, err error)

InvokeWatchServiceCallback invokes the registered service watch callback.

func (*Client) LoadStore

func (xdsC *Client) LoadStore() *load.Store

LoadStore returns the underlying load data store.

func (*Client) Name

func (xdsC *Client) Name() string

Name returns the name of the xds client.

func (*Client) ReportLoad

func (xdsC *Client) ReportLoad(server string, clusterName string) (cancel func())

ReportLoad starts reporting load about clusterName to server.

func (*Client) WaitForCancelClusterWatch

func (xdsC *Client) WaitForCancelClusterWatch(ctx context.Context) error

WaitForCancelClusterWatch waits for a CDS watch to be cancelled and returns context.DeadlineExceeded otherwise.

func (*Client) WaitForCancelEDSWatch

func (xdsC *Client) WaitForCancelEDSWatch(ctx context.Context) error

WaitForCancelEDSWatch waits for a EDS watch to be cancelled and returns context.DeadlineExceeded otherwise.

func (*Client) WaitForClose

func (xdsC *Client) WaitForClose(ctx context.Context) error

WaitForClose waits for Close to be invoked on this client and returns context.DeadlineExceeded otherwise.

func (*Client) WaitForReportLoad

func (xdsC *Client) WaitForReportLoad(ctx context.Context) (ReportLoadArgs, error)

WaitForReportLoad waits for ReportLoad to be invoked on this client and returns the arguments passed to it.

func (*Client) WaitForWatchCluster

func (xdsC *Client) WaitForWatchCluster(ctx context.Context) (string, error)

WaitForWatchCluster waits for WatchCluster to be invoked on this client and returns the clusterName being watched.

func (*Client) WaitForWatchEDS

func (xdsC *Client) WaitForWatchEDS(ctx context.Context) (string, error)

WaitForWatchEDS waits for WatchEndpoints to be invoked on this client and returns the clusterName being watched.

func (*Client) WaitForWatchService

func (xdsC *Client) WaitForWatchService(ctx context.Context) (string, error)

WaitForWatchService waits for WatchService to be invoked on this client and returns the serviceName being watched.

func (*Client) WatchCluster

func (xdsC *Client) WatchCluster(clusterName string, callback func(xdsclient.ClusterUpdate, error)) func()

WatchCluster registers a CDS watch.

func (*Client) WatchEndpoints

func (xdsC *Client) WatchEndpoints(clusterName string, callback func(xdsclient.EndpointsUpdate, error)) (cancel func())

WatchEndpoints registers an EDS watch for provided clusterName.

func (*Client) WatchService

func (xdsC *Client) WatchService(target string, callback func(xdsclient.ServiceUpdate, error)) func()

WatchService registers a LDS/RDS watch.

type ReportLoadArgs

type ReportLoadArgs struct {
	// Server is the name of the server to which the load is reported.
	Server string
	// Cluster is the name of the cluster for which load is reported.
	Cluster string
}

ReportLoadArgs wraps the arguments passed to ReportLoad.