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.8.0.tar.gz (47.7 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.8.0.tar.gz.

File metadata

  • Download URL: ess_community_integration_tests-26.8.0.tar.gz
  • Upload date:
  • Size: 47.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.1 {"installer":{"name":"uv","version":"0.12.1","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.8.0.tar.gz
Algorithm Hash digest
SHA256 4a493721e830d800f8bf324379c1de820a983ae7189138b01220adb6d844dc11
MD5 5967b490ec17328d2e643cf1baa499cd
BLAKE2b-256 7756d599688724ce16c20890e7be6e9b041947abaae680178bc8f427dc6a0d29

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ess_community_integration_tests-26.8.0-py3-none-any.whl
  • Upload date:
  • Size: 70.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.1 {"installer":{"name":"uv","version":"0.12.1","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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4bc4dfff7202fdd3aa2cef644caafb461d021924dfd3e95238abd90daf7aa2f0
MD5 2c2fe6285f2593de35117d8f02cac878
BLAKE2b-256 602096e8e3a2378fe0b4c82e3f34fd46db52b1633d2870d327037a9a3115e541

See more details on using hashes here.

Release history Release notifications | RSS feed

26.9.1

2 files

26.9.0

2 files

26.8.1

2 files

This release

26.8.0 This release

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