#109: Added flag which allows to select compression strategy of SLC during export (#111)

fixes #109

Author: tomuben

doc/changes/unreleased.md

@@ -3,4 +3,8 @@
 
 ## Refactorings
 
- - #106: Updated dependencies
+ - #106: Updated dependencies
+
+## Features
+
+ - #109: Added flag which allows to select compression strategy of SLC during export 

exasol/python_extension_common/deployment/language_container_builder.py

@@ -8,6 +8,7 @@
 from typing import Callable
 
 from exasol.slc import api  # type: ignore
+from exasol.slc.models.compression_strategy import CompressionStrategy
 from exasol.slc.models.export_container_result import (
     ExportContainerResult,  # type: ignore
 )
@@ -125,7 +126,9 @@ def build(self) -> dict[str, ImageInfo]:
         image_info = api.build(flavor_path=(str(self.flavor_path),), goal=("release",))
         return image_info
 
-    def export(self, export_path: str | Path | None = None) -> ExportContainerResult:
+    def export(
+        self, export_path: str | Path | None = None, compression_strategy=CompressionStrategy.GZIP
+    ) -> ExportContainerResult:
         """
         Exports the container into an archive.
         """
@@ -143,6 +146,7 @@ def export(self, export_path: str | Path | None = None) -> ExportContainerResult
             flavor_path=(str(self.flavor_path),),
             output_directory=str(self._output_path),
             export_path=str(export_path),
+            compression_strategy=compression_strategy,
         )
         return export_result
 

test/integration/deployment/test_language_container_builder.py

@@ -2,6 +2,9 @@
 from pathlib import Path
 from test.utils.db_utils import assert_udf_running
 
+import pytest
+from exasol.slc.models.compression_strategy import CompressionStrategy
+
 from exasol.python_extension_common.deployment.language_container_builder import (
     LanguageContainerBuilder,
     find_path_backwards,
@@ -32,22 +35,43 @@ def test_prepare_flavor_extra():
         assert container_builder.requirements_file.read_text().startswith(dummy_req)
 
 
-def test_language_container_builder(deployer_factory, db_schema, language_alias):
+@pytest.fixture(scope="session")
+def language_container_builder():
     project_directory = find_path_backwards("pyproject.toml", __file__).parent
 
-    with ExitStack() as stack:
-        # Build the SLC
-        container_builder = stack.enter_context(LanguageContainerBuilder("test_container"))
+    with LanguageContainerBuilder("test_container") as container_builder:
+        # Prepare the SLC
         container_builder.prepare_flavor(project_directory)
-        export_result = container_builder.export()
-        export_info = export_result.export_infos[str(container_builder.flavor_path)]["release"]
+        yield container_builder
+
+
+@pytest.fixture(
+    scope="session",
+    params=[
+        (CompressionStrategy.GZIP, ".tar.gz"),
+        (CompressionStrategy.NONE, ".tar"),
+    ],
+    ids=["with_gzip_compression", "no_compression"],
+)
+def slc_container_file_path(request, language_container_builder):
+    compression_strategy = request.param[0]
+    expected_container_file_suffix = request.param[1]
+
+    export_result = language_container_builder.export(compression_strategy=compression_strategy)
+    export_info = export_result.export_infos[str(language_container_builder.flavor_path)]["release"]
+    container_file_path = Path(export_info.cache_file)
+    assert container_file_path.name.endswith(
+        expected_container_file_suffix
+    ), f"Expected container file suffix {expected_container_file_suffix} does not match {container_file_path}"
+    return container_file_path
 
-        container_file_path = Path(export_info.cache_file)
 
-        # Deploy the SCL
-        deployer = stack.enter_context(deployer_factory(create_test_schema=True))
+def test_language_container_builder(
+    language_container_builder, deployer_factory, db_schema, language_alias, slc_container_file_path
+):
+    with deployer_factory(db_schema) as deployer:
         deployer.run(
-            container_file=Path(container_file_path), alter_system=True, allow_override=True
+            container_file=Path(slc_container_file_path), alter_system=True, allow_override=True
         )
 
         # Verify that the deployed SLC works.

test/unit/deployment/test_language_container_builder.py

@@ -1,6 +1,13 @@
 import re
+from unittest.mock import (
+    MagicMock,
+    call,
+)
 
 import pytest
+from _pytest.monkeypatch import MonkeyPatch
+from exasol.slc import api
+from exasol.slc.models.compression_strategy import CompressionStrategy
 
 from exasol.python_extension_common.deployment.language_container_builder import (
     LanguageContainerBuilder,
@@ -33,3 +40,33 @@ def test_copy_slc_flavor(tmp_path):
     flavor_base = tmp_path / "flavor_base"
     assert flavor_base.exists()
     assert len(list(flavor_base.rglob("*"))) == 7
+
+
+@pytest.fixture
+def mock_export(monkeypatch: MonkeyPatch) -> MagicMock:
+    mock_function_to_mock = MagicMock()
+    monkeypatch.setattr(api, "export", mock_function_to_mock)
+    return mock_function_to_mock
+
+
+@pytest.mark.parametrize(
+    "compression_strategy",
+    [
+        (CompressionStrategy.GZIP),
+        (CompressionStrategy.NONE),
+    ],
+)
+def test_export(mock_export, tmp_path, compression_strategy):
+    project_directory = find_path_backwards("pyproject.toml", __file__).parent
+    with LanguageContainerBuilder("test_container") as builder:
+        builder.prepare_flavor(project_directory)
+        builder.export(tmp_path, compression_strategy=compression_strategy)
+        expected_calls = [
+            call(
+                flavor_path=(str(builder.flavor_path),),
+                output_directory=str(builder._output_path),
+                export_path=str(tmp_path),
+                compression_strategy=compression_strategy,
+            ),
+        ]
+        assert mock_export.has_calls(expected_calls)

version.py

@@ -1,9 +1,12 @@
-# ATTENTION:
-# This file is generated by exasol/toolbox/nox/_package_version.py when using:
-#   * either "poetry run -- nox -s project:fix"
-#   * or "poetry run -- nox version:check -- --fix"
-# Do not edit this file manually!
-# If you need to change the version, do so in the pyproject.toml, e.g. by using `poetry version X.Y.Z`.
+"""ATTENTION:
+This file is generated by exasol/toolbox/nox/_package_version.py when using:
+   * either "poetry run -- nox -s project:fix"
+   * or "poetry run -- nox -s version:check -- --fix"
+Do not edit this file manually!
+If you need to change the version, do so in the pyproject.toml, e.g. by using
+`poetry version X.Y.Z`.
+"""
+
 MAJOR = 0
 MINOR = 10
 PATCH = 0