Change cache_dir location to prefer venv and project_directory

Author: ssbarnea

.vscode/settings.json

@@ -10,7 +10,7 @@
       "source.fixAll": "explicit",
       "source.organizeImports": "explicit"
     },
-    "editor.defaultFormatter": "ms-python.black-formatter",
+    "editor.defaultFormatter": "charliermarsh.ruff",
     "editor.formatOnSave": true
   },
   "editor.formatOnSave": true,
@@ -40,5 +40,6 @@
   "yaml.completion": true,
   "yaml.customTags": ["!encrypted/pkcs1-oaep scalar", "!vault scalar"],
   "yaml.format.enable": false,
-  "yaml.validate": true
+  "yaml.validate": true,
+  "cSpell.words": ["delenv"]
 }

src/ansible_compat/prerun.py

@@ -1,22 +1,25 @@
 """Utilities for configuring ansible runtime environment."""
 
-import hashlib
 import os
 from pathlib import Path
 
 
-def get_cache_dir(project_dir: Path) -> Path:
-    """Compute cache directory to be used based on project path."""
-    # we only use the basename instead of the full path in order to ensure that
-    # we would use the same key regardless the location of the user home
-    # directory or where the project is clones (as long the project folder uses
-    # the same name).
-    basename = project_dir.resolve().name.encode(encoding="utf-8")
-    # 6 chars of entropy should be enough
-    cache_key = hashlib.sha256(basename).hexdigest()[:6]
-    cache_dir = (
-        Path(os.getenv("XDG_CACHE_HOME", "~/.cache")).expanduser()
-        / "ansible-compat"
-        / cache_key
-    )
+def get_cache_dir(project_dir: Path, *, isolated: bool = True) -> Path:
+    """Compute cache directory to be used based on project path.
+
+    Returns:
+        Cache directory path.
+    """
+    if "VIRTUAL_ENV" in os.environ:
+        cache_dir = Path(os.environ["VIRTUAL_ENV"]) / ".ansible"
+    elif isolated:
+        cache_dir = project_dir / ".ansible"
+    else:
+        cache_dir = Path(os.environ.get("ANSIBLE_HOME", "~/.ansible")).expanduser()
+
+    # Ensure basic folder structure exists so `ansible-galaxy list` does not
+    # fail with: None of the provided paths were usable. Please specify a valid path with
+    for name in ("roles", "collections"):
+        (cache_dir / name).mkdir(parents=True, exist_ok=True)
+
     return cache_dir

src/ansible_compat/runtime.py

@@ -208,8 +208,8 @@ def __init__(
         if "PYTHONWARNINGS" not in self.environ:  # pragma: no cover
             self.environ["PYTHONWARNINGS"] = "ignore:Blowfish has been deprecated"
 
-        if isolated:
-            self.cache_dir = get_cache_dir(self.project_dir)
+        self.cache_dir = get_cache_dir(self.project_dir, isolated=self.isolated)
+
         self.config = AnsibleConfig(cache_dir=self.cache_dir)
 
         # Add the sys.path to the collection paths if not isolated

test/test_prerun.py

@@ -1,6 +1,12 @@
 """Tests for ansible_compat.prerun module."""
 
+from __future__ import annotations
+
 from pathlib import Path
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from _pytest.monkeypatch import MonkeyPatch
 
 from ansible_compat.prerun import get_cache_dir
 
@@ -10,3 +16,9 @@ def test_get_cache_dir_relative() -> None:
     relative_path = Path()
     abs_path = relative_path.resolve()
     assert get_cache_dir(relative_path) == get_cache_dir(abs_path)
+
+
+def test_get_cache_dir_no_isolation_no_venv(monkeypatch: MonkeyPatch) -> None:
+    """Test behaviors of get_cache_dir."""
+    monkeypatch.delenv("VIRTUAL_ENV", raising=False)
+    assert get_cache_dir(Path(), isolated=False) == Path("~/.ansible").expanduser()

test/test_runtime.py

@@ -652,10 +652,9 @@ def test_upgrade_collection(runtime_tmp: Runtime) -> None:
     runtime_tmp.require_collection("community.molecule", "0.1.0")
 
 
-def test_require_collection_no_cache_dir() -> None:
+def test_require_collection_not_isolated() -> None:
     """Check require_collection without a cache directory."""
-    runtime = Runtime()
-    assert not runtime.cache_dir
+    runtime = Runtime(isolated=False)
     runtime.require_collection("community.molecule", "0.1.0", install=True)
 
 
@@ -1022,6 +1021,11 @@ def test_runtime_has_playbook() -> None:
     """Tests has_playbook method."""
     runtime = Runtime(require_module=True)
 
+    runtime.prepare_environment(
+        required_collections={"community.molecule": "0.1.0"},
+        install_local=True,
+    )
+
     assert not runtime.has_playbook("this-does-not-exist.yml")
     # call twice to ensure cache is used:
     assert not runtime.has_playbook("this-does-not-exist.yml")