Merge branch 'issues/78-support-sparse-checkout-dirs' into 'master'

Resolve "#PEGE-3141 配置文件支持 sparse-checkout-dirs 字段"

Closes #78

See merge request devtools/mgit!87

Author: 黄顽强

Cargo.toml

@@ -7,7 +7,7 @@ members = [
 resolver = "2"
 
 [workspace.package]
-version = "1.2.2"
+version = "1.2.3"
 edition = "2021"
 rust-version = "1.74.0"
 repository = "https://github.com/funny/mgit"

core/src/core/git.rs

@@ -273,3 +273,20 @@ pub fn log_current(path: impl AsRef<Path>) -> Result<String, anyhow::Error> {
     ];
     exec_cmd(path, "git", &args)
 }
+
+pub fn sparse_checkout_set(
+    path: impl AsRef<Path>,
+    dirs: &Vec<String>,
+) -> Result<(), anyhow::Error> {
+    let mut args = vec!["sparse-checkout", "set", "--no-cone"];
+    for dir in dirs {
+        args.push(dir)
+    }
+
+    exec_cmd(path, "git", &args).map(|_| ())
+}
+
+pub fn sparse_checkout_disable(path: impl AsRef<Path>) -> Result<(), anyhow::Error> {
+    let args = vec!["sparse-checkout", "disable"];
+    exec_cmd(path, "git", &args).map(|_| ())
+}

core/src/core/repo.rs

@@ -22,6 +22,7 @@ pub struct TomlRepo {
     pub branch: Option<String>,
     pub tag: Option<String>,
     pub commit: Option<String>,
+    pub sparse_checkout_dirs: Option<Vec<String>>,
 }
 
 impl RepoId {

core/src/ops/snapshot.rs

@@ -154,6 +154,7 @@ pub fn snapshot_repo(options: SnapshotOptions) -> MgitResult {
                 branch,
                 tag: None,
                 commit,
+                sparse_checkout_dirs: None,
             };
             repos.push(toml_repo);
             logger::info(format!("  + {}", norm_str));

core/src/ops/sync.rs

@@ -365,6 +365,11 @@ fn inner_exec(
             // reset --hard
             exec_reset(input_path, repo_info, progress, ResetType::Hard)
         }
+    }?;
+
+    match repo_info.toml_repo.sparse_checkout_dirs.as_ref() {
+        Some(dirs) => git::sparse_checkout_set(&full_path, dirs),
+        None => git::sparse_checkout_disable(&full_path),
     }
 }
 
@@ -420,7 +425,8 @@ fn exec_reset(
         ResetType::Mixed => "--mixed",
         ResetType::Hard => "--hard",
     };
-    git::reset(full_path, reset_type, remote_ref_str)
+
+    git::reset(&full_path, reset_type, remote_ref_str)
 }
 
 fn exec_stash(

core/tests/common.rs

@@ -22,6 +22,7 @@ pub mod failed_message {
     pub const GIT_FETCH: &str = "git fetch failed";
     pub const GIT_CONFIG: &str = "git config failed";
     pub const GIT_REV_LIST: &str = "git rev-list failed";
+    pub const GIT_SPARSE_CHECKOUT: &str = "git sparse-checkout failed";
 
     pub const WRITE_FILE: &str = "write file failed";
 }

core/tests/sync_test.rs

@@ -1707,3 +1707,96 @@ fn cli_sync_new_remote_url() -> MgitResult<()> {
     std::fs::remove_dir_all(&path).unwrap();
     Ok(())
 }
+
+/// 测试内容：
+///     1、运行命令 mgit sync <path> --no-checkout
+///     2、检查配置的稀疏检出是否和预期匹配
+///     3、根目录是仓库
+///
+/// 测试目录结构:
+///   cli_sync_with_sparse_checkout_dirs(.git)
+///     ├─Doc
+///     ├─img
+///     └─README.md
+#[test]
+fn cli_sync_with_sparse_checkout_dirs() -> MgitResult<()> {
+    let path = env::current_dir()
+        .unwrap()
+        .join("target")
+        .join("tmp")
+        .join("cli_sync_with_sparse_checkout_dirs");
+    let input_path = path.to_str().unwrap();
+
+    let _ = std::fs::remove_dir_all(&path);
+    std::fs::create_dir_all(&path).unwrap();
+
+    let mut toml_string = TomlBuilder::default()
+        .default_branch("develop")
+        .join_repo(".", &CSBOOKS_REPO, Some("master"), None, None)
+        .build();
+    let sparse_checkout_dirs = r#"sparse-checkout-dirs = ["Doc", "/*.md"]"#;
+    toml_string.push_str(sparse_checkout_dirs);
+
+    let config_file = path.join(".gitrepos");
+    std::fs::write(&config_file, toml_string.trim()).expect(failed_message::WRITE_FILE);
+
+    // initialize the repositories tree
+    ops::sync_repo(
+        SyncOptions::new(
+            Some(input_path),
+            None::<PathBuf>,
+            None,
+            None,
+            None,
+            None,
+            Some(true),
+            None,
+            Some(true),
+            None,
+        ),
+        TestProgress,
+    )?;
+
+    // compaire sparse-checkout list
+    if let Ok(output) = exec_cmd(&path, "git", &["sparse-checkout", "list"]) {
+        assert_eq!(output.contains("Doc"), true);
+        assert_eq!(output.contains("img"), false);
+        assert_eq!(output.contains("/*.md"), true);
+
+        assert_eq!(path.join("Doc").exists(), true);
+        assert_eq!(path.join("img").exists(), false);
+        assert_eq!(path.join("README.md").exists(), true);
+    } else {
+        panic!("{}", failed_message::GIT_SPARSE_CHECKOUT);
+    }
+
+    toml_string = toml_string.replace(sparse_checkout_dirs, "");
+    std::fs::write(&config_file, toml_string.trim()).expect(failed_message::WRITE_FILE);
+    // excute sync
+    ops::sync_repo(
+        SyncOptions::new(
+            Some(input_path),
+            None::<PathBuf>,
+            None,
+            None,
+            None,
+            None,
+            None,
+            None,
+            None,
+            Some(true),
+        ),
+        TestProgress,
+    )?;
+
+    // compaire sparse-checkout list
+    let res = exec_cmd(&path, "git", &["sparse-checkout", "list"]);
+    assert!(res.is_err());
+    assert_eq!(path.join("Doc").exists(), true);
+    assert_eq!(path.join("img").exists(), true);
+    assert_eq!(path.join("README.md").exists(), true);
+
+    // clean-up
+    std::fs::remove_dir_all(&path).unwrap();
+    Ok(())
+}