#319: Add restore_package_file method to class ScriptLanguagesContainer (#322)

fixes #319

Author: tomuben

doc/changes/unreleased.md

@@ -9,4 +9,8 @@
 ## Refactoring
 
 * #314: Added more robust for class ScriptLanguageContainer
-* #316: Implemented consistency check for workspace in ScriptLanguageContainer.create()
+* #316: Implemented consistency check for workspace in ScriptLanguageContainer.create()
+
+## Features
+
+* #319: Add restore_package_file method to class ScriptLanguagesContainer

exasol/nb_connector/slc/__init__.py

@@ -1,6 +1,6 @@
-from exasol.nb_connector.slc.script_language_container import (
+from exasol.nb_connector.slc.package_types import (
     CondaPackageDefinition,
     PipPackageDefinition,
-    ScriptLanguageContainer,
 )
+from exasol.nb_connector.slc.script_language_container import ScriptLanguageContainer
 from exasol.nb_connector.slc.slc_error import SlcError

exasol/nb_connector/slc/git_access.py

@@ -25,3 +25,8 @@ def clone_from_recursively(url: str, path: Path, branch: str) -> None:
     def checkout_recursively(path: Path) -> None:
         repo = Repo(path)
         repo.git.checkout("--recurse-submodules", ".")
+
+    @staticmethod
+    def checkout_file(repo_path: Path, file: Path) -> None:
+        repo = Repo(repo_path)
+        repo.git.checkout("HEAD", "--", str(file))

exasol/nb_connector/slc/package_file_editor.py

@@ -0,0 +1,67 @@
+import logging
+from pathlib import Path
+
+from exasol.nb_connector.slc.package_types import (
+    CondaPackageDefinition,
+    PipPackageDefinition,
+)
+from exasol.nb_connector.slc.slc_error import SlcError
+
+
+def _read_packages(file_path: Path, package_definition: type) -> list:
+    packages = []
+    with file_path.open("r", encoding="utf-8") as f:
+        for line in f:
+            line = line.strip()
+            if not line or line.startswith("#"):
+                continue  # skip empty or commented lines
+            # Take everything before the '|' as package name
+            package, version = line.split("|", 1)
+            packages.append(package_definition(package, version))
+    return packages
+
+
+def _ends_with_newline(file_path: Path) -> bool:
+    content = file_path.read_text()
+    return content.endswith("\n")
+
+
+def _filter_packages(
+    original_packages: list[PipPackageDefinition] | list[CondaPackageDefinition],
+    new_packages: list[PipPackageDefinition] | list[CondaPackageDefinition],
+) -> list[PipPackageDefinition | CondaPackageDefinition]:
+    filtered_packages = []
+    for package in new_packages:
+        add_package = True
+        for original_package in original_packages:
+            if package.pkg == original_package.pkg:
+                add_package = False
+                if package.version == original_package.version:
+                    logging.warning("Package already exists: %s", original_package)
+                else:
+                    raise SlcError(
+                        "Package already exists: %s but with different version",
+                        original_package,
+                    )
+        if add_package:
+            filtered_packages.append(package)
+    return filtered_packages
+
+
+def append_packages(
+    file_path: Path,
+    package_definition: type,
+    packages: list[PipPackageDefinition] | list[CondaPackageDefinition],
+):
+    """
+    Appends packages to the custom packages file.
+    """
+    original_packages = _read_packages(file_path, package_definition)
+    filtered_packages = _filter_packages(original_packages, packages)
+    ends_with_newline = _ends_with_newline(file_path)
+    if filtered_packages:
+        with open(file_path, "a") as f:
+            if not ends_with_newline:
+                f.write("\n")
+            for p in filtered_packages:
+                print(f"{p.pkg}|{p.version}", file=f)

exasol/nb_connector/slc/package_types.py

@@ -0,0 +1,4 @@
+from collections import namedtuple
+
+PipPackageDefinition = namedtuple("PipPackageDefinition", ["pkg", "version"])
+CondaPackageDefinition = namedtuple("CondaPackageDefinition", ["pkg", "version"])

exasol/nb_connector/slc/script_language_container.py

@@ -2,7 +2,6 @@
 
 import logging
 import re
-from collections import namedtuple
 from pathlib import (
     Path,
 )
@@ -20,6 +19,12 @@
 from exasol.nb_connector.ai_lab_config import AILabConfig as CKey
 from exasol.nb_connector.secret_store import Secrets
 from exasol.nb_connector.slc import constants
+from exasol.nb_connector.slc.git_access import GitAccess
+from exasol.nb_connector.slc.package_file_editor import append_packages
+from exasol.nb_connector.slc.package_types import (
+    CondaPackageDefinition,
+    PipPackageDefinition,
+)
 from exasol.nb_connector.slc.slc_compression_strategy import SlcCompressionStrategy
 from exasol.nb_connector.slc.slc_flavor import (
     SlcError,
@@ -31,9 +36,6 @@
 )
 from exasol.nb_connector.utils import optional_str_to_bool
 
-PipPackageDefinition = namedtuple("PipPackageDefinition", ["pkg", "version"])
-CondaPackageDefinition = namedtuple("CondaPackageDefinition", ["pkg", "version"])
-
 NAME_PATTERN = re.compile(r"^[A-Z][A-Z0-9_]*$", flags=re.IGNORECASE)
 
 
@@ -45,65 +47,6 @@ def _verify_name(slc_name: str) -> None:
         )
 
 
