From fdbd6bb11a0c47bf9ba1428e6bd432cd2ce72045 Mon Sep 17 00:00:00 2001 From: Alexander Andreev Date: Mon, 30 Sep 2019 11:58:53 +0300 Subject: Added test for check doc strings in crates. #1856 --- crates/ra_tools/src/bin/pre-commit.rs | 2 + crates/ra_tools/src/boilerplate_gen.rs | 4 +- crates/ra_tools/src/help.rs | 2 + crates/ra_tools/src/lib.rs | 2 + crates/ra_tools/src/main.rs | 2 + crates/ra_tools/tests/cli.rs | 5 +-- crates/ra_tools/tests/docs.rs | 67 ++++++++++++++++++++++++++++++++++ crates/ra_tools/tests/main.rs | 2 + 8 files changed, 82 insertions(+), 4 deletions(-) create mode 100644 crates/ra_tools/tests/docs.rs create mode 100644 crates/ra_tools/tests/main.rs (limited to 'crates/ra_tools') diff --git a/crates/ra_tools/src/bin/pre-commit.rs b/crates/ra_tools/src/bin/pre-commit.rs index a628f64b2..16bbf9cb2 100644 --- a/crates/ra_tools/src/bin/pre-commit.rs +++ b/crates/ra_tools/src/bin/pre-commit.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use std::process::Command; use ra_tools::{project_root, run, run_rustfmt, Overwrite, Result}; diff --git a/crates/ra_tools/src/boilerplate_gen.rs b/crates/ra_tools/src/boilerplate_gen.rs index 1d112c0af..39f1cae66 100644 --- a/crates/ra_tools/src/boilerplate_gen.rs +++ b/crates/ra_tools/src/boilerplate_gen.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + use std::{ collections::BTreeMap, fs, @@ -282,7 +284,7 @@ fn reformat(text: impl std::fmt::Display) -> Result { let output = rustfmt.wait_with_output()?; let stdout = String::from_utf8(output.stdout)?; let preamble = "Generated file, do not edit by hand, see `crate/ra_tools/src/codegen`"; - Ok(format!("// {}\n\n{}", preamble, stdout)) + Ok(format!("//! {}\n\n{}", preamble, stdout)) } #[derive(Deserialize, Debug)] diff --git a/crates/ra_tools/src/help.rs b/crates/ra_tools/src/help.rs index 9eb4dfbe4..72dfabacd 100644 --- a/crates/ra_tools/src/help.rs +++ b/crates/ra_tools/src/help.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + pub const GLOBAL_HELP: &str = "tasks USAGE: diff --git a/crates/ra_tools/src/lib.rs b/crates/ra_tools/src/lib.rs index 9ba23caaa..aa993a38a 100644 --- a/crates/ra_tools/src/lib.rs +++ b/crates/ra_tools/src/lib.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + mod boilerplate_gen; use std::{ diff --git a/crates/ra_tools/src/main.rs b/crates/ra_tools/src/main.rs index a951ce427..161871ccf 100644 --- a/crates/ra_tools/src/main.rs +++ b/crates/ra_tools/src/main.rs @@ -1,3 +1,5 @@ +//! FIXME: write short doc here + mod help; use core::fmt::Write; diff --git a/crates/ra_tools/tests/cli.rs b/crates/ra_tools/tests/cli.rs index 91b19c8f8..609fd4d8b 100644 --- a/crates/ra_tools/tests/cli.rs +++ b/crates/ra_tools/tests/cli.rs @@ -1,6 +1,5 @@ -use walkdir::WalkDir; - use ra_tools::{gen_tests, generate_boilerplate, project_root, run_rustfmt, Verify}; +use walkdir::WalkDir; #[test] fn generated_grammar_is_fresh() { @@ -36,7 +35,7 @@ fn no_todo() { let text = std::fs::read_to_string(e.path()).unwrap(); if text.contains("TODO") || text.contains("TOOD") { panic!( - "\nTODO markers should not be commited to the master branch,\n\ + "\nTODO markers should not be committed to the master branch,\n\ use FIXME instead\n\ {}\n", e.path().display(), diff --git a/crates/ra_tools/tests/docs.rs b/crates/ra_tools/tests/docs.rs new file mode 100644 index 000000000..1629247da --- /dev/null +++ b/crates/ra_tools/tests/docs.rs @@ -0,0 +1,67 @@ +use std::fs; +use std::io::prelude::*; +use std::io::BufReader; +use std::path::Path; + +use walkdir::{DirEntry, WalkDir}; + +use ra_tools::project_root; + +fn is_exclude_dir(p: &Path) -> bool { + let exclude_dirs = ["tests", "test_data"]; + let mut cur_path = p; + while let Some(path) = cur_path.parent() { + if exclude_dirs.iter().any(|dir| path.ends_with(dir)) { + return true; + } + cur_path = path; + } + + false +} + +fn is_exclude_file(d: &DirEntry) -> bool { + let file_names = ["tests.rs"]; + + d.file_name().to_str().map(|f_n| file_names.iter().any(|name| *name == f_n)).unwrap_or(false) +} + +fn is_hidden(entry: &DirEntry) -> bool { + entry.file_name().to_str().map(|s| s.starts_with(".")).unwrap_or(false) +} + +#[test] +fn no_docs_comments() { + let crates = project_root().join("crates"); + let iter = WalkDir::new(crates); + for f in iter.into_iter().filter_entry(|e| !is_hidden(e)) { + let f = f.unwrap(); //dbg!(f.unwrap()); + if f.file_type().is_dir() { + continue; + } + if f.path().extension().map(|it| it != "rs").unwrap_or(false) { + //dbg!(f.path()); + continue; + } + if is_exclude_dir(f.path()) { + //dbg!(f.path()); + continue; + } + if is_exclude_file(&f) { + //dbg!(f.path()); + continue; + } + let mut reader = BufReader::new(fs::File::open(f.path()).unwrap()); + let mut line = String::new(); + reader.read_line(&mut line).unwrap(); + if !line.starts_with("//!") { + //dbg!(line); + panic!( + "\nMissing docs strings\n\ + module: {}\n\ + Need add doc for module or this string \"//! FIXME: write short doc here\"\n", + f.path().display() + ) + } + } +} diff --git a/crates/ra_tools/tests/main.rs b/crates/ra_tools/tests/main.rs new file mode 100644 index 000000000..56d1318d6 --- /dev/null +++ b/crates/ra_tools/tests/main.rs @@ -0,0 +1,2 @@ +mod cli; +mod docs; -- cgit v1.2.3 From 506222a9b1cf2aa5ff6f798fc84dabbc74ceb845 Mon Sep 17 00:00:00 2001 From: Alexander Andreev Date: Mon, 30 Sep 2019 12:09:56 +0300 Subject: Drop debug strings. --- crates/ra_tools/tests/docs.rs | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) (limited to 'crates/ra_tools') diff --git a/crates/ra_tools/tests/docs.rs b/crates/ra_tools/tests/docs.rs index 1629247da..b4403c471 100644 --- a/crates/ra_tools/tests/docs.rs +++ b/crates/ra_tools/tests/docs.rs @@ -35,27 +35,23 @@ fn no_docs_comments() { let crates = project_root().join("crates"); let iter = WalkDir::new(crates); for f in iter.into_iter().filter_entry(|e| !is_hidden(e)) { - let f = f.unwrap(); //dbg!(f.unwrap()); + let f = f.unwrap(); if f.file_type().is_dir() { continue; } if f.path().extension().map(|it| it != "rs").unwrap_or(false) { - //dbg!(f.path()); continue; } if is_exclude_dir(f.path()) { - //dbg!(f.path()); continue; } if is_exclude_file(&f) { - //dbg!(f.path()); continue; } let mut reader = BufReader::new(fs::File::open(f.path()).unwrap()); let mut line = String::new(); reader.read_line(&mut line).unwrap(); if !line.starts_with("//!") { - //dbg!(line); panic!( "\nMissing docs strings\n\ module: {}\n\ -- cgit v1.2.3 From a47bca636cec350cf29c296dafd0c1bec51cd654 Mon Sep 17 00:00:00 2001 From: Alexander Andreev Date: Mon, 30 Sep 2019 13:31:28 +0300 Subject: Change user message. --- crates/ra_tools/tests/docs.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'crates/ra_tools') diff --git a/crates/ra_tools/tests/docs.rs b/crates/ra_tools/tests/docs.rs index b4403c471..ea3330175 100644 --- a/crates/ra_tools/tests/docs.rs +++ b/crates/ra_tools/tests/docs.rs @@ -55,7 +55,7 @@ fn no_docs_comments() { panic!( "\nMissing docs strings\n\ module: {}\n\ - Need add doc for module or this string \"//! FIXME: write short doc here\"\n", + Need add doc for module\n", f.path().display() ) } -- cgit v1.2.3