framework

Documentation

Overview

Package framework is a package helping setting up end-to-end testing across a Kubernetes cluster.

Index

• Constants
• Variables
• func FleetReadyCount(amount int32) func(fleet *agonesv1.Fleet) bool
• func GetAllocation(f *agonesv1.Fleet) *allocationv1.GameServerAllocation
• func ParseTestFlags() error
• func SendGameServerTCP(gs *agonesv1.GameServer, msg string) (string, error)
• func SendGameServerTCPToPort(gs *agonesv1.GameServer, portName string, msg string) (string, error)
• func SendGameServerUDP(gs *agonesv1.GameServer, msg string) (string, error)
• func SendGameServerUDPToPort(gs *agonesv1.GameServer, portName string, msg string) (string, error)
• func SendTCP(address, msg string) (string, error)
• func SendUDP(address, msg string) (string, error)
• type Framework
  • func New(kubeconfig string) (*Framework, error)
  • func NewFromFlags() (*Framework, error)
  • func NewWithRates(kubeconfig string, qps float32, burst int) (*Framework, error)
  • func (f *Framework) AssertFleetCondition(t *testing.T, flt *agonesv1.Fleet, condition func(fleet *agonesv1.Fleet) bool)
  • func (f *Framework) CleanUp(ns string) error
  • func (f *Framework) CreateAndApplyAllocation(t *testing.T, flt *agonesv1.Fleet) *allocationv1.GameServerAllocation
  • func (f *Framework) CreateGameServerAndWaitUntilReady(ns string, gs *agonesv1.GameServer) (*agonesv1.GameServer, error)
  • func (f *Framework) CreateNamespace(namespace string) error
  • func (f *Framework) DefaultGameServer(namespace string) *agonesv1.GameServer
  • func (f *Framework) DeleteNamespace(namespace string) error
  • func (f *Framework) ListGameServersFromFleet(flt *agonesv1.Fleet) ([]agonesv1.GameServer, error)
  • func (f *Framework) NewStatsCollector(name, version string) *StatsCollector
  • func (f *Framework) WaitForFleetAutoScalerCondition(t *testing.T, fas *autoscaling.FleetAutoscaler, ...)
  • func (f *Framework) WaitForFleetCondition(t *testing.T, flt *agonesv1.Fleet, condition func(fleet *agonesv1.Fleet) bool) error
  • func (f *Framework) WaitForFleetGameServerListCondition(flt *agonesv1.Fleet, cond func(servers []agonesv1.GameServer) bool) error
  • func (f *Framework) WaitForFleetGameServersCondition(flt *agonesv1.Fleet, cond func(server *agonesv1.GameServer) bool) error
  • func (f *Framework) WaitForGameServerState(gs *agonesv1.GameServer, state agonesv1.GameServerState, timeout time.Duration) (*agonesv1.GameServer, error)
  • func (f *Framework) WaitForGameServerStateWithLogger(logger *logrus.Entry, gs *agonesv1.GameServer, state agonesv1.GameServerState, ...) (*agonesv1.GameServer, error)
• type StatsCollector
  • func (p *StatsCollector) Report()
  • func (p *StatsCollector) ReportDuration(d time.Duration, err error)

Constants

const (
	AutoCleanupLabelKey   = "agones.dev/e2e-test-auto-cleanup"
	AutoCleanupLabelValue = "true"
)

special labels that can be put on pods to trigger automatic cleanup.

Variables

var NamespaceLabel = map[string]string{"owner": "e2e-test"}

NamespaceLabel is the label that is put on all namespaces that are created for e2e tests.

Functions

func FleetReadyCount

func FleetReadyCount(amount int32) func(fleet *agonesv1.Fleet) bool

FleetReadyCount returns the ready count in a fleet

func GetAllocation

func GetAllocation(f *agonesv1.Fleet) *allocationv1.GameServerAllocation

GetAllocation returns a GameServerAllocation that is looking for a Ready GameServer from this fleet.

func ParseTestFlags

func ParseTestFlags() error

ParseTestFlags Parses go test flags separately because pflag package ignores flags with '-test.' prefix Related issues: https://github.com/spf13/pflag/issues/63 https://github.com/spf13/pflag/issues/238

func SendGameServerTCP

func SendGameServerTCP(gs *agonesv1.GameServer, msg string) (string, error)

SendGameServerTCP sends a message to a gameserver and returns its reply finds the first tcp port from the spec to send the message to, returns error if no Ports were allocated

func SendGameServerTCPToPort

func SendGameServerTCPToPort(gs *agonesv1.GameServer, portName string, msg string) (string, error)

SendGameServerTCPToPort sends a message to a gameserver at the named port and returns its reply returns error if no Ports were allocated or a port of the specified name doesn't exist

func SendGameServerUDP

func SendGameServerUDP(gs *agonesv1.GameServer, msg string) (string, error)

SendGameServerUDP sends a message to a gameserver and returns its reply finds the first udp port from the spec to send the message to, returns error if no Ports were allocated

func SendGameServerUDPToPort

func SendGameServerUDPToPort(gs *agonesv1.GameServer, portName string, msg string) (string, error)

SendGameServerUDPToPort sends a message to a gameserver at the named port and returns its reply returns error if no Ports were allocated or a port of the specified name doesn't exist

func SendTCP

func SendTCP(address, msg string) (string, error)

SendTCP sends a message to an address, and returns its reply if it returns one in 30 seconds

func SendUDP

func SendUDP(address, msg string) (string, error)

