Adding upstream version 1.64.0+dfsg1.upstream/1.64.0+dfsg1

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 66 insertions, 0 deletions

diff --git a/src/tools/tidy/src/unit_tests.rs b/src/tools/tidy/src/unit_tests.rs
new file mode 100644
index 000000000..f675b7865
--- /dev/null
+++ b/src/tools/tidy/src/unit_tests.rs
@@ -0,0 +1,66 @@
+//! Tidy check to ensure `#[test]` and `#[bench]` are not used directly inside `core`.
+//!
+//! `#![no_core]` libraries cannot be tested directly due to duplicating lang
+//! items. All tests and benchmarks must be written externally in `core/{tests,benches}`.
+//!
+//! Outside of core tests and benchmarks should be outlined into separate files
+//! named `tests.rs` or `benches.rs`, or directories named `tests` or `benches` unconfigured
+//! during normal build.
+
+use std::path::Path;
+
+pub fn check(root_path: &Path, bad: &mut bool) {
+    let core = &root_path.join("core");
+    let core_tests = &core.join("tests");
+    let core_benches = &core.join("benches");
+    let is_core = |path: &Path| {
+        path.starts_with(core) && !(path.starts_with(core_tests) || path.starts_with(core_benches))
+    };
+
+    let mut skip = |path: &Path| {
+        let file_name = path.file_name().unwrap_or_default();
+        if path.is_dir() {
+            super::filter_dirs(path)
+                || path.ends_with("src/test")
+                || path.ends_with("src/doc")
+                || (file_name == "tests" || file_name == "benches") && !is_core(path)
+        } else {
+            let extension = path.extension().unwrap_or_default();
+            extension != "rs"
+                || (file_name == "tests.rs" || file_name == "benches.rs") && !is_core(path)
+                // UI tests with different names
+                || path.ends_with("src/thread/local/dynamic_tests.rs")
+                || path.ends_with("src/sync/mpsc/sync_tests.rs")
+        }
+    };
+
+    super::walk(root_path, &mut skip, &mut |entry, contents| {
+        let path = entry.path();
+        let is_core = path.starts_with(core);
+        for (i, line) in contents.lines().enumerate() {
+            let line = line.trim();
+            let is_test = || line.contains("#[test]") && !line.contains("`#[test]");
+            let is_bench = || line.contains("#[bench]") && !line.contains("`#[bench]");
+            if !line.starts_with("//") && (is_test() || is_bench()) {
+                let explanation = if is_core {
+                    "core unit tests and benchmarks must be placed into \
+                         `core/tests` or `core/benches`"
+                } else {
+                    "unit tests and benchmarks must be placed into \
+                         separate files or directories named \
+                         `tests.rs`, `benches.rs`, `tests` or `benches`"
+                };
+                let name = if is_test() { "test" } else { "bench" };
+                tidy_error!(
+                    bad,
+                    "`{}:{}` contains `#[{}]`; {}",
+                    path.display(),
+                    i + 1,
+                    name,
+                    explanation,
+                );
+                return;
+            }
+        }
+    });
+}