Fix issue with slashes being turned into backslashes on Windows

[nauman897]

Fix slash handling in nodeid paths for Windows environments.

• Resolved issue with backslashes being incorrectly converted in nodeid paths on Windows.
• This change closes Slashes in parametrization values get turned into backslashes on Windows #12745.

[nauman897]

I’ve tackled the issue with backslashes getting messed up in nodeid paths on Windows by isolating the path and nodeid parts, handling them separately, and then putting them back together. This should take care of the problem, including a few tricky edge cases with mixed slashes and special characters.

I haven’t added unit tests yet—figured I’d wait to see if the approach looks good to you all. If it does, I’ll go ahead and write the tests to make sure everything’s covered.

[dongfangtianyu]

Thank you @nauman897 for this PR.
I have debugged and verified it locally, and everything is fine.

[nicoddemus]

I just tested this on Windows, on the main branch, and it passes... does this fail only on Linux?

[nauman897]

Hey @nicoddemus ,
The problem specifically occurs under these circumstances as mentioned in the issue:
The IDs show up correctly in --collect-only, and they show correctly when test_x.py is not in a subfolder, or when pytest is not invoked in the subfolder.

[The-Compiler]

But then the test case should make sure to replicate that scenario, no?

[nauman897]

Yeah. I'll fix that

[nauman897]

I believe @dongfangtianyu has already taken care of it: nauman897#1

[dongfangtianyu]

Hi @nauman897 ,I have submitted a PR to your repository, hoping that you can review, verify, and merge this modification. It’s not difficult, you can give it a try.

Ideally:

1. The test case will fail when pytest runs without your patch being merged.
2. The test case will pass after merging your patch into pytest.
   

If the actual result is different, it indicates there are still issues with our code, and it should not be merged into pytest’s main branch.

[nauman897]

Thanks @dongfangtianyu for the help with these tests.
I can confirm that:

1. The tests fail with the previous logic in cwd_relative_nodeid:

FAILED test_foo.py::test_x[x\y] - assert False
FAILED test_foo.py::test_x[C:\path] - assert False
FAILED test_foo.py::test_x[\] - assert False
FAILED test_foo.py::test_x[C:\path] - assert False
FAILED test_foo.py::test_x[a::b\] - assert False

2. The tests pass after the patch is applied.

test_foo.py::test_x[x/y] FAILED                                          [ 20%]
test_foo.py::test_x[C:/path] FAILED                                      [ 40%]
test_foo.py::test_x[\\] FAILED                                           [ 60%]
test_foo.py::test_x[C:\\path] FAILED                                     [ 80%]
test_foo.py::test_x[a::b/] FAILED                                        [100%]

I had to make a minor adjustment to the new tests, as Python 3.11 and later requires passing the encoding_type param while calling the write_text method.

[dongfangtianyu]

That's cool @nauman897 !

2. The tests pass after the patch is applied.

test_terminal.py::TestNodeIDHandling::test_nodeid_handling_windows_paths PASSED [100%]

This is a more intuitive output:

test_foo.py::test_x[x/y] FAILED                                          [ 20%]
test_foo.py::test_x[C:/path] FAILED                                      [ 40%]
test_foo.py::test_x[\\] FAILED                                           [ 60%]
test_foo.py::test_x[C:\\path] FAILED                                     [ 80%]
test_foo.py::test_x[a::b/] FAILED                                        [100%]

[nicoddemus]

Thanks folks, we greatly appreciate it!

[patchback]

Backport to 8.3.x: 💚 backport PR created

✅ Backport PR branch: patchback/backports/8.3.x/d35b802805b210c6d5281864d663f53c6a72f153/pr-12760

Backported as #12787

🤖 @patchback
I'm built with octomachinery and
my source is open — /~https://github.com/sanitizers/patchback-github-app.