server

Documentation

Index

• func GetServers(sharConcurrency int, apiAuth authz.APIFunc, authN authn.Check, ...) (Server, Server, error)
• type NatsLogger
  • func (n *NatsLogger) Debugf(format string, v ...interface{})
  • func (n *NatsLogger) Errorf(format string, v ...interface{})
  • func (n *NatsLogger) Fatalf(format string, v ...interface{})
  • func (n *NatsLogger) Noticef(format string, v ...interface{})
  • func (n *NatsLogger) Tracef(format string, v ...interface{})
  • func (n *NatsLogger) Warnf(format string, v ...interface{})
• type NatsServer
  • func (natserver *NatsServer) GetEndPoint() string
  • func (natserver *NatsServer) Listen() error
  • func (natserver *NatsServer) Shutdown()
• type Server
• type ZenSharOptionApplyFn
  • func WithNatsPersistHostPath(natsPersistHostPath string) ZenSharOptionApplyFn
  • func WithNatsServerAddress(addr string) ZenSharOptionApplyFn
  • func WithNatsServerImageUrl(imageUrl string) ZenSharOptionApplyFn
  • func WithNoRecovery() ZenSharOptionApplyFn
  • func WithSharServerImageUrl(imageUrl string) ZenSharOptionApplyFn
  • func WithSharServerTelemetry(endpoint string) ZenSharOptionApplyFn
  • func WithSharVersion(ver string) ZenSharOptionApplyFn
  • func WithShowSplash() ZenSharOptionApplyFn

Functions

func GetServers

func GetServers(sharConcurrency int, apiAuth authz.APIFunc, authN authn.Check, option ...ZenSharOptionApplyFn) (Server, Server, error)

GetServers returns a test NATS and SHAR server. nolint:ireturn

Types

type NatsLogger

type NatsLogger struct {
}

NatsLogger provides a simple logger that logs to console

func (*NatsLogger) Debugf

func (n *NatsLogger) Debugf(format string, v ...interface{})

Debugf logs a debug statement

func (*NatsLogger) Errorf

func (n *NatsLogger) Errorf(format string, v ...interface{})

Errorf logs an error

func (*NatsLogger) Fatalf

func (n *NatsLogger) Fatalf(format string, v ...interface{})

Fatalf logs a fatal error

func (*NatsLogger) Noticef

func (n *NatsLogger) Noticef(format string, v ...interface{})

Noticef logs a notice statement

func (*NatsLogger) Tracef

func (n *NatsLogger) Tracef(format string, v ...interface{})

Tracef logs a trace statement

func (*NatsLogger) Warnf

func (n *NatsLogger) Warnf(format string, v ...interface{})

Warnf logs a warning statement

type NatsServer

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

NatsServer is a wrapper around the nats lib server so that its lifecycle can be defined in terms of the Server interface needed by integration tests

func (*NatsServer) GetEndPoint

func (natserver *NatsServer) GetEndPoint() string

GetEndPoint returns the url of the nats endpoint

func (*NatsServer) Listen

func (natserver *NatsServer) Listen() error

Listen starts an in process nats server

func (*NatsServer) Shutdown

func (natserver *NatsServer) Shutdown()

Shutdown shutsdown an in process nats server

type Server

type Server interface {
	Shutdown()
	Listen() error
	GetEndPoint() string
}

Server is a general interface representing either an inprocess or in container Shar server

type ZenSharOptionApplyFn

type ZenSharOptionApplyFn func(cfg *zenOpts)

ZenSharOptionApplyFn represents a SHAR Zen Server configuration function

func WithNatsPersistHostPath

func WithNatsPersistHostPath(natsPersistHostPath string) ZenSharOptionApplyFn

WithNatsPersistHostPath will make zen-shar persist nats messages between test runs if we are running against a containerised nats server

func WithNatsServerAddress

func WithNatsServerAddress(addr string) ZenSharOptionApplyFn

WithNatsServerAddress provides a specific address for the NATS server.

func WithNatsServerImageUrl

func WithNatsServerImageUrl(imageUrl string) ZenSharOptionApplyFn

WithNatsServerImageUrl will make zen-shar start nats server in a container from the specificed image URL

func WithNoRecovery

func WithNoRecovery() ZenSharOptionApplyFn

WithNoRecovery will make zen-shar vulnerable to panics. This should only be used for testing purposes.

func WithSharServerImageUrl

func WithSharServerImageUrl(imageUrl string) ZenSharOptionApplyFn

WithSharServerImageUrl will make zen-shar start shar server in a container from the specificed image URL

func WithSharServerTelemetry

func WithSharServerTelemetry(endpoint string) ZenSharOptionApplyFn

WithSharServerTelemetry will make zen-shar persist nats messages between test runs if we are running against a containerised nats server

func WithSharVersion

func WithSharVersion(ver string) ZenSharOptionApplyFn

WithSharVersion artificially sets the reported server version.

func WithShowSplash

func WithShowSplash() ZenSharOptionApplyFn

WithShowSplash will make zen-shar start nats server with splash screen