mock

Documentation

Index

• Constants
• type GDS
  • func NewGDS(conf config.DirectoryConfig) (g *GDS, err error)
  • func (g *GDS) Client() (client gds.TRISADirectoryClient, err error)
  • func (g *GDS) DialOpts() (opts []grpc.DialOption)
  • func (g *GDS) Lookup(ctx context.Context, in *gds.LookupRequest) (*gds.LookupReply, error)
  • func (g *GDS) Register(ctx context.Context, in *gds.RegisterRequest) (*gds.RegisterReply, error)
  • func (g *GDS) Reset()
  • func (g *GDS) Search(ctx context.Context, in *gds.SearchRequest) (*gds.SearchReply, error)
  • func (g *GDS) Shutdown()
  • func (g *GDS) Status(ctx context.Context, in *gds.HealthCheck) (*gds.ServiceState, error)
  • func (g *GDS) UseError(rpc string, code codes.Code, msg string) error
  • func (g *GDS) UseFixture(rpc, path string) (err error)
  • func (g *GDS) Verification(ctx context.Context, in *gds.VerificationRequest) (*gds.VerificationReply, error)
  • func (g *GDS) VerifyContact(ctx context.Context, in *gds.VerifyContactRequest) (*gds.VerifyContactReply, error)
• type Members
  • func NewMembers(conf config.MembersConfig) (m *Members, err error)
  • func (g *Members) Client() (client members.TRISAMembersClient, err error)
  • func (m *Members) Details(ctx context.Context, in *members.DetailsRequest) (*members.MemberDetails, error)
  • func (g *Members) DialOpts() (opts []grpc.DialOption)
  • func (m *Members) List(ctx context.Context, in *members.ListRequest) (*members.ListReply, error)
  • func (m *Members) Reset()
  • func (g *Members) Shutdown()
  • func (m *Members) Summary(ctx context.Context, in *members.SummaryRequest) (*members.SummaryReply, error)
  • func (m *Members) UseError(rpc string, code codes.Code, msg string) error
  • func (m *Members) UseFixture(rpc, path string) (err error)
• type Trtl
  • func NewTrtl() (t *Trtl, err error)
  • func (t *Trtl) Client() (_ store.Store, err error)
  • func (t *Trtl) Shutdown()

Constants

const (
	RegisterRPC      = "Register"
	LookupRPC        = "Lookup"
	SearchRPC        = "Search"
	VerificationRPC  = "Verification"
	VerifyContactRPC = "VerifyContact"
	StatusRPC        = "Status"
)

const (
	ListRPC    = "List"
	SummaryRPC = "Summary"
	DetailsRPC = "Details"
)

Types

type GDS

type GDS struct {
	gds.UnimplementedTRISADirectoryServer

	Calls           map[string]int
	OnRegister      func(context.Context, *gds.RegisterRequest) (*gds.RegisterReply, error)
	OnLookup        func(context.Context, *gds.LookupRequest) (*gds.LookupReply, error)
	OnSearch        func(context.Context, *gds.SearchRequest) (*gds.SearchReply, error)
	OnVerification  func(context.Context, *gds.VerificationRequest) (*gds.VerificationReply, error)
	OnVerifyContact func(context.Context, *gds.VerifyContactRequest) (*gds.VerifyContactReply, error)
	OnStatus        func(context.Context, *gds.HealthCheck) (*gds.ServiceState, error)
	// contains filtered or unexported fields
}

GDS implements a mock gRPC server that listens on a buffconc and registers the TRISA directory service. The RPC methods are able to be set from individual tests so that the user can specify the return of the RPC in order to test specific functionality. The mock allows us to test dual GDS (TestNet and MainNet) handling from the BFF without having to set up a whole microservices architecture with data storage and managing fixtures.

To set the response of the mock for a particular test, update the GDS OnRPC method. e.g. to mock the Register RPC, set the OnRegister method. The number of calls to the RPC will be recorded to verifiy that the service is being called correctly. Use the Reset method to remove all RPC handlers and set calls back to 0.

NOTE: this mock is not safe for concurrent use. NOTE: if the OnRPC function is not set, the test will panic

func NewGDS

func NewGDS(conf config.DirectoryConfig) (g *GDS, err error)

