Merge pull request 'pytests: use /tmp on macos to avoid unix socket issues' (#3073) from nixpkgs-update into main

Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3073

pkgs/clan-cli/tests/fixtures_flakes.py

@@ -16,6 +16,7 @@ from clan_cli.locked_open import locked_open
 from clan_cli.nix import nix_test_store
 from fixture_error import FixtureError
 from root import CLAN_CORE
+from temporary_dir import TEMPDIR
 
 log = logging.getLogger(__name__)
 
@@ -209,13 +210,13 @@ class ClanFlake:
 @pytest.fixture(scope="session")
 def minimal_flake_template() -> Iterator[ClanFlake]:
     with (
-        tempfile.TemporaryDirectory(prefix="flake-") as _home,
+        tempfile.TemporaryDirectory(prefix="minimal-flake-", dir=TEMPDIR) as _dirpath,
         pytest.MonkeyPatch.context() as mp,
     ):
-        home = Path(_home).resolve()
+        temporary_home = Path(_dirpath).resolve()
-        mp.setenv("HOME", str(home))
+        mp.setenv("HOME", str(temporary_home))
         flake = ClanFlake(
-            temporary_home=home,
+            temporary_home=temporary_home,
             flake_template=clan_templates(TemplateType.CLAN) / "minimal",
         )
         flake.init_from_template()

pkgs/clan-cli/tests/temporary_dir.py

@@ -3,21 +3,27 @@ import os
 import tempfile
 from collections.abc import Iterator
 from pathlib import Path
+from sys import platform
 
 import pytest
 
 log = logging.getLogger(__name__)
 
 
-@pytest.fixture
+TEMPDIR = None
-def temporary_home(monkeypatch: pytest.MonkeyPatch) -> Iterator[Path]:
+# macOS' default temporary directory is too long for unix sockets
-    with tempfile.TemporaryDirectory(prefix="pytest-home-") as _dirpath:
+# This can break applications such as gpg-agent
-        dirpath = Path(_dirpath).resolve()
+if platform == "darwin":
-        xdg_runtime_dir = os.getenv("XDG_RUNTIME_DIR")
+    TEMPDIR = Path("/tmp")
-        monkeypatch.setenv("HOME", str(dirpath))
-        monkeypatch.setenv("XDG_CONFIG_HOME", str(dirpath / ".config"))
 
-        runtime_dir = dirpath / "xdg-runtime-dir"
+
+@pytest.fixture
+def temporary_home(temp_dir: Path, monkeypatch: pytest.MonkeyPatch) -> Path:
+    xdg_runtime_dir = os.getenv("XDG_RUNTIME_DIR")
+    monkeypatch.setenv("HOME", str(temp_dir))
+    monkeypatch.setenv("XDG_CONFIG_HOME", str(temp_dir / ".config"))
+
+    runtime_dir = temp_dir / "xdg-runtime-dir"
     runtime_dir.mkdir()
     runtime_dir.chmod(0o700)
 
@@ -29,16 +35,14 @@ def temporary_home(monkeypatch: pytest.MonkeyPatch) -> Iterator[Path]:
     # Iterate over all environment variables
     for key, value in os.environ.items():
         if xdg_runtime_dir and value.startswith(xdg_runtime_dir):
-                monkeypatch.setenv(
+            monkeypatch.setenv(key, value.replace(xdg_runtime_dir, str(runtime_dir)))
-                    key, value.replace(xdg_runtime_dir, str(runtime_dir))
-                )
 
     monkeypatch.setenv("XDG_RUNTIME_DIR", str(runtime_dir))
-        monkeypatch.chdir(str(dirpath))
+    monkeypatch.chdir(str(temp_dir))
-        yield dirpath
+    return temp_dir
 
 
 @pytest.fixture
 def temp_dir() -> Iterator[Path]:
-    with tempfile.TemporaryDirectory(prefix="pytest-") as _dirpath:
+    with tempfile.TemporaryDirectory(prefix="pytest-", dir=TEMPDIR) as _dirpath:
         yield Path(_dirpath).resolve()