test

package

v0.38.4 Latest Latest Go to latest Published: Sep 22, 2023 License: Apache-2.0 Imports: 4 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/knative/eventing

Links

Open Source Insights

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 tests with scripts

Presubmit tests

presubmit-tests.sh is the entry point for the tests before code submission.

You can run it simply with:

test/presubmit-tests.sh

By default, this script will run build tests, unit tests and integration tests. If you only want to run one type of tests, you can run this script with corresponding flags like below:

test/presubmit-tests.sh --build-tests
test/presubmit-tests.sh --unit-tests
test/presubmit-tests.sh --integration-tests

Note that if the tests you are running include integration tests, it will create a new GKE cluster in project $PROJECT_ID, start Knative Serving and Eventing system, upload test images to $KO_DOCKER_REPO, and run all e2e-*tests.sh scripts under test.

E2E tests

e2e-tests.sh is the entry point for running all e2e tests.

In this section we use GCP as an example, other platforms might need different options.

You can run it simply with:

test/e2e-tests.sh --gcp-project-id=$PROJECT_ID

By default, it will create a new GKE cluster in project $PROJECT_ID, start Knative Serving and Eventing system, upload test images to $KO_DOCKER_REPO, and run the end-to-end tests. After the tests finishes, it will delete the cluster.

If you have already created your own Kubernetes cluster but haven't installed Knative, you can run with test/e2e-tests.sh --run-tests --gcp-project-id=$PROJECT_ID.

If you have set up a running environment that meets the e2e test environment requirements, you can run with test/e2e-tests.sh --run-tests --skip-knative-setup --gcp-project-id=$PROJECT_ID.

If you want to turn off the chaosduck during the test, you can set $SCALE_CHAOSDUCK_TO_ZERO to 1.

Running tests with `go test` command

Running unit tests

You can also use go test command to run unit tests:

go test -v ./pkg/...

By default go test will not run the e2e tests, which needs -tags=e2e to be enabled.

Running end-to-end tests

To run the e2e tests with go test command, you need to have a running environment that meets the e2e test environment requirements, and you need to specify the build tag e2e.

If you are using a private registry that will require authentication then you'll need to create a Secret in your default Namespace called kn-eventing-test-pull-secret with the Docker login credentials. This Secret will then be copied into any new Namespace that is created by the testing infrastructure, and linked to any ServiceAccount created as a imagePullSecret. Note: some tests will use the knative-eventing-injection label to automatically create new ServiceAccounts in some Namespaces, this feature does not yet support private registries. See https://github.com/knative/eventing/issues/1862 for status of this issue.

SYSTEM_NAMESPACE=knative-eventing go test -v -tags=e2e -count=1 ./test/e2e

By default, tests run against images with the latest tag. To override this behavior you can specify a different tag through -tag:

SYSTEM_NAMESPACE=knative-eventing go test -v -tags=e2e -count=1 ./test/e2e -tag e2e

One test case

To run one e2e test case, e.g. TestSingleBinaryEventForChannel, use the -run flag with go test:

SYSTEM_NAMESPACE=knative-eventing go test -v -tags=e2e -count=1 ./test/e2e -run ^TestSingleBinaryEventForChannel$

Environment requirements

There's couple of things you need to install before running e2e tests locally.

A running Knative cluster
A docker repo containing the test images

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_REPO to be set
You to be authenticated with your KO_DOCKER_REPO
docker to be installed

PLATFORM environment variable is optional. If it is specified, test images will be built for specific hardware architecture, according to its value (for instance,linux/arm64).

To run the script for all end to end test images:

./test/upload-test-images.sh

For images deployed in GCR, a docker tag is mandatory to avoid issues with using latest tag:

./test/upload-test-images.sh e2e

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 ¶

Constants ¶

View Source

const (
	ChannelUsage = "The names of the channel type metas, separated by comma. " +
		`Example: "messaging.knative.dev/v1:InMemoryChannel,` +
		`messaging.knative.dev/v1beta1:KafkaChannel".`
	BrokerClassUsage = "Which brokerclass to test, requires the proper Broker " +
		"implementation to have been installed, and only one value. brokerclass " +
		"must be (for now) 'MTChannelBasedBroker'."
	SourceUsage = "The names of the source type metas, separated by comma. " +
		`Example: "sources.knative.dev/v1:ApiServerSource,` +
		`sources.knative.dev/v1beta2:PingSource".`
	BrokerUsage = "The name of the broker type metas, separated by comma. " +
		`Example: "eventing.knative.dev/v1:MTChannelBasedBroker`
	BrokerNameUsage = "When testing a pre-existing broker, specify the Broker name so the conformance tests " +
		"won't create their own."
	BrokerNamespaceUsage = "When testing a pre-existing broker, this variable specifies the namespace the broker can be found in."
	BrokerClass          = "MTChannelBasedBroker"
)

Variables ¶