Merge pull request #384 from jumpstarter-dev/xdg

Use xdg config home for client config

Author: NickCao

conftest.py

@@ -7,7 +7,7 @@
 
 try:
     from jumpstarter.common.utils import serve
-    from jumpstarter.config import ClientConfigV1Alpha1, ExporterConfigV1Alpha1DriverInstance, UserConfigV1Alpha1
+    from jumpstarter.config import ExporterConfigV1Alpha1DriverInstance
     from jumpstarter.config.exporter import ExporterConfigV1Alpha1
 except ImportError:
     # some packages in the workspace does not depend on jumpstarter
@@ -26,6 +26,5 @@ def jumpstarter_namespace(doctest_namespace):
 
     @pytest.fixture(autouse=True)
     def tmp_config_path(tmp_path, monkeypatch):
-        monkeypatch.setattr(UserConfigV1Alpha1, "USER_CONFIG_PATH", tmp_path / "config.yaml")
-        monkeypatch.setattr(ClientConfigV1Alpha1, "CLIENT_CONFIGS_PATH", tmp_path / "clients")
+        monkeypatch.setenv("XDG_CONFIG_HOME", str(tmp_path / "client-config"))
         monkeypatch.setattr(ExporterConfigV1Alpha1, "BASE_PATH", tmp_path / "exporters")

docs/source/api-reference/adapters/network.md

@@ -55,7 +55,7 @@ export:
 ```{doctest}
 >>> with UnixPortforwardAdapter(client=client.unix_socket) as addr:
 ...     print(addr)
-/tmp/jumpstarter-.../socket
+/.../socket
 >>> # the type of the remote socket and the local one doesn't have to match
 >>> # e.g. forward a remote Unix domain socket to a local TCP port
 >>> with TcpPortforwardAdapter(client=client.unix_socket) as addr:

packages/jumpstarter/jumpstarter/common/tempfile.py

@@ -5,11 +5,12 @@
 
 from anyio import create_task_group, create_tcp_listener, create_unix_listener
 from anyio.abc import SocketAttribute
+from xdg_base_dirs import xdg_runtime_dir
 
 
 @contextmanager
 def TemporarySocket():
-    with TemporaryDirectory(prefix="jumpstarter-") as tempdir:
+    with TemporaryDirectory(dir=xdg_runtime_dir(), prefix="jumpstarter-") as tempdir:
         yield Path(tempdir) / "socket"
 
 

packages/jumpstarter/jumpstarter/config/common.py

@@ -1,9 +1,8 @@
-from pathlib import Path
-
 from pydantic import BaseModel
+from xdg_base_dirs import xdg_config_home
 
 CONFIG_API_VERSION = "jumpstarter.dev/v1alpha1"
-CONFIG_PATH = Path.home() / ".config" / "jumpstarter"
+CONFIG_PATH = xdg_config_home() / "jumpstarter"
 
 
 class ObjectMeta(BaseModel):

packages/jumpstarter/pyproject.toml

@@ -16,7 +16,8 @@ dependencies = [
     "anyio>=4.4.0,!=4.6.2",
     "aiohttp>=3.10.5",
     "tqdm>=4.66.5",
-    "pydantic>=2.8.2"
+    "pydantic>=2.8.2",
+    "xdg-base-dirs>=6.0.2",
 ]
 
 [dependency-groups]