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
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 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.9.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ess_community_integration_tests-26.9.2.tar.gz | 47.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ess_community_integration_tests-26.9.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 118.2 kB
Release files / ess_community_integration_tests-26.9.2.tar.gz
| Download URL | ess_community_integration_tests-26.9.2.tar.gz |
|---|---|
| Size | 47.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8b18e6a8935c87c8ee9907c7a771acde60982213ddfe893689fd65c3b2876171
|
|
BLAKE2b-256 checksum How to use checksums |
a8e3be52a0781a9cc01ac82e3b151b433be2d79ffc8c99e38798ce0c03986b58
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.15 {"installer":{"name":"uv","version":"0.12.15","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.9.2-py3-none-any.whl
| Download URL | ess_community_integration_tests-26.9.2-py3-none-any.whl |
|---|---|
| Size | 70.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
25df82eeb5e502ff843357681f058887e5d352c63bb4c9eeca843534c3bf4ba8
|
|
BLAKE2b-256 checksum How to use checksums |
88ba0a2fefd3686df410b51c11cc71975788d580e441f23634cfef6fcbbc6849
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.15 {"installer":{"name":"uv","version":"0.12.15","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}
|