fake_git_repo.rs

  1use crate::FakeFs;
  2use anyhow::{Context as _, Result, anyhow};
  3use collections::{HashMap, HashSet};
  4use futures::future::{self, BoxFuture};
  5use git::{
  6    blame::Blame,
  7    repository::{
  8        AskPassDelegate, Branch, CommitDetails, GitRepository, GitRepositoryCheckpoint,
  9        PushOptions, Remote, RepoPath, ResetMode,
 10    },
 11    status::{FileStatus, GitStatus, StatusCode, TrackedStatus, UnmergedStatus},
 12};
 13use gpui::{AsyncApp, BackgroundExecutor};
 14use ignore::gitignore::GitignoreBuilder;
 15use rope::Rope;
 16use smol::future::FutureExt as _;
 17use std::{path::PathBuf, sync::Arc};
 18
 19#[derive(Clone)]
 20pub struct FakeGitRepository {
 21    pub(crate) fs: Arc<FakeFs>,
 22    pub(crate) executor: BackgroundExecutor,
 23    pub(crate) dot_git_path: PathBuf,
 24}
 25
 26#[derive(Debug, Clone)]
 27pub struct FakeGitRepositoryState {
 28    pub path: PathBuf,
 29    pub event_emitter: smol::channel::Sender<PathBuf>,
 30    pub unmerged_paths: HashMap<RepoPath, UnmergedStatus>,
 31    pub head_contents: HashMap<RepoPath, String>,
 32    pub index_contents: HashMap<RepoPath, String>,
 33    pub blames: HashMap<RepoPath, Blame>,
 34    pub current_branch_name: Option<String>,
 35    pub branches: HashSet<String>,
 36    pub simulated_index_write_error_message: Option<String>,
 37}
 38
 39impl FakeGitRepositoryState {
 40    pub fn new(path: PathBuf, event_emitter: smol::channel::Sender<PathBuf>) -> Self {
 41        FakeGitRepositoryState {
 42            path,
 43            event_emitter,
 44            head_contents: Default::default(),
 45            index_contents: Default::default(),
 46            unmerged_paths: Default::default(),
 47            blames: Default::default(),
 48            current_branch_name: Default::default(),
 49            branches: Default::default(),
 50            simulated_index_write_error_message: Default::default(),
 51        }
 52    }
 53}
 54
 55impl FakeGitRepository {
 56    fn with_state<F, T>(&self, f: F) -> T
 57    where
 58        F: FnOnce(&mut FakeGitRepositoryState) -> T,
 59    {
 60        self.fs
 61            .with_git_state(&self.dot_git_path, false, f)
 62            .unwrap()
 63    }
 64
 65    fn with_state_async<F, T>(&self, write: bool, f: F) -> BoxFuture<'static, Result<T>>
 66    where
 67        F: 'static + Send + FnOnce(&mut FakeGitRepositoryState) -> Result<T>,
 68        T: Send,
 69    {
 70        let fs = self.fs.clone();
 71        let executor = self.executor.clone();
 72        let dot_git_path = self.dot_git_path.clone();
 73        async move {
 74            executor.simulate_random_delay().await;
 75            fs.with_git_state(&dot_git_path, write, f)?
 76        }
 77        .boxed()
 78    }
 79}
 80
 81impl GitRepository for FakeGitRepository {
 82    fn reload_index(&self) {}
 83
 84    fn load_index_text(&self, path: RepoPath) -> BoxFuture<Option<String>> {
 85        async {
 86            self.with_state_async(false, move |state| {
 87                state
 88                    .index_contents
 89                    .get(path.as_ref())
 90                    .ok_or_else(|| anyhow!("not present in index"))
 91                    .cloned()
 92            })
 93            .await
 94            .ok()
 95        }
 96        .boxed()
 97    }
 98
 99    fn load_committed_text(&self, path: RepoPath) -> BoxFuture<Option<String>> {
100        async {
101            self.with_state_async(false, move |state| {
102                state
103                    .head_contents
104                    .get(path.as_ref())
105                    .ok_or_else(|| anyhow!("not present in HEAD"))
106                    .cloned()
107            })
108            .await
109            .ok()
110        }
111        .boxed()
112    }
113
114    fn load_commit(
115        &self,
116        _commit: String,
117        _cx: AsyncApp,
118    ) -> BoxFuture<Result<git::repository::CommitDiff>> {
119        unimplemented!()
120    }
121
122    fn set_index_text(
123        &self,
124        path: RepoPath,
125        content: Option<String>,
126        _env: Arc<HashMap<String, String>>,
127    ) -> BoxFuture<anyhow::Result<()>> {
128        self.with_state_async(true, move |state| {
129            if let Some(message) = state.simulated_index_write_error_message.clone() {
130                return Err(anyhow!("{}", message));
131            } else if let Some(content) = content {
132                state.index_contents.insert(path, content);
133            } else {
134                state.index_contents.remove(&path);
135            }
136            Ok(())
137        })
138    }
139
140    fn remote_url(&self, _name: &str) -> Option<String> {
141        None
142    }
143
144    fn head_sha(&self) -> Option<String> {
145        None
146    }
147
148    fn merge_head_shas(&self) -> Vec<String> {
149        vec![]
150    }
151
152    fn show(&self, _commit: String) -> BoxFuture<Result<CommitDetails>> {
153        unimplemented!()
154    }
155
156    fn reset(
157        &self,
158        _commit: String,
159        _mode: ResetMode,
160        _env: Arc<HashMap<String, String>>,
161    ) -> BoxFuture<Result<()>> {
162        unimplemented!()
163    }
164
165    fn checkout_files(
166        &self,
167        _commit: String,
168        _paths: Vec<RepoPath>,
169        _env: Arc<HashMap<String, String>>,
170    ) -> BoxFuture<Result<()>> {
171        unimplemented!()
172    }
173
174    fn path(&self) -> PathBuf {
175        self.with_state(|state| state.path.clone())
176    }
177
178    fn main_repository_path(&self) -> PathBuf {
179        self.path()
180    }
181
182    fn merge_message(&self) -> BoxFuture<Option<String>> {
183        async move { None }.boxed()
184    }
185
186    fn status(&self, path_prefixes: &[RepoPath]) -> BoxFuture<Result<GitStatus>> {
187        let workdir_path = self.dot_git_path.parent().unwrap();
188
189        // Load gitignores
190        let ignores = workdir_path
191            .ancestors()
192            .filter_map(|dir| {
193                let ignore_path = dir.join(".gitignore");
194                let content = self.fs.read_file_sync(ignore_path).ok()?;
195                let content = String::from_utf8(content).ok()?;
196                let mut builder = GitignoreBuilder::new(dir);
197                for line in content.lines() {
198                    builder.add_line(Some(dir.into()), line).ok()?;
199                }
200                builder.build().ok()
201            })
202            .collect::<Vec<_>>();
203
204        // Load working copy files.
205        let git_files: HashMap<RepoPath, (String, bool)> = self
206            .fs
207            .files()
208            .iter()
209            .filter_map(|path| {
210                let repo_path = path.strip_prefix(workdir_path).ok()?;
211                let mut is_ignored = false;
212                for ignore in &ignores {
213                    match ignore.matched_path_or_any_parents(path, false) {
214                        ignore::Match::None => {}
215                        ignore::Match::Ignore(_) => is_ignored = true,
216                        ignore::Match::Whitelist(_) => break,
217                    }
218                }
219                let content = self
220                    .fs
221                    .read_file_sync(path)
222                    .ok()
223                    .map(|content| String::from_utf8(content).unwrap())?;
224                Some((repo_path.into(), (content, is_ignored)))
225            })
226            .collect();
227
228        let result = self.fs.with_git_state(&self.dot_git_path, false, |state| {
229            let mut entries = Vec::new();
230            let paths = state
231                .head_contents
232                .keys()
233                .chain(state.index_contents.keys())
234                .chain(git_files.keys())
235                .collect::<HashSet<_>>();
236            for path in paths {
237                if !path_prefixes.iter().any(|prefix| path.starts_with(prefix)) {
238                    continue;
239                }
240
241                let head = state.head_contents.get(path);
242                let index = state.index_contents.get(path);
243                let unmerged = state.unmerged_paths.get(path);
244                let fs = git_files.get(path);
245                let status = match (unmerged, head, index, fs) {
246                    (Some(unmerged), _, _, _) => FileStatus::Unmerged(*unmerged),
247                    (_, Some(head), Some(index), Some((fs, _))) => {
248                        FileStatus::Tracked(TrackedStatus {
249                            index_status: if head == index {
250                                StatusCode::Unmodified
251                            } else {
252                                StatusCode::Modified
253                            },
254                            worktree_status: if fs == index {
255                                StatusCode::Unmodified
256                            } else {
257                                StatusCode::Modified
258                            },
259                        })
260                    }
261                    (_, Some(head), Some(index), None) => FileStatus::Tracked(TrackedStatus {
262                        index_status: if head == index {
263                            StatusCode::Unmodified
264                        } else {
265                            StatusCode::Modified
266                        },
267                        worktree_status: StatusCode::Deleted,
268                    }),
269                    (_, Some(_), None, Some(_)) => FileStatus::Tracked(TrackedStatus {
270                        index_status: StatusCode::Deleted,
271                        worktree_status: StatusCode::Added,
272                    }),
273                    (_, Some(_), None, None) => FileStatus::Tracked(TrackedStatus {
274                        index_status: StatusCode::Deleted,
275                        worktree_status: StatusCode::Deleted,
276                    }),
277                    (_, None, Some(index), Some((fs, _))) => FileStatus::Tracked(TrackedStatus {
278                        index_status: StatusCode::Added,
279                        worktree_status: if fs == index {
280                            StatusCode::Unmodified
281                        } else {
282                            StatusCode::Modified
283                        },
284                    }),
285                    (_, None, Some(_), None) => FileStatus::Tracked(TrackedStatus {
286                        index_status: StatusCode::Added,
287                        worktree_status: StatusCode::Deleted,
288                    }),
289                    (_, None, None, Some((_, is_ignored))) => {
290                        if *is_ignored {
291                            continue;
292                        }
293                        FileStatus::Untracked
294                    }
295                    (_, None, None, None) => {
296                        unreachable!();
297                    }
298                };
299                if status
300                    != FileStatus::Tracked(TrackedStatus {
301                        index_status: StatusCode::Unmodified,
302                        worktree_status: StatusCode::Unmodified,
303                    })
304                {
305                    entries.push((path.clone(), status));
306                }
307            }
308            entries.sort_by(|a, b| a.0.cmp(&b.0));
309            anyhow::Ok(GitStatus {
310                entries: entries.into(),
311            })
312        });
313        async move { result? }.boxed()
314    }
315
316    fn branches(&self) -> BoxFuture<Result<Vec<Branch>>> {
317        self.with_state_async(false, move |state| {
318            let current_branch = &state.current_branch_name;
319            Ok(state
320                .branches
321                .iter()
322                .map(|branch_name| Branch {
323                    is_head: Some(branch_name) == current_branch.as_ref(),
324                    name: branch_name.into(),
325                    most_recent_commit: None,
326                    upstream: None,
327                })
328                .collect())
329        })
330    }
331
332    fn change_branch(&self, name: String) -> BoxFuture<Result<()>> {
333        self.with_state_async(true, |state| {
334            state.current_branch_name = Some(name);
335            Ok(())
336        })
337    }
338
339    fn create_branch(&self, name: String) -> BoxFuture<Result<()>> {
340        self.with_state_async(true, move |state| {
341            state.branches.insert(name.to_owned());
342            Ok(())
343        })
344    }
345
346    fn blame(&self, path: RepoPath, _content: Rope) -> BoxFuture<Result<git::blame::Blame>> {
347        self.with_state_async(false, move |state| {
348            state
349                .blames
350                .get(&path)
351                .with_context(|| format!("failed to get blame for {:?}", path.0))
352                .cloned()
353        })
354    }
355
356    fn stage_paths(
357        &self,
358        _paths: Vec<RepoPath>,
359        _env: Arc<HashMap<String, String>>,
360    ) -> BoxFuture<Result<()>> {
361        unimplemented!()
362    }
363
364    fn unstage_paths(
365        &self,
366        _paths: Vec<RepoPath>,
367        _env: Arc<HashMap<String, String>>,
368    ) -> BoxFuture<Result<()>> {
369        unimplemented!()
370    }
371
372    fn commit(
373        &self,
374        _message: gpui::SharedString,
375        _name_and_email: Option<(gpui::SharedString, gpui::SharedString)>,
376        _env: Arc<HashMap<String, String>>,
377    ) -> BoxFuture<Result<()>> {
378        unimplemented!()
379    }
380
381    fn push(
382        &self,
383        _branch: String,
384        _remote: String,
385        _options: Option<PushOptions>,
386        _askpass: AskPassDelegate,
387        _env: Arc<HashMap<String, String>>,
388        _cx: AsyncApp,
389    ) -> BoxFuture<Result<git::repository::RemoteCommandOutput>> {
390        unimplemented!()
391    }
392
393    fn pull(
394        &self,
395        _branch: String,
396        _remote: String,
397        _askpass: AskPassDelegate,
398        _env: Arc<HashMap<String, String>>,
399        _cx: AsyncApp,
400    ) -> BoxFuture<Result<git::repository::RemoteCommandOutput>> {
401        unimplemented!()
402    }
403
404    fn fetch(
405        &self,
406        _askpass: AskPassDelegate,
407        _env: Arc<HashMap<String, String>>,
408        _cx: AsyncApp,
409    ) -> BoxFuture<Result<git::repository::RemoteCommandOutput>> {
410        unimplemented!()
411    }
412
413    fn get_remotes(&self, _branch: Option<String>) -> BoxFuture<Result<Vec<Remote>>> {
414        unimplemented!()
415    }
416
417    fn check_for_pushed_commit(&self) -> BoxFuture<Result<Vec<gpui::SharedString>>> {
418        future::ready(Ok(Vec::new())).boxed()
419    }
420
421    fn diff(&self, _diff: git::repository::DiffType) -> BoxFuture<Result<String>> {
422        unimplemented!()
423    }
424
425    fn checkpoint(&self) -> BoxFuture<'static, Result<GitRepositoryCheckpoint>> {
426        unimplemented!()
427    }
428
429    fn restore_checkpoint(&self, _checkpoint: GitRepositoryCheckpoint) -> BoxFuture<Result<()>> {
430        unimplemented!()
431    }
432
433    fn compare_checkpoints(
434        &self,
435        _left: GitRepositoryCheckpoint,
436        _right: GitRepositoryCheckpoint,
437    ) -> BoxFuture<Result<bool>> {
438        unimplemented!()
439    }
440
441    fn delete_checkpoint(&self, _checkpoint: GitRepositoryCheckpoint) -> BoxFuture<Result<()>> {
442        unimplemented!()
443    }
444
445    fn diff_checkpoints(
446        &self,
447        _base_checkpoint: GitRepositoryCheckpoint,
448        _target_checkpoint: GitRepositoryCheckpoint,
449    ) -> BoxFuture<Result<String>> {
450        unimplemented!()
451    }
452}