1use crate::{FakeFs, FakeFsEntry, Fs};
2use anyhow::{Context as _, Result, bail};
3use collections::{HashMap, HashSet};
4use futures::future::{self, BoxFuture, join_all};
5use git::{
6 Oid, RunHook,
7 blame::Blame,
8 repository::{
9 AskPassDelegate, Branch, CommitDetails, CommitOptions, FetchOptions, GitRepository,
10 GitRepositoryCheckpoint, PushOptions, Remote, RepoPath, ResetMode, Worktree,
11 },
12 status::{
13 DiffTreeType, FileStatus, GitStatus, StatusCode, TrackedStatus, TreeDiff, TreeDiffStatus,
14 UnmergedStatus,
15 },
16};
17use gpui::{AsyncApp, BackgroundExecutor, SharedString, Task, TaskLabel};
18use ignore::gitignore::GitignoreBuilder;
19use parking_lot::Mutex;
20use rope::Rope;
21use smol::future::FutureExt as _;
22use std::{
23 path::PathBuf,
24 sync::{Arc, LazyLock},
25};
26use util::{paths::PathStyle, rel_path::RelPath};
27
28pub static LOAD_INDEX_TEXT_TASK: LazyLock<TaskLabel> = LazyLock::new(TaskLabel::new);
29pub static LOAD_HEAD_TEXT_TASK: LazyLock<TaskLabel> = LazyLock::new(TaskLabel::new);
30
31#[derive(Clone)]
32pub struct FakeGitRepository {
33 pub(crate) fs: Arc<FakeFs>,
34 pub(crate) checkpoints: Arc<Mutex<HashMap<Oid, FakeFsEntry>>>,
35 pub(crate) executor: BackgroundExecutor,
36 pub(crate) dot_git_path: PathBuf,
37 pub(crate) repository_dir_path: PathBuf,
38 pub(crate) common_dir_path: PathBuf,
39}
40
41#[derive(Debug, Clone)]
42pub struct FakeGitRepositoryState {
43 pub event_emitter: smol::channel::Sender<PathBuf>,
44 pub unmerged_paths: HashMap<RepoPath, UnmergedStatus>,
45 pub head_contents: HashMap<RepoPath, String>,
46 pub index_contents: HashMap<RepoPath, String>,
47 // everything in commit contents is in oids
48 pub merge_base_contents: HashMap<RepoPath, Oid>,
49 pub oids: HashMap<Oid, String>,
50 pub blames: HashMap<RepoPath, Blame>,
51 pub current_branch_name: Option<String>,
52 pub branches: HashSet<String>,
53 pub simulated_index_write_error_message: Option<String>,
54 pub refs: HashMap<String, String>,
55}
56
57impl FakeGitRepositoryState {
58 pub fn new(event_emitter: smol::channel::Sender<PathBuf>) -> Self {
59 FakeGitRepositoryState {
60 event_emitter,
61 head_contents: Default::default(),
62 index_contents: Default::default(),
63 unmerged_paths: Default::default(),
64 blames: Default::default(),
65 current_branch_name: Default::default(),
66 branches: Default::default(),
67 simulated_index_write_error_message: Default::default(),
68 refs: HashMap::from_iter([("HEAD".into(), "abc".into())]),
69 merge_base_contents: Default::default(),
70 oids: Default::default(),
71 }
72 }
73}
74
75impl FakeGitRepository {
76 fn with_state_async<F, T>(&self, write: bool, f: F) -> BoxFuture<'static, Result<T>>
77 where
78 F: 'static + Send + FnOnce(&mut FakeGitRepositoryState) -> Result<T>,
79 T: Send,
80 {
81 let fs = self.fs.clone();
82 let executor = self.executor.clone();
83 let dot_git_path = self.dot_git_path.clone();
84 async move {
85 executor.simulate_random_delay().await;
86 fs.with_git_state(&dot_git_path, write, f)?
87 }
88 .boxed()
89 }
90}
91
92impl GitRepository for FakeGitRepository {
93 fn reload_index(&self) {}
94
95 fn load_index_text(&self, path: RepoPath) -> BoxFuture<'_, Option<String>> {
96 let fut = self.with_state_async(false, move |state| {
97 state
98 .index_contents
99 .get(&path)
100 .context("not present in index")
101 .cloned()
102 });
103 self.executor
104 .spawn_labeled(*LOAD_INDEX_TEXT_TASK, async move { fut.await.ok() })
105 .boxed()
106 }
107
108 fn load_committed_text(&self, path: RepoPath) -> BoxFuture<'_, Option<String>> {
109 let fut = self.with_state_async(false, move |state| {
110 state
111 .head_contents
112 .get(&path)
113 .context("not present in HEAD")
114 .cloned()
115 });
116 self.executor
117 .spawn_labeled(*LOAD_HEAD_TEXT_TASK, async move { fut.await.ok() })
118 .boxed()
119 }
120
121 fn load_blob_content(&self, oid: git::Oid) -> BoxFuture<'_, Result<String>> {
122 self.with_state_async(false, move |state| {
123 state.oids.get(&oid).cloned().context("oid does not exist")
124 })
125 .boxed()
126 }
127
128 fn load_commit(
129 &self,
130 _commit: String,
131 _cx: AsyncApp,
132 ) -> BoxFuture<'_, Result<git::repository::CommitDiff>> {
133 unimplemented!()
134 }
135
136 fn set_index_text(
137 &self,
138 path: RepoPath,
139 content: Option<String>,
140 _env: Arc<HashMap<String, String>>,
141 _is_executable: bool,
142 ) -> BoxFuture<'_, anyhow::Result<()>> {
143 self.with_state_async(true, move |state| {
144 if let Some(message) = &state.simulated_index_write_error_message {
145 anyhow::bail!("{message}");
146 } else if let Some(content) = content {
147 state.index_contents.insert(path, content);
148 } else {
149 state.index_contents.remove(&path);
150 }
151 Ok(())
152 })
153 }
154
155 fn remote_url(&self, _name: &str) -> Option<String> {
156 None
157 }
158
159 fn diff_tree(&self, _request: DiffTreeType) -> BoxFuture<'_, Result<TreeDiff>> {
160 let mut entries = HashMap::default();
161 self.with_state_async(false, |state| {
162 for (path, content) in &state.head_contents {
163 let status = if let Some((oid, original)) = state
164 .merge_base_contents
165 .get(path)
166 .map(|oid| (oid, &state.oids[oid]))
167 {
168 if original == content {
169 continue;
170 }
171 TreeDiffStatus::Modified { old: *oid }
172 } else {
173 TreeDiffStatus::Added
174 };
175 entries.insert(path.clone(), status);
176 }
177 for (path, oid) in &state.merge_base_contents {
178 if !entries.contains_key(path) {
179 entries.insert(path.clone(), TreeDiffStatus::Deleted { old: *oid });
180 }
181 }
182 Ok(TreeDiff { entries })
183 })
184 .boxed()
185 }
186
187 fn revparse_batch(&self, revs: Vec<String>) -> BoxFuture<'_, Result<Vec<Option<String>>>> {
188 self.with_state_async(false, |state| {
189 Ok(revs
190 .into_iter()
191 .map(|rev| state.refs.get(&rev).cloned())
192 .collect())
193 })
194 }
195
196 fn show(&self, commit: String) -> BoxFuture<'_, Result<CommitDetails>> {
197 async {
198 Ok(CommitDetails {
199 sha: commit.into(),
200 ..Default::default()
201 })
202 }
203 .boxed()
204 }
205
206 fn reset(
207 &self,
208 _commit: String,
209 _mode: ResetMode,
210 _env: Arc<HashMap<String, String>>,
211 ) -> BoxFuture<'_, Result<()>> {
212 unimplemented!()
213 }
214
215 fn checkout_files(
216 &self,
217 _commit: String,
218 _paths: Vec<RepoPath>,
219 _env: Arc<HashMap<String, String>>,
220 ) -> BoxFuture<'_, Result<()>> {
221 unimplemented!()
222 }
223
224 fn path(&self) -> PathBuf {
225 self.repository_dir_path.clone()
226 }
227
228 fn main_repository_path(&self) -> PathBuf {
229 self.common_dir_path.clone()
230 }
231
232 fn merge_message(&self) -> BoxFuture<'_, Option<String>> {
233 async move { None }.boxed()
234 }
235
236 fn status(&self, path_prefixes: &[RepoPath]) -> Task<Result<GitStatus>> {
237 let workdir_path = self.dot_git_path.parent().unwrap();
238
239 // Load gitignores
240 let ignores = workdir_path
241 .ancestors()
242 .filter_map(|dir| {
243 let ignore_path = dir.join(".gitignore");
244 let content = self.fs.read_file_sync(ignore_path).ok()?;
245 let content = String::from_utf8(content).ok()?;
246 let mut builder = GitignoreBuilder::new(dir);
247 for line in content.lines() {
248 builder.add_line(Some(dir.into()), line).ok()?;
249 }
250 builder.build().ok()
251 })
252 .collect::<Vec<_>>();
253
254 // Load working copy files.
255 let git_files: HashMap<RepoPath, (String, bool)> = self
256 .fs
257 .files()
258 .iter()
259 .filter_map(|path| {
260 // TODO better simulate git status output in the case of submodules and worktrees
261 let repo_path = path.strip_prefix(workdir_path).ok()?;
262 let mut is_ignored = repo_path.starts_with(".git");
263 for ignore in &ignores {
264 match ignore.matched_path_or_any_parents(path, false) {
265 ignore::Match::None => {}
266 ignore::Match::Ignore(_) => is_ignored = true,
267 ignore::Match::Whitelist(_) => break,
268 }
269 }
270 let content = self
271 .fs
272 .read_file_sync(path)
273 .ok()
274 .map(|content| String::from_utf8(content).unwrap())?;
275 let repo_path = RelPath::new(repo_path, PathStyle::local()).ok()?;
276 Some((RepoPath::from_rel_path(&repo_path), (content, is_ignored)))
277 })
278 .collect();
279
280 let result = self.fs.with_git_state(&self.dot_git_path, false, |state| {
281 let mut entries = Vec::new();
282 let paths = state
283 .head_contents
284 .keys()
285 .chain(state.index_contents.keys())
286 .chain(git_files.keys())
287 .collect::<HashSet<_>>();
288 for path in paths {
289 if !path_prefixes.iter().any(|prefix| path.starts_with(prefix)) {
290 continue;
291 }
292
293 let head = state.head_contents.get(path);
294 let index = state.index_contents.get(path);
295 let unmerged = state.unmerged_paths.get(path);
296 let fs = git_files.get(path);
297 let status = match (unmerged, head, index, fs) {
298 (Some(unmerged), _, _, _) => FileStatus::Unmerged(*unmerged),
299 (_, Some(head), Some(index), Some((fs, _))) => {
300 FileStatus::Tracked(TrackedStatus {
301 index_status: if head == index {
302 StatusCode::Unmodified
303 } else {
304 StatusCode::Modified
305 },
306 worktree_status: if fs == index {
307 StatusCode::Unmodified
308 } else {
309 StatusCode::Modified
310 },
311 })
312 }
313 (_, Some(head), Some(index), None) => FileStatus::Tracked(TrackedStatus {
314 index_status: if head == index {
315 StatusCode::Unmodified
316 } else {
317 StatusCode::Modified
318 },
319 worktree_status: StatusCode::Deleted,
320 }),
321 (_, Some(_), None, Some(_)) => FileStatus::Tracked(TrackedStatus {
322 index_status: StatusCode::Deleted,
323 worktree_status: StatusCode::Added,
324 }),
325 (_, Some(_), None, None) => FileStatus::Tracked(TrackedStatus {
326 index_status: StatusCode::Deleted,
327 worktree_status: StatusCode::Deleted,
328 }),
329 (_, None, Some(index), Some((fs, _))) => FileStatus::Tracked(TrackedStatus {
330 index_status: StatusCode::Added,
331 worktree_status: if fs == index {
332 StatusCode::Unmodified
333 } else {
334 StatusCode::Modified
335 },
336 }),
337 (_, None, Some(_), None) => FileStatus::Tracked(TrackedStatus {
338 index_status: StatusCode::Added,
339 worktree_status: StatusCode::Deleted,
340 }),
341 (_, None, None, Some((_, is_ignored))) => {
342 if *is_ignored {
343 continue;
344 }
345 FileStatus::Untracked
346 }
347 (_, None, None, None) => {
348 unreachable!();
349 }
350 };
351 if status
352 != FileStatus::Tracked(TrackedStatus {
353 index_status: StatusCode::Unmodified,
354 worktree_status: StatusCode::Unmodified,
355 })
356 {
357 entries.push((path.clone(), status));
358 }
359 }
360 entries.sort_by(|a, b| a.0.cmp(&b.0));
361 anyhow::Ok(GitStatus {
362 entries: entries.into(),
363 })
364 });
365 Task::ready(match result {
366 Ok(result) => result,
367 Err(e) => Err(e),
368 })
369 }
370
371 fn stash_entries(&self) -> BoxFuture<'_, Result<git::stash::GitStash>> {
372 async { Ok(git::stash::GitStash::default()) }.boxed()
373 }
374
375 fn branches(&self) -> BoxFuture<'_, Result<Vec<Branch>>> {
376 self.with_state_async(false, move |state| {
377 let current_branch = &state.current_branch_name;
378 Ok(state
379 .branches
380 .iter()
381 .map(|branch_name| Branch {
382 is_head: Some(branch_name) == current_branch.as_ref(),
383 ref_name: branch_name.into(),
384 most_recent_commit: None,
385 upstream: None,
386 })
387 .collect())
388 })
389 }
390
391 fn worktrees(&self) -> BoxFuture<'_, Result<Vec<Worktree>>> {
392 unimplemented!()
393 }
394
395 fn create_worktree(
396 &self,
397 _: String,
398 _: PathBuf,
399 _: Option<String>,
400 ) -> BoxFuture<'_, Result<()>> {
401 unimplemented!()
402 }
403
404 fn change_branch(&self, name: String) -> BoxFuture<'_, Result<()>> {
405 self.with_state_async(true, |state| {
406 state.current_branch_name = Some(name);
407 Ok(())
408 })
409 }
410
411 fn create_branch(
412 &self,
413 name: String,
414 _base_branch: Option<String>,
415 ) -> BoxFuture<'_, Result<()>> {
416 self.with_state_async(true, move |state| {
417 state.branches.insert(name);
418 Ok(())
419 })
420 }
421
422 fn rename_branch(&self, branch: String, new_name: String) -> BoxFuture<'_, Result<()>> {
423 self.with_state_async(true, move |state| {
424 if !state.branches.remove(&branch) {
425 bail!("no such branch: {branch}");
426 }
427 state.branches.insert(new_name.clone());
428 if state.current_branch_name == Some(branch) {
429 state.current_branch_name = Some(new_name);
430 }
431 Ok(())
432 })
433 }
434
435 fn delete_branch(&self, _name: String) -> BoxFuture<'_, Result<()>> {
436 unimplemented!()
437 }
438
439 fn blame(&self, path: RepoPath, _content: Rope) -> BoxFuture<'_, Result<git::blame::Blame>> {
440 self.with_state_async(false, move |state| {
441 state
442 .blames
443 .get(&path)
444 .with_context(|| format!("failed to get blame for {:?}", path))
445 .cloned()
446 })
447 }
448
449 fn stage_paths(
450 &self,
451 paths: Vec<RepoPath>,
452 _env: Arc<HashMap<String, String>>,
453 ) -> BoxFuture<'_, Result<()>> {
454 Box::pin(async move {
455 let contents = paths
456 .into_iter()
457 .map(|path| {
458 let abs_path = self
459 .dot_git_path
460 .parent()
461 .unwrap()
462 .join(&path.as_std_path());
463 Box::pin(async move { (path.clone(), self.fs.load(&abs_path).await.ok()) })
464 })
465 .collect::<Vec<_>>();
466 let contents = join_all(contents).await;
467 self.with_state_async(true, move |state| {
468 for (path, content) in contents {
469 if let Some(content) = content {
470 state.index_contents.insert(path, content);
471 } else {
472 state.index_contents.remove(&path);
473 }
474 }
475 Ok(())
476 })
477 .await
478 })
479 }
480
481 fn unstage_paths(
482 &self,
483 paths: Vec<RepoPath>,
484 _env: Arc<HashMap<String, String>>,
485 ) -> BoxFuture<'_, Result<()>> {
486 self.with_state_async(true, move |state| {
487 for path in paths {
488 match state.head_contents.get(&path) {
489 Some(content) => state.index_contents.insert(path, content.clone()),
490 None => state.index_contents.remove(&path),
491 };
492 }
493 Ok(())
494 })
495 }
496
497 fn stash_paths(
498 &self,
499 _paths: Vec<RepoPath>,
500 _env: Arc<HashMap<String, String>>,
501 ) -> BoxFuture<'_, Result<()>> {
502 unimplemented!()
503 }
504
505 fn stash_pop(
506 &self,
507 _index: Option<usize>,
508 _env: Arc<HashMap<String, String>>,
509 ) -> BoxFuture<'_, Result<()>> {
510 unimplemented!()
511 }
512
513 fn stash_apply(
514 &self,
515 _index: Option<usize>,
516 _env: Arc<HashMap<String, String>>,
517 ) -> BoxFuture<'_, Result<()>> {
518 unimplemented!()
519 }
520
521 fn stash_drop(
522 &self,
523 _index: Option<usize>,
524 _env: Arc<HashMap<String, String>>,
525 ) -> BoxFuture<'_, Result<()>> {
526 unimplemented!()
527 }
528
529 fn commit(
530 &self,
531 _message: gpui::SharedString,
532 _name_and_email: Option<(gpui::SharedString, gpui::SharedString)>,
533 _options: CommitOptions,
534 _askpass: AskPassDelegate,
535 _env: Arc<HashMap<String, String>>,
536 ) -> BoxFuture<'_, Result<()>> {
537 unimplemented!()
538 }
539
540 fn run_hook(
541 &self,
542 _hook: RunHook,
543 _env: Arc<HashMap<String, String>>,
544 ) -> BoxFuture<'_, Result<()>> {
545 unimplemented!()
546 }
547
548 fn push(
549 &self,
550 _branch: String,
551 _remote: String,
552 _options: Option<PushOptions>,
553 _askpass: AskPassDelegate,
554 _env: Arc<HashMap<String, String>>,
555 _cx: AsyncApp,
556 ) -> BoxFuture<'_, Result<git::repository::RemoteCommandOutput>> {
557 unimplemented!()
558 }
559
560 fn pull(
561 &self,
562 _branch: Option<String>,
563 _remote: String,
564 _rebase: bool,
565 _askpass: AskPassDelegate,
566 _env: Arc<HashMap<String, String>>,
567 _cx: AsyncApp,
568 ) -> BoxFuture<'_, Result<git::repository::RemoteCommandOutput>> {
569 unimplemented!()
570 }
571
572 fn fetch(
573 &self,
574 _fetch_options: FetchOptions,
575 _askpass: AskPassDelegate,
576 _env: Arc<HashMap<String, String>>,
577 _cx: AsyncApp,
578 ) -> BoxFuture<'_, Result<git::repository::RemoteCommandOutput>> {
579 unimplemented!()
580 }
581
582 fn get_push_remote(&self, _branch: String) -> BoxFuture<'_, Result<Option<Remote>>> {
583 unimplemented!()
584 }
585
586 fn get_branch_remote(&self, _branch: String) -> BoxFuture<'_, Result<Option<Remote>>> {
587 unimplemented!()
588 }
589
590 fn get_all_remotes(&self) -> BoxFuture<'_, Result<Vec<Remote>>> {
591 unimplemented!()
592 }
593
594 fn check_for_pushed_commit(&self) -> BoxFuture<'_, Result<Vec<gpui::SharedString>>> {
595 future::ready(Ok(Vec::new())).boxed()
596 }
597
598 fn diff(&self, _diff: git::repository::DiffType) -> BoxFuture<'_, Result<String>> {
599 unimplemented!()
600 }
601
602 fn checkpoint(&self) -> BoxFuture<'static, Result<GitRepositoryCheckpoint>> {
603 let executor = self.executor.clone();
604 let fs = self.fs.clone();
605 let checkpoints = self.checkpoints.clone();
606 let repository_dir_path = self.repository_dir_path.parent().unwrap().to_path_buf();
607 async move {
608 executor.simulate_random_delay().await;
609 let oid = git::Oid::random(&mut executor.rng());
610 let entry = fs.entry(&repository_dir_path)?;
611 checkpoints.lock().insert(oid, entry);
612 Ok(GitRepositoryCheckpoint { commit_sha: oid })
613 }
614 .boxed()
615 }
616
617 fn restore_checkpoint(&self, checkpoint: GitRepositoryCheckpoint) -> BoxFuture<'_, Result<()>> {
618 let executor = self.executor.clone();
619 let fs = self.fs.clone();
620 let checkpoints = self.checkpoints.clone();
621 let repository_dir_path = self.repository_dir_path.parent().unwrap().to_path_buf();
622 async move {
623 executor.simulate_random_delay().await;
624 let checkpoints = checkpoints.lock();
625 let entry = checkpoints
626 .get(&checkpoint.commit_sha)
627 .context(format!("invalid checkpoint: {}", checkpoint.commit_sha))?;
628 fs.insert_entry(&repository_dir_path, entry.clone())?;
629 Ok(())
630 }
631 .boxed()
632 }
633
634 fn compare_checkpoints(
635 &self,
636 left: GitRepositoryCheckpoint,
637 right: GitRepositoryCheckpoint,
638 ) -> BoxFuture<'_, Result<bool>> {
639 let executor = self.executor.clone();
640 let checkpoints = self.checkpoints.clone();
641 async move {
642 executor.simulate_random_delay().await;
643 let checkpoints = checkpoints.lock();
644 let left = checkpoints
645 .get(&left.commit_sha)
646 .context(format!("invalid left checkpoint: {}", left.commit_sha))?;
647 let right = checkpoints
648 .get(&right.commit_sha)
649 .context(format!("invalid right checkpoint: {}", right.commit_sha))?;
650
651 Ok(left == right)
652 }
653 .boxed()
654 }
655
656 fn diff_checkpoints(
657 &self,
658 _base_checkpoint: GitRepositoryCheckpoint,
659 _target_checkpoint: GitRepositoryCheckpoint,
660 ) -> BoxFuture<'_, Result<String>> {
661 unimplemented!()
662 }
663
664 fn default_branch(&self) -> BoxFuture<'_, Result<Option<SharedString>>> {
665 async { Ok(Some("main".into())) }.boxed()
666 }
667}
668
669#[cfg(test)]
670mod tests {
671 use crate::{FakeFs, Fs};
672 use gpui::BackgroundExecutor;
673 use serde_json::json;
674 use std::path::Path;
675 use util::path;
676
677 #[gpui::test]
678 async fn test_checkpoints(executor: BackgroundExecutor) {
679 let fs = FakeFs::new(executor);
680 fs.insert_tree(
681 path!("/"),
682 json!({
683 "bar": {
684 "baz": "qux"
685 },
686 "foo": {
687 ".git": {},
688 "a": "lorem",
689 "b": "ipsum",
690 },
691 }),
692 )
693 .await;
694 fs.with_git_state(Path::new("/foo/.git"), true, |_git| {})
695 .unwrap();
696 let repository = fs
697 .open_repo(Path::new("/foo/.git"), Some("git".as_ref()))
698 .unwrap();
699
700 let checkpoint_1 = repository.checkpoint().await.unwrap();
701 fs.write(Path::new("/foo/b"), b"IPSUM").await.unwrap();
702 fs.write(Path::new("/foo/c"), b"dolor").await.unwrap();
703 let checkpoint_2 = repository.checkpoint().await.unwrap();
704 let checkpoint_3 = repository.checkpoint().await.unwrap();
705
706 assert!(
707 repository
708 .compare_checkpoints(checkpoint_2.clone(), checkpoint_3.clone())
709 .await
710 .unwrap()
711 );
712 assert!(
713 !repository
714 .compare_checkpoints(checkpoint_1.clone(), checkpoint_2.clone())
715 .await
716 .unwrap()
717 );
718
719 repository.restore_checkpoint(checkpoint_1).await.unwrap();
720 assert_eq!(
721 fs.files_with_contents(Path::new("")),
722 [
723 (Path::new(path!("/bar/baz")).into(), b"qux".into()),
724 (Path::new(path!("/foo/a")).into(), b"lorem".into()),
725 (Path::new(path!("/foo/b")).into(), b"ipsum".into())
726 ]
727 );
728 }
729}