// Copyright 2025 The Jujutsu Authors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // https://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. //! Test that optimized revset evaluates to the same result as the original //! expression. use std::rc::Rc; use itertools::Itertools as _; use jj_lib::backend::CommitId; use jj_lib::commit::Commit; use jj_lib::config::ConfigLayer; use jj_lib::config::ConfigSource; use jj_lib::repo::MutableRepo; use jj_lib::repo::Repo; use jj_lib::revset::ResolvedRevsetExpression; use jj_lib::revset::RevsetExpression; use jj_lib::revset::RevsetFilterPredicate; use jj_lib::rewrite::RebaseOptions; use jj_lib::rewrite::RebasedCommit; use jj_lib::settings::UserSettings; use proptest::prelude::*; use testutils::TestRepo; fn stable_settings() -> UserSettings { let mut config = testutils::base_user_config(); let mut layer = ConfigLayer::empty(ConfigSource::User); layer .set_value("debug.commit-timestamp", "2001-02-03T04:05:06+07:00") .unwrap(); config.add_layer(layer); UserSettings::from_config(config).unwrap() } fn write_new_commit<'a>( repo: &mut MutableRepo, desc: &str, parents: impl IntoIterator, ) -> Commit { let parents = parents.into_iter().map(|c| c.id().clone()).collect(); let tree_id = repo.store().empty_merged_tree_id(); repo.new_commit(parents, tree_id) .set_description(desc) .write() .unwrap() } fn rebase_descendants(repo: &mut MutableRepo) -> Vec { let mut commits = Vec::new(); repo.rebase_descendants_with_options(&RebaseOptions::default(), |_, rebased| match rebased { RebasedCommit::Rewritten(commit) => commits.push(commit), RebasedCommit::Abandoned { .. } => {} }) .unwrap(); commits } /// Strategy to generate arbitrary revset expressions. fn arb_expression( known_commits: Vec, visible_heads: Vec>, ) -> impl Strategy> { // https://proptest-rs.github.io/proptest/proptest/tutorial/recursive.html let max_commits = known_commits.len(); let leaf_expr = prop_oneof![ Just(RevsetExpression::none()), Just(RevsetExpression::all()), Just(RevsetExpression::visible_heads()), Just(RevsetExpression::root()), proptest::sample::subsequence(known_commits, 1..=5.min(max_commits)) .prop_map(RevsetExpression::commits), // Use merges() as a filter that isn't constant. Since we don't have an // optimization rule that rewrites filter predicates, we wouldn't have // to add various filter predicates. Just(RevsetExpression::filter( RevsetFilterPredicate::ParentCount(2..u32::MAX) )), ]; leaf_expr.prop_recursive( 10, // depth 100, // total nodes 2, // unary or binary move |expr| { // This table includes redundant expressions (e.g. parents() and // ancestors()) if they are common, which will probably make them be // more weighted? prop_oneof![ // Ancestors expr.clone().prop_map(|x| x.parents()), expr.clone().prop_map(|x| x.ancestors()), (expr.clone(), 0..5_u64).prop_map(|(x, d)| x.ancestors_range(0..d)), // Descendants expr.clone().prop_map(|x| x.children()), expr.clone().prop_map(|x| x.descendants()), (expr.clone(), 0..5_u64).prop_map(|(x, d)| x.descendants_range(0..d)), // Range (expr.clone(), expr.clone()).prop_map(|(x, y)| x.range(&y)), // DagRange (expr.clone(), expr.clone()).prop_map(|(x, y)| x.dag_range_to(&y)), expr.clone().prop_map(|x| x.connected()), // Reachable (expr.clone(), expr.clone()).prop_map(|(x, y)| x.reachable(&y)), // Heads expr.clone().prop_map(|x| x.heads()), // Roots expr.clone().prop_map(|x| x.roots()), // ForkPoint expr.clone().prop_map(|x| x.fork_point()), // Latest (expr.clone(), 0..5_usize).prop_map(|(x, n)| x.latest(n)), // AtOperation (or WithinVisibility) ( expr.clone(), proptest::sample::select(visible_heads.clone()) ) .prop_map(|(candidates, visible_heads)| Rc::new( RevsetExpression::WithinVisibility { candidates, visible_heads } )), // Coalesce (in binary form) [expr.clone(), expr.clone()].prop_map(|xs| RevsetExpression::coalesce(&xs)), // General set operations expr.clone().prop_map(|x| x.negated()), (expr.clone(), expr.clone()).prop_map(|(x, y)| x.union(&y)), (expr.clone(), expr.clone()).prop_map(|(x, y)| x.intersection(&y)), (expr.clone(), expr.clone()).prop_map(|(x, y)| x.minus(&y)), ] }, ) } fn verify_optimized( repo: &dyn Repo, expression: &Rc, ) -> Result<(), TestCaseError> { let optimized_revset = expression.clone().evaluate(repo).unwrap(); let unoptimized_revset = expression.clone().evaluate_unoptimized(repo).unwrap(); let optimized_ids: Vec<_> = optimized_revset.iter().try_collect().unwrap(); let unoptimized_ids: Vec<_> = unoptimized_revset.iter().try_collect().unwrap(); prop_assert_eq!(optimized_ids, unoptimized_ids); Ok(()) } #[test] fn test_mostly_linear() { let settings = stable_settings(); let test_repo = TestRepo::init_with_settings(&settings); let repo = test_repo.repo; // 8 9 // 6 7 // |/| // 4 5 // 3 | // 1 2 // |/ // 0 let mut tx = repo.start_transaction(); let commit0 = repo.store().root_commit(); let commit1 = write_new_commit(tx.repo_mut(), "1", [&commit0]); let commit2 = write_new_commit(tx.repo_mut(), "2", [&commit0]); let commit3 = write_new_commit(tx.repo_mut(), "3", [&commit1]); let commit4 = write_new_commit(tx.repo_mut(), "4", [&commit3]); let commit5 = write_new_commit(tx.repo_mut(), "5", [&commit2]); let commit6 = write_new_commit(tx.repo_mut(), "6", [&commit4]); let commit7 = write_new_commit(tx.repo_mut(), "7", [&commit4, &commit5]); let commit8 = write_new_commit(tx.repo_mut(), "8", [&commit6]); let commit9 = write_new_commit(tx.repo_mut(), "9", [&commit7]); let commits = vec![ commit0, commit1, commit2, commit3, commit4, commit5, commit6, commit7, commit8, commit9, ]; let repo = tx.commit("a").unwrap(); // Commit ids for reference insta::assert_snapshot!( commits.iter().map(|c| format!("{:<2} {}\n", c.description(), c.id())).join(""), @r" 00000000000000000000 1 b454727d1ac1243807d5 2 efbe8bc183cdad501010 3 668852e79ac986cbb24a 4 e2cfc9485a41e3039864 5 9f4cab37e672b9a20029 6 7433850ea79a09758b78 7 11f067071cc8223b818b 8 480c23000c48225eec16 9 773cad10cdad4b30c9bf "); let commit_ids = commits.iter().map(|c| c.id().clone()).collect_vec(); let visible_heads = vec![ vec![commit_ids[0].clone()], vec![commit_ids[8].clone(), commit_ids[9].clone()], ]; proptest!(|(expression in arb_expression(commit_ids, visible_heads))| { verify_optimized(repo.as_ref(), &expression)?; }); } #[test] fn test_weird_merges() { let settings = stable_settings(); let test_repo = TestRepo::init_with_settings(&settings); let repo = test_repo.repo; // 8 // /|\ // 4 5 6 7 // |X| |/ // 1 2 3 // \|/ // 0 let mut tx = repo.start_transaction(); let commit0 = repo.store().root_commit(); let commit1 = write_new_commit(tx.repo_mut(), "1", [&commit0]); let commit2 = write_new_commit(tx.repo_mut(), "2", [&commit0]); let commit3 = write_new_commit(tx.repo_mut(), "3", [&commit0]); let commit4 = write_new_commit(tx.repo_mut(), "4", [&commit1, &commit2]); let commit5 = write_new_commit(tx.repo_mut(), "5", [&commit1, &commit2]); let commit6 = write_new_commit(tx.repo_mut(), "6", [&commit3]); let commit7 = write_new_commit(tx.repo_mut(), "7", [&commit3]); let commit8 = write_new_commit(tx.repo_mut(), "8", [&commit5, &commit6, &commit7]); let commits = vec![ commit0, commit1, commit2, commit3, commit4, commit5, commit6, commit7, commit8, ]; let repo = tx.commit("a").unwrap(); // Commit ids for reference insta::assert_snapshot!( commits.iter().map(|c| format!("{:<2} {}\n", c.description(), c.id())).join(""), @r" 00000000000000000000 1 b454727d1ac1243807d5 2 efbe8bc183cdad501010 3 8e6b4a4aa763e550916a 4 ff56a4d7893e7c13b323 5 f1fbd424801c4550decb 6 8d3dad20495f63c76f5e 7 116c29c5f0f7d1eef9cb 8 50774213daae44ce0e66 "); let commit_ids = commits.iter().map(|c| c.id().clone()).collect_vec(); let visible_heads = vec![ vec![commit_ids[0].clone()], vec![commit_ids[4].clone(), commit_ids[8].clone()], ]; proptest!(|(expression in arb_expression(commit_ids, visible_heads))| { verify_optimized(repo.as_ref(), &expression)?; }); } #[test] fn test_rewritten() { let settings = stable_settings(); let test_repo = TestRepo::init_with_settings(&settings); let repo = test_repo.repo; // 5 // |\ // 4 | 3 // | |/ // 1 2 // |/ // 0 let mut tx = repo.start_transaction(); let commit0 = repo.store().root_commit(); let commit1 = write_new_commit(tx.repo_mut(), "1", [&commit0]); let commit2 = write_new_commit(tx.repo_mut(), "2", [&commit0]); let commit3 = write_new_commit(tx.repo_mut(), "3", [&commit2]); let commit4 = write_new_commit(tx.repo_mut(), "4", [&commit1]); let commit5 = write_new_commit(tx.repo_mut(), "5", [&commit4, &commit2]); let mut commits = vec![commit0, commit1, commit2, commit3, commit4, commit5]; let repo = tx.commit("a").unwrap(); // Rewrite 2, rebase 3 and 5 let mut tx = repo.start_transaction(); let commit2b = tx .repo_mut() .rewrite_commit(&commits[2]) .set_description("2b") .write() .unwrap(); commits.push(commit2b); commits.extend(rebase_descendants(tx.repo_mut())); let repo = tx.commit("b").unwrap(); // Abandon 4, rebase 5 let mut tx = repo.start_transaction(); tx.repo_mut().record_abandoned_commit(&commits[4]); commits.extend(rebase_descendants(tx.repo_mut())); let repo = tx.commit("c").unwrap(); // Commit ids for reference insta::assert_snapshot!( commits.iter().map(|c| format!("{:<2} {}\n", c.description(), c.id())).join(""), @r" 00000000000000000000 1 b454727d1ac1243807d5 2 efbe8bc183cdad501010 3 bf42a9771bc9322180c3 4 fb270b6eeef978c0a12b 5 479dec6a96f336043233 2b d0d01d78d2d69c0afa23 3 1894713af307b49e5644 5 9c5d36510c963d5a5ca3 5 e8b2f867cecdf8cce16d "); let commit_ids = commits.iter().map(|c| c.id().clone()).collect_vec(); let visible_heads = vec![ vec![commit_ids[0].clone()], vec![commit_ids[3].clone(), commit_ids[5].clone()], vec![commit_ids[7].clone(), commit_ids[8].clone()], vec![commit_ids[7].clone(), commit_ids[9].clone()], ]; proptest!(|(expression in arb_expression(commit_ids, visible_heads))| { verify_optimized(repo.as_ref(), &expression)?; }); }