use super::*;
use mbx_cache_core::{ActionPrediction, CacheFileNode, LocalActionCache};
fn store_object(store: &Path, contents: &[u8]) -> CacheDigest {
let digest = CacheDigest::blake3(contents);
LocalCas::new(store).store_bytes(&digest, contents).unwrap();
digest
}
fn age(store: &Path, digest: &CacheDigest, age: Duration) {
let path = LocalCas::new(store).path_for(digest).unwrap();
let when = SystemTime::now() - age;
let time = filetime::FileTime::from_system_time(when);
filetime::set_file_times(path, time, time).unwrap();
}
fn store_result(store: &Path, name: &str, outputs: &[CacheDigest]) -> CacheDigest {
let directory = CacheDirectory {
directories: Vec::new(),
files: outputs
.iter()
.enumerate()
.map(|(index, digest)| CacheFileNode {
digest: digest.clone(),
executable: false,
mode: 0o644,
name: format!("output-{index}"),
})
.collect(),
symlinks: Vec::new(),
version: 1,
};
let encoded = serde_json::to_vec(&directory).unwrap();
let output_root = store_object(store, &encoded);
let action = store_object(store, name.as_bytes());
LocalActionCache::new(store)
.store(&RemoteActionResult {
version: 1,
action: action.clone(),
metadata: None,
output_root: Some(output_root),
})
.unwrap();
action
}
fn record_build(store: &Path, identity: &str, workspace_root: &Path, actions: &[CacheDigest]) {
record_checkout(
store,
identity,
workspace_root,
&workspace_root.join("target"),
)
.unwrap();
let predictions = actions
.iter()
.enumerate()
.map(|(index, action)| ActionPrediction {
invocation: CacheDigest::blake3(format!("{identity}-{index}").as_bytes()),
action: action.clone(),
adapter: "rustc".into(),
payload: "{}".into(),
})
.collect::<Vec<_>>();
let manifest = serde_json::json!({
"version": 1,
"task": identity,
"predictions": predictions,
});
let path = store
.join("task-manifests")
.join("v1")
.join(format!("{identity}.json"));
crate::util::write_atomic(&path, &serde_json::to_vec(&manifest).unwrap()).unwrap();
}
#[test]
fn reports_an_empty_store() {
let directory = tempfile::tempdir().unwrap();
assert_eq!(stats(directory.path()).unwrap(), StoreStats::default());
}
#[test]
fn lists_largest_entries_in_descending_order() {
let directory = tempfile::tempdir().unwrap();
store_object(directory.path(), b"small");
store_object(directory.path(), b"a much larger object");
let entries = largest(directory.path(), 1).unwrap();
assert_eq!(entries.len(), 1);
assert_eq!(entries[0].kind, "object");
assert_eq!(entries[0].bytes, 20);
}
#[test]
fn verification_reports_a_corrupt_object() {
let directory = tempfile::tempdir().unwrap();
let digest = store_object(directory.path(), b"original");
let path = LocalCas::new(directory.path()).path_for(&digest).unwrap();
std::fs::write(&path, b"corrupt!").unwrap();
let outcome = verify(directory.path()).unwrap();
assert_eq!(outcome.checked_objects, 1);
assert_eq!(outcome.problems, vec![path]);
}
#[test]
fn verification_reports_a_result_whose_objects_are_gone() {
let directory = tempfile::tempdir().unwrap();
let output = store_object(directory.path(), b"output");
let action = store_result(directory.path(), "compile", std::slice::from_ref(&output));
let result_path = LocalActionCache::new(directory.path())
.path_for(&action)
.unwrap();
let cas = LocalCas::new(directory.path());
std::fs::remove_file(cas.path_for(&action).unwrap()).unwrap();
let outcome = verify(directory.path()).unwrap();
assert_eq!(outcome.checked_action_results, 1);
assert!(
outcome.problems.contains(&result_path),
"a result pointing at a missing object is a problem: {:?}",
outcome.problems
);
}
#[test]
fn inspection_ignores_in_progress_staging_paths() {
let directory = tempfile::tempdir().unwrap();
let action = store_result(directory.path(), "compile", &[]);
let cas_path = LocalCas::new(directory.path()).path_for(&action).unwrap();
let result_path = LocalActionCache::new(directory.path())
.path_for(&action)
.unwrap();
let staging_file = tempfile::NamedTempFile::new_in(cas_path.parent().unwrap()).unwrap();
std::fs::write(staging_file.path(), vec![b'x'; 1_024]).unwrap();
let staging_directory = tempfile::tempdir_in(result_path.parent().unwrap()).unwrap();
std::fs::write(
staging_directory.path().join("result.json"),
vec![b'x'; 2_048],
)
.unwrap();
let entries = largest(directory.path(), 10).unwrap();
let outcome = verify(directory.path()).unwrap();
assert_eq!(entries.len(), 3);
assert!(
entries
.iter()
.all(|entry| entry.path != staging_file.path())
);
assert!(
entries
.iter()
.all(|entry| !entry.path.starts_with(staging_directory.path()))
);
assert_eq!(outcome.checked_objects, 2);
assert_eq!(outcome.checked_action_results, 1);
assert!(outcome.problems.is_empty());
}
#[test]
fn attributes_reachable_cache_bytes_to_a_workspace() {
let directory = tempfile::tempdir().unwrap();
let workspace = directory.path().join("workspace");
std::fs::create_dir_all(&workspace).unwrap();
let output = store_object(directory.path(), b"artifact");
let action = store_result(directory.path(), "compile", &[output]);
record_build(directory.path(), &"a".repeat(64), &workspace, &[action]);
let projects = projects(directory.path()).unwrap();
assert_eq!(projects.len(), 1);
assert_eq!(projects[0].workspace_root, workspace);
assert_eq!(projects[0].identities, 1);
assert!(projects[0].action_bytes > 0);
assert!(projects[0].live);
}
#[test]
fn project_usage_excludes_expired_claims() {
let directory = tempfile::tempdir().unwrap();
let workspace = directory.path().join("workspace");
std::fs::create_dir_all(&workspace).unwrap();
let action = store_result(directory.path(), "compile", &[]);
let identity = "a".repeat(64);
record_build(directory.path(), &identity, &workspace, &[action]);
let stale = CheckoutRecord {
version: CHECKOUT_RECORD_VERSION,
workspace_root: workspace.clone(),
target_dir: workspace.join("target"),
updated_secs: SystemTime::now()
.duration_since(UNIX_EPOCH)
.unwrap()
.as_secs()
- CHECKOUT_RETENTION.as_secs()
- 1,
};
crate::util::write_atomic(
&checkout_record_path(directory.path(), &identity, &workspace),
&serde_json::to_vec(&stale).unwrap(),
)
.unwrap();
let projects = projects(directory.path()).unwrap();
assert_eq!(projects.len(), 1);
assert_eq!(projects[0].workspace_root, workspace);
assert_eq!(projects[0].identities, 0);
assert_eq!(projects[0].action_bytes, 0);
assert!(!projects[0].live);
}
#[cfg(unix)]
#[test]
fn project_usage_follows_a_recorded_target_symlink() {
use std::os::unix::fs::symlink;
let directory = tempfile::tempdir().unwrap();
let workspace = directory.path().join("workspace");
let actual_target = directory.path().join("managed-target");
std::fs::create_dir_all(&workspace).unwrap();
std::fs::create_dir_all(&actual_target).unwrap();
std::fs::write(actual_target.join("artifact"), b"compiled").unwrap();
symlink(&actual_target, workspace.join("target")).unwrap();
record_build(directory.path(), &"a".repeat(64), &workspace, &[]);
let projects = projects(directory.path()).unwrap();
assert_eq!(projects[0].target_bytes, 8);
}
#[test]
fn target_sizes_are_cached_by_recorded_path() {
let directory = tempfile::tempdir().unwrap();
let target = directory.path().join("target");
std::fs::create_dir_all(&target).unwrap();
std::fs::write(target.join("artifact"), b"first").unwrap();
let mut cache = BTreeMap::new();
assert_eq!(cached_tree_bytes(&mut cache, &target), 5);
std::fs::write(target.join("artifact"), b"changed after the walk").unwrap();
assert_eq!(cached_tree_bytes(&mut cache, &target), 5);
}
#[test]
fn removes_only_the_requested_workspaces_checkout_claims() {
let directory = tempfile::tempdir().unwrap();
let first = directory.path().join("first");
let second = directory.path().join("second");
std::fs::create_dir_all(&first).unwrap();
std::fs::create_dir_all(&second).unwrap();
record_build(directory.path(), &"a".repeat(64), &first, &[]);
record_build(directory.path(), &"b".repeat(64), &second, &[]);
let outcome = remove_project(directory.path(), &first).unwrap();
assert_eq!(outcome.removed_checkout_records, 1);
let remaining = projects(directory.path()).unwrap();
assert_eq!(remaining.len(), 1);
assert_eq!(remaining[0].workspace_root, second);
}
#[test]
fn counts_objects_and_results() {
let directory = tempfile::tempdir().unwrap();
let store = directory.path();
store_object(store, b"first");
store_object(store, b"second object");
let stats = stats(store).unwrap();
assert_eq!(stats.objects, 2);
assert_eq!(stats.object_bytes, 5 + 13);
assert_eq!(stats.total_bytes(), 18);
}
#[test]
fn keeps_the_store_under_its_budget_evicting_oldest_first() {
let directory = tempfile::tempdir().unwrap();
let store = directory.path();
let old = store_object(store, b"0123456789");
let recent = store_object(store, b"abcdefghij");
age(store, &old, Duration::from_secs(60 * 60));
age(store, &recent, Duration::from_secs(1));
let outcome = gc(store, 10).unwrap();
assert_eq!(outcome.removed_objects, 1);
assert_eq!(outcome.removed_bytes, 10);
assert_eq!(outcome.remaining_bytes, 10);
let cas = LocalCas::new(store);
assert!(cas.find(&old).unwrap().is_none());
assert!(cas.find(&recent).unwrap().is_some());
}
#[test]
fn leaves_a_store_within_budget_alone() {
let directory = tempfile::tempdir().unwrap();
let store = directory.path();
store_object(store, b"kept");
let outcome = gc(store, 1024).unwrap();
assert_eq!(
outcome,
GcOutcome {
remaining_bytes: 4,
..GcOutcome::default()
}
);
assert_eq!(stats(store).unwrap().objects, 1);
}
#[test]
fn dry_run_reports_evictions_without_removing_objects() {
let directory = tempfile::tempdir().unwrap();
let store = directory.path();
let digest = store_object(store, b"kept for now");
let outcome = gc_dry_run(store, 0).unwrap();
assert_eq!(outcome.removed_objects, 1);
assert!(LocalCas::new(store).find(&digest).unwrap().is_some());
}
#[test]
fn a_blocked_unrooted_object_does_not_cost_a_rooted_one() {
let locked = PathBuf::from("locked-unrooted");
let removable = PathBuf::from("removable-unrooted");
let protected = PathBuf::from("rooted");
let objects = [&locked, &removable, &protected]
.into_iter()
.map(|path| Entry {
path: path.clone(),
size: 10,
used: SystemTime::UNIX_EPOCH,
})
.collect::<Vec<_>>();
let rooted = HashSet::from([protected.clone()]);
let mut attempted = Vec::new();
let outcome = evict_objects(&objects, &rooted, 30, 5, |path| {
attempted.push(path.to_path_buf());
Ok(if path == locked {
Removal::Blocked
} else {
Removal::Removed
})
})
.unwrap();
assert_eq!(attempted, vec![locked, removable]);
assert_eq!(
outcome,
ObjectEvictions {
removed_objects: 1,
removed_bytes: 10,
remaining_bytes: 20,
},
"a locked unrooted blob should leave the store over budget before protected objects are evicted"
);
}
#[test]
fn drops_an_action_result_whose_descriptor_blob_is_gone() {
let directory = tempfile::tempdir().unwrap();
let store = directory.path();
let action = store_object(store, b"action key");
let output_root = store_object(store, b"output root blob");
let result = RemoteActionResult {
version: 1,
action: action.clone(),
metadata: None,
output_root: Some(output_root.clone()),
};
let cache = LocalActionCache::new(store);
cache.store(&result).unwrap();
std::fs::remove_file(LocalCas::new(store).find(&action).unwrap().unwrap()).unwrap();
let outcome = gc(store, u64::MAX).unwrap();
assert_eq!(outcome.removed_action_results, 1);
assert!(cache.find(&action).unwrap().is_none());
}
#[test]
fn keeps_an_action_result_whose_blob_is_present_but_corrupt() {
let directory = tempfile::tempdir().unwrap();
let store = directory.path();
let action = store_object(store, b"action key");
LocalActionCache::new(store)
.store(&RemoteActionResult {
version: 1,
action: action.clone(),
metadata: None,
output_root: None,
})
.unwrap();
let path = LocalCas::new(store).path_for(&action).unwrap();
std::fs::write(&path, b"corrupted!").unwrap();
let outcome = gc(store, u64::MAX).unwrap();
assert_eq!(outcome.removed_action_results, 0);
assert!(path.exists());
}
#[test]
fn drops_action_results_left_without_their_objects() {
let directory = tempfile::tempdir().unwrap();
let store = directory.path();
let action = store_object(store, b"action key");
let metadata = store_object(store, b"metadata blob");
let result = RemoteActionResult {
version: 1,
action: action.clone(),
metadata: Some(metadata),
output_root: None,
};
LocalActionCache::new(store).store(&result).unwrap();
let outcome = gc(store, 0).unwrap();
assert!(outcome.removed_objects >= 1);
assert_eq!(outcome.removed_action_results, 1);
assert!(
LocalActionCache::new(store)
.find(&action)
.unwrap()
.is_none()
);
}
#[test]
fn evicts_objects_no_live_checkout_needs_before_older_rooted_ones() {
let directory = tempfile::tempdir().unwrap();
let store = directory.path().join("store");
let live = directory.path().join("live");
let deleted = directory.path().join("deleted");
std::fs::create_dir_all(&live).unwrap();
std::fs::create_dir_all(&deleted).unwrap();
let kept = store_object(&store, b"0123456789");
let dropped = store_object(&store, b"abcdefghij");
record_build(
&store,
&"a".repeat(64),
&live,
&[store_result(
&store,
"live action",
std::slice::from_ref(&kept),
)],
);
record_build(
&store,
&"b".repeat(64),
&deleted,
&[store_result(
&store,
"deleted action",
std::slice::from_ref(&dropped),
)],
);
age(&store, &kept, Duration::from_secs(60 * 60));
age(&store, &dropped, Duration::from_secs(1));
std::fs::remove_dir_all(&deleted).unwrap();
gc(&store, stats(&store).unwrap().total_bytes() - 10).unwrap();
let cas = LocalCas::new(&store);
assert!(
cas.find(&kept).unwrap().is_some(),
"a live checkout still needs this object"
);
assert!(
cas.find(&dropped).unwrap().is_none(),
"nothing that still exists needs this object"
);
}
#[test]
fn keeps_rooting_when_a_sibling_worktree_survives() {
let directory = tempfile::tempdir().unwrap();
let store = directory.path().join("store");
let first = directory.path().join("first");
let second = directory.path().join("second");
std::fs::create_dir_all(&first).unwrap();
std::fs::create_dir_all(&second).unwrap();
let identity = "c".repeat(64);
let shared = store_object(&store, b"shared artifact");
let action = store_result(&store, "shared action", std::slice::from_ref(&shared));
record_build(&store, &identity, &first, std::slice::from_ref(&action));
record_build(&store, &identity, &second, &[action]);
let spare = store_object(&store, b"unrooted spare");
std::fs::remove_dir_all(&second).unwrap();
let outcome = gc(&store, stats(&store).unwrap().total_bytes() - 1).unwrap();
assert_eq!(outcome.removed_checkout_records, 1);
let cas = LocalCas::new(&store);
assert!(cas.find(&shared).unwrap().is_some());
assert!(cas.find(&spare).unwrap().is_none());
}
#[test]
fn roots_objects_nested_in_an_output_tree() {
let directory = tempfile::tempdir().unwrap();
let store = directory.path().join("store");
let checkout = directory.path().join("checkout");
std::fs::create_dir_all(&checkout).unwrap();
let artifact = store_object(&store, b"the compiled artifact");
let action = store_result(&store, "an action", std::slice::from_ref(&artifact));
record_build(&store, &"d".repeat(64), &checkout, &[action]);
let spare = store_object(&store, b"unrooted spare");
gc(&store, stats(&store).unwrap().total_bytes() - 1).unwrap();
let cas = LocalCas::new(&store);
assert!(cas.find(&artifact).unwrap().is_some());
assert!(cas.find(&spare).unwrap().is_none());
}
#[test]
fn treats_a_store_with_no_checkout_records_as_plain_lru() {
let directory = tempfile::tempdir().unwrap();
let store = directory.path();
let old = store_object(store, b"0123456789");
let recent = store_object(store, b"abcdefghij");
age(store, &old, Duration::from_secs(60 * 60));
age(store, &recent, Duration::from_secs(1));
gc(store, 10).unwrap();
let cas = LocalCas::new(store);
assert!(cas.find(&old).unwrap().is_none());
assert!(cas.find(&recent).unwrap().is_some());
}
#[test]
fn drops_checkout_records_whose_worktree_is_gone() {
let directory = tempfile::tempdir().unwrap();
let store = directory.path().join("store");
let gone = directory.path().join("gone");
std::fs::create_dir_all(&gone).unwrap();
record_checkout(&store, &"e".repeat(64), &gone, &gone.join("target")).unwrap();
assert_eq!(stats(&store).unwrap().live_checkouts, 1);
std::fs::remove_dir_all(&gone).unwrap();
let after = stats(&store).unwrap();
assert_eq!(after.stale_checkouts, 1);
assert_eq!(after.live_checkouts, 0);
let outcome = gc(&store, u64::MAX).unwrap();
assert_eq!(outcome.removed_checkout_records, 1);
assert_eq!(stats(&store).unwrap(), StoreStats::default());
}
#[test]
fn keeps_a_checkout_recorded_while_its_worktree_exists() {
let directory = tempfile::tempdir().unwrap();
let store = directory.path().join("store");
let live = directory.path().join("live");
std::fs::create_dir_all(&live).unwrap();
record_checkout(&store, &"f".repeat(64), &live, &live.join("target")).unwrap();
let outcome = gc(&store, u64::MAX).unwrap();
assert_eq!(outcome.removed_checkout_records, 0);
assert_eq!(stats(&store).unwrap().live_checkouts, 1);
}
#[test]
fn forgets_a_claim_no_build_has_renewed() {
let directory = tempfile::tempdir().unwrap();
let store = directory.path().join("store");
let checkout = directory.path().join("checkout");
std::fs::create_dir_all(&checkout).unwrap();
let identity = "2".repeat(64);
let orphan = store_object(&store, b"what that command built");
record_build(
&store,
&identity,
&checkout,
&[store_result(
&store,
"stale action",
std::slice::from_ref(&orphan),
)],
);
let stale = CheckoutRecord {
version: CHECKOUT_RECORD_VERSION,
workspace_root: checkout.clone(),
target_dir: checkout.join("target"),
updated_secs: SystemTime::now()
.duration_since(UNIX_EPOCH)
.unwrap()
.as_secs()
- CHECKOUT_RETENTION.as_secs()
- 1,
};
crate::util::write_atomic(
&checkout_record_path(&store, &identity, &checkout),
&serde_json::to_vec(&stale).unwrap(),
)
.unwrap();
age(&store, &orphan, Duration::from_secs(60 * 60));
assert_eq!(stats(&store).unwrap().stale_checkouts, 1);
gc(&store, stats(&store).unwrap().total_bytes() - 1).unwrap();
assert!(
LocalCas::new(&store).find(&orphan).unwrap().is_none(),
"an expired claim roots nothing"
);
}
#[test]
fn ignores_what_it_did_not_write_beside_the_checkout_records() {
let directory = tempfile::tempdir().unwrap();
let store = directory.path().join("store");
let checkout = directory.path().join("project");
std::fs::create_dir_all(&checkout).unwrap();
record_checkout(&store, &"3".repeat(64), &checkout, &checkout.join("target")).unwrap();
let intruder = store.join(CHECKOUTS_DIR).join("4".repeat(64));
std::fs::write(&intruder, b"not a directory of records").unwrap();
std::fs::write(store.join(CHECKOUTS_DIR).join("notes.txt"), b"nor this").unwrap();
assert_eq!(stats(&store).unwrap().live_checkouts, 1);
assert_eq!(gc(&store, u64::MAX).unwrap().removed_checkout_records, 0);
assert!(intruder.exists(), "and nothing of theirs is deleted either");
}
#[test]
fn keeps_a_checkout_whose_absence_it_cannot_corroborate() {
let directory = tempfile::tempdir().unwrap();
let parent = directory.path().join("worktrees");
std::fs::create_dir_all(&parent).unwrap();
assert!(!checkout_is_live(&parent.join("removed")));
assert!(checkout_is_live(
&directory.path().join("gone/deeper/still")
));
assert!(checkout_is_live(directory.path()));
}
#[test]
fn sweeps_only_once_within_the_interval() {
let directory = tempfile::tempdir().unwrap();
let store = directory.path();
store_object(store, b"kept");
assert!(
sweep_if_due(store, u64::MAX, Duration::from_secs(3600))
.unwrap()
.is_some()
);
assert!(
sweep_if_due(store, u64::MAX, Duration::from_secs(3600))
.unwrap()
.is_none(),
"the interval has not passed"
);
assert!(
sweep_if_due(store, u64::MAX, Duration::ZERO)
.unwrap()
.is_some(),
"a zero interval always sweeps"
);
}
#[test]
fn concurrent_callers_claim_only_one_sweep() {
let directory = tempfile::tempdir().unwrap();
let store = std::sync::Arc::new(directory.path().to_path_buf());
let barrier = std::sync::Arc::new(std::sync::Barrier::new(8));
let callers = (0..8)
.map(|_| {
let store = store.clone();
let barrier = barrier.clone();
std::thread::spawn(move || {
barrier.wait();
claim_sweep(&store, Duration::from_secs(3600)).unwrap()
})
})
.collect::<Vec<_>>();
let claimed = callers
.into_iter()
.map(|caller| caller.join().unwrap())
.filter(|claimed| *claimed)
.count();
assert_eq!(claimed, 1);
}
#[test]
fn does_not_count_its_own_bookkeeping_against_the_budget() {
let directory = tempfile::tempdir().unwrap();
let store = directory.path().join("store");
let checkout = directory.path().join("checkout");
std::fs::create_dir_all(&checkout).unwrap();
record_checkout(&store, &"1".repeat(64), &checkout, &checkout.join("target")).unwrap();
sweep_if_due(&store, u64::MAX, Duration::ZERO).unwrap();
assert_eq!(stats(&store).unwrap().total_bytes(), 0);
}