두 번째 commit. 사용자 facing surface (CLI binary, env vars, XDG paths) + 코드 안 single-letter token (`KB_`, `kb.sqlite`, `/kb/`, tracing target) 일괄 rename. 그리고 3 개 file rename: - 디자인 doc `2026-04-27-kb-final-form-design.md` → `2026-04-27-kebab-final-form-design.md` - 최초 보고서 `kb_local_rust_report.md` → `kebab_local_rust_report.md` - workspace ignore `.kbignore` → `.kebabignore` ## 변경 - `crates/kebab-cli/Cargo.toml`: `[[bin]] name = "kb"` → `"kebab"`. - `crates/kebab-cli/src/main.rs`: `#[command(name = "kb", …)]` → `name = "kebab"`. - 모든 `KB_*` env var (코드 + doc + 테스트) → `KEBAB_*`. apply_env prefix 매칭 + 30+ 개 setting 키 모두. - XDG paths: `~/.config/kb` / `~/.local/share/kb` / `~/.cache/kb` / `~/.local/state/kb` → `~/.config/kebab` 등. config defaults + expand_path tests + paths.rs 의 hardcode 모두. - SQLite filename: `kb.sqlite` → `kebab.sqlite` (`SQLITE_FILE` const + 테스트 hardcode 모두). - tracing target: `target: "kb-*"` → `"kebab-*"` (10+ 곳). - snapshot fixture: `.kbignore` → `.kebabignore` (`fixtures/source-fs/ tree-1.snapshot.json` 갱신). ## 검증 - `cargo test --workspace -j 1` clean (linker OOM 회피 위해 직렬). - `cargo clippy --workspace --all-targets -- -D warnings` clean. 다음 commit 에서 docs sweep. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
140 lines
5.0 KiB
Rust
140 lines
5.0 KiB
Rust
//! Snapshot + determinism tests against `fixtures/source-fs/tree-1`.
|
|
//!
|
|
//! Layout (committed under `<repo>/fixtures/source-fs/tree-1/`):
|
|
//!
|
|
//! ```
|
|
//! tree-1/
|
|
//! ├── README.md
|
|
//! ├── notes/
|
|
//! │ ├── alpha.md
|
|
//! │ └── beta.md
|
|
//! ├── ignored/
|
|
//! │ └── skip.tmp # excluded by .kebabignore
|
|
//! ├── .kebabignore # contains: *.tmp
|
|
//! └── .DS_Store # implicitly excluded
|
|
//! ```
|
|
//!
|
|
//! Two assertions:
|
|
//! 1. Snapshot stability — `scan` output (with `discovered_at` stripped)
|
|
//! matches the committed baseline JSON byte-for-byte.
|
|
//! 2. Determinism — running `scan` twice produces byte-identical JSON
|
|
//! after stripping `discovered_at`.
|
|
//!
|
|
//! `discovered_at` is wall-clock and intentionally NOT part of the
|
|
//! contract: the task spec says strip it before comparison.
|
|
|
|
use std::path::PathBuf;
|
|
|
|
use kebab_config::Config;
|
|
use kebab_core::{SourceConnector, SourceScope};
|
|
use kebab_source_fs::FsSourceConnector;
|
|
use serde_json::Value;
|
|
|
|
/// Repo root, derived from `CARGO_MANIFEST_DIR` (= `crates/kb-source-fs`).
|
|
fn repo_root() -> PathBuf {
|
|
PathBuf::from(env!("CARGO_MANIFEST_DIR"))
|
|
.parent()
|
|
.unwrap()
|
|
.parent()
|
|
.unwrap()
|
|
.to_path_buf()
|
|
}
|
|
|
|
fn fixture_root() -> PathBuf {
|
|
repo_root().join("fixtures/source-fs/tree-1")
|
|
}
|
|
|
|
fn baseline_path() -> PathBuf {
|
|
repo_root().join("fixtures/source-fs/tree-1.snapshot.json")
|
|
}
|
|
|
|
fn cfg_for_fixture(root: &str) -> Config {
|
|
let mut c = Config::defaults();
|
|
c.workspace.root = root.to_string();
|
|
// Clear default excludes (`.git/**`, `node_modules/**`, `.obsidian/**`)
|
|
// so the snapshot is purely a function of the fixture + .kebabignore +
|
|
// baked-in default-excludes.
|
|
c.workspace.exclude.clear();
|
|
c
|
|
}
|
|
|
|
/// Run `scan` against the fixture and return the JSON value with every
|
|
/// `discovered_at` field replaced by the literal string "<stripped>".
|
|
/// Also strip `source_uri.value` and `stored.path` because they contain
|
|
/// absolute paths that vary by checkout location — the snapshot must be
|
|
/// portable across machines and CI checkout dirs.
|
|
fn scan_and_strip() -> Value {
|
|
let root = fixture_root();
|
|
let cfg = cfg_for_fixture(root.to_str().unwrap());
|
|
let conn = FsSourceConnector::new(&cfg).expect("connector init");
|
|
let assets = conn
|
|
.scan(&SourceScope::default())
|
|
.expect("scan must succeed against committed fixture");
|
|
|
|
let mut v = serde_json::to_value(&assets).expect("serialize");
|
|
if let Value::Array(items) = &mut v {
|
|
for item in items {
|
|
if let Value::Object(map) = item {
|
|
map.insert(
|
|
"discovered_at".to_string(),
|
|
Value::String("<stripped>".to_string()),
|
|
);
|
|
// source_uri = { kind: "file", value: "<abs>" } — strip value.
|
|
if let Some(Value::Object(s)) = map.get_mut("source_uri") {
|
|
if s.contains_key("value") {
|
|
s.insert("value".to_string(), Value::String("<stripped>".to_string()));
|
|
}
|
|
}
|
|
// stored = { kind: "copied"|"reference", path: "<abs>", ... } — strip path.
|
|
if let Some(Value::Object(s)) = map.get_mut("stored") {
|
|
if s.contains_key("path") {
|
|
s.insert("path".to_string(), Value::String("<stripped>".to_string()));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
v
|
|
}
|
|
|
|
#[test]
|
|
fn tree_1_snapshot_matches_baseline() {
|
|
let actual = scan_and_strip();
|
|
|
|
// If KEBAB_REGEN_SNAPSHOT is set, (re)write the baseline and exit
|
|
// *before* attempting to read it. This is the only path that may
|
|
// create the file from scratch.
|
|
if std::env::var_os("KEBAB_REGEN_SNAPSHOT").is_some() {
|
|
let pretty = serde_json::to_string_pretty(&actual).unwrap() + "\n";
|
|
std::fs::write(baseline_path(), pretty).expect("write baseline");
|
|
panic!("regenerated baseline; rerun without KEBAB_REGEN_SNAPSHOT to verify");
|
|
}
|
|
|
|
let baseline_text = std::fs::read_to_string(baseline_path()).unwrap_or_else(|_| {
|
|
panic!(
|
|
"missing baseline at {} — regenerate via `KEBAB_REGEN_SNAPSHOT=1 cargo test \
|
|
-p kb-source-fs --test snapshot_tree1 -- tree_1_snapshot_matches_baseline`",
|
|
baseline_path().display()
|
|
)
|
|
});
|
|
let expected: Value = serde_json::from_str(&baseline_text)
|
|
.expect("baseline JSON must parse");
|
|
|
|
if actual != expected {
|
|
let actual_pretty = serde_json::to_string_pretty(&actual).unwrap();
|
|
let expected_pretty = serde_json::to_string_pretty(&expected).unwrap();
|
|
panic!(
|
|
"snapshot drift.\n--- expected ---\n{expected_pretty}\n--- actual ---\n{actual_pretty}\n"
|
|
);
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn tree_1_scan_is_deterministic() {
|
|
let v1 = scan_and_strip();
|
|
let v2 = scan_and_strip();
|
|
let s1 = serde_json::to_string(&v1).unwrap();
|
|
let s2 = serde_json::to_string(&v2).unwrap();
|
|
assert_eq!(s1, s2, "two consecutive scans diverged");
|
|
}
|