Initial commit: Fabrilis docs, rules and deterministic core
Docs (architecture, decisions, coupling, determinism, UI, references), code rules enforced by tools/limits, deterministic core with units, time, math, sched, snapshot, vec and rng, plus smoke tests. ref/ stays out of git.
This commit is contained in:
commit
79928b645b
222 changed files with 5335 additions and 0 deletions
163
tools/limits/tests/rules.rs
Normal file
163
tools/limits/tests/rules.rs
Normal file
|
|
@ -0,0 +1,163 @@
|
|||
mod tree;
|
||||
|
||||
use fabrilis_limits::{MAX_LINES, scan};
|
||||
use tree::TempTree;
|
||||
|
||||
fn errors(tree: &TempTree) -> Vec<String> {
|
||||
scan(tree.path()).errors
|
||||
}
|
||||
|
||||
fn manifest(name: &str, dependencies: &[&str]) -> String {
|
||||
let deps: String = dependencies
|
||||
.iter()
|
||||
.map(|d| format!("fabrilis-{d} = {{ path = \"../{d}\" }}\n"))
|
||||
.collect();
|
||||
format!("[package]\nname = \"fabrilis-{name}\"\n\n[dependencies]\n{deps}")
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn inline_test_module_is_rejected() {
|
||||
let tree = TempTree::new("inline");
|
||||
tree.write(
|
||||
"a.rs",
|
||||
"fn f() {}\n\n#[cfg(test)]\nmod tests {\n#[test]\nfn t() {}\n}\n",
|
||||
);
|
||||
let found = errors(&tree);
|
||||
assert!(found.iter().any(|e| e.contains("a.rs:3")), "{found:?}");
|
||||
assert!(found.iter().any(|e| e.contains("a.rs:5")), "{found:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn out_of_line_test_module_is_accepted() {
|
||||
let tree = TempTree::new("outline");
|
||||
tree.write("a.rs", "fn f() {}\n#[cfg(test)]\nmod tests;\n");
|
||||
tree.write(
|
||||
"b.rs",
|
||||
"#[cfg(test)]\n\n#[allow(dead_code)]\npub mod tests;\n",
|
||||
);
|
||||
assert!(errors(&tree).is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_helpers_behind_cfg_test_are_rejected() {
|
||||
let tree = TempTree::new("helper");
|
||||
tree.write("a.rs", "#[cfg(test)]\nfn helper() {}\n");
|
||||
assert_eq!(errors(&tree).len(), 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_attribute_is_fine_in_test_files() {
|
||||
let tree = TempTree::new("testfiles");
|
||||
tree.write("sched/tests.rs", "#[test]\nfn t() {}\n");
|
||||
tree.write("tests/it.rs", "#[test]\nfn t() {}\n");
|
||||
tree.write("benches/b.rs", "#[test]\nfn t() {}\n");
|
||||
assert!(errors(&tree).is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn vague_names_are_rejected() {
|
||||
let tree = TempTree::new("names");
|
||||
tree.write("utils.rs", "");
|
||||
tree.write("ok/helpers/a.rs", "");
|
||||
tree.write("fine/units.rs", "");
|
||||
assert_eq!(errors(&tree).len(), 2);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn work_markers_in_comments_are_rejected() {
|
||||
let tree = TempTree::new("markers");
|
||||
tree.write("a.rs", "// TODO: fix\n/* FIXME later */\nfn f() {}\n");
|
||||
assert_eq!(errors(&tree).len(), 2);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn markers_in_strings_and_todo_md_references_are_fine() {
|
||||
let tree = TempTree::new("markers-ok");
|
||||
tree.write("a.rs", "// tracked in TODO.md\nlet s = \"TODO FIXME\";\n");
|
||||
assert!(errors(&tree).is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn layering_accepts_downward_dependencies() {
|
||||
let tree = TempTree::new("layers-ok");
|
||||
tree.write("crates/core/Cargo.toml", &manifest("core", &[]));
|
||||
tree.write(
|
||||
"crates/scene/Cargo.toml",
|
||||
&manifest("scene", &["core", "storage"]),
|
||||
);
|
||||
tree.write("crates/storage/Cargo.toml", &manifest("storage", &["core"]));
|
||||
assert!(errors(&tree).is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn layering_rejects_same_layer_and_upward_dependencies() {
|
||||
let tree = TempTree::new("layers-up");
|
||||
tree.write("crates/physics/Cargo.toml", &manifest("physics", &["aero"]));
|
||||
tree.write("crates/core/Cargo.toml", &manifest("core", &["modes"]));
|
||||
assert_eq!(errors(&tree).len(), 2);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn simulation_crates_must_not_use_gui_crates() {
|
||||
let tree = TempTree::new("layers-gui");
|
||||
tree.write("crates/modes/Cargo.toml", &manifest("modes", &["render"]));
|
||||
let found = errors(&tree);
|
||||
assert!(found.iter().any(|e| e.contains("GUI crate")), "{found:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unknown_crates_must_be_registered() {
|
||||
let tree = TempTree::new("layers-unknown");
|
||||
tree.write("crates/zzz/Cargo.toml", &manifest("zzz", &[]));
|
||||
let found = errors(&tree);
|
||||
assert!(found.iter().any(|e| e.contains("layer table")), "{found:?}");
|
||||
}
|
||||
|
||||
fn lines(count: usize) -> String {
|
||||
"let _x = 1;\n".repeat(count)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_files_do_not_count_towards_the_file_limit() {
|
||||
let tree = TempTree::new("files-tests");
|
||||
for i in 0..4 {
|
||||
tree.write(&format!("src/f{i}.rs"), "");
|
||||
}
|
||||
tree.write("src/tests.rs", "");
|
||||
assert!(errors(&tree).is_empty(), "{:?}", errors(&tree));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn every_directory_is_limited_on_its_own() {
|
||||
let tree = TempTree::new("files-nested");
|
||||
for i in 0..4 {
|
||||
tree.write(&format!("src/f{i}.rs"), "");
|
||||
tree.write(&format!("src/sub{i}/a.rs"), "");
|
||||
}
|
||||
assert!(errors(&tree).is_empty(), "{:?}", errors(&tree));
|
||||
|
||||
tree.write("src/sub0/b.rs", "");
|
||||
tree.write("src/sub0/c.rs", "");
|
||||
tree.write("src/sub0/d.rs", "");
|
||||
tree.write("src/sub0/e.rs", "");
|
||||
assert_eq!(errors(&tree).len(), 1, "{:?}", errors(&tree));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn long_test_files_are_exempt_from_the_size_limit() {
|
||||
let tree = TempTree::new("size-tests");
|
||||
tree.write("src/tests.rs", &lines(MAX_LINES + 100));
|
||||
tree.write("tests/it.rs", &lines(MAX_LINES + 100));
|
||||
tree.write("benches/b.rs", &lines(MAX_LINES + 100));
|
||||
assert!(errors(&tree).is_empty(), "{:?}", errors(&tree));
|
||||
let report = scan(tree.path());
|
||||
assert!(report.warnings.is_empty(), "{:?}", report.warnings);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn reference_clones_are_not_checked() {
|
||||
let tree = TempTree::new("ref");
|
||||
tree.write("ref/bad.rs", &lines(MAX_LINES + 10));
|
||||
tree.write("ref/utils/common.rs", "");
|
||||
assert!(errors(&tree).is_empty(), "{:?}", errors(&tree));
|
||||
}
|
||||
81
tools/limits/tests/scan.rs
Normal file
81
tools/limits/tests/scan.rs
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
mod tree;
|
||||
|
||||
use fabrilis_limits::{MAX_FILES_PER_DIR, MAX_LINES, WARN_LINES, scan};
|
||||
use tree::TempTree;
|
||||
|
||||
fn lines(count: usize) -> String {
|
||||
"let _x = 1;\n".repeat(count)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn clean_tree_has_no_findings() {
|
||||
let tree = TempTree::new("clean");
|
||||
tree.write("a.rs", &lines(10));
|
||||
let report = scan(tree.path());
|
||||
assert!(report.errors.is_empty() && report.warnings.is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn soft_limit_warns_but_does_not_fail() {
|
||||
let tree = TempTree::new("soft");
|
||||
tree.write("a.rs", &lines(WARN_LINES + 1));
|
||||
let report = scan(tree.path());
|
||||
assert!(report.errors.is_empty());
|
||||
assert_eq!(report.warnings.len(), 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn exactly_at_limits_is_fine() {
|
||||
let tree = TempTree::new("edge");
|
||||
tree.write("a.rs", &lines(MAX_LINES));
|
||||
let report = scan(tree.path());
|
||||
assert!(report.errors.is_empty());
|
||||
assert_eq!(report.warnings.len(), 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hard_limit_is_an_error() {
|
||||
let tree = TempTree::new("hard");
|
||||
tree.write("a.rs", &lines(MAX_LINES + 1));
|
||||
let report = scan(tree.path());
|
||||
assert_eq!(report.errors.len(), 1);
|
||||
assert!(report.warnings.is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn too_many_files_in_one_directory_is_an_error() {
|
||||
let tree = TempTree::new("files");
|
||||
for i in 0..=MAX_FILES_PER_DIR {
|
||||
tree.write(&format!("d/f{i}.rs"), "");
|
||||
}
|
||||
tree.write("other/a.rs", "");
|
||||
let report = scan(tree.path());
|
||||
assert_eq!(report.errors.len(), 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn subdirectories_do_not_count_towards_the_file_limit() {
|
||||
let tree = TempTree::new("subdirs");
|
||||
for i in 0..MAX_FILES_PER_DIR {
|
||||
tree.write(&format!("d/f{i}.rs"), "");
|
||||
tree.write(&format!("d/sub{i}/mod.rs"), "");
|
||||
}
|
||||
assert!(scan(tree.path()).errors.is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn non_english_comment_is_an_error_with_a_location() {
|
||||
let tree = TempTree::new("lang");
|
||||
tree.write("a.rs", "fn a() {}\n// комментарий\n");
|
||||
let report = scan(tree.path());
|
||||
assert_eq!(report.errors.len(), 1);
|
||||
assert!(report.errors[0].contains("a.rs:2"), "{:?}", report.errors);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn docs_and_target_are_ignored() {
|
||||
let tree = TempTree::new("skip");
|
||||
tree.write("docs/x.rs", &lines(MAX_LINES + 10));
|
||||
tree.write("target/y.rs", &lines(MAX_LINES + 10));
|
||||
assert!(scan(tree.path()).errors.is_empty());
|
||||
}
|
||||
37
tools/limits/tests/tree/mod.rs
Normal file
37
tools/limits/tests/tree/mod.rs
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
//! A temporary directory tree for rule tests.
|
||||
|
||||
#![allow(
|
||||
clippy::unwrap_used,
|
||||
reason = "test helper: a failure should abort the test"
|
||||
)]
|
||||
|
||||
use std::fs;
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
pub struct TempTree(PathBuf);
|
||||
|
||||
impl TempTree {
|
||||
pub fn new(name: &str) -> Self {
|
||||
let root =
|
||||
std::env::temp_dir().join(format!("fabrilis-limits-{}-{name}", std::process::id()));
|
||||
let _ = fs::remove_dir_all(&root);
|
||||
fs::create_dir_all(&root).unwrap();
|
||||
Self(root)
|
||||
}
|
||||
|
||||
pub fn path(&self) -> &Path {
|
||||
&self.0
|
||||
}
|
||||
|
||||
pub fn write(&self, relative: &str, content: &str) {
|
||||
let path = self.0.join(relative);
|
||||
fs::create_dir_all(path.parent().unwrap()).unwrap();
|
||||
fs::write(path, content).unwrap();
|
||||
}
|
||||
}
|
||||
|
||||
impl Drop for TempTree {
|
||||
fn drop(&mut self) {
|
||||
let _ = fs::remove_dir_all(&self.0);
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue