#317: Implemented reuse of workspace directory (#325)

fixes #317

Author: tomuben

doc/changes/unreleased.md

@@ -14,4 +14,5 @@
 ## Features
 
 * #319: Add restore_package_file method to class ScriptLanguagesContainer
-* #318: Added method to generate and store language_definition
+* #318: Added method to generate and store language_definition
+* #317: Implemented reuse of workspace directory

exasol/nb_connector/slc/constants.py

@@ -28,3 +28,8 @@
 """
 GitHub URL which is used as base for the Script-Languages-Container.
 """
+
+SLC_WORKSPACE_KEY_PREFIX = "slc_workspace_"
+"""
+Key prefix of the key in secret store to save the workspace directory. 
+"""

exasol/nb_connector/slc/script_language_container.py

@@ -78,7 +78,7 @@ def __init__(
         _verify_name(name)
         self.flavor = SlcFlavor(name).verify(secrets)
         self.compression_strategy = SlcCompressionStrategy(name).verify(secrets)
-        self.workspace = Workspace.for_slc(name)
+        self.workspace = Workspace.for_slc(name, secrets)
         if not self.checkout_dir.is_dir():
             raise SlcError(
                 f"SLC Git repository not checked out to {self.checkout_dir}."
@@ -113,7 +113,7 @@ def create(
             )
         slc_flavor.save(secrets, flavor)
         slc_compression_strategy.save(secrets, compression_strategy)
-        workspace = Workspace.for_slc(name)
+        workspace = Workspace.for_slc(name, secrets)
         workspace.clone_slc_repo()
         return cls(secrets=secrets, name=name)
 
@@ -144,7 +144,7 @@ def create_or_open(
             )
         else:
             slc_compression_strategy.save(secrets, compression_strategy)
-        workspace = Workspace.for_slc(name)
+        workspace = Workspace.for_slc(name, secrets)
         workspace.clone_slc_repo()
         return cls(secrets=secrets, name=name)
 

exasol/nb_connector/slc/workspace.py

@@ -6,6 +6,7 @@
 import shutil
 from pathlib import Path
 
+from exasol.nb_connector.secret_store import Secrets
 from exasol.nb_connector.slc import constants
 from exasol.nb_connector.slc.git_access import GitAccess
 
@@ -32,8 +33,14 @@ def __init__(self, root_dir: Path):
         self.root_dir = root_dir
 
     @classmethod
-    def for_slc(cls, name: str) -> Workspace:
-        return cls(Path.cwd() / constants.WORKSPACE_DIR / name)
+    def for_slc(cls, name: str, secrets: Secrets) -> Workspace:
+        workspace_key = constants.SLC_WORKSPACE_KEY_PREFIX + name
+        path = Path.cwd()
+        if path_from_secret_store := secrets.get(workspace_key):
+            path = Path(path_from_secret_store)
+        else:
+            secrets.save(workspace_key, str(path))
+        return cls(path / constants.WORKSPACE_DIR / name)
 
     def clone_slc_repo(self):
         """

test/unit/slc/utest_workspace.py

@@ -0,0 +1,65 @@
+import contextlib
+import logging
+import textwrap
+from collections.abc import Generator
+from pathlib import Path
+from test.unit.slc.util import (
+    SlcSecretsMock,
+    not_raises,
+)
+from typing import (
+    Callable,
+)
+from unittest import mock
+from unittest.mock import (
+    Mock,
+    create_autospec,
+)
+
+import pytest
+import requests
+from _pytest.monkeypatch import MonkeyPatch
+from exasol.slc.models.compression_strategy import CompressionStrategy
+
+from exasol.nb_connector.ai_lab_config import AILabConfig as CKey
+from exasol.nb_connector.slc import (
+    constants,
+    script_language_container,
+    workspace,
+)
+from exasol.nb_connector.slc.git_access import GitAccess
+from exasol.nb_connector.slc.script_language_container import (
+    PipPackageDefinition,
+    ScriptLanguageContainer,
+)
+from exasol.nb_connector.slc.slc_flavor import (
+    SlcError,
+    SlcFlavor,
+)
+from exasol.nb_connector.slc.workspace import (
+    Workspace,
+    current_directory,
+)
+
+
+@pytest.fixture
+def sample_slc_name() -> str:
+    return "CUDA"
+
+
+def test_workspace_reuses_directory(sample_slc_name, tmp_path):
+    secrets = SlcSecretsMock(sample_slc_name)
+    workspace_dir1 = tmp_path / "ws1"
+    workspace_dir2 = tmp_path / "ws2"
+
+    workspace_dir1.mkdir()
+    workspace_dir2.mkdir()
+
+    with current_directory(workspace_dir1) as _:
+        ws1 = Workspace.for_slc(sample_slc_name, secrets)
+
+    with current_directory(workspace_dir2) as _:
+        ws2 = Workspace.for_slc(sample_slc_name, secrets)
+        assert (
+            ws2.root_dir == workspace_dir1 / constants.WORKSPACE_DIR / sample_slc_name
+        )