Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Catch an edge case in expand._assert_local() #3595

Merged
merged 2 commits into from Oct 14, 2022
Merged

Catch an edge case in expand._assert_local() #3595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4249da1
Catch an edge case in expand._assert_local()
mssalvatore Sep 18, 2022
063aecd
Use abspath() instead of resolve() in expand._assert_local()
mssalvatore Sep 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion setuptools/config/expand.py
View file
Open in desktop
Expand Up @@ -41,6 +41,7 @@
Union,
cast
)
from pathlib import Path
from types import ModuleType

from distutils.errors import DistutilsOptionError
Expand Down Expand Up @@ -150,7 +151,7 @@ def _read_file(filepath: Union[bytes, _Path]) -> str:


def _assert_local(filepath: _Path, root_dir: str):
if not os.path.abspath(filepath).startswith(root_dir):
if Path(os.path.abspath(root_dir)) not in Path(os.path.abspath(filepath)).parents:
msg = f"Cannot access {filepath!r} (or anything outside {root_dir!r})"
raise DistutilsOptionError(msg)

Expand Down
9 changes: 9 additions & 0 deletions setuptools/tests/config/test_expand.py
View file
Open in desktop
@@ -1,4 +1,5 @@
import os
from pathlib import Path

import pytest

Expand Down Expand Up @@ -45,6 +46,10 @@ def test_read_files(tmp_path, monkeypatch):
}
write_files(files, dir_)

secrets = Path(str(dir_) + "secrets")
secrets.mkdir(exist_ok=True)
write_files({"secrets.txt": "secret keys"}, secrets)

with monkeypatch.context() as m:
m.chdir(dir_)
assert expand.read_files(list(files)) == "a\nb\nc"
Expand All @@ -53,6 +58,10 @@ def test_read_files(tmp_path, monkeypatch):
with pytest.raises(DistutilsOptionError, match=cannot_access_msg):
expand.read_files(["../a.txt"])

cannot_access_secrets_msg = r"Cannot access '.*secrets\.txt'"
with pytest.raises(DistutilsOptionError, match=cannot_access_secrets_msg):
expand.read_files(["../dir_secrets/secrets.txt"])

# Make sure the same APIs work outside cwd
assert expand.read_files(list(files), dir_) == "a\nb\nc"
with pytest.raises(DistutilsOptionError, match=cannot_access_msg):
Expand Down