README
¶
Test
This directory contains tests and testing docs for Knative Eventing.
- Unit tests reside in the codebase alongside the code they test
- End-to-end tests reside in
/test/e2e
Running unit tests
Use go test:
go test -v ./pkg/...
By default go test will not run the e2e tests,
which need -tags=e2e to be enabled.
Presubmit tests
presubmit-tests.sh is the entry point for the
end-to-end tests.
This script, and consequently, the e2e tests will be run before every code submission. You can run these tests manually with:
test/presubmit-tests.sh
Note that to run presubmit-tests.sh or e2e-tests.sh scripts, you need to
have a running environment that meets
the e2e test environment requirements
Running end-to-end tests
To run the e2e tests, you need to have a running environment that meets
the e2e test environment requirements, and you need
to specify the build tag e2e.
go test -v -tags=e2e -count=1 ./test/e2e
One test case
To run one e2e test case, e.g. TestKubernetesEvents, use
the -run flag with go test:
go test -v -tags=e2e -count=1 ./test/e2e -run ^TestKubernetesEvents$
Environment requirements
There's couple of things you need to install before running e2e tests locally.
-
kubetestinstalled:go get -u k8s.io/test-infra/kubetest -
[A running
Knative Servingcluster.] -
A docker repo containing the test images
Simply run the ./test/e2e-tests.sh script. It will create a GKE cluster,
install Knative Serving stack with Istio, upload test images to your Docker repo
and run the end-to-end tests against the Knative Eventing built from source.
If you already have the *_OVERRIDE environment variables set, call the script
with the --run-tests argument and it will use the cluster and run the tests.
Note that this requires you to have Serving and Istio installed and configured
to your particular configuration setup. Knative Eventing will still built and
deployed from source.
Otherwise, calling this script without arguments will create a new cluster in
project $PROJECT_ID, start Knative Serving and the eventing system, upload
test images, run the tests and delete the cluster. In this case, it's required
that $KO_DOCKER_REPO points to a valid writable docker repo.
Test images
Building the test images
Note: this is only required when you run e2e tests locally with go test
commands. Running tests through e2e-tests.sh will publish the images
automatically.
The upload-test-images.sh script can be used to
build and push the test images used by the e2e tests. It requires:
KO_DOCKER_REPOto be set- You to be
authenticated with your
KO_DOCKER_REPO dockerto be installed
To run the script for all end to end test images:
./test/upload-test-images.sh e2e
A docker tag is mandatory to avoid issues with using latest tag for images
deployed in GCR.
Adding new test images
New test images should be placed in ./test/test_images. For each image create
a new sub-folder and include a Go file that will be an entry point to the
application. This Go file should use the package "main" and include the function
main(). It is a good practice to include a readme file as well. When uploading
test images, ko will build an image from this folder.
Flags
Flags are similar to those in
Knative Serving
Documentation
¶
Index ¶
- Constants
- Variables
- func Broker(name string, namespace string) *v1alpha1.Broker
- func Channel(name string, namespace string, provisioner *corev1.ObjectReference) *v1alpha1.Channel
- func ChannelRef(name string) *corev1.ObjectReference
- func ClusterChannelProvisioner(name string) *corev1.ObjectReference
- func EventLoggerPod(name string, namespace string, selector map[string]string) *corev1.Pod
- func EventSenderPod(name string, namespace string, sink string, event *CloudEvent) *corev1.Pod
- func EventTransformationPod(name string, namespace string, selector map[string]string, msgPostfix string) *corev1.Pod
- func IsBrokerReady(b *eventingv1alpha1.Broker) (bool, error)
- func IsChannelReady(c *eventingv1alpha1.Channel) (bool, error)
- func IsSubscriptionReady(s *eventingv1alpha1.Subscription) (bool, error)
- func IsTriggerReady(t *eventingv1alpha1.Trigger) (bool, error)
- func PodsRunning(podList *corev1.PodList) (bool, error)
- func ReplyStrategyForChannel(name string) *v1alpha1.ReplyStrategy
- func Service(name string, namespace string, selector map[string]string) *corev1.Service
- func SubscriberSpecForService(name string) *v1alpha1.SubscriberSpec
- func Subscription(name string, namespace string, channel *corev1.ObjectReference, ...) *v1alpha1.Subscription
- func TriggersReady(triggerList *eventingv1alpha1.TriggerList) (bool, error)
- func WaitForBrokerState(client eventingclient.BrokerInterface, name string, ...) error
- func WaitForChannelState(client eventingclient.ChannelInterface, name string, ...) error
- func WaitForSubscriptionState(client eventingclient.SubscriptionInterface, name string, ...) error
- func WaitForTriggerState(client eventingclient.TriggerInterface, name string, ...) error
- func WaitForTriggersListState(clients eventingclient.TriggerInterface, ...) error
- type Cleaner
- type Clients
- type CloudEvent
- type EventingEnvironmentFlags
- type ResourceDeleter
- type TriggerBuilder
- func (b *TriggerBuilder) Broker(brokerName string) *TriggerBuilder
- func (b *TriggerBuilder) Build() *eventingv1alpha1.Trigger
- func (b *TriggerBuilder) EventSource(eventSource string) *TriggerBuilder
- func (b *TriggerBuilder) EventType(eventType string) *TriggerBuilder
- func (b *TriggerBuilder) SubscriberSvc(svcName string) *TriggerBuilder
- type TypeAndSource
Constants ¶
const ( CloudEventEncodingBinary = "binary" CloudEventEncodingStructured = "structured" CloudEventDefaultEncoding = CloudEventEncodingBinary CloudEventDefaultType = "dev.knative.test.event" )
Variables ¶
var EventingFlags = initializeEventingFlags()
EventingFlags holds the command line flags specific to knative/eventing
Functions ¶
func ChannelRef ¶
func ChannelRef(name string) *corev1.ObjectReference
ChannelRef returns an ObjectReference for a given Channel Name.
func ClusterChannelProvisioner ¶
func ClusterChannelProvisioner(name string) *corev1.ObjectReference
ClusterChannelProvisioner returns a ClusterChannelProvisioner for a given name.
func EventLoggerPod ¶
EventLoggerPod creates a Pod that logs events received.
func EventSenderPod ¶
EventSenderPod creates a Pod that sends a single event to the given address.
func EventTransformationPod ¶
func EventTransformationPod(name string, namespace string, selector map[string]string, msgPostfix string) *corev1.Pod
EventTransformationPod creates a Pod that transforms events received.
func IsBrokerReady ¶
func IsBrokerReady(b *eventingv1alpha1.Broker) (bool, error)
IsBrokerReady will check the status conditions of the Broker and return true if the Broker is ready.
func IsChannelReady ¶
func IsChannelReady(c *eventingv1alpha1.Channel) (bool, error)
IsChannelReady will check the status conditions of the Channel and return true if the Channel is ready.
func IsSubscriptionReady ¶
func IsSubscriptionReady(s *eventingv1alpha1.Subscription) (bool, error)
IsSubscriptionReady will check the status conditions of the Subscription and return true if the Subscription is ready.
func IsTriggerReady ¶
func IsTriggerReady(t *eventingv1alpha1.Trigger) (bool, error)
IsTriggerReady will check the status conditions of the Trigger and return true if the Trigger is ready.
func PodsRunning ¶
PodsRunning will check the status conditions of the pod list and return true if all pods are Running.
func ReplyStrategyForChannel ¶
func ReplyStrategyForChannel(name string) *v1alpha1.ReplyStrategy
ReplyStrategyForChannel returns a ReplyStrategy for a given Channel.
func Service ¶
Service creates a Kubernetes Service with the given name, namespace, and selector. Port 8080 is assumed the target port.
func SubscriberSpecForService ¶
func SubscriberSpecForService(name string) *v1alpha1.SubscriberSpec
SubscriberSpecForService returns a SubscriberSpec for a given Knative Service.
func Subscription ¶
func Subscription(name string, namespace string, channel *corev1.ObjectReference, subscriber *v1alpha1.SubscriberSpec, reply *v1alpha1.ReplyStrategy) *v1alpha1.Subscription
Subscription returns a Subscription.
func TriggersReady ¶
func TriggersReady(triggerList *eventingv1alpha1.TriggerList) (bool, error)
TriggersReady will check the status conditions of the trigger list and return true if all triggers are Ready.
func WaitForBrokerState ¶
func WaitForBrokerState(client eventingclient.BrokerInterface, name string, inState func(r *eventingv1alpha1.Broker) (bool, error), desc string) error
WaitForBrokerState polls the status of the Broker called name from client every interval until inState returns `true` indicating it is done, returns an error or timeout. desc will be used to name the metric that is emitted to track how long it took for name to get into the state checked by inState.
func WaitForChannelState ¶
func WaitForChannelState(client eventingclient.ChannelInterface, name string, inState func(r *eventingv1alpha1.Channel) (bool, error), desc string) error
WaitForChannelState polls the status of the Channel called name from client every interval until inState returns `true` indicating it is done, returns an error or timeout. desc will be used to name the metric that is emitted to track how long it took for name to get into the state checked by inState.
func WaitForSubscriptionState ¶
func WaitForSubscriptionState(client eventingclient.SubscriptionInterface, name string, inState func(r *eventingv1alpha1.Subscription) (bool, error), desc string) error
WaitForSubscriptionState polls the status of the Subscription called name from client every interval until inState returns `true` indicating it is done, returns an error or timeout. desc will be used to name the metric that is emitted to track how long it took for name to get into the state checked by inState.
func WaitForTriggerState ¶
func WaitForTriggerState(client eventingclient.TriggerInterface, name string, inState func(r *eventingv1alpha1.Trigger) (bool, error), desc string) error
WaitForTriggerState polls the status of the Trigger called name from client every interval until inState returns `true` indicating it is done, returns an error or timeout. desc will be used to name the metric that is emitted to track how long it took for name to get into the state checked by inState.
func WaitForTriggersListState ¶
func WaitForTriggersListState(clients eventingclient.TriggerInterface, inState func(t *eventingv1alpha1.TriggerList) (bool, error), desc string) error
WaitForTriggersListState polls the status of the TriggerList from client every interval until inState returns `true` indicating it is done, returns an error or timeout. desc will be used to name the metric that is emitted to track how long it took to get into the state checked by inState.
Types ¶
type Cleaner ¶
type Cleaner struct {
// contains filtered or unexported fields
}
Cleaner holds resources that will be cleaned after test
func NewCleaner ¶
func NewCleaner(log logging.FormatLogger, client dynamic.Interface) *Cleaner
NewCleaner creates a new Cleaner
func (*Cleaner) Add ¶
func (c *Cleaner) Add(group string, version string, resource string, namespace string, name string) error
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)
type Clients ¶
type Clients struct {
Kube *test.KubeClient
Eventing *eventing.Clientset
Dynamic dynamic.Interface
}
Clients holds instances of interfaces for making requests to Knative.
func NewClients ¶
NewClients instantiates and returns several clientsets required for making request to the cluster specified by the combination of clusterName and configPath. Clients can make requests within namespace.
type CloudEvent ¶
type CloudEvent struct {
ID string
Type string
Source string
Data string
Encoding string // binary or structured
}
CloudEvent specifies the arguments for a CloudEvent sent by the sendevent binary.
type EventingEnvironmentFlags ¶
type EventingEnvironmentFlags struct {
Provisioner string // The name of the Channel's ClusterChannelProvisioner
}
EventingEnvironmentFlags holds the e2e flags needed only by the eventing repo
type ResourceDeleter ¶
type ResourceDeleter struct {
Resource dynamic.ResourceInterface
Name string
}
ResourceDeleter holds the cleaner and name of resource to be cleaned
type TriggerBuilder ¶
type TriggerBuilder struct {
*eventingv1alpha1.Trigger
}
Builder for trigger objects.
func NewTriggerBuilder ¶
func NewTriggerBuilder(name, namespace string) *TriggerBuilder
func (*TriggerBuilder) Broker ¶
func (b *TriggerBuilder) Broker(brokerName string) *TriggerBuilder
func (*TriggerBuilder) Build ¶
func (b *TriggerBuilder) Build() *eventingv1alpha1.Trigger
func (*TriggerBuilder) EventSource ¶
func (b *TriggerBuilder) EventSource(eventSource string) *TriggerBuilder
func (*TriggerBuilder) EventType ¶
func (b *TriggerBuilder) EventType(eventType string) *TriggerBuilder
func (*TriggerBuilder) SubscriberSvc ¶
func (b *TriggerBuilder) SubscriberSvc(svcName string) *TriggerBuilder
type TypeAndSource ¶
TypeAndSource specifies the type and source of an Event.
Source Files
Directories