Skip to main content

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

Installation

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

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ess_community_integration_tests-26.9.1.tar.gz (47.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file ess_community_integration_tests-26.9.1.tar.gz.

File metadata

  • Download URL: ess_community_integration_tests-26.9.1.tar.gz
  • Upload date:
  • Size: 47.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for ess_community_integration_tests-26.9.1.tar.gz
Algorithm Hash digest
SHA256 25f094c02af827ac7047417b1fcf7068e2ed91b29bfd99e21f3abc3f79ff1f09
MD5 9da7823238afdc845f4f993ef26a8e80
BLAKE2b-256 2bc42a121a1ffb553439cf2ce968ab6c5289bb66c822895d6067f6736a7e9c0d

See more details on using hashes here.

File details

Details for the file ess_community_integration_tests-26.9.1-py3-none-any.whl.

File metadata

  • Download URL: ess_community_integration_tests-26.9.1-py3-none-any.whl
  • Upload date:
  • Size: 70.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for ess_community_integration_tests-26.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 67b05f1c734116fdc6aa79dc3eda4bad14464522aacfc2b5977c7c631bc41fcb
MD5 571771e0a77471267679e08cf99b6235
BLAKE2b-256 7c6fb0baf796f9dc471b217531f184e950f0f2fa4d54e6fb4151cf4f13b61fe0

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

26.9.1 This release

2 files

26.9.0

2 files

26.8.1

2 files

26.8.0

2 files

26.7.2

2 files

26.7.1

2 files

26.7.0

2 files

26.6.2

2 files

26.6.1

2 files

26.6.0

2 files

26.5.1

2 files

26.5.0

2 files

26.4.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page