testutils

Documentation

Overview

Package testutils provides utility types, for use in xds tests.

Index

• Variables
• func BuildResourceName(typeName, auth, id string, ctxParams map[string]string) string
• func LocalityIDToProto(l internal.LocalityID) *v2corepb.Locality
• func ServerConfigForAddress(t *testing.T, addr string) *bootstrap.ServerConfig
• type AddLocalityOptions
• type ClusterLoadAssignmentBuilder
  • func NewClusterLoadAssignmentBuilder(clusterName string, dropPercents map[string]uint32) *ClusterLoadAssignmentBuilder
  • func (clab *ClusterLoadAssignmentBuilder) AddLocality(subzone string, weight uint32, priority uint32, addrsWithPort []string, ...)
  • func (clab *ClusterLoadAssignmentBuilder) Build() *v2xdspb.ClusterLoadAssignment
• type TestResourceWatcher
  • func NewTestResourceWatcher() *TestResourceWatcher
  • func (w *TestResourceWatcher) OnError(err error)
  • func (w *TestResourceWatcher) OnResourceDoesNotExist()
  • func (w *TestResourceWatcher) OnUpdate(data xdsresource.ResourceData)

Variables

var EmptyNodeProtoV2 = &v2corepb.Node{}

EmptyNodeProtoV2 is a v2 Node proto with no fields set.

var EmptyNodeProtoV3 = &v3corepb.Node{}

EmptyNodeProtoV3 is a v3 Node proto with no fields set.

Functions

func BuildResourceName

func BuildResourceName(typeName, auth, id string, ctxParams map[string]string) string

BuildResourceName returns the resource name in the format of an xdstp:// resource.

func LocalityIDToProto

func LocalityIDToProto(l internal.LocalityID) *v2corepb.Locality

LocalityIDToProto converts a LocalityID to its proto representation.

func ServerConfigForAddress

func ServerConfigForAddress(t *testing.T, addr string) *bootstrap.ServerConfig

ServerConfigForAddress returns a bootstrap.ServerConfig for the given address with default values of insecure channel_creds and v3 server_features.

Types

type AddLocalityOptions

type AddLocalityOptions struct {
	Health []v2corepb.HealthStatus
	Weight []uint32
}

AddLocalityOptions contains options when adding locality to the builder.

type ClusterLoadAssignmentBuilder

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

ClusterLoadAssignmentBuilder builds a ClusterLoadAssignment, aka EDS response.

func NewClusterLoadAssignmentBuilder

func NewClusterLoadAssignmentBuilder(clusterName string, dropPercents map[string]uint32) *ClusterLoadAssignmentBuilder

NewClusterLoadAssignmentBuilder creates a ClusterLoadAssignmentBuilder.

func (*ClusterLoadAssignmentBuilder) AddLocality

func (clab *ClusterLoadAssignmentBuilder) AddLocality(subzone string, weight uint32, priority uint32, addrsWithPort []string, opts *AddLocalityOptions)

AddLocality adds a locality to the builder.

func (*ClusterLoadAssignmentBuilder) Build

func (clab *ClusterLoadAssignmentBuilder) Build() *v2xdspb.ClusterLoadAssignment

Build builds ClusterLoadAssignment.

type TestResourceWatcher

type TestResourceWatcher struct {
	// UpdateCh is the channel on which xDS client updates are delivered.
	UpdateCh chan *xdsresource.ResourceData
	// ErrorCh is the channel on which errors from the xDS client are delivered.
	ErrorCh chan error
	// ResourceDoesNotExistCh is the channel used to indicate calls to OnResourceDoesNotExist
	ResourceDoesNotExistCh chan struct{}
}

TestResourceWatcher implements the xdsresource.ResourceWatcher interface, used to receive updates on watches registered with the xDS client, when using the resource-type agnostic WatchResource API.

Tests can use the channels provided by this type to get access to updates and errors sent by the xDS client.

func NewTestResourceWatcher

func NewTestResourceWatcher() *TestResourceWatcher

NewTestResourceWatcher returns a TestResourceWatcher to watch for resources via the xDS client.

func (*TestResourceWatcher) OnError

func (w *TestResourceWatcher) OnError(err error)

OnError is invoked by the xDS client to report the latest error.

func (*TestResourceWatcher) OnResourceDoesNotExist

func (w *TestResourceWatcher) OnResourceDoesNotExist()

OnResourceDoesNotExist is used by the xDS client to report that the resource being watched no longer exists.

func (*TestResourceWatcher) OnUpdate

func (w *TestResourceWatcher) OnUpdate(data xdsresource.ResourceData)

OnUpdate is invoked by the xDS client to report the latest update on the resource being watched.