lib

package
v0.15.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 28, 2020 License: Apache-2.0 Imports: 52 Imported by: 58

Documentation

Index

Constants

View Source 
const (
	ClusterRoleKind = "ClusterRole"
	RoleKind        = "Role"
)
View Source 
const GetEntryPath = "/entry/"

HTTP path for the GetEntry REST call

View Source 
const GetMinMaxPath = "/minmax"

HTTP path for the GetMinMax REST call

View Source 
const RecordEventsPort = 8392

Port for the recordevents pod REST listener

View Source 
const TrimThroughPath = "/trimthrough/"

HTTP path for the TrimThrough REST call

Variables

View Source 
var BrokerTypeMeta = EventingTypeMeta(resources.BrokerKind)

BrokerTypeMeta is the TypeMeta ref for Broker.

View Source 
var ChannelFeatureMap = map[metav1.TypeMeta][]Feature{
	InMemoryChannelTypeMeta:  {FeatureBasic},
	MessagingChannelTypeMeta: {FeatureBasic},
}

ChannelFeatureMap saves the channel-features mapping. Each pair means the channel support the list of features.

View Source 
var ChannelTypeMeta = MessagingTypeMeta(resources.ChannelKind)

ChannelTypeMeta is the TypeMeta ref for Channel.

View Source 
var DefaultChannel = InMemoryChannelTypeMeta

DefaultChannel is the default channel we will run tests against.

View Source 
var FlowsParallelTypeMeta = FlowsTypeMeta(resources.FlowsParallelKind)

FlowsParallelTypeMeta is the TypeMeta ref for Parallel (in flows.knative.dev).

View Source 
var FlowsSequenceTypeMeta = FlowsTypeMeta(resources.FlowsSequenceKind)

FlowsSequenceTypeMeta is the TypeMeta ref for Sequence (in flows.knative.dev).

View Source 
var InMemoryChannelTypeMeta = metav1.TypeMeta{
	APIVersion: resources.MessagingAPIVersion,
	Kind:       resources.InMemoryChannelKind,
}

InMemoryChannelTypeMeta is the metav1.TypeMeta for InMemoryChannel.

View Source 
var MessagingChannelTypeMeta = metav1.TypeMeta{
	APIVersion: resources.MessagingAPIVersion,
	Kind:       resources.ChannelKind,
}

MessagingChannelTypeMeta is the metav1.TypeMeta for messaging.Channel.

View Source 
var ParallelTypeMeta = MessagingTypeMeta(resources.ParallelKind)

ParallelTypeMeta is the TypeMeta ref for Parallel.

View Source 
var SequenceTypeMeta = MessagingTypeMeta(resources.SequenceKind)

SequenceTypeMeta is the TypeMeta ref for Sequence.

View Source 
var SubscriptionTypeMeta = MessagingTypeMeta(resources.SubscriptionKind)

SubscriptionTypeMeta is the TypeMeta ref for Subscription.

View Source 
var TriggerTypeMeta = EventingTypeMeta(resources.TriggerKind)

TriggerTypeMeta is the TypeMeta ref for Trigger.

Functions

func AwaitForAll added in v0.15.0 

func AwaitForAll(log *zap.SugaredLogger) error

AwaitForAll will wait until all registered wait routines resolves

func CheckerContains 

func CheckerContains(content string) func(string) bool

CheckerContains returns a checker function to check if the log contains the given content.

func CheckerContainsAll 

func CheckerContainsAll(contents []string) func(string) bool

CheckerContainsAll returns a checker function to check if the log contains all the given contents.

func CheckerContainsAtLeast 

func CheckerContainsAtLeast(content string, count int) func(string) bool

CheckerContainsAtLeast returns a checker function to check if the log contains at least the count number of given content.

func CheckerContainsCount 

func CheckerContainsCount(content string, count int) func(string) bool

CheckerContainsCount returns a checker function to check if the log contains the count number of given content.

func CreateNamespaceIfNeeded 

func CreateNamespaceIfNeeded(t *testing.T, client *Client, namespace string)

CreateNamespaceIfNeeded creates a new namespace if it does not exist.

func DeleteNameSpace 

