Skip to content

Commit

Permalink
Include reason in cache path warnings to aid debugging (#11005)
Browse files Browse the repository at this point in the history
Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
  • Loading branch information
scop and nicoddemus committed May 18, 2023
1 parent 6041511 commit c8641f8
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 5 deletions.
1 change: 1 addition & 0 deletions changelog/11005.improvement.rst
@@ -0,0 +1 @@
Added underlying exception to cache provider path creation and write warning messages.
14 changes: 10 additions & 4 deletions src/_pytest/cacheprovider.py
Expand Up @@ -179,16 +179,22 @@ def set(self, key: str, value: object) -> None:
else:
cache_dir_exists_already = self._cachedir.exists()
path.parent.mkdir(exist_ok=True, parents=True)
except OSError:
self.warn("could not create cache path {path}", path=path, _ispytest=True)
except OSError as exc:
self.warn(
f"could not create cache path {path}: {exc}",
_ispytest=True,
)
return
if not cache_dir_exists_already:
self._ensure_supporting_files()
data = json.dumps(value, ensure_ascii=False, indent=2)
try:
f = path.open("w", encoding="UTF-8")
except OSError:
self.warn("cache could not write path {path}", path=path, _ispytest=True)
except OSError as exc:
self.warn(
f"cache could not write path {path}: {exc}",
_ispytest=True,
)
else:
with f:
f.write(data)
Expand Down
2 changes: 1 addition & 1 deletion testing/test_cacheprovider.py
Expand Up @@ -87,7 +87,7 @@ def test_cache_failure_warns(
"*= warnings summary =*",
"*/cacheprovider.py:*",
" */cacheprovider.py:*: PytestCacheWarning: could not create cache path "
f"{unwritable_cache_dir}/v/cache/nodeids",
f"{unwritable_cache_dir}/v/cache/nodeids: *",
' config.cache.set("cache/nodeids", sorted(self.cached_nodeids))',
"*1 failed, 3 warnings in*",
]
Expand Down

0 comments on commit c8641f8

Please sign in to comment.