-def _read_packages(file_path: Path, package_definition: type) -> list:
-    packages = []
-    with file_path.open("r", encoding="utf-8") as f:
-        for line in f:
-            line = line.strip()
-            if not line or line.startswith("#"):
-                continue  # skip empty or commented lines
-            # Take everything before the '|' as package name
-            package, version = line.split("|", 1)
-            packages.append(package_definition(package, version))
-    return packages
-
-
-def _ends_with_newline(file_path: Path) -> bool:
-    content = file_path.read_text()
-    return content.endswith("\n")
-
-
-def _filter_packages(
-    original_packages: list[PipPackageDefinition] | list[CondaPackageDefinition],
-    new_packages: list[PipPackageDefinition] | list[CondaPackageDefinition],
-) -> list[PipPackageDefinition | CondaPackageDefinition]:
-    filtered_packages = []
-    for package in new_packages:
-        add_package = True
-        for original_package in original_packages:
-            if package.pkg == original_package.pkg:
-                add_package = False
-                if package.version == original_package.version:
-                    logging.warning("Package already exists: %s", original_package)
-                else:
-                    raise SlcError(
-                        "Package already exists: %s but with different version",
-                        original_package,
-                    )
-        if add_package:
-            filtered_packages.append(package)
-    return filtered_packages
-
-
-def _append_packages(
-    file_path: Path,
-    package_definition: type,
-    packages: list[PipPackageDefinition] | list[CondaPackageDefinition],
-):
-    """
-    Appends packages to the custom packages file.
-    """
-    original_packages = _read_packages(file_path, package_definition)
-    filtered_packages = _filter_packages(original_packages, packages)
-    ends_with_newline = _ends_with_newline(file_path)
-    if filtered_packages:
-        with open(file_path, "a") as f:
-            if not ends_with_newline:
-                f.write("\n")
-            for p in filtered_packages:
-                print(f"{p.pkg}|{p.version}", file=f)
-
-
 class ScriptLanguageContainer:
     """
     Support building different flavors of Exasol Script Language
@@ -242,6 +185,24 @@ def custom_conda_file(self) -> Path:
         """
         return self.custom_packages_dir / "conda_packages"
 
+    def restore_custom_pip_file(self):
+        """
+        Restores the custom pip packages file from Git. All changes will be overwritten.
+        """
+        GitAccess.checkout_file(
+            self.checkout_dir / "script-languages",
+            self.custom_pip_file.relative_to(self.checkout_dir),
+        )
+
+    def restore_custom_conda_file(self):
+        """
+        Restores the custom conda packages file from Git. All changes will be overwritten.
+        """
+        GitAccess.checkout_file(
+            self.checkout_dir / "script-languages",
+            self.custom_conda_file.relative_to(self.checkout_dir),
+        )
+
     def export(self) -> None:
         """
         Exports the current SLC to the export directory.
@@ -333,7 +294,7 @@ def append_custom_pip_packages(self, pip_packages: list[PipPackageDefinition]):
         Note: This method is not idempotent: Multiple calls with the same
         package definitions will result in duplicated entries.
         """
