e2e

README

End to end tests

• Running e2e tests

Adding end to end tests

Knative Serving e2e tests test the end to end functionality of the Knative Serving API to verify the behavior of this specific implementation.

These tests use the test library.

Requirements

The e2e tests are used to test whether the flow of Knative Serving is performing as designed from start to finish.

The e2e tests MUST:

1. Provide frequent output describing what actions they are undertaking, especially before performing long running operations. Please see the Log section for detailed instructions.
2. Follow Golang best practices.

Documentation

Index

• func AssertAutoscaleUpToNumPods(ctx *TestContext, curPods, targetPods float64, done <-chan time.Time, ...)
• func AutoscaleUpToNumPods(ctx *TestContext, curPods, targetPods float64, done <-chan time.Time, ...) func() error
• func CreateAndVerifyInitialScaleConfiguration(t *testing.T, clients *test.Clients, names test.ResourceNames, wantPods int)
• func RevisionFromConfiguration(clients *test.Clients, configName string) (string, error)
• func ScaleToWithin(t *testing.T, scale int, duration time.Duration, latencies Latencies)
• func Setup(t *testing.T) *test.Clients
• func SetupAlternativeNamespace(t *testing.T) *test.Clients
• func ValidateWebSocketConnection(t *testing.T, clients *test.Clients, names test.ResourceNames, ...) error
• func WaitForScaleToZero(t *testing.T, deploymentName string, clients *test.Clients) error
• type AutoscalerOptions
• type Latencies
• type TestContext
  • func SetupSvc(t *testing.T, aopts *AutoscalerOptions, topts test.Options, ...) *TestContext
  • func (ctx *TestContext) Clients() *test.Clients
  • func (ctx *TestContext) Names() *test.ResourceNames
  • func (ctx *TestContext) Resources() *v1test.ResourceObjects
  • func (ctx *TestContext) SetNames(names *test.ResourceNames)
  • func (ctx *TestContext) SetResources(resources *v1test.ResourceObjects)

Functions

func AssertAutoscaleUpToNumPods

func AssertAutoscaleUpToNumPods(ctx *TestContext, curPods, targetPods float64, done <-chan time.Time, quick bool)

AssertAutoscaleUpToNumPods asserts the number of pods gets scaled to targetPods. It supports two test modes: quick, and not quick.

1. Quick mode: succeeds when the number of pods meets targetPods.
2. Not Quick (sustaining) mode: succeeds when the number of pods gets scaled to targetPods and sustains there until the `done` channel sends a signal.

func AutoscaleUpToNumPods

func AutoscaleUpToNumPods(ctx *TestContext, curPods, targetPods float64, done <-chan time.Time, quick bool) func() error

AutoscaleUpToNumPods starts the traffic for AssertAutoscaleUpToNumPods and returns a function to wait for which will return any error from test execution. Starting the routines is separated from waiting for easy re-use in other places (e.g. upgrade tests).

func CreateAndVerifyInitialScaleConfiguration

func CreateAndVerifyInitialScaleConfiguration(t *testing.T, clients *test.Clients, names test.ResourceNames, wantPods int)

CreateAndVerifyInitialScaleConfiguration creates a Configuration with the `initialScale` annotation set and validates the `wantPods` number of pods are created.

func RevisionFromConfiguration

func RevisionFromConfiguration(clients *test.Clients, configName string) (string, error)

Get revision name from configuration.

func ScaleToWithin

func ScaleToWithin(t *testing.T, scale int, duration time.Duration, latencies Latencies)

ScaleToWithin creates `scale` services in parallel subtests and reports the time taken to `latencies`.

func Setup

func Setup(t *testing.T) *test.Clients

Setup creates the client objects needed in the e2e tests.

func SetupAlternativeNamespace

func SetupAlternativeNamespace(t *testing.T) *test.Clients

SetupAlternativeNamespace creates the client objects needed in e2e tests under the alternative namespace.

func ValidateWebSocketConnection

func ValidateWebSocketConnection(t *testing.T, clients *test.Clients, names test.ResourceNames, timeoutSeconds string) error

func WaitForScaleToZero

func WaitForScaleToZero(t *testing.T, deploymentName string, clients *test.Clients) error

WaitForScaleToZero will wait for the specified deployment to scale to 0 replicas. Will wait up to 6 times the configured ScaleToZeroGracePeriod before failing.

Types

type AutoscalerOptions

type AutoscalerOptions struct {
	Class             string
	Metric            string
	TargetUtilization float64
	Target            int
}

AutoscalerOptions holds autoscaling parameters for knative service.

type Latencies

type Latencies interface {
	// Add takes the name of this measurement and the time at which it began.
	// This should be called at the moment of completion, so that duration may
	// be computed with `time.Since(start)`.  We use this signature to that this
	// function is suitable for use in a `defer`.
	Add(name string, start time.Time)
}

Latencies is an interface for providing mechanisms for recording timings for the parts of the scale test.

type TestContext

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

TestContext includes context for autoscaler testing.

func SetupSvc

func SetupSvc(t *testing.T, aopts *AutoscalerOptions, topts test.Options, fopts ...rtesting.ServiceOption) *TestContext

SetupSvc creates a new service, with given service options. It returns a TestContext that has resources, K8s clients and other needed data points.

func (*TestContext) Clients

func (ctx *TestContext) Clients() *test.Clients

Clients returns the clients of the TestContext.

func (*TestContext) Names

func (ctx *TestContext) Names() *test.ResourceNames

Names returns the resource names of the TestContext.

func (*TestContext) Resources

func (ctx *TestContext) Resources() *v1test.ResourceObjects

Resources returns the resources of the TestContext.

func (*TestContext) SetNames

func (ctx *TestContext) SetNames(names *test.ResourceNames)

SetNames set the resource names of the TestContext to the given values.

func (*TestContext) SetResources

func (ctx *TestContext) SetResources(resources *v1test.ResourceObjects)

SetResources sets the resources of the TestContext to the given values.