ESS Community Integration Tests

Overview

The ESS Community Integration Tests project is designed to facilitate the testing of components against Element Server Suite. It provides a command-line interface (CLI) to run ESS integration tests.

Features

• Set up a Kubernetes cluster for testing.
• Run integration tests for ESS using predefined test suites.
• Customize test runs with additional values files.

Prerequisites

• Python 3.11 or higher
• Docker
• k3d
• Helm
• Optional: uv to install from git

The browser based tests drive a Chromium running in a docker container, so no browser needs to be installed locally. They need the optional Playwright controller:

• On glibc hosts, install it with the browser extra, e.g. pipx install ess-community-integration-tests[browser].
• On musl hosts (e.g. Alpine Linux), Playwright publishes no packages: install it with scripts/setup_playwright_controller.sh instead.

Without it, the browser tests are skipped.

Installation

pipx install ess-community-integration-tests
uvx ess-community-integration-tests

To also run the browser based tests, install the browser extra:

pipx install ess-community-integration-tests[browser]
uvx --from 'ess-community-integration-tests[browser]' pytest-ess

You can also install it from the git repository :

# You can also use any ESS Community version
VERSION=main
uv tool install git+https://github.com/element-hq/ess-helm.git@$VERSION#subdirectory=tests

Example:

VERSION=main
uv tool install git+https://github.com/element-hq/ess-helm.git@$VERSION#subdirectory=tests
    Updated https://github.com/element-hq/ess-helm.git (d6d33a7f7051a0b6bbdcc609a059ae328feee269)
      Built ess-community-integration-tests @ git+https://github.com/element-hq/ess-helm.git@d6d33a7f7051a0b6bbdcc609a059ae328feee269#subdirectory=tests
...
Installed 3 executables: collect-ess-logs, pytest-ess, setup-ess-cluster

Usage

Setting Up a Cluster

To set up a Kubernetes cluster for testing, use the setup-ess-cluster command:

setup-ess-cluster

Running Tests

To run tests, use the run-tests command:

pytest-ess --test-suite <test-suite-name> [options]

Options

• --test-suite: Name of the test suite to run. Available test suites are defined in the env directory as .rc files.
• --pull-chart: Pull the Helm chart for testing.
• --chart-version: Specify the chart version to pull. If not provided, the version is inferred from the package version.
• --keep: Keep the Kubernetes cluster after tests complete.
• --additional-test-values-file: Path to an additional values file for custom test configurations.

Test Suites

Test suites are defined in the env directory as .rc files. Each file corresponds to a different test environment configuration.