func DeleteNameSpace(client *Client) error

DeleteNameSpace deletes the namespace that has the given name.

func EventingTypeMeta 

func EventingTypeMeta(kind string) *metav1.TypeMeta

EventingTypeMeta returns the TypeMeta ref for an eventing resource.

func FlowsTypeMeta 

func FlowsTypeMeta(kind string) *metav1.TypeMeta

FlowsTypeMeta returns the TypeMeta ref for an eventing messaing resource.

func InterestingHeaders added in v0.14.0 

func InterestingHeaders() []string

InterestingHeaders is used by logging pods to decide interesting HTTP headers to log

func MessagingTypeMeta 

func MessagingTypeMeta(kind string) *metav1.TypeMeta

MessagingTypeMeta returns the TypeMeta ref for an eventing messaging resource.

func TearDown 

func TearDown(client *Client)

TearDown will delete created names using clients.

func WaitFor added in v0.15.0 

func WaitFor(name string, routine AwaitRoutine)

WaitFor will register a wait routine to be resolved later

func WaitForReadiness added in v0.15.0 

func WaitForReadiness(port int) error

WaitForReadiness will wait until readiness endpoint reports OK

func WithService 

func WithService(name string) func(*corev1.Pod, *Client) error

WithService returns an option that creates a Service binded with the given pod.

Types

type AwaitRoutine added in v0.15.0 

type AwaitRoutine func() error

type ChannelTestRunner 

type ChannelTestRunner struct {
	ChannelFeatureMap map[metav1.TypeMeta][]Feature
	ChannelsToTest    []metav1.TypeMeta
}

ChannelTestRunner is used to run tests against channels.

func (*ChannelTestRunner) RunTests 

func (tr *ChannelTestRunner) RunTests(
	t *testing.T,
	feature Feature,
	testFunc func(st *testing.T, channel metav1.TypeMeta),
)

RunTests will use all channels that support the given feature, to run a test for the testFunc.

type Client 

type Client struct {
	Kube          *test.KubeClient
	Eventing      *eventing.Clientset
	Apiextensions *apiextensionsv1beta1.ApiextensionsV1beta1Client
	Dynamic       dynamic.Interface
	Config        *rest.Config

	Namespace string
	T         *testing.T
	Tracker   *Tracker
	// contains filtered or unexported fields
}

Client holds instances of interfaces for making requests to Knative.

func NewClient 

func NewClient(configPath string, clusterName string, namespace string, t *testing.T) (*Client, error)

NewClient instantiates and returns several clientsets required for making request to the cluster specified by the combination of clusterName and configPath.

func Setup 

func Setup(t *testing.T, runInParallel bool, options ...SetupClientOption) *Client

Setup creates the client objects needed in the e2e tests, and does other setups, like creating namespaces, set the test case to run in parallel, etc.

func (*Client) CheckConfigMapsEqual added in v0.13.0 

func (c *Client) CheckConfigMapsEqual(originalNamespace, cmp string, names ...string) error

CheckConfigMapsEqual will check if configmaps have the same data as the original one.

func (*Client) CheckConfigMapsExist added in v0.13.0 

func (c *Client) CheckConfigMapsExist(namespace string, names ...string) error

CheckConfigMapsExist will check if copy configmaps exist.

func (*Client) CheckLog 

func (c *Client) CheckLog(podName string, checker func(string) bool) error

CheckLog waits until logs for the logger Pod satisfy the checker. If the checker does not pass within timeout it returns error.

func (*Client) CheckLogEmpty 

func (c *Client) CheckLogEmpty(podName string, timeout time.Duration) error

CheckLogEmpty waits the given amount of time and check the log is empty

func (*Client) CreateApiServerSourceOrFail 

func (c *Client) CreateApiServerSourceOrFail(apiServerSource *sourcesv1alpha2.ApiServerSource)

CreateApiServerSourceOrFail will create an ApiServerSource

func (*Client) CreateBrokerConfigMapOrFail added in v0.13.0 

func (c *Client) CreateBrokerConfigMapOrFail(name string, channel *metav1.TypeMeta) *duckv1.KReference

func (*Client) CreateBrokerOrFail 