func (*GDS) Client

func (g *GDS) Client() (client gds.TRISADirectoryClient, err error)

func (*GDS) DialOpts

func (g *GDS) DialOpts() (opts []grpc.DialOption)

func (*GDS) Lookup

func (g *GDS) Lookup(ctx context.Context, in *gds.LookupRequest) (*gds.LookupReply, error)

func (*GDS) Register

func (g *GDS) Register(ctx context.Context, in *gds.RegisterRequest) (*gds.RegisterReply, error)

func (*GDS) Reset

func (g *GDS) Reset()

func (*GDS) Search

func (g *GDS) Search(ctx context.Context, in *gds.SearchRequest) (*gds.SearchReply, error)

func (*GDS) Shutdown

func (g *GDS) Shutdown()

func (*GDS) Status

func (g *GDS) Status(ctx context.Context, in *gds.HealthCheck) (*gds.ServiceState, error)

func (*GDS) UseError

func (g *GDS) UseError(rpc string, code codes.Code, msg string) error

UseError allows you to specify a gRPC status error to return from the specified RPC.

func (*GDS) UseFixture

func (g *GDS) UseFixture(rpc, path string) (err error)

UseFixture allows you to specify a JSON fixture that is loaded from disk as the protocol buffer response for the specified RPC, simplifying the handler mocking.

func (*GDS) Verification

func (g *GDS) Verification(ctx context.Context, in *gds.VerificationRequest) (*gds.VerificationReply, error)

func (*GDS) VerifyContact

func (g *GDS) VerifyContact(ctx context.Context, in *gds.VerifyContactRequest) (*gds.VerifyContactReply, error)

type Members

type Members struct {
	members.UnimplementedTRISAMembersServer

	Calls     map[string]int
	OnList    func(context.Context, *members.ListRequest) (*members.ListReply, error)
	OnSummary func(context.Context, *members.SummaryRequest) (*members.SummaryReply, error)
	OnDetails func(context.Context, *members.DetailsRequest) (*members.MemberDetails, error)
	// contains filtered or unexported fields
}

Memberss implements a mock gRPC server that listens on a buffcon and registers the TRISA members service. The RPC methods are able to be set from individual tests so that the user can specify the return of the RPC in order to test specific functionality. The mock allows us to test dual members (TestNet and MainNet) handling from the BFF without having to set up a whole microservices architecture with data storage and managing fixtures.

To set the response of the mock for a particular test, update the Members OnRPC method. e.g. to mock the Summary RPC, set the OnSummary method. The number of calls to the RPC will be recorded to verifiy that the service is being called correctly. Use the Reset method to remove all RPC handlers and set calls back to 0.

NOTE: this mock is not safe for concurrent use. NOTE: if the OnRPC function is not set, the test will panic

func NewMembers

func NewMembers(conf config.MembersConfig) (m *Members, err error)

func (*Members) Client

func (g *Members) Client() (client members.TRISAMembersClient, err error)

func (*Members) Details

func (m *Members) Details(ctx context.Context, in *members.DetailsRequest) (*members.MemberDetails, error)

func (*Members) DialOpts

func (g *Members) DialOpts() (opts []grpc.DialOption)

func (*Members) List

func (m *Members) List(ctx context.Context, in *members.ListRequest) (*members.ListReply, error)

func (*Members) Reset

func (m *Members) Reset()

func (*Members) Shutdown

func (g *Members) Shutdown()

func (*Members) Summary

func (m *Members) Summary(ctx context.Context, in *members.SummaryRequest) (*members.SummaryReply, error)

func (*Members) UseError

func (m *Members) UseError(rpc string, code codes.Code, msg string) error

UseError allows you to specify a gRPC status error to return from the specified RPC.

func (*Members) UseFixture

func (m *Members) UseFixture(rpc, path string) (err error)

UseFixture allows you to specify a JSON fixture that is loaded from disk as the protocol buffer response for the specified RPC, simplifying the handler mocking.

type Trtl

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

func NewTrtl

func NewTrtl() (t *Trtl, err error)

func (*Trtl) Client

func (t *Trtl) Client() (_ store.Store, err error)

func (*Trtl) Shutdown

func (t *Trtl) Shutdown()