xmpptest

Documentation

Overview

Package xmpptest provides utilities for XMPP testing.

Index

• func NewClientSession(finalState xmpp.SessionState, rw io.ReadWriter) *xmpp.Session
• func NewServerSession(finalState xmpp.SessionState, rw io.ReadWriter) *xmpp.Session
• func NopNegotiator(state xmpp.SessionState, streamNS string) xmpp.Negotiator
• func RunEncodingTests(t *testing.T, testCases []EncodingTestCase)
• func RunFeatureTests(t *testing.T, tcs []FeatureTestCase)
• func RunTransformerTests(t *testing.T, T xmlstream.Transformer, tcs []TransformerTestCase)
• type ClientServer
  • func NewClientServer(opts ...Option) *ClientServer
  • func (cs *ClientServer) Close() error
• type EncodingTestCase
• type FeatureTestCase
• type Option
  • func ClientHandler(handler xmpp.Handler) Option
  • func ClientHandlerFunc(handler xmpp.HandlerFunc) Option
  • func ClientState(state xmpp.SessionState) Option
  • func ServerHandler(handler xmpp.Handler) Option
  • func ServerHandlerFunc(handler xmpp.HandlerFunc) Option
  • func ServerState(state xmpp.SessionState) Option
• type Tokens
  • func (r *Tokens) Token() (xml.Token, error)
• type TransformerTestCase

Functions

func NewClientSession

func NewClientSession(finalState xmpp.SessionState, rw io.ReadWriter) *xmpp.Session

NewClientSession returns a new client-to-client XMPP session with the state bits set to finalState|xmpp.Ready, the origin JID set to "test@example.net" and the location JID set to "example.net".

NewClientSession panics on error for ease of use in testing, where a panic is acceptable.

func NewServerSession

func NewServerSession(finalState xmpp.SessionState, rw io.ReadWriter) *xmpp.Session

NewServerSession is like NewClientSession except that the stream uses the server-to-server namespace.

func NopNegotiator

func NopNegotiator(state xmpp.SessionState, streamNS string) xmpp.Negotiator

NopNegotiator marks the state as ready (by returning state|xmpp.Ready) and pops the first token (likely <stream:stream>) but does not perform any validation on the token, transmit any data over the wire, or perform any other session negotiation.

func RunEncodingTests

func RunEncodingTests(t *testing.T, testCases []EncodingTestCase)

RunEncodingTests iterates over the test cases and runs each one.

func RunFeatureTests

func RunFeatureTests(t *testing.T, tcs []FeatureTestCase)

RunFeatureTests simulates a stream feature neogtiation and tests the output.

func RunTransformerTests

func RunTransformerTests(t *testing.T, T xmlstream.Transformer, tcs []TransformerTestCase)

Types

type ClientServer

type ClientServer struct {
	Client *xmpp.Session
	Server *xmpp.Session
	// contains filtered or unexported fields
}

ClientServer is two coupled xmpp.Session's that can respond to one another in tests.

func NewClientServer

func NewClientServer(opts ...Option) *ClientServer

NewClientServer returns a ClientServer with the client and server goroutines started. Both serve goroutines are started when NewClientServer is called and shut down when the ClientServer is closed.

func (*ClientServer) Close

func (cs *ClientServer) Close() error

Close calls the client and server sessions' close methods.

type EncodingTestCase

type EncodingTestCase struct {
	Value       interface{}
	XML         string
	Err         error
	NoMarshal   bool
	NoUnmarshal bool
}

EncodingTestCase is a test that marshals the value and checks that the result matches XML, then unmarshals XML into a new zero value of the type in value and checks that it matches the original value with reflect.DeepEqual. If NoMarshal or NoUnmarshal is set then the corresponding part of the test is not run (for payloads that are not roundtrippable).

type FeatureTestCase

type FeatureTestCase struct {
	State      xmpp.SessionState
	Feature    xmpp.StreamFeature
	In         string
	Out        string
	FinalState xmpp.SessionState
	Err        error
}

FeatureTestCase is a data driven test for stream feature negotiation.

type Option

type Option func(*ClientServer)

Option is a type for configuring a ClientServer.

func ClientHandler

func ClientHandler(handler xmpp.Handler) Option

ClientHandler sets up the client side of a ClientServer.

func ClientHandlerFunc

func ClientHandlerFunc(handler xmpp.HandlerFunc) Option

ClientHandlerFunc sets up the client side of a ClientServer using an xmpp.HandlerFunc.

func ClientState

func ClientState(state xmpp.SessionState) Option

ClientState configures extra state bits to add to the client session.

func ServerHandler

func ServerHandler(handler xmpp.Handler) Option

ServerHandler sets up the server side of a ClientServer.

func ServerHandlerFunc

func ServerHandlerFunc(handler xmpp.HandlerFunc) Option

ServerHandlerFunc sets up the server side of a ClientServer using an xmpp.HandlerFunc.

func ServerState

func ServerState(state xmpp.SessionState) Option

ServerState configures extra state bits to add to the server session.

type Tokens

type Tokens []xml.Token

Tokens is a slice of XML tokens that can also act as an xml.TokenReader by popping tokens from itself. This is useful for testing contrived scenarios where the tokens cannot be constructed using an xml.Decoder because the stream to be tested violates the well-formedness rules of XML or otherwise would result in an error from the decoder.

func (*Tokens) Token

func (r *Tokens) Token() (xml.Token, error)

Token satisfies the xml.TokenReader interface for Tokens.

type TransformerTestCase

type TransformerTestCase struct {
	In  string
	Out string

	// If InStream is not nil, it will be used instead of "In" and should result
	// in tokens matching Out.
	InStream xml.TokenReader
}

TransformerTestCase is a data driven test for XML transformers.