func (c *Client) CreateBrokerOrFail(name string, options ...resources.BrokerOption) *v1alpha1.Broker

CreateBrokerOrFail will create a Broker or fail the test if there is an error.

func (*Client) CreateBrokerV1Beta1OrFail added in v0.13.0 

func (c *Client) CreateBrokerV1Beta1OrFail(name string, options ...resources.BrokerV1Beta1Option) *v1beta1.Broker

CreateBrokerOrFail will create a Broker or fail the test if there is an error.

func (*Client) CreateBrokersOrFail 

func (c *Client) CreateBrokersOrFail(names []string, channelTypeMeta *metav1.TypeMeta)

CreateBrokersOrFail will create a list of Brokers.

func (*Client) CreateChannelOrFail 

func (c *Client) CreateChannelOrFail(name string, channelTypeMeta *metav1.TypeMeta)

CreateChannelOrFail will create a typed Channel Resource in Eventing or fail the test if there is an error.

func (*Client) CreateChannelWithDefaultOrFail 

func (c *Client) CreateChannelWithDefaultOrFail(channel *messagingv1alpha1.Channel)

CreateChannelWithDefaultOrFail will create a default Channel Resource in Eventing or fail the test if there is an error.

func (*Client) CreateChannelsOrFail 

func (c *Client) CreateChannelsOrFail(names []string, channelTypeMeta *metav1.TypeMeta)

CreateChannelsOrFail will create a list of typed Channel Resources in Eventing or fail the test if there is an error.

func (*Client) CreateClusterRoleBindingOrFail 

func (c *Client) CreateClusterRoleBindingOrFail(saName, crName, crbName string)

CreateClusterRoleBindingOrFail will create a ClusterRoleBinding or fail the test if there is an error.

func (*Client) CreateClusterRoleOrFail 

func (c *Client) CreateClusterRoleOrFail(cr *rbacv1.ClusterRole)

CreateClusterRoleOrFail creates the given ClusterRole or fail the test if there is an error.

func (*Client) CreateConfigMapOrFail added in v0.13.0 

func (c *Client) CreateConfigMapOrFail(name, namespace string, data map[string]string) *corev1.ConfigMap

CreateConfigMapOrFail will create a configmap or fail the test if there is an error.

func (*Client) CreateConfigMapPropagationOrFail added in v0.13.0 

func (c *Client) CreateConfigMapPropagationOrFail(name string) *configsv1alpha1.ConfigMapPropagation

func (*Client) CreateContainerSourceV1Alpha2OrFail added in v0.14.0 

func (c *Client) CreateContainerSourceV1Alpha2OrFail(containerSource *sourcesv1alpha2.ContainerSource)

CreateContainerSourceV1Alpha2OrFail will create a ContainerSource.

func (*Client) CreateCronJobOrFail 

func (c *Client) CreateCronJobOrFail(cronjob *batchv1beta1.CronJob, options ...func(*batchv1beta1.CronJob, *Client) error)

CreateCronJobOrFail will create a CronJob or fail the test if there is an error.

func (*Client) CreateDeploymentOrFail 

func (c *Client) CreateDeploymentOrFail(deploy *appsv1.Deployment, options ...func(*appsv1.Deployment, *Client) error)

CreateDeploymentOrFail will create a Deployment or fail the test if there is an error.

func (*Client) CreateFlowsParallelOrFail 

func (c *Client) CreateFlowsParallelOrFail(parallel *flowsv1alpha1.Parallel)

CreateFlowsParallelOrFail will create a Parallel (in flows.knative.dev api group) or fail the test if there is an error.

func (*Client) CreateFlowsSequenceOrFail 

func (c *Client) CreateFlowsSequenceOrFail(sequence *flowsv1alpha1.Sequence)

CreateFlowsSequenceOrFail will create a Sequence (in flows.knative.dev api group) or fail the test if there is an error.

func (*Client) CreatePingSourceV1Alpha1OrFail added in v0.13.0 

func (c *Client) CreatePingSourceV1Alpha1OrFail(pingSource *sourcesv1alpha1.PingSource)

CreatePingSourceV1Alpha1OrFail will create an PingSource

