cluster-tests

Tests for Cluster Orchestration Service

Overview

This repo documents the test plan for Cluster Orchestration subsystem in Intel® Open Edge Platform. It also hosts the integration test framework and test cases that is used test the cluster orchestration subsystem.

Get started

Prerequisites

This repo uses the following tools. Make sure you have them installed on your system:

• mage build tool to build and run the tests.
• asdf to manage the versions of the tools used in the tests.
• docker to run the tests in a containerized environment.

Install other dependencies

To install the dependencies, run the following command:

mage asdfPlugins

Make sure to set export PATH="$HOME/.asdf/shims:$PATH" in your shell profile to ensure that the tools installed by asdf are available in your PATH.

Running the tests

To run the tests, run the following command:

make test

To verify your environment first (recommended), run:

make preflight

The above step will internally invoke the bootstrap make target to bootstrap the environment with the dependencies configured in .test-dependencies.yaml file before running the tests.

Refer the test-plan/test-plan.md for the detailed test plan.

vEN mode (Virtual Edge Node)

Tests run against a vEN (Virtual Edge Node) reachable over SSH.

To run, set:

• EDGE_NODE_PROVIDER=ven
• NODEGUID (or VEN_NODEGUID) to the onboarded host GUID
• SSH connection info:
  • VEN_SSH_HOST
  • VEN_SSH_KEY (path to private key)
  • optional: VEN_SSH_USER, VEN_SSH_PORT (default: 22)

Note: the default VEN_SSH_USER depends on the bootstrap script:

• scripts/ven/bootstrap.sh defaults to root
• scripts/ven/bootstrap_vm_cluster_agent.sh defaults to ubuntu (default in make test)

You can either export these variables directly, or use a bootstrap command that writes .ven.env which is automatically sourced by make test targets:

EDGE_NODE_PROVIDER=ven \
VEN_BOOTSTRAP_CMD=./scripts/ven/bootstrap.sh \
NODEGUID=<host-guid> \
VEN_SSH_HOST=<ven-ip-or-hostname> \
VEN_SSH_KEY=$HOME/.ssh/id_rsa \
make test

Configuring test dependencies

While there is a default configuration to bootstrap the test environment, it is also possible for you to configure the dependencies.

Below is the format the .test-dependencies.yaml file. You can add the dependencies that you need to install for your tests.

# .test-dependencies.yaml
# This YAML file defines the dependencies for the test bootstrap step. It specifies build steps for various dependencies
# required for the test environment. The file contains the following fields:
#
# Fields:
# - kind-cluster-config: Specifies the configuration file for the kind cluster.
#
# - components: A list of components, each with its own configuration:
#   - name: The name of the component.
#   - skip-component: A flag to skip the component during the build process (true/false).
#   - skip-local-build: A flag to skip the local build of the component (true/false).
#   - pre-install-commands: Commands to run before installing the component.
#   - helm-repo: Details for the Helm repositories, including:
#       - url: The URL of the Helm repository.
#         release-name: The release name for the Helm chart.
#         package: The Helm chart package name.
#         namespace: The Kubernetes namespace for the Helm release.
#         version: The version of the Helm chart.
#         use-devel: A flag to enable (or not) usage of developer versions of the chart
#         overrides: The Helm chart overrides.
#   - git-repo:
#       url: The Git URL of the component's repository.
#       version: The Git branch/tag/commit of the component to use.
#   - make-directory: The directory containing the Makefile.
#   - make-variables: Variables to pass to the `make` command.
#   - make-targets: `make` targets to build the component.
#   - post-install-commands: Commands to run after installing the component.

You can override the default configuration by setting the ADDITIONAL_CONFIG environment variable for the test:bootstrap target like below.

ADDITIONAL_CONFIG='{"components":[{"name":"cluster-api-provider-intel", "skip-local-build": false, "git-repo": {"version":"my-dev-branch"}}]}' mage test:bootstrap

This example command will override the version of the cluster-api-provider-intel component to my-dev-branch.

NOTE: The ADDITIONAL_CONFIG should be a valid JSON string and should follow the format specified in the .test-dependencies.yaml file.

Contribute

We welcome contributions from the community! To contribute, please open a pull request to have your changes reviewed and merged. See the contributor's guide to learn more.

The project will accept contributions through Pull-Requests (PRs). PRs must be built successfully by the CI pipeline, pass linters verifications and the unit tests.

Community and Support

To learn more about the project, its community, and governance, visit the Edge Orchestrator Community. For support, start with Troubleshooting or contact us.

There are several convenience make targets to support developer activities, you can run mage -l to see the list of available targets.

License

Cluster tests is licensed under Apache 2.0 License