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

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.

Metadata

Release files for ess-community-integration-tests 26.10.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ess-community-integration-tests 26.10.3
File Size Uploaded Provenance Actions
ess_community_integration_tests-26.10.3.tar.gz 50.2 kB Without provenance Details for ess_community_integration_tests-26.10.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ess-community-integration-tests 26.10.3
File Interpreter ABI Platform Actions
ess_community_integration_tests-26.10.3-py3-none-any.whl Python 3 none any Details for ess_community_integration_tests-26.10.3-py3-none-any.whl

Total release size: 120.3 kB

Release files / ess_community_integration_tests-26.10.3.tar.gz

Download URL ess_community_integration_tests-26.10.3.tar.gz
Size 50.2 kB
Tags Source
SHA-256 checksum
How to use checksums
81b077dac3a25ad982594b4c28466f636c3371e2202b15c6179201c720b5f43d
BLAKE2b-256 checksum
How to use checksums
df41e68bfda7ea1eb56a463e1bd4984d7cbc866e6a7cfdd3c47a824523bd467b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","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}

Release files / ess_community_integration_tests-26.10.3-py3-none-any.whl

Download URL ess_community_integration_tests-26.10.3-py3-none-any.whl
Size 70.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
58b04d4ae58c5c3a1f27f0a82b478d14e508b4e7f6e2b0be41dee5d457872a64
BLAKE2b-256 checksum
How to use checksums
cb4403ab54384e7a0c18dbceb249eeba3a5eaa71acc2f8226937fe9e7903f250
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","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}

Security for ess-community-integration-tests 26.10.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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