func (*Client) CreatePingSourceV1Alpha2OrFail added in v0.13.0 

func (c *Client) CreatePingSourceV1Alpha2OrFail(pingSource *sourcesv1alpha2.PingSource)

CreatePingSourceV1Alpha2OrFail will create an PingSource

func (*Client) CreatePodOrFail 

func (c *Client) CreatePodOrFail(pod *corev1.Pod, options ...func(*corev1.Pod, *Client) error)

CreatePodOrFail will create a Pod or fail the test if there is an error.

func (*Client) CreateRBACResourcesForBrokers 

func (c *Client) CreateRBACResourcesForBrokers()

CreateRBACResourcesForBrokers creates required RBAC resources for creating Brokers, see https://github.com/knative/docs/blob/master/docs/eventing/broker-trigger.md - Manual Setup.

func (*Client) CreateRoleBindingOrFail 

func (c *Client) CreateRoleBindingOrFail(saName, rKind, rName, rbName, rbNamespace string)

CreateRoleBindingOrFail will create a RoleBinding or fail the test if there is an error.

func (*Client) CreateRoleOrFail 

func (c *Client) CreateRoleOrFail(r *rbacv1.Role)

CreateRoleOrFail creates the given Role in the Client namespace or fail the test if there is an error.

func (*Client) CreateServiceAccountOrFail 

func (c *Client) CreateServiceAccountOrFail(saName string)

CreateServiceAccountOrFail will create a ServiceAccount or fail the test if there is an error.

func (*Client) CreateServiceOrFail 

func (c *Client) CreateServiceOrFail(svc *corev1.Service) *corev1.Service

func (*Client) CreateSinkBindingV1Alpha1OrFail added in v0.13.0 

func (c *Client) CreateSinkBindingV1Alpha1OrFail(sb *sourcesv1alpha1.SinkBinding)

CreateSinkBindingV1Alpha1OrFail will create a SinkBinding or fail the test if there is an error.

func (*Client) CreateSinkBindingV1Alpha2OrFail added in v0.13.0 

func (c *Client) CreateSinkBindingV1Alpha2OrFail(sb *sourcesv1alpha2.SinkBinding)

CreateSinkBindingV1Alpha2OrFail will create a SinkBinding or fail the test if there is an error.

func (*Client) CreateSubscriptionOrFail 

func (c *Client) CreateSubscriptionOrFail(
	name, channelName string,
	channelTypeMeta *metav1.TypeMeta,
	options ...resources.SubscriptionOption,
) *messagingv1alpha1.Subscription

CreateSubscriptionOrFail will create a Subscription or fail the test if there is an error.

func (*Client) CreateSubscriptionOrFailV1Beta1 added in v0.13.0 

func (c *Client) CreateSubscriptionOrFailV1Beta1(
	name, channelName string,
	channelTypeMeta *metav1.TypeMeta,
	options ...resources.SubscriptionOptionV1Beta1,
)

CreateSubscriptionOrFailV1Beta1 will create a Subscription or fail the test if there is an error.

func (*Client) CreateSubscriptionsOrFail 

func (c *Client) CreateSubscriptionsOrFail(
	names []string,
	channelName string,
	channelTypeMeta *metav1.TypeMeta,
	options ...resources.SubscriptionOption,
)

CreateSubscriptionsOrFail will create a list of Subscriptions with the same configuration except the name.

func (*Client) CreateTriggerOrFail 

func (c *Client) CreateTriggerOrFail(name string, options ...resources.TriggerOption) *v1alpha1.Trigger

CreateTriggerOrFail will create a Trigger or fail the test if there is an error.

func (*Client) CreateTriggerOrFailV1Beta1 added in v0.13.0 

func (c *Client) CreateTriggerOrFailV1Beta1(name string, options ...resources.TriggerOptionV1Beta1) *v1beta1.Trigger

CreateTriggerOrFailV1Beta1 will create a v1beta1 Trigger or fail the test if there is an error.

func (*Client) ExportLogs added in v0.15.0 

func (c *Client) ExportLogs(dir string) error

func (*Client) FindAnyLogContents 

func (c *Client) FindAnyLogContents(podName string, contents []string) (bool, error)