-        _append_packages(self.custom_pip_file, PipPackageDefinition, pip_packages)
+        append_packages(self.custom_pip_file, PipPackageDefinition, pip_packages)
 
     def append_custom_conda_packages(
         self, conda_packages: list[CondaPackageDefinition]
@@ -343,7 +304,7 @@ def append_custom_conda_packages(
         Note: This method is not idempotent: Multiple calls with the same
         package definitions will result in duplicated entries.
         """
-        _append_packages(self.custom_conda_file, CondaPackageDefinition, conda_packages)
+        append_packages(self.custom_conda_file, CondaPackageDefinition, conda_packages)
 
     @property
     def docker_image_tags(self) -> list[str]:

test/integration/ordinary/itest_slc.py

@@ -356,3 +356,39 @@ def test_fresh_clone_if_repo_is_corrupt(
     assert not marker_file.exists()
     expected_error = f"Git repository is inconsistent: {temp_cwd_func}/slc_workspace/{slc_name}/git-clone. Doing a fresh clone..."
     assert expected_error in caplog.text
+
+
+def test_restore_pip_custom_file(
+    temp_cwd_func,
+    secrets_module: Secrets,
+    default_flavor: str,
+    compression_strategy: CompressionStrategy,
+):
+    slc_name = "slc_restore_pip_custom_file"
+    slc = create_slc(secrets_module, slc_name, default_flavor, compression_strategy)
+
+    slc.append_custom_pip_packages([PipPackageDefinition("my_test_package", "1.2.3")])
+    custom_pip_file_content = slc.custom_pip_file.read_text()
+    assert "my_test_package" in custom_pip_file_content
+    slc.restore_custom_pip_file()
+    custom_pip_file_content = slc.custom_pip_file.read_text()
+    assert "my_test_package" not in custom_pip_file_content
+
+
+def test_restore_conda_custom_file(
+    temp_cwd_func,
+    secrets_module: Secrets,
+    compression_strategy: CompressionStrategy,
+):
+    slc_name = "slc_restore_conda_custom_file"
+    flavor = DEFAULT_FLAVORS[PackageManager.CONDA]
+    slc = create_slc(secrets_module, slc_name, flavor, compression_strategy)
+
+    slc.append_custom_conda_packages(
+        [CondaPackageDefinition("my_test_package", "1.2.3")]
+    )
+    custom_conda_file_content = slc.custom_conda_file.read_text()
+    assert "my_test_package" in custom_conda_file_content
+    slc.restore_custom_conda_file()
+    custom_conda_file_content = slc.custom_conda_file.read_text()
+    assert "my_test_package" not in custom_conda_file_content

test/unit/slc/utest_slc.py

@@ -1,6 +1,5 @@
 import contextlib
 import logging
-import shutil
 import textwrap
 from collections.abc import Generator
 from pathlib import Path
@@ -11,6 +10,7 @@
 from typing import (
     Callable,
 )
+from unittest import mock
 from unittest.mock import (
     Mock,
     create_autospec,
@@ -53,6 +53,7 @@ def create_dir(url: str, dir: Path, branch: str):
 
         mock = create_autospec(GitAccess)
         monkeypatch.setattr(workspace, "GitAccess", mock)
+        monkeypatch.setattr(script_language_container, "GitAccess", mock)
         mock.clone_from_recursively.side_effect = create_dir
         yield mock
 
@@ -613,3 +614,39 @@ def test_make_fresh_clone_if_repo_is_corrupt(
             f"Git repository is inconsistent: something went wrong. Doing a fresh clone..."
             in caplog.text
         )
+
+
+def test_restore_pip_package_file(sample_slc_name, slc_factory_create, git_access_mock):
+    flavor = "Strawberry"
+    with slc_factory_create.context(slc_name=sample_slc_name, flavor=flavor) as slc:
+        with git_access_mock(flavor) as git_access:
+            slc.restore_custom_pip_file()
+            assert git_access.checkout_file.mock_calls == [
+                mock.call(
+                    slc.workspace.git_clone_path / "script-languages",
+                    Path("flavors")
+                    / flavor
+                    / "flavor_customization"
+                    / "packages"
+                    / "python3_pip_packages",
+                )
+            ]
+
+
+def test_restore_conda_package_file(
+    sample_slc_name, slc_factory_create, git_access_mock
+):
+    flavor = "Strawberry"
+    with slc_factory_create.context(slc_name=sample_slc_name, flavor=flavor) as slc:
+        with git_access_mock(flavor) as git_access:
+            slc.restore_custom_conda_file()
+            assert git_access.checkout_file.mock_calls == [
+                mock.call(
+                    slc.workspace.git_clone_path / "script-languages",
+                    Path("flavors")
+                    / flavor
+                    / "flavor_customization"
+                    / "packages"
+                    / "conda_packages",
+                )
+            ]