1pub mod repository;
2
3use anyhow::{anyhow, Result};
4use fsevent::EventStream;
5use futures::{future::BoxFuture, Stream, StreamExt};
6use git2::Repository as LibGitRepository;
7use lazy_static::lazy_static;
8use parking_lot::Mutex;
9use regex::Regex;
10use repository::GitRepository;
11use rope::Rope;
12use smol::io::{AsyncReadExt, AsyncWriteExt};
13use std::borrow::Cow;
14use std::cmp;
15use std::io::Write;
16use std::sync::Arc;
17use std::{
18 io,
19 os::unix::fs::MetadataExt,
20 path::{Component, Path, PathBuf},
21 pin::Pin,
22 time::{Duration, SystemTime},
23};
24use tempfile::NamedTempFile;
25use util::ResultExt;
26
27#[cfg(any(test, feature = "test-support"))]
28use collections::{btree_map, BTreeMap};
29#[cfg(any(test, feature = "test-support"))]
30use repository::FakeGitRepositoryState;
31#[cfg(any(test, feature = "test-support"))]
32use std::sync::Weak;
33
34lazy_static! {
35 static ref LINE_SEPERATORS_REGEX: Regex = Regex::new("\r\n|\r|\u{2028}|\u{2029}").unwrap();
36}
37
38#[derive(Clone, Copy, Debug, PartialEq)]
39pub enum LineEnding {
40 Unix,
41 Windows,
42}
43
44impl Default for LineEnding {
45 fn default() -> Self {
46 #[cfg(unix)]
47 return Self::Unix;
48
49 #[cfg(not(unix))]
50 return Self::CRLF;
51 }
52}
53
54impl LineEnding {
55 pub fn as_str(&self) -> &'static str {
56 match self {
57 LineEnding::Unix => "\n",
58 LineEnding::Windows => "\r\n",
59 }
60 }
61
62 pub fn detect(text: &str) -> Self {
63 let mut max_ix = cmp::min(text.len(), 1000);
64 while !text.is_char_boundary(max_ix) {
65 max_ix -= 1;
66 }
67
68 if let Some(ix) = text[..max_ix].find(&['\n']) {
69 if ix > 0 && text.as_bytes()[ix - 1] == b'\r' {
70 Self::Windows
71 } else {
72 Self::Unix
73 }
74 } else {
75 Self::default()
76 }
77 }
78
79 pub fn normalize(text: &mut String) {
80 if let Cow::Owned(replaced) = LINE_SEPERATORS_REGEX.replace_all(text, "\n") {
81 *text = replaced;
82 }
83 }
84
85 pub fn normalize_arc(text: Arc<str>) -> Arc<str> {
86 if let Cow::Owned(replaced) = LINE_SEPERATORS_REGEX.replace_all(&text, "\n") {
87 replaced.into()
88 } else {
89 text
90 }
91 }
92}
93
94#[async_trait::async_trait]
95pub trait Fs: Send + Sync {
96 async fn create_dir(&self, path: &Path) -> Result<()>;
97 async fn create_file(&self, path: &Path, options: CreateOptions) -> Result<()>;
98 async fn copy_file(&self, source: &Path, target: &Path, options: CopyOptions) -> Result<()>;
99 async fn rename(&self, source: &Path, target: &Path, options: RenameOptions) -> Result<()>;
100 async fn remove_dir(&self, path: &Path, options: RemoveOptions) -> Result<()>;
101 async fn remove_file(&self, path: &Path, options: RemoveOptions) -> Result<()>;
102 async fn open_sync(&self, path: &Path) -> Result<Box<dyn io::Read>>;
103 async fn load(&self, path: &Path) -> Result<String>;
104 async fn atomic_write(&self, path: PathBuf, text: String) -> Result<()>;
105 async fn save(&self, path: &Path, text: &Rope, line_ending: LineEnding) -> Result<()>;
106 async fn canonicalize(&self, path: &Path) -> Result<PathBuf>;
107 async fn is_file(&self, path: &Path) -> bool;
108 async fn metadata(&self, path: &Path) -> Result<Option<Metadata>>;
109 async fn read_dir(
110 &self,
111 path: &Path,
112 ) -> Result<Pin<Box<dyn Send + Stream<Item = Result<PathBuf>>>>>;
113 async fn watch(
114 &self,
115 path: &Path,
116 latency: Duration,
117 ) -> Pin<Box<dyn Send + Stream<Item = Vec<fsevent::Event>>>>;
118 fn open_repo(&self, abs_dot_git: &Path) -> Option<Arc<Mutex<dyn GitRepository>>>;
119 fn is_fake(&self) -> bool;
120 #[cfg(any(test, feature = "test-support"))]
121 fn as_fake(&self) -> &FakeFs;
122}
123
124#[derive(Copy, Clone, Default)]
125pub struct CreateOptions {
126 pub overwrite: bool,
127 pub ignore_if_exists: bool,
128}
129
130#[derive(Copy, Clone, Default)]
131pub struct CopyOptions {
132 pub overwrite: bool,
133 pub ignore_if_exists: bool,
134}
135
136#[derive(Copy, Clone, Default)]
137pub struct RenameOptions {
138 pub overwrite: bool,
139 pub ignore_if_exists: bool,
140}
141
142#[derive(Copy, Clone, Default)]
143pub struct RemoveOptions {
144 pub recursive: bool,
145 pub ignore_if_not_exists: bool,
146}
147
148#[derive(Clone, Debug)]
149pub struct Metadata {
150 pub inode: u64,
151 pub mtime: SystemTime,
152 pub is_symlink: bool,
153 pub is_dir: bool,
154}
155
156impl From<lsp::CreateFileOptions> for CreateOptions {
157 fn from(options: lsp::CreateFileOptions) -> Self {
158 Self {
159 overwrite: options.overwrite.unwrap_or(false),
160 ignore_if_exists: options.ignore_if_exists.unwrap_or(false),
161 }
162 }
163}
164
165impl From<lsp::RenameFileOptions> for RenameOptions {
166 fn from(options: lsp::RenameFileOptions) -> Self {
167 Self {
168 overwrite: options.overwrite.unwrap_or(false),
169 ignore_if_exists: options.ignore_if_exists.unwrap_or(false),
170 }
171 }
172}
173
174impl From<lsp::DeleteFileOptions> for RemoveOptions {
175 fn from(options: lsp::DeleteFileOptions) -> Self {
176 Self {
177 recursive: options.recursive.unwrap_or(false),
178 ignore_if_not_exists: options.ignore_if_not_exists.unwrap_or(false),
179 }
180 }
181}
182
183pub struct RealFs;
184
185#[async_trait::async_trait]
186impl Fs for RealFs {
187 async fn create_dir(&self, path: &Path) -> Result<()> {
188 Ok(smol::fs::create_dir_all(path).await?)
189 }
190
191 async fn create_file(&self, path: &Path, options: CreateOptions) -> Result<()> {
192 let mut open_options = smol::fs::OpenOptions::new();
193 open_options.write(true).create(true);
194 if options.overwrite {
195 open_options.truncate(true);
196 } else if !options.ignore_if_exists {
197 open_options.create_new(true);
198 }
199 open_options.open(path).await?;
200 Ok(())
201 }
202
203 async fn copy_file(&self, source: &Path, target: &Path, options: CopyOptions) -> Result<()> {
204 if !options.overwrite && smol::fs::metadata(target).await.is_ok() {
205 if options.ignore_if_exists {
206 return Ok(());
207 } else {
208 return Err(anyhow!("{target:?} already exists"));
209 }
210 }
211
212 smol::fs::copy(source, target).await?;
213 Ok(())
214 }
215
216 async fn rename(&self, source: &Path, target: &Path, options: RenameOptions) -> Result<()> {
217 if !options.overwrite && smol::fs::metadata(target).await.is_ok() {
218 if options.ignore_if_exists {
219 return Ok(());
220 } else {
221 return Err(anyhow!("{target:?} already exists"));
222 }
223 }
224
225 smol::fs::rename(source, target).await?;
226 Ok(())
227 }
228
229 async fn remove_dir(&self, path: &Path, options: RemoveOptions) -> Result<()> {
230 let result = if options.recursive {
231 smol::fs::remove_dir_all(path).await
232 } else {
233 smol::fs::remove_dir(path).await
234 };
235 match result {
236 Ok(()) => Ok(()),
237 Err(err) if err.kind() == io::ErrorKind::NotFound && options.ignore_if_not_exists => {
238 Ok(())
239 }
240 Err(err) => Err(err)?,
241 }
242 }
243
244 async fn remove_file(&self, path: &Path, options: RemoveOptions) -> Result<()> {
245 match smol::fs::remove_file(path).await {
246 Ok(()) => Ok(()),
247 Err(err) if err.kind() == io::ErrorKind::NotFound && options.ignore_if_not_exists => {
248 Ok(())
249 }
250 Err(err) => Err(err)?,
251 }
252 }
253
254 async fn open_sync(&self, path: &Path) -> Result<Box<dyn io::Read>> {
255 Ok(Box::new(std::fs::File::open(path)?))
256 }
257
258 async fn load(&self, path: &Path) -> Result<String> {
259 let mut file = smol::fs::File::open(path).await?;
260 let mut text = String::new();
261 file.read_to_string(&mut text).await?;
262 Ok(text)
263 }
264
265 async fn atomic_write(&self, path: PathBuf, data: String) -> Result<()> {
266 smol::unblock(move || {
267 let mut tmp_file = NamedTempFile::new()?;
268 tmp_file.write_all(data.as_bytes())?;
269 tmp_file.persist(path)?;
270 Ok::<(), anyhow::Error>(())
271 })
272 .await?;
273
274 Ok(())
275 }
276
277 async fn save(&self, path: &Path, text: &Rope, line_ending: LineEnding) -> Result<()> {
278 let buffer_size = text.summary().len.min(10 * 1024);
279 let file = smol::fs::File::create(path).await?;
280 let mut writer = smol::io::BufWriter::with_capacity(buffer_size, file);
281 for chunk in chunks(text, line_ending) {
282 writer.write_all(chunk.as_bytes()).await?;
283 }
284 writer.flush().await?;
285 Ok(())
286 }
287
288 async fn canonicalize(&self, path: &Path) -> Result<PathBuf> {
289 Ok(smol::fs::canonicalize(path).await?)
290 }
291
292 async fn is_file(&self, path: &Path) -> bool {
293 smol::fs::metadata(path)
294 .await
295 .map_or(false, |metadata| metadata.is_file())
296 }
297
298 async fn metadata(&self, path: &Path) -> Result<Option<Metadata>> {
299 let symlink_metadata = match smol::fs::symlink_metadata(path).await {
300 Ok(metadata) => metadata,
301 Err(err) => {
302 return match (err.kind(), err.raw_os_error()) {
303 (io::ErrorKind::NotFound, _) => Ok(None),
304 (io::ErrorKind::Other, Some(libc::ENOTDIR)) => Ok(None),
305 _ => Err(anyhow::Error::new(err)),
306 }
307 }
308 };
309
310 let is_symlink = symlink_metadata.file_type().is_symlink();
311 let metadata = if is_symlink {
312 smol::fs::metadata(path).await?
313 } else {
314 symlink_metadata
315 };
316 Ok(Some(Metadata {
317 inode: metadata.ino(),
318 mtime: metadata.modified().unwrap(),
319 is_symlink,
320 is_dir: metadata.file_type().is_dir(),
321 }))
322 }
323
324 async fn read_dir(
325 &self,
326 path: &Path,
327 ) -> Result<Pin<Box<dyn Send + Stream<Item = Result<PathBuf>>>>> {
328 let result = smol::fs::read_dir(path).await?.map(|entry| match entry {
329 Ok(entry) => Ok(entry.path()),
330 Err(error) => Err(anyhow!("failed to read dir entry {:?}", error)),
331 });
332 Ok(Box::pin(result))
333 }
334
335 async fn watch(
336 &self,
337 path: &Path,
338 latency: Duration,
339 ) -> Pin<Box<dyn Send + Stream<Item = Vec<fsevent::Event>>>> {
340 let (tx, rx) = smol::channel::unbounded();
341 let (stream, handle) = EventStream::new(&[path], latency);
342 std::thread::spawn(move || {
343 stream.run(move |events| smol::block_on(tx.send(events)).is_ok());
344 });
345 Box::pin(rx.chain(futures::stream::once(async move {
346 drop(handle);
347 vec![]
348 })))
349 }
350
351 fn open_repo(&self, dotgit_path: &Path) -> Option<Arc<Mutex<dyn GitRepository>>> {
352 LibGitRepository::open(&dotgit_path)
353 .log_err()
354 .and_then::<Arc<Mutex<dyn GitRepository>>, _>(|libgit_repository| {
355 Some(Arc::new(Mutex::new(libgit_repository)))
356 })
357 }
358
359 fn is_fake(&self) -> bool {
360 false
361 }
362 #[cfg(any(test, feature = "test-support"))]
363 fn as_fake(&self) -> &FakeFs {
364 panic!("called `RealFs::as_fake`")
365 }
366}
367
368#[cfg(any(test, feature = "test-support"))]
369pub struct FakeFs {
370 // Use an unfair lock to ensure tests are deterministic.
371 state: Mutex<FakeFsState>,
372 executor: Weak<gpui::executor::Background>,
373}
374
375#[cfg(any(test, feature = "test-support"))]
376struct FakeFsState {
377 root: Arc<Mutex<FakeFsEntry>>,
378 next_inode: u64,
379 next_mtime: SystemTime,
380 event_txs: Vec<smol::channel::Sender<Vec<fsevent::Event>>>,
381 events_paused: bool,
382 buffered_events: Vec<fsevent::Event>,
383}
384
385#[cfg(any(test, feature = "test-support"))]
386#[derive(Debug)]
387enum FakeFsEntry {
388 File {
389 inode: u64,
390 mtime: SystemTime,
391 content: String,
392 },
393 Dir {
394 inode: u64,
395 mtime: SystemTime,
396 entries: BTreeMap<String, Arc<Mutex<FakeFsEntry>>>,
397 git_repo_state: Option<Arc<Mutex<repository::FakeGitRepositoryState>>>,
398 },
399 Symlink {
400 target: PathBuf,
401 },
402}
403
404#[cfg(any(test, feature = "test-support"))]
405impl FakeFsState {
406 fn read_path<'a>(&'a self, target: &Path) -> Result<Arc<Mutex<FakeFsEntry>>> {
407 Ok(self
408 .try_read_path(target)
409 .ok_or_else(|| anyhow!("path does not exist: {}", target.display()))?
410 .0)
411 }
412
413 fn try_read_path<'a>(&'a self, target: &Path) -> Option<(Arc<Mutex<FakeFsEntry>>, PathBuf)> {
414 let mut path = target.to_path_buf();
415 let mut real_path = PathBuf::new();
416 let mut entry_stack = Vec::new();
417 'outer: loop {
418 let mut path_components = path.components().collect::<collections::VecDeque<_>>();
419 while let Some(component) = path_components.pop_front() {
420 match component {
421 Component::Prefix(_) => panic!("prefix paths aren't supported"),
422 Component::RootDir => {
423 entry_stack.clear();
424 entry_stack.push(self.root.clone());
425 real_path.clear();
426 real_path.push("/");
427 }
428 Component::CurDir => {}
429 Component::ParentDir => {
430 entry_stack.pop()?;
431 real_path.pop();
432 }
433 Component::Normal(name) => {
434 let current_entry = entry_stack.last().cloned()?;
435 let current_entry = current_entry.lock();
436 if let FakeFsEntry::Dir { entries, .. } = &*current_entry {
437 let entry = entries.get(name.to_str().unwrap()).cloned()?;
438 let _entry = entry.lock();
439 if let FakeFsEntry::Symlink { target, .. } = &*_entry {
440 let mut target = target.clone();
441 target.extend(path_components);
442 path = target;
443 continue 'outer;
444 } else {
445 entry_stack.push(entry.clone());
446 real_path.push(name);
447 }
448 } else {
449 return None;
450 }
451 }
452 }
453 }
454 break;
455 }
456 entry_stack.pop().map(|entry| (entry, real_path))
457 }
458
459 fn write_path<Fn, T>(&self, path: &Path, callback: Fn) -> Result<T>
460 where
461 Fn: FnOnce(btree_map::Entry<String, Arc<Mutex<FakeFsEntry>>>) -> Result<T>,
462 {
463 let path = normalize_path(path);
464 let filename = path
465 .file_name()
466 .ok_or_else(|| anyhow!("cannot overwrite the root"))?;
467 let parent_path = path.parent().unwrap();
468
469 let parent = self.read_path(parent_path)?;
470 let mut parent = parent.lock();
471 let new_entry = parent
472 .dir_entries(parent_path)?
473 .entry(filename.to_str().unwrap().into());
474 callback(new_entry)
475 }
476
477 fn emit_event<I, T>(&mut self, paths: I)
478 where
479 I: IntoIterator<Item = T>,
480 T: Into<PathBuf>,
481 {
482 self.buffered_events
483 .extend(paths.into_iter().map(|path| fsevent::Event {
484 event_id: 0,
485 flags: fsevent::StreamFlags::empty(),
486 path: path.into(),
487 }));
488
489 if !self.events_paused {
490 self.flush_events(self.buffered_events.len());
491 }
492 }
493
494 fn flush_events(&mut self, mut count: usize) {
495 count = count.min(self.buffered_events.len());
496 let events = self.buffered_events.drain(0..count).collect::<Vec<_>>();
497 self.event_txs.retain(|tx| {
498 let _ = tx.try_send(events.clone());
499 !tx.is_closed()
500 });
501 }
502}
503
504#[cfg(any(test, feature = "test-support"))]
505impl FakeFs {
506 pub fn new(executor: Arc<gpui::executor::Background>) -> Arc<Self> {
507 Arc::new(Self {
508 executor: Arc::downgrade(&executor),
509 state: Mutex::new(FakeFsState {
510 root: Arc::new(Mutex::new(FakeFsEntry::Dir {
511 inode: 0,
512 mtime: SystemTime::UNIX_EPOCH,
513 entries: Default::default(),
514 git_repo_state: None,
515 })),
516 next_mtime: SystemTime::UNIX_EPOCH,
517 next_inode: 1,
518 event_txs: Default::default(),
519 buffered_events: Vec::new(),
520 events_paused: false,
521 }),
522 })
523 }
524
525 pub async fn insert_file(&self, path: impl AsRef<Path>, content: String) {
526 self.write_file_internal(path, content).unwrap()
527 }
528
529 pub async fn insert_symlink(&self, path: impl AsRef<Path>, target: PathBuf) {
530 let mut state = self.state.lock();
531 let path = path.as_ref();
532 let file = Arc::new(Mutex::new(FakeFsEntry::Symlink { target }));
533 state
534 .write_path(path.as_ref(), move |e| match e {
535 btree_map::Entry::Vacant(e) => {
536 e.insert(file);
537 Ok(())
538 }
539 btree_map::Entry::Occupied(mut e) => {
540 *e.get_mut() = file;
541 Ok(())
542 }
543 })
544 .unwrap();
545 state.emit_event(&[path]);
546 }
547
548 fn write_file_internal(&self, path: impl AsRef<Path>, content: String) -> Result<()> {
549 let mut state = self.state.lock();
550 let path = path.as_ref();
551 let inode = state.next_inode;
552 let mtime = state.next_mtime;
553 state.next_inode += 1;
554 state.next_mtime += Duration::from_nanos(1);
555 let file = Arc::new(Mutex::new(FakeFsEntry::File {
556 inode,
557 mtime,
558 content,
559 }));
560 state.write_path(path, move |entry| {
561 match entry {
562 btree_map::Entry::Vacant(e) => {
563 e.insert(file);
564 }
565 btree_map::Entry::Occupied(mut e) => {
566 *e.get_mut() = file;
567 }
568 }
569 Ok(())
570 })?;
571 state.emit_event(&[path]);
572 Ok(())
573 }
574
575 pub async fn pause_events(&self) {
576 self.state.lock().events_paused = true;
577 }
578
579 pub async fn buffered_event_count(&self) -> usize {
580 self.state.lock().buffered_events.len()
581 }
582
583 pub async fn flush_events(&self, count: usize) {
584 self.state.lock().flush_events(count);
585 }
586
587 #[must_use]
588 pub fn insert_tree<'a>(
589 &'a self,
590 path: impl 'a + AsRef<Path> + Send,
591 tree: serde_json::Value,
592 ) -> futures::future::BoxFuture<'a, ()> {
593 use futures::FutureExt as _;
594 use serde_json::Value::*;
595
596 async move {
597 let path = path.as_ref();
598
599 match tree {
600 Object(map) => {
601 self.create_dir(path).await.unwrap();
602 for (name, contents) in map {
603 let mut path = PathBuf::from(path);
604 path.push(name);
605 self.insert_tree(&path, contents).await;
606 }
607 }
608 Null => {
609 self.create_dir(path).await.unwrap();
610 }
611 String(contents) => {
612 self.insert_file(&path, contents).await;
613 }
614 _ => {
615 panic!("JSON object must contain only objects, strings, or null");
616 }
617 }
618 }
619 .boxed()
620 }
621
622 pub async fn set_index_for_repo(&self, dot_git: &Path, head_state: &[(&Path, String)]) {
623 let mut state = self.state.lock();
624 let entry = state.read_path(dot_git).unwrap();
625 let mut entry = entry.lock();
626
627 if let FakeFsEntry::Dir { git_repo_state, .. } = &mut *entry {
628 let repo_state = git_repo_state.get_or_insert_with(Default::default);
629 let mut repo_state = repo_state.lock();
630
631 repo_state.index_contents.clear();
632 repo_state.index_contents.extend(
633 head_state
634 .iter()
635 .map(|(path, content)| (path.to_path_buf(), content.clone())),
636 );
637
638 state.emit_event([dot_git]);
639 } else {
640 panic!("not a directory");
641 }
642 }
643
644 pub fn paths(&self) -> Vec<PathBuf> {
645 let mut result = Vec::new();
646 let mut queue = collections::VecDeque::new();
647 queue.push_back((PathBuf::from("/"), self.state.lock().root.clone()));
648 while let Some((path, entry)) = queue.pop_front() {
649 if let FakeFsEntry::Dir { entries, .. } = &*entry.lock() {
650 for (name, entry) in entries {
651 queue.push_back((path.join(name), entry.clone()));
652 }
653 }
654 result.push(path);
655 }
656 result
657 }
658
659 pub fn directories(&self) -> Vec<PathBuf> {
660 let mut result = Vec::new();
661 let mut queue = collections::VecDeque::new();
662 queue.push_back((PathBuf::from("/"), self.state.lock().root.clone()));
663 while let Some((path, entry)) = queue.pop_front() {
664 if let FakeFsEntry::Dir { entries, .. } = &*entry.lock() {
665 for (name, entry) in entries {
666 queue.push_back((path.join(name), entry.clone()));
667 }
668 result.push(path);
669 }
670 }
671 result
672 }
673
674 pub fn files(&self) -> Vec<PathBuf> {
675 let mut result = Vec::new();
676 let mut queue = collections::VecDeque::new();
677 queue.push_back((PathBuf::from("/"), self.state.lock().root.clone()));
678 while let Some((path, entry)) = queue.pop_front() {
679 let e = entry.lock();
680 match &*e {
681 FakeFsEntry::File { .. } => result.push(path),
682 FakeFsEntry::Dir { entries, .. } => {
683 for (name, entry) in entries {
684 queue.push_back((path.join(name), entry.clone()));
685 }
686 }
687 FakeFsEntry::Symlink { .. } => {}
688 }
689 }
690 result
691 }
692
693 async fn simulate_random_delay(&self) {
694 self.executor
695 .upgrade()
696 .expect("executor has been dropped")
697 .simulate_random_delay()
698 .await;
699 }
700}
701
702#[cfg(any(test, feature = "test-support"))]
703impl FakeFsEntry {
704 fn is_file(&self) -> bool {
705 matches!(self, Self::File { .. })
706 }
707
708 fn file_content(&self, path: &Path) -> Result<&String> {
709 if let Self::File { content, .. } = self {
710 Ok(content)
711 } else {
712 Err(anyhow!("not a file: {}", path.display()))
713 }
714 }
715
716 fn set_file_content(&mut self, path: &Path, new_content: String) -> Result<()> {
717 if let Self::File { content, mtime, .. } = self {
718 *mtime = SystemTime::now();
719 *content = new_content;
720 Ok(())
721 } else {
722 Err(anyhow!("not a file: {}", path.display()))
723 }
724 }
725
726 fn dir_entries(
727 &mut self,
728 path: &Path,
729 ) -> Result<&mut BTreeMap<String, Arc<Mutex<FakeFsEntry>>>> {
730 if let Self::Dir { entries, .. } = self {
731 Ok(entries)
732 } else {
733 Err(anyhow!("not a directory: {}", path.display()))
734 }
735 }
736}
737
738#[cfg(any(test, feature = "test-support"))]
739#[async_trait::async_trait]
740impl Fs for FakeFs {
741 async fn create_dir(&self, path: &Path) -> Result<()> {
742 self.simulate_random_delay().await;
743
744 let mut created_dirs = Vec::new();
745 let mut cur_path = PathBuf::new();
746 for component in path.components() {
747 let mut state = self.state.lock();
748 cur_path.push(component);
749 if cur_path == Path::new("/") {
750 continue;
751 }
752
753 let inode = state.next_inode;
754 let mtime = state.next_mtime;
755 state.next_mtime += Duration::from_nanos(1);
756 state.next_inode += 1;
757 state.write_path(&cur_path, |entry| {
758 entry.or_insert_with(|| {
759 created_dirs.push(cur_path.clone());
760 Arc::new(Mutex::new(FakeFsEntry::Dir {
761 inode,
762 mtime,
763 entries: Default::default(),
764 git_repo_state: None,
765 }))
766 });
767 Ok(())
768 })?
769 }
770
771 self.state.lock().emit_event(&created_dirs);
772 Ok(())
773 }
774
775 async fn create_file(&self, path: &Path, options: CreateOptions) -> Result<()> {
776 self.simulate_random_delay().await;
777 let mut state = self.state.lock();
778 let inode = state.next_inode;
779 let mtime = state.next_mtime;
780 state.next_mtime += Duration::from_nanos(1);
781 state.next_inode += 1;
782 let file = Arc::new(Mutex::new(FakeFsEntry::File {
783 inode,
784 mtime,
785 content: String::new(),
786 }));
787 state.write_path(path, |entry| {
788 match entry {
789 btree_map::Entry::Occupied(mut e) => {
790 if options.overwrite {
791 *e.get_mut() = file;
792 } else if !options.ignore_if_exists {
793 return Err(anyhow!("path already exists: {}", path.display()));
794 }
795 }
796 btree_map::Entry::Vacant(e) => {
797 e.insert(file);
798 }
799 }
800 Ok(())
801 })?;
802 state.emit_event(&[path]);
803 Ok(())
804 }
805
806 async fn rename(&self, old_path: &Path, new_path: &Path, options: RenameOptions) -> Result<()> {
807 self.simulate_random_delay().await;
808
809 let old_path = normalize_path(old_path);
810 let new_path = normalize_path(new_path);
811 let mut state = self.state.lock();
812 let moved_entry = state.write_path(&old_path, |e| {
813 if let btree_map::Entry::Occupied(e) = e {
814 Ok(e.remove())
815 } else {
816 Err(anyhow!("path does not exist: {}", &old_path.display()))
817 }
818 })?;
819 state.write_path(&new_path, |e| {
820 match e {
821 btree_map::Entry::Occupied(mut e) => {
822 if options.overwrite {
823 *e.get_mut() = moved_entry;
824 } else if !options.ignore_if_exists {
825 return Err(anyhow!("path already exists: {}", new_path.display()));
826 }
827 }
828 btree_map::Entry::Vacant(e) => {
829 e.insert(moved_entry);
830 }
831 }
832 Ok(())
833 })?;
834 state.emit_event(&[old_path, new_path]);
835 Ok(())
836 }
837
838 async fn copy_file(&self, source: &Path, target: &Path, options: CopyOptions) -> Result<()> {
839 self.simulate_random_delay().await;
840
841 let source = normalize_path(source);
842 let target = normalize_path(target);
843 let mut state = self.state.lock();
844 let mtime = state.next_mtime;
845 let inode = util::post_inc(&mut state.next_inode);
846 state.next_mtime += Duration::from_nanos(1);
847 let source_entry = state.read_path(&source)?;
848 let content = source_entry.lock().file_content(&source)?.clone();
849 let entry = state.write_path(&target, |e| match e {
850 btree_map::Entry::Occupied(e) => {
851 if options.overwrite {
852 Ok(Some(e.get().clone()))
853 } else if !options.ignore_if_exists {
854 return Err(anyhow!("{target:?} already exists"));
855 } else {
856 Ok(None)
857 }
858 }
859 btree_map::Entry::Vacant(e) => Ok(Some(
860 e.insert(Arc::new(Mutex::new(FakeFsEntry::File {
861 inode,
862 mtime,
863 content: String::new(),
864 })))
865 .clone(),
866 )),
867 })?;
868 if let Some(entry) = entry {
869 entry.lock().set_file_content(&target, content)?;
870 }
871 state.emit_event(&[target]);
872 Ok(())
873 }
874
875 async fn remove_dir(&self, path: &Path, options: RemoveOptions) -> Result<()> {
876 self.simulate_random_delay().await;
877
878 let path = normalize_path(path);
879 let parent_path = path
880 .parent()
881 .ok_or_else(|| anyhow!("cannot remove the root"))?;
882 let base_name = path.file_name().unwrap();
883
884 let mut state = self.state.lock();
885 let parent_entry = state.read_path(parent_path)?;
886 let mut parent_entry = parent_entry.lock();
887 let entry = parent_entry
888 .dir_entries(parent_path)?
889 .entry(base_name.to_str().unwrap().into());
890
891 match entry {
892 btree_map::Entry::Vacant(_) => {
893 if !options.ignore_if_not_exists {
894 return Err(anyhow!("{path:?} does not exist"));
895 }
896 }
897 btree_map::Entry::Occupied(e) => {
898 {
899 let mut entry = e.get().lock();
900 let children = entry.dir_entries(&path)?;
901 if !options.recursive && !children.is_empty() {
902 return Err(anyhow!("{path:?} is not empty"));
903 }
904 }
905 e.remove();
906 }
907 }
908 state.emit_event(&[path]);
909 Ok(())
910 }
911
912 async fn remove_file(&self, path: &Path, options: RemoveOptions) -> Result<()> {
913 self.simulate_random_delay().await;
914
915 let path = normalize_path(path);
916 let parent_path = path
917 .parent()
918 .ok_or_else(|| anyhow!("cannot remove the root"))?;
919 let base_name = path.file_name().unwrap();
920 let mut state = self.state.lock();
921 let parent_entry = state.read_path(parent_path)?;
922 let mut parent_entry = parent_entry.lock();
923 let entry = parent_entry
924 .dir_entries(parent_path)?
925 .entry(base_name.to_str().unwrap().into());
926 match entry {
927 btree_map::Entry::Vacant(_) => {
928 if !options.ignore_if_not_exists {
929 return Err(anyhow!("{path:?} does not exist"));
930 }
931 }
932 btree_map::Entry::Occupied(e) => {
933 e.get().lock().file_content(&path)?;
934 e.remove();
935 }
936 }
937 state.emit_event(&[path]);
938 Ok(())
939 }
940
941 async fn open_sync(&self, path: &Path) -> Result<Box<dyn io::Read>> {
942 let text = self.load(path).await?;
943 Ok(Box::new(io::Cursor::new(text)))
944 }
945
946 async fn load(&self, path: &Path) -> Result<String> {
947 let path = normalize_path(path);
948 self.simulate_random_delay().await;
949 let state = self.state.lock();
950 let entry = state.read_path(&path)?;
951 let entry = entry.lock();
952 entry.file_content(&path).cloned()
953 }
954
955 async fn atomic_write(&self, path: PathBuf, data: String) -> Result<()> {
956 self.simulate_random_delay().await;
957 let path = normalize_path(path.as_path());
958 self.write_file_internal(path, data.to_string())?;
959
960 Ok(())
961 }
962
963 async fn save(&self, path: &Path, text: &Rope, line_ending: LineEnding) -> Result<()> {
964 self.simulate_random_delay().await;
965 let path = normalize_path(path);
966 let content = chunks(text, line_ending).collect();
967 self.write_file_internal(path, content)?;
968 Ok(())
969 }
970
971 async fn canonicalize(&self, path: &Path) -> Result<PathBuf> {
972 let path = normalize_path(path);
973 self.simulate_random_delay().await;
974 let state = self.state.lock();
975 if let Some((_, real_path)) = state.try_read_path(&path) {
976 Ok(real_path)
977 } else {
978 Err(anyhow!("path does not exist: {}", path.display()))
979 }
980 }
981
982 async fn is_file(&self, path: &Path) -> bool {
983 let path = normalize_path(path);
984 self.simulate_random_delay().await;
985 let state = self.state.lock();
986 if let Some((entry, _)) = state.try_read_path(&path) {
987 entry.lock().is_file()
988 } else {
989 false
990 }
991 }
992
993 async fn metadata(&self, path: &Path) -> Result<Option<Metadata>> {
994 self.simulate_random_delay().await;
995 let path = normalize_path(path);
996 let state = self.state.lock();
997 if let Some((entry, real_path)) = state.try_read_path(&path) {
998 let entry = entry.lock();
999 let is_symlink = real_path != path;
1000
1001 Ok(Some(match &*entry {
1002 FakeFsEntry::File { inode, mtime, .. } => Metadata {
1003 inode: *inode,
1004 mtime: *mtime,
1005 is_dir: false,
1006 is_symlink,
1007 },
1008 FakeFsEntry::Dir { inode, mtime, .. } => Metadata {
1009 inode: *inode,
1010 mtime: *mtime,
1011 is_dir: true,
1012 is_symlink,
1013 },
1014 FakeFsEntry::Symlink { .. } => unreachable!(),
1015 }))
1016 } else {
1017 Ok(None)
1018 }
1019 }
1020
1021 async fn read_dir(
1022 &self,
1023 path: &Path,
1024 ) -> Result<Pin<Box<dyn Send + Stream<Item = Result<PathBuf>>>>> {
1025 self.simulate_random_delay().await;
1026 let path = normalize_path(path);
1027 let state = self.state.lock();
1028 let entry = state.read_path(&path)?;
1029 let mut entry = entry.lock();
1030 let children = entry.dir_entries(&path)?;
1031 let paths = children
1032 .keys()
1033 .map(|file_name| Ok(path.join(file_name)))
1034 .collect::<Vec<_>>();
1035 Ok(Box::pin(futures::stream::iter(paths)))
1036 }
1037
1038 async fn watch(
1039 &self,
1040 path: &Path,
1041 _: Duration,
1042 ) -> Pin<Box<dyn Send + Stream<Item = Vec<fsevent::Event>>>> {
1043 self.simulate_random_delay().await;
1044 let (tx, rx) = smol::channel::unbounded();
1045 self.state.lock().event_txs.push(tx);
1046 let path = path.to_path_buf();
1047 let executor = self.executor.clone();
1048 Box::pin(futures::StreamExt::filter(rx, move |events| {
1049 let result = events.iter().any(|event| event.path.starts_with(&path));
1050 let executor = executor.clone();
1051 async move {
1052 if let Some(executor) = executor.clone().upgrade() {
1053 executor.simulate_random_delay().await;
1054 }
1055 result
1056 }
1057 }))
1058 }
1059
1060 fn open_repo(&self, abs_dot_git: &Path) -> Option<Arc<Mutex<dyn GitRepository>>> {
1061 let state = self.state.lock();
1062 let entry = state.read_path(abs_dot_git).unwrap();
1063 let mut entry = entry.lock();
1064 if let FakeFsEntry::Dir { git_repo_state, .. } = &mut *entry {
1065 let state = git_repo_state
1066 .get_or_insert_with(|| Arc::new(Mutex::new(FakeGitRepositoryState::default())))
1067 .clone();
1068 Some(repository::FakeGitRepository::open(state))
1069 } else {
1070 None
1071 }
1072 }
1073
1074 fn is_fake(&self) -> bool {
1075 true
1076 }
1077
1078 #[cfg(any(test, feature = "test-support"))]
1079 fn as_fake(&self) -> &FakeFs {
1080 self
1081 }
1082}
1083
1084fn chunks(rope: &Rope, line_ending: LineEnding) -> impl Iterator<Item = &str> {
1085 rope.chunks().flat_map(move |chunk| {
1086 let mut newline = false;
1087 chunk.split('\n').flat_map(move |line| {
1088 let ending = if newline {
1089 Some(line_ending.as_str())
1090 } else {
1091 None
1092 };
1093 newline = true;
1094 ending.into_iter().chain([line])
1095 })
1096 })
1097}
1098
1099pub fn normalize_path(path: &Path) -> PathBuf {
1100 let mut components = path.components().peekable();
1101 let mut ret = if let Some(c @ Component::Prefix(..)) = components.peek().cloned() {
1102 components.next();
1103 PathBuf::from(c.as_os_str())
1104 } else {
1105 PathBuf::new()
1106 };
1107
1108 for component in components {
1109 match component {
1110 Component::Prefix(..) => unreachable!(),
1111 Component::RootDir => {
1112 ret.push(component.as_os_str());
1113 }
1114 Component::CurDir => {}
1115 Component::ParentDir => {
1116 ret.pop();
1117 }
1118 Component::Normal(c) => {
1119 ret.push(c);
1120 }
1121 }
1122 }
1123 ret
1124}
1125
1126pub fn copy_recursive<'a>(
1127 fs: &'a dyn Fs,
1128 source: &'a Path,
1129 target: &'a Path,
1130 options: CopyOptions,
1131) -> BoxFuture<'a, Result<()>> {
1132 use futures::future::FutureExt;
1133
1134 async move {
1135 let metadata = fs
1136 .metadata(source)
1137 .await?
1138 .ok_or_else(|| anyhow!("path does not exist: {}", source.display()))?;
1139 if metadata.is_dir {
1140 if !options.overwrite && fs.metadata(target).await.is_ok() {
1141 if options.ignore_if_exists {
1142 return Ok(());
1143 } else {
1144 return Err(anyhow!("{target:?} already exists"));
1145 }
1146 }
1147
1148 let _ = fs
1149 .remove_dir(
1150 target,
1151 RemoveOptions {
1152 recursive: true,
1153 ignore_if_not_exists: true,
1154 },
1155 )
1156 .await;
1157 fs.create_dir(target).await?;
1158 let mut children = fs.read_dir(source).await?;
1159 while let Some(child_path) = children.next().await {
1160 if let Ok(child_path) = child_path {
1161 if let Some(file_name) = child_path.file_name() {
1162 let child_target_path = target.join(file_name);
1163 copy_recursive(fs, &child_path, &child_target_path, options).await?;
1164 }
1165 }
1166 }
1167
1168 Ok(())
1169 } else {
1170 fs.copy_file(source, target, options).await
1171 }
1172 }
1173 .boxed()
1174}
1175
1176#[cfg(test)]
1177mod tests {
1178 use super::*;
1179 use gpui::TestAppContext;
1180 use serde_json::json;
1181
1182 #[gpui::test]
1183 async fn test_fake_fs(cx: &mut TestAppContext) {
1184 let fs = FakeFs::new(cx.background());
1185
1186 fs.insert_tree(
1187 "/root",
1188 json!({
1189 "dir1": {
1190 "a": "A",
1191 "b": "B"
1192 },
1193 "dir2": {
1194 "c": "C",
1195 "dir3": {
1196 "d": "D"
1197 }
1198 }
1199 }),
1200 )
1201 .await;
1202
1203 assert_eq!(
1204 fs.files(),
1205 vec![
1206 PathBuf::from("/root/dir1/a"),
1207 PathBuf::from("/root/dir1/b"),
1208 PathBuf::from("/root/dir2/c"),
1209 PathBuf::from("/root/dir2/dir3/d"),
1210 ]
1211 );
1212
1213 fs.insert_symlink("/root/dir2/link-to-dir3", "./dir3".into())
1214 .await;
1215
1216 assert_eq!(
1217 fs.canonicalize("/root/dir2/link-to-dir3".as_ref())
1218 .await
1219 .unwrap(),
1220 PathBuf::from("/root/dir2/dir3"),
1221 );
1222 assert_eq!(
1223 fs.canonicalize("/root/dir2/link-to-dir3/d".as_ref())
1224 .await
1225 .unwrap(),
1226 PathBuf::from("/root/dir2/dir3/d"),
1227 );
1228 assert_eq!(
1229 fs.load("/root/dir2/link-to-dir3/d".as_ref()).await.unwrap(),
1230 "D",
1231 );
1232 }
1233}