README ¶
End-to-end Upgrade Tests
Overview
This project contains end-to-end upgrade tests run for the Kyma upgrade plan on CI. The tests are written in Go. The framework allows you to define two actions:
- Preparing the data
- Running tests against the prepared data
Prerequisites
To set up the project, use these tools:
Usage
Run end-to-end upgrade tests for the Kyma upgrade plan on Prow. The continuous integration flow looks as follows:
- Install Kyma from the latest release.
- Create data for end-to-end upgrade tests. The CreateResources method is executed for all registered tests.
- Upgrade Kyma cluster.
- Run the
testing.sh
script. - Run end-to-end upgrade tests. The TestResources method is executed for all registered tests.
Use environment variables
Use the following environment variables to configure the application:
Name | Required | Default | Description |
---|---|---|---|
APP_LOGGER_LEVEL | NO | info |
A parameter that sets the logging level in an application. The possible values are debug , info , warn , warning , error , fatal , and panic . |
APP_KUBECONFIG_PATH | NO | - | A path to the kubeconfig file needed to run an application outside of the cluster. |
APP_MAX_CONCURRENCY_LEVEL | NO | 1 |
A maximum concurrency level used for running tests. |
Use flags
Use the following flags to configure the application:
Name | Required | Description |
---|---|---|
action | YES | Defines what kind of action to execute. The possible values are prepareData and executeTests . |
verbose | NO | Prints logs for all tests. |
See the example:
go run main.go --action prepareData --verbose
Development
This section presents how to add and run a new test. It also describes how to verify the code and ensure that your test is correct.
Add a new test
Add a new test under the pkg/tests/{domain-name}
directory and implement the following interface:
UpgradeTest interface {
CreateResources(stop <-chan struct{}, log logrus.FieldLogger, namespace string) error
TestResources(stop <-chan struct{}, log logrus.FieldLogger, namespace string) error
}
In each method, the framework injects the following parameters:
- stop - a channel called when the application shutdown is requested. Use it to gracefully shutdown your test.
- log - a logger used when you need additional logging in your test. Logged data is printed only if a given method fails.
- namespace - a space created for you by the framework.
This interface allows you to easily register the test in the main.go
file by adding a new entry in the test map:
// Register tests. Convention:
// {test-name} : {test-instance}
//
// Using map is intentional - we ensure that test name is not duplicated.
// Test name is sanitized and used for creating dedicated Namespace for a given test
// so that it doesn't overlap with others.
tests := map[string]runner.UpgradeTest{
"YourTestName": yourpkg.NewTest(),
}
See the example test here.
NOTE: If your test operates on Kubernetes resources, ensure that RBAC rules are updated in the upgrade Helm chart.
Run end-to-end tests locally
Run the application without building a binary file. To do so:
- Prepare the upgrade data:
env APP_KUBECONFIG_PATH=/Users/$USER/.kube/config APP_LOGGER_LEVEL=debug go run main.go --action prepareData
- Run tests:
env APP_KUBECONFIG_PATH=/Users/$USER/.kube/config APP_LOGGER_LEVEL=debug go run main.go --action executeTests
For the description of the available environment variables, see this section.
Run tests using a Helm chart
Run the application using Helm:
-
Prepare the upgrade data:
helm install --name e2e-test-upgrade --namespace {namespace} ./chart/upgrade/ --wait --tls
-
Run tests:
helm test e2e-test-upgrade --tls
Run tests using Telepresence
Telepresence allows you to run tests locally while connecting a service to a remote Kubernetes cluster. It is helpful when the test needs access to other services in a cluster.
- Install Telepresence.
- Run tests:
env APP_KUBECONFIG_PATH=/Users/$USER/.kube/config telepresence --run go run main.go --action executeTests --verbose
Verify the code
Use the before-commit.sh
script or the make build
command to test your changes before each commit.
Project structure
The repository has the following structure:
.
├── chart # The Helm chart for deploying the upgrade test application
├── internal # The internal source code of the upgrade test framework
├── pkg # The directory which contains all secondary Go packages
│ └── tests # The package where upgrade tests are defined. Put your test here.
├── vendor # Dep-managed dependencies
├── main.go # The entrypoint for upgrade test runner
├── Gopkg.toml # A dep manifest
└── Gopkg.lock # A dep lock which is generated automatically. Do not edit it.
Documentation ¶
There is no documentation for this package.