tools

Documentation

Index

• func DecoderConfig(output interface{}) *mapstructure.DecoderConfig
• func ErrorMessageFromConfigError(err error, configPath string) string
• func GenerateConfig(f string) error
• func GetLogAddresses(addresses []string) string
• func MakeTLSConfig(v ConfigGetter, keyPrefix string) (*tls.Config, error)
• func NodeWithMemoryEngine() *centrifuge.Node
• func NodeWithMemoryEngineNoHandlers() *centrifuge.Node
• func SecureCompare(given, actual []byte) bool
• func SecureCompareString(given, actual string) bool
• func StringToDurationHookFunc() mapstructure.DecodeHookFunc
• func StripPassword(address string) string
• type CommonGRPCProxyTestCase
  • func NewCommonGRPCProxyTestCase(ctx context.Context, srv proxyproto.CentrifugoProxyServer) *CommonGRPCProxyTestCase
  • func (c *CommonGRPCProxyTestCase) Teardown()
• type CommonHTTPProxyTestCase
  • func NewCommonHTTPProxyTestCase(ctx context.Context) *CommonHTTPProxyTestCase
  • func (c *CommonHTTPProxyTestCase) Teardown()
• type ConfigGetter
• type Duration
  • func (d Duration) MarshalJSON() ([]byte, error)
  • func (d *Duration) UnmarshalJSON(b []byte) error
• type TestClientMock
  • func (m TestClientMock) Context() context.Context
  • func (m TestClientMock) ID() string
  • func (m TestClientMock) IsSubscribed(s string) bool
  • func (m TestClientMock) Transport() centrifuge.TransportInfo
  • func (m TestClientMock) UserID() string
• type TestTransport
  • func NewTestTransport() *TestTransport
  • func (t *TestTransport) AppLevelPing() centrifuge.AppLevelPing
  • func (t *TestTransport) Close(disconnect centrifuge.Disconnect) error
  • func (t *TestTransport) DisabledPushFlags() uint64
  • func (t *TestTransport) Emulation() bool
  • func (t *TestTransport) Name() string
  • func (t *TestTransport) Protocol() centrifuge.ProtocolType
  • func (t *TestTransport) ProtocolVersion() centrifuge.ProtocolVersion
  • func (t *TestTransport) Unidirectional() bool
  • func (t *TestTransport) Write(message []byte) error
  • func (t *TestTransport) WriteMany(messages ...[]byte) error

Functions

func DecoderConfig

func DecoderConfig(output interface{}) *mapstructure.DecoderConfig

DecoderConfig returns default mapstructure.DecoderConfig with support of time.Duration values & string slices & Duration

func ErrorMessageFromConfigError

func ErrorMessageFromConfigError(err error, configPath string) string

ErrorMessageFromConfigError tries building a more human-friendly error from a configuration error. At the moment we can additionally extract JSON syntax error line and column. Related issue: https://github.com/golang/go/issues/43513.

func GenerateConfig

func GenerateConfig(f string) error

GenerateConfig generates configuration file at provided path.

func GetLogAddresses

func GetLogAddresses(addresses []string) string

GetLogAddresses returns a string with addresses (concatenated with comma) with password stripped from each address.

func MakeTLSConfig

func MakeTLSConfig(v ConfigGetter, keyPrefix string) (*tls.Config, error)

func NodeWithMemoryEngine

func NodeWithMemoryEngine() *centrifuge.Node

NodeWithMemoryEngine - builder for centrifuge node with memory engine

func NodeWithMemoryEngineNoHandlers

func NodeWithMemoryEngineNoHandlers() *centrifuge.Node

NodeWithMemoryEngineNoHandlers - builder for centrifuge node with memory engine

func SecureCompare

func SecureCompare(given, actual []byte) bool

SecureCompare use constant time function to compare the two given array.

func SecureCompareString

func SecureCompareString(given, actual string) bool

SecureCompareString use constant time function to compare the two given string.

