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

crates_io_tarball: Ignore duplicate readme files #8802

Closed
wants to merge 1 commit into from
Closed

crates_io_tarball: Ignore duplicate readme files #8802

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 16 additions & 3 deletions crates/crates_io_tarball/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,11 @@ pub fn process_tarball<R: Read>(

let lowercase_path = entry_path.as_os_str().to_ascii_lowercase();
if !paths.insert(lowercase_path) {
return Err(TarballError::DuplicatePath(
entry_path.display().to_string(),
));
let path = entry_path.display().to_string();
// see https://github.com/rust-lang/crates.io/pull/8788#issuecomment-2151695951
if !path.to_ascii_lowercase().ends_with("/readme.md") {
return Err(TarballError::DuplicatePath(path));
}
}

// Let's go hunting for the VCS info and crate manifest. The only valid place for these is
Expand Down Expand Up @@ -334,4 +336,15 @@ mod tests {
let err = assert_err!(process_tarball("foo-0.0.1", &*tarball, MAX_SIZE));
assert_snapshot!(err, @"duplicate path found: foo-0.0.1/FOO.rs")
}

#[test]
fn test_double_readme() {
let tarball = TarballBuilder::new()
.add_file("foo-0.0.1/Cargo.toml", MANIFEST)
.add_file("foo-0.0.1/Readme.md", b"")
.add_file("foo-0.0.1/README.md", b"")
.build();

assert_ok!(process_tarball("foo-0.0.1", &*tarball, MAX_SIZE));
}
}