Skip to content

additional edge cases tests for path.rs 🧪 #141105

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.

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
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

GrantBirki
Copy link

This pull request adds a few new edge case tests to the std::path module. The new tests cover scenarios such as paths with only separators, non-ASCII and Unicode characters, embedded null bytes, etc. Each new test is documented with some helpful in-line comments as well.

@rustbot
Copy link
Collaborator

rustbot commented May 16, 2025

r? @jhpratt

rustbot has assigned @jhpratt.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels May 16, 2025
@rust-log-analyzer

This comment has been minimized.

@GrantBirki
Copy link
Author

It appears that mingw-check-tidy failed, but I am not sure how to correct it. Perhaps its a linter of some sort?

@ChaiTRex
Copy link
Contributor

It appears that mingw-check-tidy failed, but I am not sure how to correct it. Perhaps its a linter of some sort?

mingw-check also failed. Click on CI / PR - mingw-check (pull_request) and see the compiler errors toward the bottom.

@ChaiTRex
Copy link
Contributor

It looks as if OsStrExt and OsStringExt have different methods on Windows than other platforms.

@workingjubilee
Copy link
Member

Yes, please fix the tests to only use functions from OsStr and OsString OR cfg the tests.

@rust-log-analyzer
Copy link
Collaborator

The job mingw-check-tidy failed! Check out the build log: (web) (plain)

Click to see the possible cause of the failure (guessed by this bot)
info: removing rustup binaries
info: rustup is uninstalled
##[group]Image checksum input
mingw-check-tidy
# We use the ghcr base image because ghcr doesn't have a rate limit
# and the mingw-check-tidy job doesn't cache docker images in CI.
FROM ghcr.io/rust-lang/ubuntu:22.04

ARG DEBIAN_FRONTEND=noninteractive
RUN apt-get update && apt-get install -y --no-install-recommends \
  g++ \
---

COPY host-x86_64/mingw-check/validate-toolstate.sh /scripts/
COPY host-x86_64/mingw-check/validate-error-codes.sh /scripts/

# NOTE: intentionally uses python2 for x.py so we can test it still works.
# validate-toolstate only runs in our CI, so it's ok for it to only support python3.
ENV SCRIPT TIDY_PRINT_DIFF=1 python2.7 ../x.py test \
           --stage 0 src/tools/tidy tidyselftest --extra-checks=py,cpp
#
# This file is autogenerated by pip-compile with Python 3.10
# by the following command:
#
#    pip-compile --allow-unsafe --generate-hashes reuse-requirements.in
---
#12 4.286      ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6.1/6.1 MB 25.8 MB/s eta 0:00:00
#12 4.330 Collecting distlib<1,>=0.3.7
#12 4.338   Downloading distlib-0.3.9-py2.py3-none-any.whl (468 kB)
#12 4.349      ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 469.0/469.0 KB 49.0 MB/s eta 0:00:00
#12 4.388 Collecting platformdirs<5,>=3.9.1
#12 4.395   Downloading platformdirs-4.3.8-py3-none-any.whl (18 kB)
#12 4.436 Collecting filelock<4,>=3.12.2
#12 4.444   Downloading filelock-3.18.0-py3-none-any.whl (16 kB)
#12 4.527 Installing collected packages: distlib, platformdirs, filelock, virtualenv
#12 4.721 Successfully installed distlib-0.3.9 filelock-3.18.0 platformdirs-4.3.8 virtualenv-20.31.2
#12 4.721 WARNING: Running pip as the 'root' user can result in broken permissions and conflicting behaviour with the system package manager. It is recommended to use a virtual environment instead: https://pip.pypa.io/warnings/venv
#12 DONE 4.8s

#13 [7/8] COPY host-x86_64/mingw-check/validate-toolstate.sh /scripts/
#13 DONE 0.0s
---
DirectMap4k:      141248 kB
DirectMap2M:     9295872 kB
DirectMap1G:     9437184 kB
##[endgroup]
Executing TIDY_PRINT_DIFF=1 python2.7 ../x.py test            --stage 0 src/tools/tidy tidyselftest --extra-checks=py,cpp
+ TIDY_PRINT_DIFF=1 python2.7 ../x.py test --stage 0 src/tools/tidy tidyselftest --extra-checks=py,cpp
##[group]Building bootstrap
    Finished `dev` profile [unoptimized] target(s) in 0.05s
##[endgroup]
WARN: currently no CI rustc builds have rustc debug assertions enabled. Please either set `rust.debug-assertions` to `false` if you want to use download CI rustc or set `rust.download-rustc` to `false`.
downloading https://static.rust-lang.org/dist/2025-05-12/rustfmt-nightly-x86_64-unknown-linux-gnu.tar.xz
---
[TIMING] core::build_steps::tool::ToolBuild { compiler: Compiler { stage: 0, host: x86_64-unknown-linux-gnu, forced_compiler: false }, target: x86_64-unknown-linux-gnu, tool: "tidy", path: "src/tools/tidy", mode: ToolBootstrap, source_type: InTree, extra_features: [], allow_features: "", cargo_args: [], artifact_kind: Binary } -- 35.411
[TIMING] core::build_steps::tool::Tidy { compiler: Compiler { stage: 0, host: x86_64-unknown-linux-gnu, forced_compiler: false }, target: x86_64-unknown-linux-gnu } -- 0.000
fmt check
fmt: checked 6014 files
Diff in /checkout/library/std/tests/path.rs:1998:
     assert_eq!(path.file_name(), Some(OsStr::new("file.txt")));
 }
 
-
 // Test: Reserved device names (Windows)
 // This test ensures that reserved device names like "CON", "PRN", etc., are handled as normal paths on non-Windows platforms,
 // and as special cases on Windows (if applicable).
Build completed unsuccessfully in 0:01:15
  local time: Sat May 17 05:51:16 UTC 2025
  network time: Sat, 17 May 2025 05:51:16 GMT
##[error]Process completed with exit code 1.
Post job cleanup.

tp!("foo./.", "bar", r"foo./.\bar");
tp!("foo./.", "bar", r"foo././bar");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this changing an existing test?

Comment on lines +2002 to +2004
// Test: Reserved device names (Windows)
// This test ensures that reserved device names like "CON", "PRN", etc., are handled as normal paths on non-Windows platforms,
// and as special cases on Windows (if applicable).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment doesn't seem to describe the test.

Comment on lines +2015 to +2017
// Test: Trailing dots/spaces (Windows)
// This test checks how Path handles trailing dots or spaces, which are special on Windows.
// On Unix, these should be treated as normal characters.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Path mostly works the same across platforms (separator differences and roots/prefixes not withstanding). If there's a difference then you should have tests for both Windows and non-Windows that shows the difference.

Comment on lines +2033 to +2035
// Test: Only extension (e.g., ".gitignore")
// This test verifies that files with only an extension and no base name are handled correctly.
// It checks that the extension is recognized and the file stem is None or empty as appropriate.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really not have a test for this anywhere else?

Comment on lines +2044 to +2046
// Test: Long components
// This test checks that Path can handle very long path components without truncation or error.
// It ensures that the length of the component is preserved.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why this would be useful for us specifically? We don't usually check that slice wrappers work on the whole slice.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants