#49 Added export_slc_async fixture

pytest-slc/README.md

@@ -1,7 +1,7 @@
 # pytest-exasol-slc Plugin
 
-The `pytest-exasol-slc` plugin provides a pytest fixture for uploading a script language container
-into the database. The fixture is backend agnostic. It runs for the selected backends
+The `pytest-exasol-slc` plugin provides a pytest fixtures for building and uploading a script language container
+into the database. The fixtures are backend agnostic. They run for the selected backends
 (see the documentation for the `pytest-exasol-backend` plugin).
 
 ## Installation
@@ -14,15 +14,20 @@ pip install pytest-exasol-slc
 
 ## Usage in Tests
 
-Below is an example of a test that requires a script language container to be uploaded into the database.
+Below is an example of a test that requires a script language container to be built and uploaded into the database.
 Note, that by default this test will run twice - once for each backend.
 
 ```python
-import pyexasol
-
-def test_something_with_slc(upload_slc, container_file_path, language_alias):
-
-    upload_slc(container_file_path=container_file_path, language_alias=language_alias)
-
-    # Now run the actual test
+import pytest
+
+@pytest.fixture(scope='session')
+def slc_builder(use_onprem, use_saas):
+    if use_onprem or use_saas:
+        with language_container_factory() as container_builder:
+            yield container_builder
+    else:
+        yield None
+
+def test_something_with_slc(upload_slc):
+    ...
 ```

pytest-slc/doc/changes/changelog.md

@@ -2,6 +2,7 @@
 
 * [unreleased](unreleased.md)
 * [0.1.0](changes_0.1.0.md)
+* [0.2.0](changes_0.2.0.md)
 
 <!--- This MyST Parser Sphinx directive is necessary to keep Sphinx happy. We need list here all release letters again, because release droid and other scripts assume Markdown --->
 ```{toctree}
@@ -10,5 +11,6 @@ hidden:
 ---
 unreleased
 changes_0.1.0
+changes_0.2.0
 
 ```

pytest-slc/doc/changes/changes_0.2.0.md

@@ -0,0 +1,9 @@
+# 0.2.0 - 2024-08-27
+
+## Summary
+
+🚀 The plugin now covers both building and uploading of the language container.
+
+## Feature
+
+* #49: Create export and upload fixture in the SLC plugin

pytest-slc/error_code_config.yml

@@ -0,0 +1,3 @@
+error-tags:
+  PYTSLC:
+    highest-index: 0

pytest-slc/exasol/pytest_slc/__init__.py

@@ -1,25 +1,80 @@
 from __future__ import annotations
-from typing import Callable
 from pathlib import Path
+from exasol.pytest_backend import paralleltask
 import pytest
 
 import pyexasol
 import exasol.bucketfs as bfs
 from exasol.python_extension_common.deployment.language_container_deployer import LanguageContainerDeployer
+from exasol.python_extension_common.deployment.language_container_builder import LanguageContainerBuilder
 
+BFS_CONTAINER_DIRECTORY = 'container'
 
-@pytest.fixture(scope="session")
-def upload_slc(backend_aware_database_params,
-               backend_aware_bucketfs_params) -> Callable[[str | Path, str, str], None]:
 
-    def func(container_file_path: str | Path,
-             language_alias: str,
-             bucketfs_path: str = ''):
+@pytest.fixture(scope='session')
+def slc_builder() -> LanguageContainerBuilder | None:
+    """
+    This fixture must be provided by the user. Below is a simple implementation.
+
+    @pytest.fixture(scope='session')
+    def slc_builder():
+        with language_container_factory() as container_builder:
+            yield container_builder
+
+    Here the language_container_factory is a context-manager function that creates a
+    LanguageContainerBuilder object. This function performs all necessary preparations for
+    building a language container, but does not call its export function. The idea is to share
+    the code that builds a language container for the release and for integration tests.
+    """
+    return None
+
+
+@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 operation will be skipped if none of the backends is in use.
+    """
+    if (not (use_onprem or use_saas)) or (slc_builder is None):
+        return None
+
+    @paralleltask
+    def export_runner():
+        yield slc_builder.export()
+
+    with export_runner() as export_task:
+        return export_task
+
+
+@pytest.fixture(scope='session')
+def export_slc(slc_builder, export_slc_async) -> Path | None:
+    """
+    The fixture waits for the LanguageContainerBuilder.export() function to finish.
+    It returns the path of the exported container.
+    """
+    if (slc_builder is None) or (export_slc_async is None):
+        # Perhaps none of the backends is enabled.
+        return None
+
+    export_result = export_slc_async.get_output()
+    export_info = export_result.export_infos[str(slc_builder.flavor_path)]["release"]
+    return Path(export_info.cache_file)
+
+
+@pytest.fixture(scope="session")
+def upload_slc(slc_builder, export_slc,
+               backend_aware_database_params, backend_aware_bucketfs_params):
+    """
+    The fixture uploads language container to a database, according to the selected
+    backends.
+    """
+    if (slc_builder is not None) and (export_slc is not None):
         pyexasol_connection = pyexasol.connect(**backend_aware_database_params)
-        bucketfs_path = bfs.path.build_path(**backend_aware_bucketfs_params, path=bucketfs_path)
+        bucketfs_path = bfs.path.build_path(**backend_aware_bucketfs_params,
+                                            path=BFS_CONTAINER_DIRECTORY)
         deployer = LanguageContainerDeployer(pyexasol_connection=pyexasol_connection,
                                              bucketfs_path=bucketfs_path,
-                                             language_alias=language_alias)
-        deployer.run(container_file=Path(container_file_path), alter_system=True, allow_override=True)
-
-    return func
+                                             language_alias=slc_builder.language_alias)
+        deployer.run(container_file=export_slc, alter_system=True, allow_override=True)

pytest-slc/exasol/pytest_slc/version.py

@@ -5,6 +5,6 @@
 # Do not edit this file manually!
 # If you need to change the version, do so in the project.toml, e.g. by using `poetry version X.Y.Z`.
 MAJOR = 0
-MINOR = 1
+MINOR = 2
 PATCH = 0
 VERSION = f"{MAJOR}.{MINOR}.{PATCH}"