FindAnyLogContents attempts to find logs for given Pod/Container that has 'any' of the given contents. It returns an error if it couldn't retrieve the logs. In case 'any' of the contents are there, it returns true.

func (*Client) GetAddressableURI 

func (c *Client) GetAddressableURI(addressableName string, typeMeta *metav1.TypeMeta) (string, error)

GetAddressableURI returns the URI of the addressable resource. To use this function, the given resource must have implemented the Addressable duck-type.

func (*Client) GetLog 

func (c *Client) GetLog(podName string) (string, error)

GetLog gets the logs from the given Pod in the namespace of this client. It will get the logs from the first container, whichever it is.

func (*Client) LabelNamespace 

func (c *Client) LabelNamespace(labels map[string]string) error

LabelNamespace labels the given namespace with the labels map.

func (*Client) NewEventInfoStore added in v0.14.0 

func (c *Client) NewEventInfoStore(podName string, logf logging.FormatLogger) (*EventInfoStore, error)

Creates an EventInfoStore that is used to iteratively download events recorded by the recordevents pod. Calling this forwards the recordevents port to the local machine and blocks waiting to connect to that pod. Fails if it cannot connect within the expected timeout (4 minutes currently)

func (*Client) SendFakeEventToAddressableOrFail added in v0.13.0 

func (c *Client) SendFakeEventToAddressableOrFail(
	senderName,
	addressableName string,
	typemeta *metav1.TypeMeta,
	event *cloudevents.CloudEvent,
)

SendFakeEventToAddressableOrFail will send the given event to the given Addressable.

func (*Client) SendFakeEventWithTracingToAddressableOrFail added in v0.13.0 

func (c *Client) SendFakeEventWithTracingToAddressableOrFail(
	senderName,
	addressableName string,
	typemeta *metav1.TypeMeta,
	event *cloudevents.CloudEvent,
)

SendFakeEventWithTracingToAddressableOrFail will send the given event with tracing to the given Addressable.

func (*Client) WaitForAllTestResourcesReady 

func (c *Client) WaitForAllTestResourcesReady() error

WaitForAllTestResourcesReady waits until all test resources in the namespace are Ready.

func (*Client) WaitForAllTestResourcesReadyOrFail 

func (c *Client) WaitForAllTestResourcesReadyOrFail()

func (*Client) WaitForResourceReadyOrFail 

func (c *Client) WaitForResourceReadyOrFail(name string, typemeta *metav1.TypeMeta)

WaitForResourceReadyOrFail waits for the resource to become ready or fail. To use this function, the given resource must have implemented the Status duck-type.

func (*Client) WaitForResourcesReadyOrFail 

func (c *Client) WaitForResourcesReadyOrFail(typemeta *metav1.TypeMeta)

WaitForResourcesReadyOrFail waits for resources of the given type in the namespace to become ready or fail. To use this function, the given resource must have implemented the Status duck-type.

func (*Client) WaitForServiceEndpointsOrFail 

func (c *Client) WaitForServiceEndpointsOrFail(svcName string, numberOfExpectedEndpoints int)

type EventInfo added in v0.14.0 

type EventInfo struct {
	// Set if the cloudevent received by the pod didn't pass validation
	ValidationError string
	// Event received if the cloudevent received by the pod passed validation
	Event *cloudevents.Event
	// HTTPHeaders of the connection that delivered the event
	HTTPHeaders map[string][]string
}

Structure to hold information about an event seen by recordevents pod.

func (*EventInfo) String added in v0.14.0 

func (ei *EventInfo) String() string

Pretty print the event. Meant for debugging. This formats the validation error or the full event as appropriate. This does NOT format the headers.

type EventInfoMatchFunc added in v0.14.0 

type EventInfoMatchFunc func(EventInfo) bool

Does the provided EventInfo match some criteria

func ValidEvFunc added in v0.14.0 

func ValidEvFunc(evf EventMatchFunc) EventInfoMatchFunc

Convert a boolean check function that checks valid messages to a function that checks EventInfo structures, returning false for any that don't contain valid events.

type EventInfoStore added in v0.14.0 

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

Stateful store of events received by the recordevents pod it is pointed at. This pulls events from the pod during any Find or Wait call, storing them locally and triming them from the remote pod store.

