Skip to content

Add relpath test for Windows error coverage #2571

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

Open
m-rsha wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add relpath test for Windows error coverage #2571

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a11b80
Add error handling for relpath ValueError, fixes #2530
SitiSchu Sep 28, 2022
3a3fe94
Add `relpath` test for Windows error coverage
m-rsha Oct 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Add relpath test for Windows error coverage
  • Loading branch information
@m-rsha
m-rsha committed Oct 31, 2022
commit 3a3fe94760488e3e5d9f2f873194fa54c613eaf0
8 changes: 4 additions & 4 deletions pre_commit/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,14 +165,14 @@ def _adjust_args_and_chdir(args: argparse.Namespace) -> None:
toplevel = git.get_root()
os.chdir(toplevel)

# https://github.com/pre-commit/pre-commit/issues/2530
# `os.relpath` raises a ValueError on Windows when the paths given are on
# separate drives.
try:
args.config = os.path.relpath(args.config)
# https://github.com/pre-commit/pre-commit/issues/2530
# os.relpath will fail with a ValueError if the two directories are on
# two different drives on Windows and since the path is made relative
# for display purposes only we can ignore the error
except ValueError:
pass

if args.command in {'run', 'try-repo'}:
args.files = [os.path.relpath(filename) for filename in args.files]
if args.commit_msg_filename is not None:
Expand Down
7 changes: 7 additions & 0 deletions tests/main_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ def test_adjust_args_and_chdir_not_in_git_dir(in_tmpdir):
main._adjust_args_and_chdir(_args())


def test_adjust_args_and_chdir_relpath_to_different_drive():
args = _args(command='run', files=['f1', 'f2'])
with mock.patch.object(os.path, 'relpath', side_effect=ValueError):
with pytest.raises(ValueError):
main._adjust_args_and_chdir(args)


def test_adjust_args_and_chdir_noop(in_git_dir):
args = _args(command='run', files=['f1', 'f2'])
main._adjust_args_and_chdir(args)
Expand Down