SendUDP sends a message to an address, and returns its reply if it returns one in 30 seconds

Types

type Framework

type Framework struct {
	KubeClient      kubernetes.Interface
	AgonesClient    versioned.Interface
	GameServerImage string
	PullSecret      string
	StressTestLevel int
	PerfOutputDir   string
	Version         string
	Namespace       string
}

Framework is a testing framework

func New

func New(kubeconfig string) (*Framework, error)

New setups a testing framework using a kubeconfig path and the game server image to use for testing.

func NewFromFlags

func NewFromFlags() (*Framework, error)

NewFromFlags sets up the testing framework with the standard command line flags.

func NewWithRates

func NewWithRates(kubeconfig string, qps float32, burst int) (*Framework, error)

NewWithRates setups a testing framework using a kubeconfig path and the game server image to use for load testing with QPS and Burst overwrites.

func (*Framework) AssertFleetCondition

func (f *Framework) AssertFleetCondition(t *testing.T, flt *agonesv1.Fleet, condition func(fleet *agonesv1.Fleet) bool)

AssertFleetCondition waits for the Fleet to be in a specific condition or fails the test if the condition can't be met in 5 minutes.

func (*Framework) CleanUp

func (f *Framework) CleanUp(ns string) error

CleanUp Delete all Agones resources in a given namespace.

func (*Framework) CreateAndApplyAllocation

func (f *Framework) CreateAndApplyAllocation(t *testing.T, flt *agonesv1.Fleet) *allocationv1.GameServerAllocation

CreateAndApplyAllocation creates and applies an Allocation to a Fleet

func (*Framework) CreateGameServerAndWaitUntilReady

func (f *Framework) CreateGameServerAndWaitUntilReady(ns string, gs *agonesv1.GameServer) (*agonesv1.GameServer, error)

CreateGameServerAndWaitUntilReady Creates a GameServer and wait for its state to become ready.

func (*Framework) CreateNamespace

func (f *Framework) CreateNamespace(namespace string) error

CreateNamespace creates a namespace and a service account in the test cluster

func (*Framework) DefaultGameServer

func (f *Framework) DefaultGameServer(namespace string) *agonesv1.GameServer

DefaultGameServer provides a default GameServer fixture, based on parameters passed to the Test Framework.

func (*Framework) DeleteNamespace

func (f *Framework) DeleteNamespace(namespace string) error

DeleteNamespace deletes a namespace from the test cluster

func (*Framework) ListGameServersFromFleet

func (f *Framework) ListGameServersFromFleet(flt *agonesv1.Fleet) ([]agonesv1.GameServer, error)

ListGameServersFromFleet lists GameServers from a particular fleet

func (*Framework) NewStatsCollector

func (f *Framework) NewStatsCollector(name, version string) *StatsCollector

NewStatsCollector returns new instance of statistics collector, which can be used to emit performance statistics for load tests and stress tests.

func (*Framework) WaitForFleetAutoScalerCondition

func (f *Framework) WaitForFleetAutoScalerCondition(t *testing.T, fas *autoscaling.FleetAutoscaler, condition func(fas *autoscaling.FleetAutoscaler) bool)

WaitForFleetAutoScalerCondition waits for the FleetAutoscaler to be in a specific condition or fails the test if the condition can't be met in 2 minutes. nolint: dupl

func (*Framework) WaitForFleetCondition

func (f *Framework) WaitForFleetCondition(t *testing.T, flt *agonesv1.Fleet, condition func(fleet *agonesv1.Fleet) bool) error

WaitForFleetCondition waits for the Fleet to be in a specific condition or returns an error if the condition can't be met in 5 minutes.

func (*Framework) WaitForFleetGameServerListCondition

func (f *Framework) WaitForFleetGameServerListCondition(flt *agonesv1.Fleet,
	cond func(servers []agonesv1.GameServer) bool) error

WaitForFleetGameServerListCondition waits for the list of GameServers to match a condition specified by a callback and the size of GameServers to match fleet's Spec.Replicas.

func (*Framework) WaitForFleetGameServersCondition

func (f *Framework) WaitForFleetGameServersCondition(flt *agonesv1.Fleet,
	cond func(server *agonesv1.GameServer) bool) error

WaitForFleetGameServersCondition waits for all GameServers for a given fleet to match a condition specified by a callback.

func (*Framework) WaitForGameServerState

func (f *Framework) WaitForGameServerState(gs *agonesv1.GameServer, state agonesv1.GameServerState,
	timeout time.Duration) (*agonesv1.GameServer, error)

WaitForGameServerState Waits untils the gameserver reach a given state before the timeout expires (with a default logger)

func (*Framework) WaitForGameServerStateWithLogger

func (f *Framework) WaitForGameServerStateWithLogger(logger *logrus.Entry, gs *agonesv1.GameServer, state agonesv1.GameServerState, timeout time.Duration) (*agonesv1.GameServer, error)

WaitForGameServerStateWithLogger Waits untils the gameserver reach a given state before the timeout expires, and logs against a give logger (usually useful to log the name of the test with the checks)

type StatsCollector

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

StatsCollector collects latency and throughput counters. The ReportDuration() method is safe for concurrent use by multiple goroutines.

func (*StatsCollector) Report

func (p *StatsCollector) Report()

Report outputs performance report to log.

func (*StatsCollector) ReportDuration

func (p *StatsCollector) ReportDuration(d time.Duration, err error)

ReportDuration adds a single time measurement.