func StringToDurationHookFunc

func StringToDurationHookFunc() mapstructure.DecodeHookFunc

StringToDurationHookFunc returns a DecodeHookFunc that converts strings to time.Duration.

func StripPassword

func StripPassword(address string) string

StripPassword from URL address.

Types

type CommonGRPCProxyTestCase

type CommonGRPCProxyTestCase struct {
	Node            *centrifuge.Node
	Client          *centrifuge.Client
	ClientCloseFunc centrifuge.ClientCloseFunc
	Server          *grpc.Server
	Listener        *bufconn.Listener
}

func NewCommonGRPCProxyTestCase

func NewCommonGRPCProxyTestCase(ctx context.Context, srv proxyproto.CentrifugoProxyServer) *CommonGRPCProxyTestCase

func (*CommonGRPCProxyTestCase) Teardown

func (c *CommonGRPCProxyTestCase) Teardown()

type CommonHTTPProxyTestCase

type CommonHTTPProxyTestCase struct {
	Node            *centrifuge.Node
	Client          *centrifuge.Client
	ClientCloseFunc centrifuge.ClientCloseFunc
	Server          *httptest.Server
	Mux             *http.ServeMux
}

func NewCommonHTTPProxyTestCase

func NewCommonHTTPProxyTestCase(ctx context.Context) *CommonHTTPProxyTestCase

func (*CommonHTTPProxyTestCase) Teardown

func (c *CommonHTTPProxyTestCase) Teardown()

type ConfigGetter

type ConfigGetter interface {
	GetBool(name string) bool
	GetString(name string) string
}

type Duration

type Duration time.Duration

func (Duration) MarshalJSON

func (d Duration) MarshalJSON() ([]byte, error)

func (*Duration) UnmarshalJSON

func (d *Duration) UnmarshalJSON(b []byte) error

type TestClientMock

type TestClientMock struct {
	IDFunc           func() string
	UserIDFunc       func() string
	IsSubscribedFunc func(string) bool
	ContextFunc      func() context.Context
	TransportFunc    func() centrifuge.TransportInfo
}

func (TestClientMock) Context

func (m TestClientMock) Context() context.Context

func (TestClientMock) ID

func (m TestClientMock) ID() string

func (TestClientMock) IsSubscribed

func (m TestClientMock) IsSubscribed(s string) bool

func (TestClientMock) Transport

func (m TestClientMock) Transport() centrifuge.TransportInfo

func (TestClientMock) UserID

func (m TestClientMock) UserID() string

type TestTransport

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

TestTransport - test transport

func NewTestTransport

func NewTestTransport() *TestTransport

NewTestTransport - builder for TestTransport

func (*TestTransport) AppLevelPing

func (t *TestTransport) AppLevelPing() centrifuge.AppLevelPing

AppLevelPing ...

func (*TestTransport) Close

func (t *TestTransport) Close(disconnect centrifuge.Disconnect) error

Close - ...

func (*TestTransport) DisabledPushFlags

func (t *TestTransport) DisabledPushFlags() uint64

DisabledPushFlags - ...

func (*TestTransport) Emulation

func (t *TestTransport) Emulation() bool

Emulation ...

func (*TestTransport) Name

func (t *TestTransport) Name() string

Name - ...

func (*TestTransport) Protocol

func (t *TestTransport) Protocol() centrifuge.ProtocolType

Protocol - ...

func (*TestTransport) ProtocolVersion

func (t *TestTransport) ProtocolVersion() centrifuge.ProtocolVersion

ProtocolVersion returns transport protocol version.

func (*TestTransport) Unidirectional

func (t *TestTransport) Unidirectional() bool

Unidirectional - ...

func (*TestTransport) Write

func (t *TestTransport) Write(message []byte) error

Write - ...

func (*TestTransport) WriteMany

func (t *TestTransport) WriteMany(messages ...[]byte) error

WriteMany - ...