pytest-exasol-backend Plugin
The pytest-exasol-backend plugin is a collection of pytest fixtures commonly used for testing
projects related to Exasol. In particular, it provides unified access to both Exasol On-Prem and
SaaS backends. This eliminates the need to build different sets of tests for different backends.
Features
- Provides session level fixtures that can be turned into connection factories for the database and the BucketFS.
- Automatically makes the tests running on the selected backends.
- Allows selecting either or both backends from the CLI that executes the pytest.
- Starts the selected backends preemptively and in parallel.
Installation
The pytest-exasol-backend plugin can be installed using pip:
pip install pytest-exasol-backend
Usage in Tests
Below is an example of a test that requires access to the database. Note, that by default this test will run twice - once for each backend.
import pyexasol
def test_number_of_rows_in_my_table(backend_aware_database_params):
with pyexasol.connect(**backend_aware_database_params, schema='MY_SCHEMA') as conn:
num_of_rows = conn.execute('SELECT COUNT(*) FROM MY_TABLE;').fetchval()
assert num_of_rows == 5
Here is an example of a test that requires access to the BucketFS. Again, this test will run for each backend, unless one of them is disabled in the CLI.
import exasol.bucketfs as bfs
def test_my_file_exists(backend_aware_bucketfs_params):
my_bfs_dir = bfs.path.build_path(**backend_aware_bucketfs_params, path='MY_BFS_PATH')
my_bfs_file = my_bfs_dir / 'my_file.dat'
assert my_bfs_file.exists()
Sometimes it may be necessary to know which backend the test is running with. In such
a case the backend fixture can be used, as in the example below.
def test_something_backend_sensitive(backend):
if backend == 'onprem':
# Do something special for the On-Prem database.
pass
elif backend == 'saas':
# Do something special for the SaaS database.
pass
else:
raise RuntimeError(f'Unknown backend {backend}')
Selecting Backends in CLI
By default, none of the backends is selected for testing. Please use the --backend option to specify the target backend.
The command below runs the tests on an on-prem database.
pytest --backend=onprem my_test_suite.py
This following command runs the test on two backends.
pytest --backend=onprem --backend=saas my_test_suite.py
The next command runs the test on all backends, which currently is equivalent to the previous command since there are only two backends available.
pytest --backend=all my_test_suite.py
Please note that all selected backends starts preemptively, regardless of their actual usage in tests. Therefore, it is important to make sure the backends are not selected where they are not needed, for instance when running unit tests only.
Setting ITDE parameters in CLI
Sometimes the default ITDE parameters cannot satisfy the test requirements. The plugin allows setting some of the parameters of the api.spawn_test_environment(...) function. The parameter values can be provided in the CLI options. Currently, it is possible to set values of the following parameters:
--itde-db-mem-size--itde-db-disk-size--itde-nameserver--itde-db-version
In the example below the tests are run using an instance of the DockerDB with increased memory.
pytest --backend=onprem --itde-db-mem-size "8 GiB" my_test_suite.py
These options are ignored if the "onprem" backend is not selected.
Metadata
Release files for pytest-exasol-backend 1.1.0
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 |
|---|---|---|---|---|
| pytest_exasol_backend-1.1.0.tar.gz | 11.1 kB | Without provenance | Details for pytest_exasol_backend-1.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pytest_exasol_backend-1.1.0-py3-none-any.whl | Python 3 | none | any | Details for pytest_exasol_backend-1.1.0-py3-none-any.whl |
Total release size: 23.5 kB
Release files / pytest_exasol_backend-1.1.0.tar.gz
| Download URL | pytest_exasol_backend-1.1.0.tar.gz |
|---|---|
| Size | 11.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ae00ab25078fc56b727e74b80c622b2e0053de84bbebb78e04118826abb733fc
|
|
BLAKE2b-256 checksum How to use checksums |
eda2e98b2b782fdbd808210c9c4ceb1949da12a3b5f9c4bee4195f5d3c91afbf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.2 CPython/3.12.3 Linux/6.11.0-1018-azure
|
Release files / pytest_exasol_backend-1.1.0-py3-none-any.whl
| Download URL | pytest_exasol_backend-1.1.0-py3-none-any.whl |
|---|---|
| Size | 12.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
89c8f74d5e092595e92a9a5e4cfbd9182d8748246822355bd3179e97cb1fd899
|
|
BLAKE2b-256 checksum How to use checksums |
7e584ae7934ac0d5767230f208988ffba2c70c0fda070a8b8214d1f1ff581ddb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.2 CPython/3.12.3 Linux/6.11.0-1018-azure
|
Security for pytest-exasol-backend 1.1.0
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.