diff --git a/pytest-backend/README.md b/pytest-backend/README.md index f6bb312..006725a 100644 --- a/pytest-backend/README.md +++ b/pytest-backend/README.md @@ -1,6 +1,6 @@ # pytest-exasol-backend Plugin -The `pytest-exasol-backend` plugin is a collection of pytest fixtures commonly used for testing +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. @@ -41,7 +41,7 @@ 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' + my_bfs_file = my_bfs_dir / 'my_file.dat' assert my_bfs_file.exists() ``` @@ -91,15 +91,15 @@ for instance when running unit tests only. Sometimes the default ITDE parameters cannot satisfy the test requirements. The plugin allows setting some of the parameters of the [api.spawn_test_environment(...)](https://github.com/exasol/integration-test-docker-environment/blob/92cc67b8f9ab78c52106c1c4ba19fe64811bcb2c/exasol_integration_test_docker_environment/lib/api/spawn_test_environment.py#L35) function. The parameter values can be provided in the CLI options. Currently, it is possible to set values of the following parameters: - - db-mem-size - - db-disk-size - - nameserver - - db-version + - `--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. +In the example below the tests are run using an instance of the DockerDB with increased memory. ```shell -pytest --backend=onprem --db-mem-size "8 GiB" my_test_suite.py +pytest --backend=onprem --itde-db-mem-size "8 GiB" my_test_suite.py ``` These options are ignored if the "onprem" backend is not selected. diff --git a/pytest-backend/doc/changes/unreleased.md b/pytest-backend/doc/changes/unreleased.md index e33b376..41f6d90 100644 --- a/pytest-backend/doc/changes/unreleased.md +++ b/pytest-backend/doc/changes/unreleased.md @@ -1,5 +1,9 @@ # Unreleased -## Internal +## Documentation + +* #69: Fixed names of CLI options in user guide of pytest-exasol-backend + +## Refactorings * Relock dependencies diff --git a/pytest-slc/doc/changes/unreleased.md b/pytest-slc/doc/changes/unreleased.md index e33b376..8b1a53e 100644 --- a/pytest-slc/doc/changes/unreleased.md +++ b/pytest-slc/doc/changes/unreleased.md @@ -1,5 +1,9 @@ # Unreleased -## Internal +## Documentation + +* #51: Corrected docstring of fixture `export_slc_async` + +## Refactorings * Relock dependencies diff --git a/pytest-slc/exasol/pytest_slc/__init__.py b/pytest-slc/exasol/pytest_slc/__init__.py index 2f1b3d1..e527a26 100644 --- a/pytest-slc/exasol/pytest_slc/__init__.py +++ b/pytest-slc/exasol/pytest_slc/__init__.py @@ -33,10 +33,11 @@ def slc_builder(): @pytest.fixture(scope='session', autouse=True) def export_slc_async(slc_builder, use_onprem: bool, use_saas: bool): """ - The fixture starts the export() function of the provided LanguageContainerBuilder object as - an asynchronous task. + The fixture starts the export() function of the provided + LanguageContainerBuilder object as an asynchronous task. - The operation will be skipped if none of the backends is in use. + The operation will be skipped if none of the backends is in use or the + container builder is not defined. """ if (not (use_onprem or use_saas)) or (slc_builder is None): return None