kyma-js v0.0.1-alpha.12

Fast integration tests

Overview

This project provides fast integration tests for Kyma. The goal is to decrease the minimal turnaround time from the current 90 minutes to less than 10 minutes (ten times). Fast integration tests will solve the problem partially. Other initiatives that are executed in parallel are equally important: switching to k3s, reducing Kubernetes provisioning time, and implementing the parallel installation of Kyma components.

The project contains also kyma-js tool which you can use in the development process. Kyma-js is a temporary solution that implements subset of commands of Kyma CLI but focuses on local development and minimal turnaround time (parallel installation). It provides some additional features that are useful for development, like: upgrade of selected components, skipping some components from installation, testing upgrade to new eventing, provisioning/deprovisioning of k3d cluster.

Prerequisites

• A node.js installation.
• KUBECONFIG pointing to the Kubernetes cluster which has Kyma installed. If you don't have Kyma yet, you can quickly run it locally using this project.
• Docker configured with 4GB RAM
• k3d - you can install it with the command: brew install k3d or curl -s https://raw.githubusercontent.com/rancher/k3d/main/install.sh | bash
• (optional) crane - tool to copy docker images, install it with the command: GO111MODULE=on go get -u github.com/google/go-containerregistry/cmd/crane

Usage

To run tests locally, follow these steps:

1. Checkout the Kyma project:

git clone git@github.com:kyma-project/kyma.git

2. Install dependencies:

cd kyma/tests/fast-integration
npm install

3. Execute the tests:

npm test

Local development

Here you have sample development tasks you can execute on your local machine working with kyma source code.

1. Install kyma-js as global package:

   npm install -g kyma-js

   or navigate to the fast-integration folder (where kyma.js file is located) and symlink the package folder:

   npm link

   The second option allows you to change the code of the installer and use it without building/publishing/updating.

2. Create local cluster:

   kyma-js provision k3d

3. Install kyma without some modules, and with new eventing (instead of knative):

   kyma-js install -v --skip-modules=monitoring,tracing,logging,kiali --new-eventing

4. Execute commerce mock test with DEBUG enabled:

   DEBUG=true mocha test/2-commerce-mock.js

5. Upgrade some component:

   kyma-js install -v --component=application-connector --new-eventing

6. Delete all, and start from scratch:

   kyma-js deprovision k3d

Execute kyma-js <command> --help to learn more about possibilities.

FAQ

Why don't you use Octopus?

Octopus is a great tool for running tests inside the Kubernetes cluster in a declarative way. But it is not the right tool for fast integration testing. The goal is to execute the tests in 4 minutes. With Octopus, you need 4 minutes or more before the tests even start (2 minutes to build the test image and push it to the Docker registry, 1 minute to deploy Octopus, and 1 minute to deploy the test Pod).

Octopus testing flow looks like this: 1. Build a test image (or images) and push it (~ 2min/image). 2. Deploy Octopus (~1 min). 3. Deploy a test Pod (test image), (~ 1min/image). 4. In many tests, sleep 20 seconds to wait for a sidecar. 5. Deploy the "test scene" (~1 min/image). 6. Execute the test (5 sec/test). 7. Wait for the test completion and collect results (~1 min).

The fast-integration tests contain just 2 steps: 1. Deploy the "test scene" (~1-2 minutes, one scene for all the tests). 2. Execute the test (5 sec/test).

In this way, we can reduce testing phase from about 40 minutes to about 4 minutes.

Why are tests written in node.js and not in Go?

Tests are written in node.js for several reasons:

• No compilation time
• Concise syntax (handling JSON responses from api-server or our test fixtures)
• Lighter dependencies (@kubernetes/client-node)
• Educational value for our customers who can read tests to learn how to use Kyma features (none of our customers write code in Go, they use JavaScript, Java, or Python)

Which pipelines use fast-integration tests?

We have several pipelines that use fast-integration tests. See the list of pipelines with links to the Prow status page: