runtime

Documentation

Index

• Constants
• Variables
• func SkipIf(t ct.TestLike, hses ...string)

Constants

const (
	Dendrite  = "dendrite"
	Synapse   = "synapse"
	Conduit   = "conduit"
	Conduwuit = "conduwuit"
)

Variables

var ContainerKillFunc = func(client *client.Client, containerID string) error {
	return client.ContainerKill(context.Background(), containerID, "KILL")
}

ContainerKillFunc is used to destroy a container, it can be overwritten by Homeserver implementations to e.g. gracefully stop a container.

var Homeserver string

Functions

func SkipIf

func SkipIf(t ct.TestLike, hses ...string)

Skip the test (via t.Skipf) if the homeserver being tested matches one of the homeservers, else return.

The homeserver being tested is detected via the presence of a `*_blacklist` tag e.g:

go test -tags="dendrite_blacklist"

This means it is important to always specify this tag when running tests. Failure to do so will result in a warning being printed to stdout, and the test will be run. When a new server implementation is added, a respective `hs_$name.go` needs to be created in this directory. This file pairs together the tag name with a string constant declared in this package e.g. dendrite_blacklist == runtime.Dendrite