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,
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 ) -> BoxFuture<'_, anyhow::Result<()>> {
142 self.with_state_async(true, move |state| {
143 if let Some(message) = &state.simulated_index_write_error_message {
144 anyhow::bail!("{message}");
145 } else if let Some(content) = content {
146 state.index_contents.insert(path, content);
147 } else {
148 state.index_contents.remove(&path);
149 }
150 Ok(())
151 })
152 }
153
154 fn remote_url(&self, _name: &str) -> Option<String> {
155 None
156 }
157
158 fn diff_tree(&self, _request: DiffTreeType) -> BoxFuture<'_, Result<TreeDiff>> {
159 let mut entries = HashMap::default();
160 self.with_state_async(false, |state| {
161 for (path, content) in &state.head_contents {
162 let status = if let Some((oid, original)) = state
163 .merge_base_contents
164 .get(path)
165 .map(|oid| (oid, &state.oids[oid]))
166 {
167 if original == content {
168 continue;
169 }
170 TreeDiffStatus::Modified { old: *oid }
171 } else {
172 TreeDiffStatus::Added
173 };
174 entries.insert(path.clone(), status);
175 }
176 for (path, oid) in &state.merge_base_contents {
177 if !entries.contains_key(path) {
178 entries.insert(path.clone(), TreeDiffStatus::Deleted { old: *oid });
179 }
180 }
181 Ok(TreeDiff { entries })
182 })
183 .boxed()
184 }
185
186 fn revparse_batch(&self, revs: Vec<String>) -> BoxFuture<'_, Result<Vec<Option<String>>>> {
187 self.with_state_async(false, |state| {
188 Ok(revs
189 .into_iter()
190 .map(|rev| state.refs.get(&rev).cloned())
191 .collect())
192 })
193 }
194
195 fn show(&self, commit: String) -> BoxFuture<'_, Result<CommitDetails>> {
196 async {
197 Ok(CommitDetails {
198 sha: commit.into(),
199 ..Default::default()
200 })
201 }
202 .boxed()
203 }
204
205 fn reset(
206 &self,
207 _commit: String,
208 _mode: ResetMode,
209 _env: Arc<HashMap<String, String>>,
210 ) -> BoxFuture<'_, Result<()>> {
211 unimplemented!()
212 }
213
214 fn checkout_files(
215 &self,
216 _commit: String,
217 _paths: Vec<RepoPath>,
218 _env: Arc<HashMap<String, String>>,
219 ) -> BoxFuture<'_, Result<()>> {
220 unimplemented!()
221 }
222
223 fn path(&self) -> PathBuf {
224 self.repository_dir_path.clone()
225 }
226
227 fn main_repository_path(&self) -> PathBuf {
228 self.common_dir_path.clone()
229 }
230
231 fn merge_message(&self) -> BoxFuture<'_, Option<String>> {
232 async move { None }.boxed()
233 }
234
235 fn status(&self, path_prefixes: &[RepoPath]) -> Task<Result<GitStatus>> {
236 let workdir_path = self.dot_git_path.parent().unwrap();
237
238 // Load gitignores
239 let ignores = workdir_path
240 .ancestors()
241 .filter_map(|dir| {
242 let ignore_path = dir.join(".gitignore");
243 let content = self.fs.read_file_sync(ignore_path).ok()?;
244 let content = String::from_utf8(content).ok()?;
245 let mut builder = GitignoreBuilder::new(dir);
246 for line in content.lines() {
247 builder.add_line(Some(dir.into()), line).ok()?;
248 }
249 builder.build().ok()
250 })
251 .collect::<Vec<_>>();
252
253 // Load working copy files.
254 let git_files: HashMap<RepoPath, (String, bool)> = self
255 .fs
256 .files()
257 .iter()
258 .filter_map(|path| {
259 // TODO better simulate git status output in the case of submodules and worktrees
260 let repo_path = path.strip_prefix(workdir_path).ok()?;
261 let mut is_ignored = repo_path.starts_with(".git");
262 for ignore in &ignores {
263 match ignore.matched_path_or_any_parents(path, false) {
264 ignore::Match::None => {}
265 ignore::Match::Ignore(_) => is_ignored = true,
266 ignore::Match::Whitelist(_) => break,
267 }
268 }
269 let content = self
270 .fs
271 .read_file_sync(path)
272 .ok()
273 .map(|content| String::from_utf8(content).unwrap())?;
274 let repo_path = RelPath::new(repo_path, PathStyle::local()).ok()?;
275 Some((repo_path.into(), (content, is_ignored)))
276 })
277 .collect();
278
279 let result = self.fs.with_git_state(&self.dot_git_path, false, |state| {
280 let mut entries = Vec::new();
281 let paths = state
282 .head_contents
283 .keys()
284 .chain(state.index_contents.keys())
285 .chain(git_files.keys())
286 .collect::<HashSet<_>>();
287 for path in paths {
288 if !path_prefixes.iter().any(|prefix| path.starts_with(prefix)) {
289 continue;
290 }
291
292 let head = state.head_contents.get(path);
293 let index = state.index_contents.get(path);
294 let unmerged = state.unmerged_paths.get(path);
295 let fs = git_files.get(path);
296 let status = match (unmerged, head, index, fs) {
297 (Some(unmerged), _, _, _) => FileStatus::Unmerged(*unmerged),
298 (_, Some(head), Some(index), Some((fs, _))) => {
299 FileStatus::Tracked(TrackedStatus {
300 index_status: if head == index {
301 StatusCode::Unmodified
302 } else {
303 StatusCode::Modified
304 },
305 worktree_status: if fs == index {
306 StatusCode::Unmodified
307 } else {
308 StatusCode::Modified
309 },
310 })
311 }
312 (_, Some(head), Some(index), None) => FileStatus::Tracked(TrackedStatus {
313 index_status: if head == index {
314 StatusCode::Unmodified
315 } else {
316 StatusCode::Modified
317 },
318 worktree_status: StatusCode::Deleted,
319 }),
320 (_, Some(_), None, Some(_)) => FileStatus::Tracked(TrackedStatus {
321 index_status: StatusCode::Deleted,
322 worktree_status: StatusCode::Added,
323 }),
324 (_, Some(_), None, None) => FileStatus::Tracked(TrackedStatus {
325 index_status: StatusCode::Deleted,
326 worktree_status: StatusCode::Deleted,
327 }),
328 (_, None, Some(index), Some((fs, _))) => FileStatus::Tracked(TrackedStatus {
329 index_status: StatusCode::Added,
330 worktree_status: if fs == index {
331 StatusCode::Unmodified
332 } else {
333 StatusCode::Modified
334 },
335 }),
336 (_, None, Some(_), None) => FileStatus::Tracked(TrackedStatus {
337 index_status: StatusCode::Added,
338 worktree_status: StatusCode::Deleted,
339 }),
340 (_, None, None, Some((_, is_ignored))) => {
341 if *is_ignored {
342 continue;
343 }
344 FileStatus::Untracked
345 }
346 (_, None, None, None) => {
347 unreachable!();
348 }
349 };
350 if status
351 != FileStatus::Tracked(TrackedStatus {
352 index_status: StatusCode::Unmodified,
353 worktree_status: StatusCode::Unmodified,
354 })
355 {
356 entries.push((path.clone(), status));
357 }
358 }
359 entries.sort_by(|a, b| a.0.cmp(&b.0));
360 anyhow::Ok(GitStatus {
361 entries: entries.into(),
362 })
363 });
364 Task::ready(match result {
365 Ok(result) => result,
366 Err(e) => Err(e),
367 })
368 }
369
370 fn stash_entries(&self) -> BoxFuture<'_, Result<git::stash::GitStash>> {
371 async { Ok(git::stash::GitStash::default()) }.boxed()
372 }
373
374 fn branches(&self) -> BoxFuture<'_, Result<Vec<Branch>>> {
375 self.with_state_async(false, move |state| {
376 let current_branch = &state.current_branch_name;
377 Ok(state
378 .branches
379 .iter()
380 .map(|branch_name| Branch {
381 is_head: Some(branch_name) == current_branch.as_ref(),
382 ref_name: branch_name.into(),
383 most_recent_commit: None,
384 upstream: None,
385 })
386 .collect())
387 })
388 }
389
390 fn worktrees(&self) -> BoxFuture<'_, Result<Vec<Worktree>>> {
391 unimplemented!()
392 }
393
394 fn create_worktree(
395 &self,
396 _: String,
397 _: PathBuf,
398 _: Option<String>,
399 ) -> BoxFuture<'_, Result<()>> {
400 unimplemented!()
401 }
402
403 fn change_branch(&self, name: String) -> BoxFuture<'_, Result<()>> {
404 self.with_state_async(true, |state| {
405 state.current_branch_name = Some(name);
406 Ok(())
407 })
408 }
409
410 fn create_branch(
411 &self,
412 name: String,
413 _base_branch: Option<String>,
414 ) -> BoxFuture<'_, Result<()>> {
415 self.with_state_async(true, move |state| {
416 state.branches.insert(name);
417 Ok(())
418 })
419 }
420
421 fn rename_branch(&self, branch: String, new_name: String) -> BoxFuture<'_, Result<()>> {
422 self.with_state_async(true, move |state| {
423 if !state.branches.remove(&branch) {
424 bail!("no such branch: {branch}");
425 }
426 state.branches.insert(new_name.clone());
427 if state.current_branch_name == Some(branch) {
428 state.current_branch_name = Some(new_name);
429 }
430 Ok(())
431 })
432 }
433
434 fn blame(&self, path: RepoPath, _content: Rope) -> BoxFuture<'_, Result<git::blame::Blame>> {
435 self.with_state_async(false, move |state| {
436 state
437 .blames
438 .get(&path)
439 .with_context(|| format!("failed to get blame for {:?}", path.0))
440 .cloned()
441 })
442 }
443
444 fn stage_paths(
445 &self,
446 paths: Vec<RepoPath>,
447 _env: Arc<HashMap<String, String>>,
448 ) -> BoxFuture<'_, Result<()>> {
449 Box::pin(async move {
450 let contents = paths
451 .into_iter()
452 .map(|path| {
453 let abs_path = self
454 .dot_git_path
455 .parent()
456 .unwrap()
457 .join(&path.as_std_path());
458 Box::pin(async move { (path.clone(), self.fs.load(&abs_path).await.ok()) })
459 })
460 .collect::<Vec<_>>();
461 let contents = join_all(contents).await;
462 self.with_state_async(true, move |state| {
463 for (path, content) in contents {
464 if let Some(content) = content {
465 state.index_contents.insert(path, content);
466 } else {
467 state.index_contents.remove(&path);
468 }
469 }
470 Ok(())
471 })
472 .await
473 })
474 }
475
476 fn unstage_paths(
477 &self,
478 paths: Vec<RepoPath>,
479 _env: Arc<HashMap<String, String>>,
480 ) -> BoxFuture<'_, Result<()>> {
481 self.with_state_async(true, move |state| {
482 for path in paths {
483 match state.head_contents.get(&path) {
484 Some(content) => state.index_contents.insert(path, content.clone()),
485 None => state.index_contents.remove(&path),
486 };
487 }
488 Ok(())
489 })
490 }
491
492 fn stash_paths(
493 &self,
494 _paths: Vec<RepoPath>,
495 _env: Arc<HashMap<String, String>>,
496 ) -> BoxFuture<'_, Result<()>> {
497 unimplemented!()
498 }
499
500 fn stash_pop(
501 &self,
502 _index: Option<usize>,
503 _env: Arc<HashMap<String, String>>,
504 ) -> BoxFuture<'_, Result<()>> {
505 unimplemented!()
506 }
507
508 fn stash_apply(
509 &self,
510 _index: Option<usize>,
511 _env: Arc<HashMap<String, String>>,
512 ) -> BoxFuture<'_, Result<()>> {
513 unimplemented!()
514 }
515
516 fn stash_drop(
517 &self,
518 _index: Option<usize>,
519 _env: Arc<HashMap<String, String>>,
520 ) -> BoxFuture<'_, Result<()>> {
521 unimplemented!()
522 }
523
524 fn commit(
525 &self,
526 _message: gpui::SharedString,
527 _name_and_email: Option<(gpui::SharedString, gpui::SharedString)>,
528 _options: CommitOptions,
529 _env: Arc<HashMap<String, String>>,
530 ) -> BoxFuture<'_, Result<()>> {
531 unimplemented!()
532 }
533
534 fn push(
535 &self,
536 _branch: String,
537 _remote: String,
538 _options: Option<PushOptions>,
539 _askpass: AskPassDelegate,
540 _env: Arc<HashMap<String, String>>,
541 _cx: AsyncApp,
542 ) -> BoxFuture<'_, Result<git::repository::RemoteCommandOutput>> {
543 unimplemented!()
544 }
545
546 fn pull(
547 &self,
548 _branch: Option<String>,
549 _remote: String,
550 _rebase: bool,
551 _askpass: AskPassDelegate,
552 _env: Arc<HashMap<String, String>>,
553 _cx: AsyncApp,
554 ) -> BoxFuture<'_, Result<git::repository::RemoteCommandOutput>> {
555 unimplemented!()
556 }
557
558 fn fetch(
559 &self,
560 _fetch_options: FetchOptions,
561 _askpass: AskPassDelegate,
562 _env: Arc<HashMap<String, String>>,
563 _cx: AsyncApp,
564 ) -> BoxFuture<'_, Result<git::repository::RemoteCommandOutput>> {
565 unimplemented!()
566 }
567
568 fn get_remotes(&self, _branch: Option<String>) -> BoxFuture<'_, Result<Vec<Remote>>> {
569 unimplemented!()
570 }
571
572 fn check_for_pushed_commit(&self) -> BoxFuture<'_, Result<Vec<gpui::SharedString>>> {
573 future::ready(Ok(Vec::new())).boxed()
574 }
575
576 fn diff(&self, _diff: git::repository::DiffType) -> BoxFuture<'_, Result<String>> {
577 unimplemented!()
578 }
579
580 fn checkpoint(&self) -> BoxFuture<'static, Result<GitRepositoryCheckpoint>> {
581 let executor = self.executor.clone();
582 let fs = self.fs.clone();
583 let checkpoints = self.checkpoints.clone();
584 let repository_dir_path = self.repository_dir_path.parent().unwrap().to_path_buf();
585 async move {
586 executor.simulate_random_delay().await;
587 let oid = git::Oid::random(&mut executor.rng());
588 let entry = fs.entry(&repository_dir_path)?;
589 checkpoints.lock().insert(oid, entry);
590 Ok(GitRepositoryCheckpoint { commit_sha: oid })
591 }
592 .boxed()
593 }
594
595 fn restore_checkpoint(&self, checkpoint: GitRepositoryCheckpoint) -> BoxFuture<'_, Result<()>> {
596 let executor = self.executor.clone();
597 let fs = self.fs.clone();
598 let checkpoints = self.checkpoints.clone();
599 let repository_dir_path = self.repository_dir_path.parent().unwrap().to_path_buf();
600 async move {
601 executor.simulate_random_delay().await;
602 let checkpoints = checkpoints.lock();
603 let entry = checkpoints
604 .get(&checkpoint.commit_sha)
605 .context(format!("invalid checkpoint: {}", checkpoint.commit_sha))?;
606 fs.insert_entry(&repository_dir_path, entry.clone())?;
607 Ok(())
608 }
609 .boxed()
610 }
611
612 fn compare_checkpoints(
613 &self,
614 left: GitRepositoryCheckpoint,
615 right: GitRepositoryCheckpoint,
616 ) -> BoxFuture<'_, Result<bool>> {
617 let executor = self.executor.clone();
618 let checkpoints = self.checkpoints.clone();
619 async move {
620 executor.simulate_random_delay().await;
621 let checkpoints = checkpoints.lock();
622 let left = checkpoints
623 .get(&left.commit_sha)
624 .context(format!("invalid left checkpoint: {}", left.commit_sha))?;
625 let right = checkpoints
626 .get(&right.commit_sha)
627 .context(format!("invalid right checkpoint: {}", right.commit_sha))?;
628
629 Ok(left == right)
630 }
631 .boxed()
632 }
633
634 fn diff_checkpoints(
635 &self,
636 _base_checkpoint: GitRepositoryCheckpoint,
637 _target_checkpoint: GitRepositoryCheckpoint,
638 ) -> BoxFuture<'_, Result<String>> {
639 unimplemented!()
640 }
641
642 fn default_branch(&self) -> BoxFuture<'_, Result<Option<SharedString>>> {
643 async { Ok(Some("main".into())) }.boxed()
644 }
645}
646
647#[cfg(test)]
648mod tests {
649 use crate::{FakeFs, Fs};
650 use gpui::BackgroundExecutor;
651 use serde_json::json;
652 use std::path::Path;
653 use util::path;
654
655 #[gpui::test]
656 async fn test_checkpoints(executor: BackgroundExecutor) {
657 let fs = FakeFs::new(executor);
658 fs.insert_tree(
659 path!("/"),
660 json!({
661 "bar": {
662 "baz": "qux"
663 },
664 "foo": {
665 ".git": {},
666 "a": "lorem",
667 "b": "ipsum",
668 },
669 }),
670 )
671 .await;
672 fs.with_git_state(Path::new("/foo/.git"), true, |_git| {})
673 .unwrap();
674 let repository = fs
675 .open_repo(Path::new("/foo/.git"), Some("git".as_ref()))
676 .unwrap();
677
678 let checkpoint_1 = repository.checkpoint().await.unwrap();
679 fs.write(Path::new("/foo/b"), b"IPSUM").await.unwrap();
680 fs.write(Path::new("/foo/c"), b"dolor").await.unwrap();
681 let checkpoint_2 = repository.checkpoint().await.unwrap();
682 let checkpoint_3 = repository.checkpoint().await.unwrap();
683
684 assert!(
685 repository
686 .compare_checkpoints(checkpoint_2.clone(), checkpoint_3.clone())
687 .await
688 .unwrap()
689 );
690 assert!(
691 !repository
692 .compare_checkpoints(checkpoint_1.clone(), checkpoint_2.clone())
693 .await
694 .unwrap()
695 );
696
697 repository.restore_checkpoint(checkpoint_1).await.unwrap();
698 assert_eq!(
699 fs.files_with_contents(Path::new("")),
700 [
701 (Path::new(path!("/bar/baz")).into(), b"qux".into()),
702 (Path::new(path!("/foo/a")).into(), b"lorem".into()),
703 (Path::new(path!("/foo/b")).into(), b"ipsum".into())
704 ]
705 );
706 }
707}