mcabber

Documentation

Overview

Package mcabber facilitates integration testing against Mcabber.

Index

• func ConfigFile(cfg Config) integration.Option
• func Ping(cmd *integration.Cmd, to jid.JID) error
• func Send(cmd *integration.Cmd, s string) error
• func Test(ctx context.Context, t *testing.T, opts ...integration.Option) integration.SubtestRunner
• type Config

Functions

func ConfigFile

func ConfigFile(cfg Config) integration.Option

ConfigFile is an option that can be used to write a temporary config file. This will overwrite the existing config file and make most of the other options in this package noops. This option only exists for the rare occasion that you need complete control over the config file.

func Ping

func Ping(cmd *integration.Cmd, to jid.JID) error

Ping sends an XMPP ping through Mcabber.

func Send

func Send(cmd *integration.Cmd, s string) error

Send transmits the given command over the control pipe.

func Test

func Test(ctx context.Context, t *testing.T, opts ...integration.Option) integration.SubtestRunner

Test starts a Mcabber instance and returns a function that runs subtests using t.Run. Multiple calls to the returned function will result in uniquely named subtests. When all subtests have completed, the daemon is stopped.

Types

type Config

type Config struct {
	JID      jid.JID
	Password string
	FIFO     *os.File
	Port     string
}

Config contains options that can be written to the config file.