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
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
browserextra, 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.shinstead.
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 theenvdirectory as.rcfiles.--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.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ess_community_integration_tests-26.10.4.tar.gz | 50.2 kB | Without provenance | Details for ess_community_integration_tests-26.10.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ess_community_integration_tests-26.10.4-py3-none-any.whl | Python 3 | none | any | Details for ess_community_integration_tests-26.10.4-py3-none-any.whl |
Total release size: 120.3 kB
Release files / ess_community_integration_tests-26.10.4.tar.gz
| Download URL | ess_community_integration_tests-26.10.4.tar.gz |
|---|---|
| Size | 50.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
915ca5770e23b12fd523e15762e3488de0edcc7eb4387fd9ae81755efd9b794e
|
|
BLAKE2b-256 checksum How to use checksums |
165badb894d9fec9c94aa3a1fe036c337ad9b6edfe6e995508b1688a41b45ea0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","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.4-py3-none-any.whl
| Download URL | ess_community_integration_tests-26.10.4-py3-none-any.whl |
|---|---|
| Size | 70.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
390da80c7fb008f70e9e203ea5a3cb425c7328b7574c94e6bcdc1e635b4d4159
|
|
BLAKE2b-256 checksum How to use checksums |
8b5910182e4a41fe8671bfce4368662e11220e93513e9d7fe6e42e6ddcd3e2b5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","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.4
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.