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) BootstrapConfig() *bootstrap.Config
  • func (xdsC *Client) Close()
  • func (xdsC *Client) InvokeWatchClusterCallback(update xdsclient.ClusterUpdate, err error)
  • func (xdsC *Client) InvokeWatchEDSCallback(name string, update xdsclient.EndpointsUpdate, err error)
  • func (xdsC *Client) InvokeWatchListenerCallback(update xdsclient.ListenerUpdate, err error)
  • func (xdsC *Client) InvokeWatchRouteConfigCallback(name string, update xdsclient.RouteConfigUpdate, err error)
  • func (xdsC *Client) LoadStore() *load.Store
  • func (xdsC *Client) Name() string
  • func (xdsC *Client) ReportLoad(server string) (loadStore *load.Store, cancel func())
  • func (xdsC *Client) SetBootstrapConfig(cfg *bootstrap.Config)
  • func (xdsC *Client) WaitForCancelClusterWatch(ctx context.Context) (string, error)
  • func (xdsC *Client) WaitForCancelEDSWatch(ctx context.Context) (string, error)
  • func (xdsC *Client) WaitForCancelListenerWatch(ctx context.Context) error
  • func (xdsC *Client) WaitForCancelReportLoad(ctx context.Context) error
  • func (xdsC *Client) WaitForCancelRouteConfigWatch(ctx context.Context) (string, 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) WaitForWatchListener(ctx context.Context) (string, error)
  • func (xdsC *Client) WaitForWatchRouteConfig(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) WatchListener(serviceName string, callback func(xdsclient.ListenerUpdate, error)) func()
  • func (xdsC *Client) WatchRouteConfig(routeName string, callback func(xdsclient.RouteConfigUpdate, error)) func()
• type ReportLoadArgs

Types

type Client

type Client struct {
	// Embed XDSClient so this fake client implements the interface, but it's
	// never set (it's always nil). This may cause nil panic since not all the
	// methods are implemented.
	xdsclient.XDSClient

	Closed *grpcsync.Event // fired when Close is called.
	// 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) BootstrapConfig

func (xdsC *Client) BootstrapConfig() *bootstrap.Config

BootstrapConfig returns the bootstrap config.

func (*Client) Close

func (xdsC *Client) Close()

Close fires xdsC.Closed, indicating it was called.

func (*Client) InvokeWatchClusterCallback

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

InvokeWatchClusterCallback invokes the registered cdsWatch callback.

Not thread safe with WatchCluster. Only call this after WaitForWatchCluster.

func (*Client) InvokeWatchEDSCallback

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

InvokeWatchEDSCallback invokes the registered edsWatch callback.

Not thread safe with WatchEndpoints. Only call this after WaitForWatchEDS.

func (*Client) InvokeWatchListenerCallback

func (xdsC *Client) InvokeWatchListenerCallback(update xdsclient.ListenerUpdate, err error)

InvokeWatchListenerCallback invokes the registered ldsWatch callback.

Not thread safe with WatchListener. Only call this after WaitForWatchListener.

func (*Client) InvokeWatchRouteConfigCallback

func (xdsC *Client) InvokeWatchRouteConfigCallback(name string, update xdsclient.RouteConfigUpdate, err error)

InvokeWatchRouteConfigCallback invokes the registered rdsWatch callback.

Not thread safe with WatchRouteConfig. Only call this after WaitForWatchRouteConfig.

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) (loadStore *load.Store, cancel func())

ReportLoad starts reporting load about clusterName to server.

func (*Client) SetBootstrapConfig

func (xdsC *Client) SetBootstrapConfig(cfg *bootstrap.Config)

SetBootstrapConfig updates the bootstrap config.

func (*Client) WaitForCancelClusterWatch

func (xdsC *Client) WaitForCancelClusterWatch(ctx context.Context) (string, 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) (string, error)

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

func (*Client) WaitForCancelListenerWatch

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

WaitForCancelListenerWatch waits for a LDS watch to be cancelled and returns context.DeadlineExceeded otherwise.

func (*Client) WaitForCancelReportLoad

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

WaitForCancelReportLoad waits for a load report to be cancelled and returns context.DeadlineExceeded otherwise.

func (*Client) WaitForCancelRouteConfigWatch

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

WaitForCancelRouteConfigWatch waits for a RDS watch to be cancelled 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) WaitForWatchListener

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

WaitForWatchListener waits for WatchCluster to be invoked on this client and returns the serviceName being watched.

func (*Client) WaitForWatchRouteConfig

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

WaitForWatchRouteConfig waits for WatchCluster to be invoked on this client and returns the routeName 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) WatchListener

func (xdsC *Client) WatchListener(serviceName string, callback func(xdsclient.ListenerUpdate, error)) func()

WatchListener registers a LDS watch.

func (*Client) WatchRouteConfig

func (xdsC *Client) WatchRouteConfig(routeName string, callback func(xdsclient.RouteConfigUpdate, error)) func()

WatchRouteConfig registers a RDS watch.

type ReportLoadArgs

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

ReportLoadArgs wraps the arguments passed to ReportLoad.