func (*EventInfoStore) Cleanup added in v0.14.0 

func (ei *EventInfoStore) Cleanup()

Clean up any background resources used by the store. Must be called exactly once after the last use.

func (*EventInfoStore) Find added in v0.14.0 

func (ei *EventInfoStore) Find(f EventInfoMatchFunc) ([]EventInfo, SearchedInfo, error)

Find all events received by the recordevents pod that match the provided function, returning all matching events as well as a SearchedInfo structure including the last 5 events seen and the total events matched. This SearchedInfo structure is primarily to ease debugging in failure printouts. The provided function is guaranteed to be called exactly once on each EventInfo from the pod.

func (*EventInfoStore) WaitAtLeastNMatch added in v0.14.0 

func (ei *EventInfoStore) WaitAtLeastNMatch(f EventInfoMatchFunc, n int) ([]EventInfo, error)

Wait a long time (currently 4 minutes) until the provided function matches at least five events. The matching events are returned if we find at least n. If the function times out, an error is returned.

type EventMatchFunc added in v0.14.0 

type EventMatchFunc func(cloudevents.Event) bool

Does the provided event match some criteria

type Feature 

type Feature string

Feature is the feature supported by the channel. 

const (
	// FeatureBasic is the feature that should be supported by all channels.
	FeatureBasic Feature = "basic"
	// FeatureRedelivery means if downstream rejects an event, that request will be attempted again.
	FeatureRedelivery Feature = "redelivery"
	// FeaturePersistence means if channel's Pod goes down, all events already ACKed by the channel
	// will persist and be retransmitted when the Pod restarts.
	FeaturePersistence Feature = "persistence"
)

type MinMaxResponse added in v0.14.0 

type MinMaxResponse struct {
	MinAvail int
	MaxSeen  int
}

On-wire json rest api format for recordevents GetMinMax calls sennt to the recordevents pod.

type ResourceDeleter 

type ResourceDeleter struct {
	Resource dynamic.ResourceInterface
	Name     string
}

ResourceDeleter holds the resource interface and name of resource to be cleaned

type SearchedInfo added in v0.14.0 

type SearchedInfo struct {
	TotalEvent int
	LastNEvent []EventInfo
}

This is mainly used for providing better failure messages

func (*SearchedInfo) String added in v0.14.0 

func (s *SearchedInfo) String() string

Pretty print the SearchedInfor for error messages

type SetupClientOption 

type SetupClientOption func(*Client)

SetupClientOption does further setup for the Client. It can be used if other projects need to do extra setups to run the tests we expose as test helpers. 

var SetupClientOptionNoop SetupClientOption = func(*Client) {

}

SetupClientOptionNoop is a SetupClientOption that does nothing.

type Tracker 

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

Tracker holds resources that need to be tracked during test execution. It includes: 1. KResources that need to check their Ready status; 2. All Kubernetes resources that need to be cleaned after test is done.

func NewTracker 

func NewTracker(t *testing.T, client dynamic.Interface) *Tracker

NewTracker creates a new Tracker

func (*Tracker) Add 

func (t *Tracker) Add(group string, version string, resource string, namespace string, name string)

Add will register a resource to be cleaned by the Clean function This function is generic enough so as to be able to register any resources Each resource is identified by: * group (e.g. serving.knative.dev) * version (e.g. v1alpha1) * resource's plural (e.g. routes) * namespace (use "" if the resource is not tied to any namespace) * actual name of the resource (e.g. myroute)

func (*Tracker) AddObj 

func (t *Tracker) AddObj(obj kmeta.OwnerRefable)

AddObj will register a resource that implements OwnerRefable interface to be cleaned by the Clean function. It also register the resource for checking if its status is Ready. Note this function assumes all resources that implement kmeta.OwnerRefable are KResources.

func (*Tracker) Clean 

func (t *Tracker) Clean(awaitDeletion bool) error

Clean will delete all registered resources

func (*Tracker) WaitForKResourcesReady 

func (t *Tracker) WaitForKResourcesReady() error

WaitForKResourcesReady will wait for all registered KResources to become ready.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.