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: 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: 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: 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 status_blocking(&self, path_prefixes: &[RepoPath]) -> Result<GitStatus> {
183        let workdir_path = self.dot_git_path.parent().unwrap();
184
185        // Load gitignores
186        let ignores = workdir_path
187            .ancestors()
188            .filter_map(|dir| {
189                let ignore_path = dir.join(".gitignore");
190                let content = self.fs.read_file_sync(ignore_path).ok()?;
191                let content = String::from_utf8(content).ok()?;
192                let mut builder = GitignoreBuilder::new(dir);
193                for line in content.lines() {
194                    builder.add_line(Some(dir.into()), line).ok()?;
195                }
196                builder.build().ok()
197            })
198            .collect::<Vec<_>>();
199
200        // Load working copy files.
201        let git_files: HashMap<RepoPath, (String, bool)> = self
202            .fs
203            .files()
204            .iter()
205            .filter_map(|path| {
206                let repo_path = path.strip_prefix(workdir_path).ok()?;
207                let mut is_ignored = false;
208                for ignore in &ignores {
209                    match ignore.matched_path_or_any_parents(path, false) {
210                        ignore::Match::None => {}
211                        ignore::Match::Ignore(_) => is_ignored = true,
212                        ignore::Match::Whitelist(_) => break,
213                    }
214                }
215                let content = self
216                    .fs
217                    .read_file_sync(path)
218                    .ok()
219                    .map(|content| String::from_utf8(content).unwrap())?;
220                Some((repo_path.into(), (content, is_ignored)))
221            })
222            .collect();
223
224        self.fs.with_git_state(&self.dot_git_path, false, |state| {
225            let mut entries = Vec::new();
226            let paths = state
227                .head_contents
228                .keys()
229                .chain(state.index_contents.keys())
230                .chain(git_files.keys())
231                .collect::<HashSet<_>>();
232            for path in paths {
233                if !path_prefixes.iter().any(|prefix| path.starts_with(prefix)) {
234                    continue;
235                }
236
237                let head = state.head_contents.get(path);
238                let index = state.index_contents.get(path);
239                let unmerged = state.unmerged_paths.get(path);
240                let fs = git_files.get(path);
241                let status = match (unmerged, head, index, fs) {
242                    (Some(unmerged), _, _, _) => FileStatus::Unmerged(*unmerged),
243                    (_, Some(head), Some(index), Some((fs, _))) => {
244                        FileStatus::Tracked(TrackedStatus {
245                            index_status: if head == index {
246                                StatusCode::Unmodified
247                            } else {
248                                StatusCode::Modified
249                            },
250                            worktree_status: if fs == index {
251                                StatusCode::Unmodified
252                            } else {
253                                StatusCode::Modified
254                            },
255                        })
256                    }
257                    (_, Some(head), Some(index), None) => FileStatus::Tracked(TrackedStatus {
258                        index_status: if head == index {
259                            StatusCode::Unmodified
260                        } else {
261                            StatusCode::Modified
262                        },
263                        worktree_status: StatusCode::Deleted,
264                    }),
265                    (_, Some(_), None, Some(_)) => FileStatus::Tracked(TrackedStatus {
266                        index_status: StatusCode::Deleted,
267                        worktree_status: StatusCode::Added,
268                    }),
269                    (_, Some(_), None, None) => FileStatus::Tracked(TrackedStatus {
270                        index_status: StatusCode::Deleted,
271                        worktree_status: StatusCode::Deleted,
272                    }),
273                    (_, None, Some(index), Some((fs, _))) => FileStatus::Tracked(TrackedStatus {
274                        index_status: StatusCode::Added,
275                        worktree_status: if fs == index {
276                            StatusCode::Unmodified
277                        } else {
278                            StatusCode::Modified
279                        },
280                    }),
281                    (_, None, Some(_), None) => FileStatus::Tracked(TrackedStatus {
282                        index_status: StatusCode::Added,
283                        worktree_status: StatusCode::Deleted,
284                    }),
285                    (_, None, None, Some((_, is_ignored))) => {
286                        if *is_ignored {
287                            continue;
288                        }
289                        FileStatus::Untracked
290                    }
291                    (_, None, None, None) => {
292                        unreachable!();
293                    }
294                };
295                if status
296                    != FileStatus::Tracked(TrackedStatus {
297                        index_status: StatusCode::Unmodified,
298                        worktree_status: StatusCode::Unmodified,
299                    })
300                {
301                    entries.push((path.clone(), status));
302                }
303            }
304            entries.sort_by(|a, b| a.0.cmp(&b.0));
305            Ok(GitStatus {
306                entries: entries.into(),
307            })
308        })?
309    }
310
311    fn branches(&self) -> BoxFuture<Result<Vec<Branch>>> {
312        self.with_state_async(false, move |state| {
313            let current_branch = &state.current_branch_name;
314            Ok(state
315                .branches
316                .iter()
317                .map(|branch_name| Branch {
318                    is_head: Some(branch_name) == current_branch.as_ref(),
319                    name: branch_name.into(),
320                    most_recent_commit: None,
321                    upstream: None,
322                })
323                .collect())
324        })
325    }
326
327    fn change_branch(&self, name: String) -> BoxFuture<Result<()>> {
328        self.with_state_async(true, |state| {
329            state.current_branch_name = Some(name);
330            Ok(())
331        })
332    }
333
334    fn create_branch(&self, name: String) -> BoxFuture<Result<()>> {
335        self.with_state_async(true, move |state| {
336            state.branches.insert(name.to_owned());
337            Ok(())
338        })
339    }
340
341    fn blame(&self, path: RepoPath, _content: Rope) -> BoxFuture<Result<git::blame::Blame>> {
342        self.with_state_async(false, move |state| {
343            state
344                .blames
345                .get(&path)
346                .with_context(|| format!("failed to get blame for {:?}", path.0))
347                .cloned()
348        })
349    }
350
351    fn stage_paths(
352        &self,
353        _paths: Vec<RepoPath>,
354        _env: HashMap<String, String>,
355    ) -> BoxFuture<Result<()>> {
356        unimplemented!()
357    }
358
359    fn unstage_paths(
360        &self,
361        _paths: Vec<RepoPath>,
362        _env: HashMap<String, String>,
363    ) -> BoxFuture<Result<()>> {
364        unimplemented!()
365    }
366
367    fn commit(
368        &self,
369        _message: gpui::SharedString,
370        _name_and_email: Option<(gpui::SharedString, gpui::SharedString)>,
371        _env: HashMap<String, String>,
372    ) -> BoxFuture<Result<()>> {
373        unimplemented!()
374    }
375
376    fn push(
377        &self,
378        _branch: String,
379        _remote: String,
380        _options: Option<PushOptions>,
381        _askpass: AskPassDelegate,
382        _env: HashMap<String, String>,
383        _cx: AsyncApp,
384    ) -> BoxFuture<Result<git::repository::RemoteCommandOutput>> {
385        unimplemented!()
386    }
387
388    fn pull(
389        &self,
390        _branch: String,
391        _remote: String,
392        _askpass: AskPassDelegate,
393        _env: HashMap<String, String>,
394        _cx: AsyncApp,
395    ) -> BoxFuture<Result<git::repository::RemoteCommandOutput>> {
396        unimplemented!()
397    }
398
399    fn fetch(
400        &self,
401        _askpass: AskPassDelegate,
402        _env: HashMap<String, String>,
403        _cx: AsyncApp,
404    ) -> BoxFuture<Result<git::repository::RemoteCommandOutput>> {
405        unimplemented!()
406    }
407
408    fn get_remotes(&self, _branch: Option<String>) -> BoxFuture<Result<Vec<Remote>>> {
409        unimplemented!()
410    }
411
412    fn check_for_pushed_commit(&self) -> BoxFuture<Result<Vec<gpui::SharedString>>> {
413        future::ready(Ok(Vec::new())).boxed()
414    }
415
416    fn diff(&self, _diff: git::repository::DiffType) -> BoxFuture<Result<String>> {
417        unimplemented!()
418    }
419
420    fn checkpoint(&self) -> BoxFuture<'static, Result<GitRepositoryCheckpoint>> {
421        unimplemented!()
422    }
423
424    fn restore_checkpoint(&self, _checkpoint: GitRepositoryCheckpoint) -> BoxFuture<Result<()>> {
425        unimplemented!()
426    }
427
428    fn compare_checkpoints(
429        &self,
430        _left: GitRepositoryCheckpoint,
431        _right: GitRepositoryCheckpoint,
432    ) -> BoxFuture<Result<bool>> {
433        unimplemented!()
434    }
435
436    fn delete_checkpoint(&self, _checkpoint: GitRepositoryCheckpoint) -> BoxFuture<Result<()>> {
437        unimplemented!()
438    }
439
440    fn diff_checkpoints(
441        &self,
442        _base_checkpoint: GitRepositoryCheckpoint,
443        _target_checkpoint: GitRepositoryCheckpoint,
444    ) -> BoxFuture<Result<String>> {
445        unimplemented!()
446    }
447}