Refactor compute base dir related code to be uniform in precedence --config_dir > ENV var > ~/.globus_compute

Author: LeiGlobus

compute_endpoint/globus_compute_endpoint/cli.py

@@ -104,9 +104,17 @@ def ensure(cls) -> CommandState:
         return click.get_current_context().ensure_object(CommandState)
 
 
-def init_config_dir() -> pathlib.Path:
+def init_config_dir(custom_dir: str) -> pathlib.Path:
+    """
+    :param custom_dir:  An optional user-specified directory from --config-dir
+
+    Fetches the base Compute dir, which defaults to ~/.globus-compute but
+    can be overridden via the ENV var GLOBUS_COMPUTE_USER_DIR.
+
+    If the directory does not exist, it will be created.
+    """
     try:
-        return ensure_compute_dir()
+        return ensure_compute_dir(custom_dir)
     except (FileExistsError, PermissionError) as e:
         raise ClickException(str(e))
 

compute_sdk/globus_compute_sdk/sdk/compute_dir.py

@@ -1,24 +1,29 @@
 from __future__ import annotations
 
 import os
-import pathlib
+from pathlib import Path
 
 
-def ensure_compute_dir() -> pathlib.Path:
-    dirname = pathlib.Path.home() / ".globus_compute"
+def ensure_compute_dir(custom_dir: str | None = None) -> Path:
+    if custom_dir:
+        # Highest priority is the --config-dir argument
+        compute_dir = Path(custom_dir)
+    else:
+        # Secondly, we check the ENV var
+        env_dir = os.getenv("GLOBUS_COMPUTE_USER_DIR")
+        if env_dir:
+            compute_dir = Path(env_dir)
+        else:
+            # Finally, default to ~/.globus_compute
+            compute_dir = Path.home() / ".globus_compute"
 
-    user_dir = os.getenv("GLOBUS_COMPUTE_USER_DIR")
-    if user_dir:
-        dirname = pathlib.Path(user_dir)
 
-    if dirname.is_dir():
-        pass
-    elif dirname.is_file():
+    if compute_dir.is_file():
         raise FileExistsError(
-            f"Error creating directory {dirname}, "
+            f"Error creating directory {compute_dir}, "
             "please remove or rename the conflicting file"
         )
-    else:
-        dirname.mkdir(mode=0o700, parents=True, exist_ok=True)
+    elif not compute_dir.exists():
+        compute_dir.mkdir(mode=0o700, parents=True, exist_ok=True)
 
-    return dirname
+    return compute_dir

compute_sdk/tests/unit/test_compute_dir.py

@@ -9,28 +9,35 @@
 
 
 @pytest.mark.parametrize("dir_exists", [True, False])
-@pytest.mark.parametrize("user_dir", ["/my/dir", None, ""])
+@pytest.mark.parametrize("env_dir", ["/my/dir", None, ""])
+@pytest.mark.parametrize("config_dir", ["/my/config_dir", None])
 def test_ensure_compute_dir(
     dir_exists: bool,
-    user_dir: str | None,
+    env_dir: str | None,
+    config_dir: str | None,
     fs: FakeFilesystem,
     monkeypatch: pytest.MonkeyPatch,
 ):
     home = pathlib.Path.home()
 
-    dirname = home / ".globus_compute"
+    if env_dir:
+        monkeypatch.setenv("GLOBUS_COMPUTE_USER_DIR", str(env_dir))
+
+    if config_dir:
+        dirname = pathlib.Path(config_dir)
+    elif env_dir:
+        dirname = pathlib.Path(env_dir)
+        monkeypatch.setenv("GLOBUS_COMPUTE_USER_DIR", str(env_dir))
+    else:
+        dirname = home / ".globus_compute"
 
     if dir_exists:
         fs.create_dir(dirname)
 
-    if user_dir is not None:
-        dirname = pathlib.Path(user_dir)
-        monkeypatch.setenv("GLOBUS_COMPUTE_USER_DIR", str(dirname))
-
-    compute_dirname = ensure_compute_dir()
+    compute_base_path = ensure_compute_dir(config_dir)
 
-    assert compute_dirname.is_dir()
-    assert compute_dirname == dirname
+    assert compute_base_path.is_dir()
+    assert compute_base_path.samefile(dirname)
 
 
 @pytest.mark.parametrize("user_dir_defined", [True, False])