Skip to content

Commit

Permalink
Remove old test about README.md being in sync with module docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fitzgen committed Sep 10, 2024
1 parent 95f27a6 commit d6fcf2f
Showing 1 changed file with 0 additions and 45 deletions.
45 changes: 0 additions & 45 deletions tests/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,53 +5,8 @@ use is_executable::is_executable;

#[cfg(unix)]
mod unix {
use std::env;
use std::fs::File;
use std::io::Read;
use std::process::Command;

use super::*;

#[test]
fn cargo_readme_up_to_date() {
if env::var("CI").is_ok() {
return;
}

println!("Checking that `cargo readme > README.md` is up to date...");

let expected = Command::new("cargo")
.arg("readme")
.current_dir(env!("CARGO_MANIFEST_DIR"))
.output()
.expect("should run `cargo readme` OK")
.stdout;
let expected = String::from_utf8_lossy(&expected);

let actual = {
let mut file = File::open(concat!(env!("CARGO_MANIFEST_DIR"), "/README.md"))
.expect("should open README.md file");
let mut s = String::new();
file.read_to_string(&mut s)
.expect("should read contents of file to string");
s
};

if actual != expected {
println!();
println!("+++ expected README.md");
println!("--- actual README.md");
for d in diff::lines(&expected, &actual) {
match d {
diff::Result::Left(l) => println!("+{}", l),
diff::Result::Right(r) => println!("-{}", r),
diff::Result::Both(b, _) => println!(" {}", b),
}
}
panic!("Run `cargo readme > README.md` to update README.md")
}
}

#[test]
fn executable() {
assert!(is_executable("./tests/i_am_executable"));
Expand Down

0 comments on commit d6fcf2f

Please sign in to comment.