Merge #2032

2032: rename tools -> xtask r=matklad a=matklad



Co-authored-by: Aleksey Kladov <[email protected]>

3 files changed, 110 insertions, 0 deletions

diff --git a/xtask/tests/tidy-tests/cli.rs b/xtask/tests/tidy-tests/cli.rs
new file mode 100644
index 000000000..5d8ddea83
--- /dev/null
+++ b/xtask/tests/tidy-tests/cli.rs
@@ -0,0 +1,45 @@
+use walkdir::WalkDir;
+use xtask::{gen_tests, generate_boilerplate, project_root, run_rustfmt, Verify};
+
+#[test]
+fn generated_grammar_is_fresh() {
+    if let Err(error) = generate_boilerplate(Verify) {
+        panic!("{}. Please update it by running `cargo xtask codegen`", error);
+    }
+}
+
+#[test]
+fn generated_tests_are_fresh() {
+    if let Err(error) = gen_tests(Verify) {
+        panic!("{}. Please update tests by running `cargo xtask gen-tests`", error);
+    }
+}
+
+#[test]
+fn check_code_formatting() {
+    if let Err(error) = run_rustfmt(Verify) {
+        panic!("{}. Please format the code by running `cargo format`", error);
+    }
+}
+
+#[test]
+fn no_todo() {
+    WalkDir::new(project_root().join("crates")).into_iter().for_each(|e| {
+        let e = e.unwrap();
+        if e.path().extension().map(|it| it != "rs").unwrap_or(true) {
+            return;
+        }
+        if e.path().ends_with("tests/cli.rs") {
+            return;
+        }
+        let text = std::fs::read_to_string(e.path()).unwrap();
+        if text.contains("TODO") || text.contains("TOOD") {
+            panic!(
+                "\nTODO markers should not be committed to the master branch,\n\
+                 use FIXME instead\n\
+                 {}\n",
+                e.path().display(),
+            )
+        }
+    })
+}
diff --git a/xtask/tests/tidy-tests/docs.rs b/xtask/tests/tidy-tests/docs.rs
new file mode 100644
index 000000000..fe5852bc6
--- /dev/null
+++ b/xtask/tests/tidy-tests/docs.rs
@@ -0,0 +1,63 @@
+use std::fs;
+use std::io::prelude::*;
+use std::io::BufReader;
+use std::path::Path;
+
+use walkdir::{DirEntry, WalkDir};
+
+use xtask::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();
+        if f.file_type().is_dir() {
+            continue;
+        }
+        if f.path().extension().map(|it| it != "rs").unwrap_or(false) {
+            continue;
+        }
+        if is_exclude_dir(f.path()) {
+            continue;
+        }
+        if is_exclude_file(&f) {
+            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("//!") {
+            panic!(
+                "\nMissing docs strings\n\
+                 module: {}\n\
+                 Need add doc for module\n",
+                f.path().display()
+            )
+        }
+    }
+}
diff --git a/xtask/tests/tidy-tests/main.rs b/xtask/tests/tidy-tests/main.rs
new file mode 100644
index 000000000..56d1318d6
--- /dev/null
+++ b/xtask/tests/tidy-tests/main.rs
@@ -0,0 +1,2 @@
+mod cli;
+mod docs;