server

Documentation

Index

• Variables
• func SessionProto(s Session) *pb.Session
• func TestProto(t Test) *pb.Test
• func TestRunProto(t Test) *pb.TestRun
• type GrpcObserverRegistry
  • func ShowcaseObserverRegistry() GrpcObserverRegistry
• type Session
  • func NewSession(name string, version pb.Session_Version, observerRegistry GrpcObserverRegistry) Session
• type StreamRequestObserver
• type StreamResponseObserver
• type Test
• type TokenGenerator
  • func NewTokenGenerator() TokenGenerator
  • func TokenGeneratorWithSalt(salt string) TokenGenerator
• type UnaryObserver
• type UniqID
  • func (u *UniqID) Next() int64
• type Waiter
  • func GetWaiterInstance() Waiter

Variables

var InvalidTokenErr = status.Errorf(
	codes.InvalidArgument,
	"The field `page_token` is invalid.")

InvalidTokenErr is the error returned if the token provided is not parseable by the TokenGenerator.

Functions

func SessionProto

func SessionProto(s Session) *pb.Session

SessionProto returns a proto representation of the Session.

func TestProto

func TestProto(t Test) *pb.Test

TestProto returns a proto representation of the Test.

func TestRunProto

func TestRunProto(t Test) *pb.TestRun

TestRunProto returns a proto representation of a test run.

Types

type GrpcObserverRegistry

type GrpcObserverRegistry interface {
	// UnaryInterceptor implements the grpc.UnaryServerInterceptor type to allow the
	// registry to hook into unary grpc methods.
	UnaryInterceptor(
		context.Context,
		interface{},
		*grpc.UnaryServerInfo,
		grpc.UnaryHandler) (interface{}, error)
	// StreamInterceptor implements the grpc.StreamServerInterceptor type to allow the
	// registry to hook into streaming grpc methods.
	StreamInterceptor(
		interface{},
		grpc.ServerStream,
		*grpc.StreamServerInfo,
		grpc.StreamHandler) error
	RegisterUnaryObserver(UnaryObserver)
	DeleteUnaryObserver(name string)
	RegisterStreamRequestObserver(StreamRequestObserver)
	DeleteStreamRequestObserver(name string)
	RegisterStreamResponseObserver(StreamResponseObserver)
	DeleteStreamResponseObserver(name string)
}

GrpcObserverRegistry is a registry of observers. These observers are hooked into the grpc interceptors that are provided by this interface.

func ShowcaseObserverRegistry

func ShowcaseObserverRegistry() GrpcObserverRegistry

ShowcaseObserverRegistry returns the showcase specific observer registry.

type Session

type Session interface {
	GetName() string
	GetVersion() pb.Session_Version
	GetReport() *pb.ReportSessionResponse
	RegisterTests(tests []Test)
	ListTests(in *pb.ListTestsRequest) (*pb.ListTestsResponse, error)
	DeleteTest(name string) (*empty.Empty, error)
}

Session represents a suite of tests, generally being made in the context of testing code generation.

A session defines tests it may expect, based on which version of the code generation spec is in use.

func NewSession

func NewSession(name string, version pb.Session_Version, observerRegistry GrpcObserverRegistry) Session

NewSession returns a session for a given name, version and observerRegistry.

type StreamRequestObserver

type StreamRequestObserver interface {
	GetName() string
	ObserveStreamRequest(
		ctx context.Context,
		req interface{},
		info *grpc.StreamServerInfo,
		err error)
}

StreamRequestObserver provides an interface for observing streaming requests.

type StreamResponseObserver

type StreamResponseObserver interface {
	GetName() string
	ObserveStreamResponse(
		ctx context.Context,
		resp interface{},
		info *grpc.StreamServerInfo,
		err error)
}

StreamResponseObserver provides an interface for observing streaming responses.

type Test

type Test interface {
	GetName() string
	GetExpectationLevel() pb.Test_ExpectationLevel
	GetDescription() string
	GetBlueprints() []*pb.Test_Blueprint
	GetIssue() *pb.Issue
}

Test represents a test case that is run. This interfaces exposes the properties of the test as well as the observers used to run this test.

A Test will also implement at least one of UnaryObserver, StreamRequestObserver, StreamResponseOvserver in order to track requests made to the showcase server.

type TokenGenerator

type TokenGenerator interface {
	ForIndex(int) string
	GetIndex(string) (int, error)
}

TokenGenerator generates a page token for a given index.

func NewTokenGenerator

func NewTokenGenerator() TokenGenerator

NewTokenGenerator provides a new instance of a TokenGenerator.

func TokenGeneratorWithSalt

func TokenGeneratorWithSalt(salt string) TokenGenerator

TokenGeneratorWithSalt provieds an instance of a TokenGenerator which uses the given salt.

type UnaryObserver

type UnaryObserver interface {
	GetName() string
	ObserveUnary(
		ctx context.Context,
		req interface{},
		resp interface{},
		info *grpc.UnaryServerInfo,
		err error)
}

UnaryObserver provides an interface for observing unary requests and responses.

type UniqID

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

UniqID provides a numerical id that is guaranteed to be unique.

func (*UniqID) Next

func (u *UniqID) Next() int64

Next gets the next unique id.

type Waiter

type Waiter interface {
	Wait(req *pb.WaitRequest) *lropb.Operation
}

Waiter handles the echo.Wait method for both the LRO service and the echo service.

func GetWaiterInstance

func GetWaiterInstance() Waiter

GetWaiterInstance returns the waiter singleton.