1use crate::{
2 worktree_settings::WorktreeSettings, Entry, EntryKind, Event, PathChange, Snapshot, Worktree,
3 WorktreeModelHandle,
4};
5use anyhow::Result;
6use fs::{FakeFs, Fs, RealFs, RemoveOptions};
7use git::{repository::GitFileStatus, GITIGNORE};
8use gpui::{BorrowAppContext, ModelContext, Task, TestAppContext};
9use parking_lot::Mutex;
10use postage::stream::Stream;
11use pretty_assertions::assert_eq;
12use rand::prelude::*;
13use serde_json::json;
14use settings::{Settings, SettingsStore};
15use std::{env, fmt::Write, mem, path::Path, sync::Arc};
16use util::{test::temp_tree, ResultExt};
17
18#[gpui::test]
19async fn test_traversal(cx: &mut TestAppContext) {
20 init_test(cx);
21 let fs = FakeFs::new(cx.background_executor.clone());
22 fs.insert_tree(
23 "/root",
24 json!({
25 ".gitignore": "a/b\n",
26 "a": {
27 "b": "",
28 "c": "",
29 }
30 }),
31 )
32 .await;
33
34 let tree = Worktree::local(
35 Path::new("/root"),
36 true,
37 fs,
38 Default::default(),
39 &mut cx.to_async(),
40 )
41 .await
42 .unwrap();
43 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
44 .await;
45
46 tree.read_with(cx, |tree, _| {
47 assert_eq!(
48 tree.entries(false, 0)
49 .map(|entry| entry.path.as_ref())
50 .collect::<Vec<_>>(),
51 vec![
52 Path::new(""),
53 Path::new(".gitignore"),
54 Path::new("a"),
55 Path::new("a/c"),
56 ]
57 );
58 assert_eq!(
59 tree.entries(true, 0)
60 .map(|entry| entry.path.as_ref())
61 .collect::<Vec<_>>(),
62 vec![
63 Path::new(""),
64 Path::new(".gitignore"),
65 Path::new("a"),
66 Path::new("a/b"),
67 Path::new("a/c"),
68 ]
69 );
70 })
71}
72
73#[gpui::test(iterations = 10)]
74async fn test_circular_symlinks(cx: &mut TestAppContext) {
75 init_test(cx);
76 let fs = FakeFs::new(cx.background_executor.clone());
77 fs.insert_tree(
78 "/root",
79 json!({
80 "lib": {
81 "a": {
82 "a.txt": ""
83 },
84 "b": {
85 "b.txt": ""
86 }
87 }
88 }),
89 )
90 .await;
91 fs.create_symlink("/root/lib/a/lib".as_ref(), "..".into())
92 .await
93 .unwrap();
94 fs.create_symlink("/root/lib/b/lib".as_ref(), "..".into())
95 .await
96 .unwrap();
97
98 let tree = Worktree::local(
99 Path::new("/root"),
100 true,
101 fs.clone(),
102 Default::default(),
103 &mut cx.to_async(),
104 )
105 .await
106 .unwrap();
107
108 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
109 .await;
110
111 tree.read_with(cx, |tree, _| {
112 assert_eq!(
113 tree.entries(false, 0)
114 .map(|entry| entry.path.as_ref())
115 .collect::<Vec<_>>(),
116 vec![
117 Path::new(""),
118 Path::new("lib"),
119 Path::new("lib/a"),
120 Path::new("lib/a/a.txt"),
121 Path::new("lib/a/lib"),
122 Path::new("lib/b"),
123 Path::new("lib/b/b.txt"),
124 Path::new("lib/b/lib"),
125 ]
126 );
127 });
128
129 fs.rename(
130 Path::new("/root/lib/a/lib"),
131 Path::new("/root/lib/a/lib-2"),
132 Default::default(),
133 )
134 .await
135 .unwrap();
136 cx.executor().run_until_parked();
137 tree.read_with(cx, |tree, _| {
138 assert_eq!(
139 tree.entries(false, 0)
140 .map(|entry| entry.path.as_ref())
141 .collect::<Vec<_>>(),
142 vec![
143 Path::new(""),
144 Path::new("lib"),
145 Path::new("lib/a"),
146 Path::new("lib/a/a.txt"),
147 Path::new("lib/a/lib-2"),
148 Path::new("lib/b"),
149 Path::new("lib/b/b.txt"),
150 Path::new("lib/b/lib"),
151 ]
152 );
153 });
154}
155
156#[gpui::test]
157async fn test_symlinks_pointing_outside(cx: &mut TestAppContext) {
158 init_test(cx);
159 let fs = FakeFs::new(cx.background_executor.clone());
160 fs.insert_tree(
161 "/root",
162 json!({
163 "dir1": {
164 "deps": {
165 // symlinks here
166 },
167 "src": {
168 "a.rs": "",
169 "b.rs": "",
170 },
171 },
172 "dir2": {
173 "src": {
174 "c.rs": "",
175 "d.rs": "",
176 }
177 },
178 "dir3": {
179 "deps": {},
180 "src": {
181 "e.rs": "",
182 "f.rs": "",
183 },
184 }
185 }),
186 )
187 .await;
188
189 // These symlinks point to directories outside of the worktree's root, dir1.
190 fs.create_symlink("/root/dir1/deps/dep-dir2".as_ref(), "../../dir2".into())
191 .await
192 .unwrap();
193 fs.create_symlink("/root/dir1/deps/dep-dir3".as_ref(), "../../dir3".into())
194 .await
195 .unwrap();
196
197 let tree = Worktree::local(
198 Path::new("/root/dir1"),
199 true,
200 fs.clone(),
201 Default::default(),
202 &mut cx.to_async(),
203 )
204 .await
205 .unwrap();
206
207 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
208 .await;
209
210 let tree_updates = Arc::new(Mutex::new(Vec::new()));
211 tree.update(cx, |_, cx| {
212 let tree_updates = tree_updates.clone();
213 cx.subscribe(&tree, move |_, _, event, _| {
214 if let Event::UpdatedEntries(update) = event {
215 tree_updates.lock().extend(
216 update
217 .iter()
218 .map(|(path, _, change)| (path.clone(), *change)),
219 );
220 }
221 })
222 .detach();
223 });
224
225 // The symlinked directories are not scanned by default.
226 tree.read_with(cx, |tree, _| {
227 assert_eq!(
228 tree.entries(true, 0)
229 .map(|entry| (entry.path.as_ref(), entry.is_external))
230 .collect::<Vec<_>>(),
231 vec![
232 (Path::new(""), false),
233 (Path::new("deps"), false),
234 (Path::new("deps/dep-dir2"), true),
235 (Path::new("deps/dep-dir3"), true),
236 (Path::new("src"), false),
237 (Path::new("src/a.rs"), false),
238 (Path::new("src/b.rs"), false),
239 ]
240 );
241
242 assert_eq!(
243 tree.entry_for_path("deps/dep-dir2").unwrap().kind,
244 EntryKind::UnloadedDir
245 );
246 });
247
248 // Expand one of the symlinked directories.
249 tree.read_with(cx, |tree, _| {
250 tree.as_local()
251 .unwrap()
252 .refresh_entries_for_paths(vec![Path::new("deps/dep-dir3").into()])
253 })
254 .recv()
255 .await;
256
257 // The expanded directory's contents are loaded. Subdirectories are
258 // not scanned yet.
259 tree.read_with(cx, |tree, _| {
260 assert_eq!(
261 tree.entries(true, 0)
262 .map(|entry| (entry.path.as_ref(), entry.is_external))
263 .collect::<Vec<_>>(),
264 vec![
265 (Path::new(""), false),
266 (Path::new("deps"), false),
267 (Path::new("deps/dep-dir2"), true),
268 (Path::new("deps/dep-dir3"), true),
269 (Path::new("deps/dep-dir3/deps"), true),
270 (Path::new("deps/dep-dir3/src"), true),
271 (Path::new("src"), false),
272 (Path::new("src/a.rs"), false),
273 (Path::new("src/b.rs"), false),
274 ]
275 );
276 });
277 assert_eq!(
278 mem::take(&mut *tree_updates.lock()),
279 &[
280 (Path::new("deps/dep-dir3").into(), PathChange::Loaded),
281 (Path::new("deps/dep-dir3/deps").into(), PathChange::Loaded),
282 (Path::new("deps/dep-dir3/src").into(), PathChange::Loaded)
283 ]
284 );
285
286 // Expand a subdirectory of one of the symlinked directories.
287 tree.read_with(cx, |tree, _| {
288 tree.as_local()
289 .unwrap()
290 .refresh_entries_for_paths(vec![Path::new("deps/dep-dir3/src").into()])
291 })
292 .recv()
293 .await;
294
295 // The expanded subdirectory's contents are loaded.
296 tree.read_with(cx, |tree, _| {
297 assert_eq!(
298 tree.entries(true, 0)
299 .map(|entry| (entry.path.as_ref(), entry.is_external))
300 .collect::<Vec<_>>(),
301 vec![
302 (Path::new(""), false),
303 (Path::new("deps"), false),
304 (Path::new("deps/dep-dir2"), true),
305 (Path::new("deps/dep-dir3"), true),
306 (Path::new("deps/dep-dir3/deps"), true),
307 (Path::new("deps/dep-dir3/src"), true),
308 (Path::new("deps/dep-dir3/src/e.rs"), true),
309 (Path::new("deps/dep-dir3/src/f.rs"), true),
310 (Path::new("src"), false),
311 (Path::new("src/a.rs"), false),
312 (Path::new("src/b.rs"), false),
313 ]
314 );
315 });
316
317 assert_eq!(
318 mem::take(&mut *tree_updates.lock()),
319 &[
320 (Path::new("deps/dep-dir3/src").into(), PathChange::Loaded),
321 (
322 Path::new("deps/dep-dir3/src/e.rs").into(),
323 PathChange::Loaded
324 ),
325 (
326 Path::new("deps/dep-dir3/src/f.rs").into(),
327 PathChange::Loaded
328 )
329 ]
330 );
331}
332
333#[cfg(target_os = "macos")]
334#[gpui::test]
335async fn test_renaming_case_only(cx: &mut TestAppContext) {
336 cx.executor().allow_parking();
337 init_test(cx);
338
339 const OLD_NAME: &str = "aaa.rs";
340 const NEW_NAME: &str = "AAA.rs";
341
342 let fs = Arc::new(RealFs::default());
343 let temp_root = temp_tree(json!({
344 OLD_NAME: "",
345 }));
346
347 let tree = Worktree::local(
348 temp_root.path(),
349 true,
350 fs.clone(),
351 Default::default(),
352 &mut cx.to_async(),
353 )
354 .await
355 .unwrap();
356
357 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
358 .await;
359 tree.read_with(cx, |tree, _| {
360 assert_eq!(
361 tree.entries(true, 0)
362 .map(|entry| entry.path.as_ref())
363 .collect::<Vec<_>>(),
364 vec![Path::new(""), Path::new(OLD_NAME)]
365 );
366 });
367
368 fs.rename(
369 &temp_root.path().join(OLD_NAME),
370 &temp_root.path().join(NEW_NAME),
371 fs::RenameOptions {
372 overwrite: true,
373 ignore_if_exists: true,
374 },
375 )
376 .await
377 .unwrap();
378
379 tree.flush_fs_events(cx).await;
380
381 tree.read_with(cx, |tree, _| {
382 assert_eq!(
383 tree.entries(true, 0)
384 .map(|entry| entry.path.as_ref())
385 .collect::<Vec<_>>(),
386 vec![Path::new(""), Path::new(NEW_NAME)]
387 );
388 });
389}
390
391#[gpui::test]
392async fn test_open_gitignored_files(cx: &mut TestAppContext) {
393 init_test(cx);
394 let fs = FakeFs::new(cx.background_executor.clone());
395 fs.insert_tree(
396 "/root",
397 json!({
398 ".gitignore": "node_modules\n",
399 "one": {
400 "node_modules": {
401 "a": {
402 "a1.js": "a1",
403 "a2.js": "a2",
404 },
405 "b": {
406 "b1.js": "b1",
407 "b2.js": "b2",
408 },
409 "c": {
410 "c1.js": "c1",
411 "c2.js": "c2",
412 }
413 },
414 },
415 "two": {
416 "x.js": "",
417 "y.js": "",
418 },
419 }),
420 )
421 .await;
422
423 let tree = Worktree::local(
424 Path::new("/root"),
425 true,
426 fs.clone(),
427 Default::default(),
428 &mut cx.to_async(),
429 )
430 .await
431 .unwrap();
432
433 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
434 .await;
435
436 tree.read_with(cx, |tree, _| {
437 assert_eq!(
438 tree.entries(true, 0)
439 .map(|entry| (entry.path.as_ref(), entry.is_ignored))
440 .collect::<Vec<_>>(),
441 vec![
442 (Path::new(""), false),
443 (Path::new(".gitignore"), false),
444 (Path::new("one"), false),
445 (Path::new("one/node_modules"), true),
446 (Path::new("two"), false),
447 (Path::new("two/x.js"), false),
448 (Path::new("two/y.js"), false),
449 ]
450 );
451 });
452
453 // Open a file that is nested inside of a gitignored directory that
454 // has not yet been expanded.
455 let prev_read_dir_count = fs.read_dir_call_count();
456 let loaded = tree
457 .update(cx, |tree, cx| {
458 tree.load_file("one/node_modules/b/b1.js".as_ref(), cx)
459 })
460 .await
461 .unwrap();
462
463 tree.read_with(cx, |tree, _| {
464 assert_eq!(
465 tree.entries(true, 0)
466 .map(|entry| (entry.path.as_ref(), entry.is_ignored))
467 .collect::<Vec<_>>(),
468 vec![
469 (Path::new(""), false),
470 (Path::new(".gitignore"), false),
471 (Path::new("one"), false),
472 (Path::new("one/node_modules"), true),
473 (Path::new("one/node_modules/a"), true),
474 (Path::new("one/node_modules/b"), true),
475 (Path::new("one/node_modules/b/b1.js"), true),
476 (Path::new("one/node_modules/b/b2.js"), true),
477 (Path::new("one/node_modules/c"), true),
478 (Path::new("two"), false),
479 (Path::new("two/x.js"), false),
480 (Path::new("two/y.js"), false),
481 ]
482 );
483
484 assert_eq!(
485 loaded.file.path.as_ref(),
486 Path::new("one/node_modules/b/b1.js")
487 );
488
489 // Only the newly-expanded directories are scanned.
490 assert_eq!(fs.read_dir_call_count() - prev_read_dir_count, 2);
491 });
492
493 // Open another file in a different subdirectory of the same
494 // gitignored directory.
495 let prev_read_dir_count = fs.read_dir_call_count();
496 let loaded = tree
497 .update(cx, |tree, cx| {
498 tree.load_file("one/node_modules/a/a2.js".as_ref(), cx)
499 })
500 .await
501 .unwrap();
502
503 tree.read_with(cx, |tree, _| {
504 assert_eq!(
505 tree.entries(true, 0)
506 .map(|entry| (entry.path.as_ref(), entry.is_ignored))
507 .collect::<Vec<_>>(),
508 vec![
509 (Path::new(""), false),
510 (Path::new(".gitignore"), false),
511 (Path::new("one"), false),
512 (Path::new("one/node_modules"), true),
513 (Path::new("one/node_modules/a"), true),
514 (Path::new("one/node_modules/a/a1.js"), true),
515 (Path::new("one/node_modules/a/a2.js"), true),
516 (Path::new("one/node_modules/b"), true),
517 (Path::new("one/node_modules/b/b1.js"), true),
518 (Path::new("one/node_modules/b/b2.js"), true),
519 (Path::new("one/node_modules/c"), true),
520 (Path::new("two"), false),
521 (Path::new("two/x.js"), false),
522 (Path::new("two/y.js"), false),
523 ]
524 );
525
526 assert_eq!(
527 loaded.file.path.as_ref(),
528 Path::new("one/node_modules/a/a2.js")
529 );
530
531 // Only the newly-expanded directory is scanned.
532 assert_eq!(fs.read_dir_call_count() - prev_read_dir_count, 1);
533 });
534
535 // No work happens when files and directories change within an unloaded directory.
536 let prev_fs_call_count = fs.read_dir_call_count() + fs.metadata_call_count();
537 fs.create_dir("/root/one/node_modules/c/lib".as_ref())
538 .await
539 .unwrap();
540 cx.executor().run_until_parked();
541 assert_eq!(
542 fs.read_dir_call_count() + fs.metadata_call_count() - prev_fs_call_count,
543 0
544 );
545}
546
547#[gpui::test]
548async fn test_dirs_no_longer_ignored(cx: &mut TestAppContext) {
549 init_test(cx);
550 let fs = FakeFs::new(cx.background_executor.clone());
551 fs.insert_tree(
552 "/root",
553 json!({
554 ".gitignore": "node_modules\n",
555 "a": {
556 "a.js": "",
557 },
558 "b": {
559 "b.js": "",
560 },
561 "node_modules": {
562 "c": {
563 "c.js": "",
564 },
565 "d": {
566 "d.js": "",
567 "e": {
568 "e1.js": "",
569 "e2.js": "",
570 },
571 "f": {
572 "f1.js": "",
573 "f2.js": "",
574 }
575 },
576 },
577 }),
578 )
579 .await;
580
581 let tree = Worktree::local(
582 Path::new("/root"),
583 true,
584 fs.clone(),
585 Default::default(),
586 &mut cx.to_async(),
587 )
588 .await
589 .unwrap();
590
591 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
592 .await;
593
594 // Open a file within the gitignored directory, forcing some of its
595 // subdirectories to be read, but not all.
596 let read_dir_count_1 = fs.read_dir_call_count();
597 tree.read_with(cx, |tree, _| {
598 tree.as_local()
599 .unwrap()
600 .refresh_entries_for_paths(vec![Path::new("node_modules/d/d.js").into()])
601 })
602 .recv()
603 .await;
604
605 // Those subdirectories are now loaded.
606 tree.read_with(cx, |tree, _| {
607 assert_eq!(
608 tree.entries(true, 0)
609 .map(|e| (e.path.as_ref(), e.is_ignored))
610 .collect::<Vec<_>>(),
611 &[
612 (Path::new(""), false),
613 (Path::new(".gitignore"), false),
614 (Path::new("a"), false),
615 (Path::new("a/a.js"), false),
616 (Path::new("b"), false),
617 (Path::new("b/b.js"), false),
618 (Path::new("node_modules"), true),
619 (Path::new("node_modules/c"), true),
620 (Path::new("node_modules/d"), true),
621 (Path::new("node_modules/d/d.js"), true),
622 (Path::new("node_modules/d/e"), true),
623 (Path::new("node_modules/d/f"), true),
624 ]
625 );
626 });
627 let read_dir_count_2 = fs.read_dir_call_count();
628 assert_eq!(read_dir_count_2 - read_dir_count_1, 2);
629
630 // Update the gitignore so that node_modules is no longer ignored,
631 // but a subdirectory is ignored
632 fs.save("/root/.gitignore".as_ref(), &"e".into(), Default::default())
633 .await
634 .unwrap();
635 cx.executor().run_until_parked();
636
637 // All of the directories that are no longer ignored are now loaded.
638 tree.read_with(cx, |tree, _| {
639 assert_eq!(
640 tree.entries(true, 0)
641 .map(|e| (e.path.as_ref(), e.is_ignored))
642 .collect::<Vec<_>>(),
643 &[
644 (Path::new(""), false),
645 (Path::new(".gitignore"), false),
646 (Path::new("a"), false),
647 (Path::new("a/a.js"), false),
648 (Path::new("b"), false),
649 (Path::new("b/b.js"), false),
650 // This directory is no longer ignored
651 (Path::new("node_modules"), false),
652 (Path::new("node_modules/c"), false),
653 (Path::new("node_modules/c/c.js"), false),
654 (Path::new("node_modules/d"), false),
655 (Path::new("node_modules/d/d.js"), false),
656 // This subdirectory is now ignored
657 (Path::new("node_modules/d/e"), true),
658 (Path::new("node_modules/d/f"), false),
659 (Path::new("node_modules/d/f/f1.js"), false),
660 (Path::new("node_modules/d/f/f2.js"), false),
661 ]
662 );
663 });
664
665 // Each of the newly-loaded directories is scanned only once.
666 let read_dir_count_3 = fs.read_dir_call_count();
667 assert_eq!(read_dir_count_3 - read_dir_count_2, 2);
668}
669
670#[gpui::test(iterations = 10)]
671async fn test_rescan_with_gitignore(cx: &mut TestAppContext) {
672 init_test(cx);
673 cx.update(|cx| {
674 cx.update_global::<SettingsStore, _>(|store, cx| {
675 store.update_user_settings::<WorktreeSettings>(cx, |project_settings| {
676 project_settings.file_scan_exclusions = Some(Vec::new());
677 });
678 });
679 });
680 let fs = FakeFs::new(cx.background_executor.clone());
681 fs.insert_tree(
682 "/root",
683 json!({
684 ".gitignore": "ancestor-ignored-file1\nancestor-ignored-file2\n",
685 "tree": {
686 ".git": {},
687 ".gitignore": "ignored-dir\n",
688 "tracked-dir": {
689 "tracked-file1": "",
690 "ancestor-ignored-file1": "",
691 },
692 "ignored-dir": {
693 "ignored-file1": ""
694 }
695 }
696 }),
697 )
698 .await;
699
700 let tree = Worktree::local(
701 "/root/tree".as_ref(),
702 true,
703 fs.clone(),
704 Default::default(),
705 &mut cx.to_async(),
706 )
707 .await
708 .unwrap();
709 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
710 .await;
711
712 tree.read_with(cx, |tree, _| {
713 tree.as_local()
714 .unwrap()
715 .refresh_entries_for_paths(vec![Path::new("ignored-dir").into()])
716 })
717 .recv()
718 .await;
719
720 cx.read(|cx| {
721 let tree = tree.read(cx);
722 assert_entry_git_state(tree, "tracked-dir/tracked-file1", None, false);
723 assert_entry_git_state(tree, "tracked-dir/ancestor-ignored-file1", None, true);
724 assert_entry_git_state(tree, "ignored-dir/ignored-file1", None, true);
725 });
726
727 fs.set_status_for_repo_via_working_copy_change(
728 &Path::new("/root/tree/.git"),
729 &[(Path::new("tracked-dir/tracked-file2"), GitFileStatus::Added)],
730 );
731
732 fs.create_file(
733 "/root/tree/tracked-dir/tracked-file2".as_ref(),
734 Default::default(),
735 )
736 .await
737 .unwrap();
738 fs.create_file(
739 "/root/tree/tracked-dir/ancestor-ignored-file2".as_ref(),
740 Default::default(),
741 )
742 .await
743 .unwrap();
744 fs.create_file(
745 "/root/tree/ignored-dir/ignored-file2".as_ref(),
746 Default::default(),
747 )
748 .await
749 .unwrap();
750
751 cx.executor().run_until_parked();
752 cx.read(|cx| {
753 let tree = tree.read(cx);
754 assert_entry_git_state(
755 tree,
756 "tracked-dir/tracked-file2",
757 Some(GitFileStatus::Added),
758 false,
759 );
760 assert_entry_git_state(tree, "tracked-dir/ancestor-ignored-file2", None, true);
761 assert_entry_git_state(tree, "ignored-dir/ignored-file2", None, true);
762 assert!(tree.entry_for_path(".git").unwrap().is_ignored);
763 });
764}
765
766#[gpui::test]
767async fn test_update_gitignore(cx: &mut TestAppContext) {
768 init_test(cx);
769 let fs = FakeFs::new(cx.background_executor.clone());
770 fs.insert_tree(
771 "/root",
772 json!({
773 ".git": {},
774 ".gitignore": "*.txt\n",
775 "a.xml": "<a></a>",
776 "b.txt": "Some text"
777 }),
778 )
779 .await;
780
781 let tree = Worktree::local(
782 "/root".as_ref(),
783 true,
784 fs.clone(),
785 Default::default(),
786 &mut cx.to_async(),
787 )
788 .await
789 .unwrap();
790 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
791 .await;
792
793 tree.read_with(cx, |tree, _| {
794 tree.as_local()
795 .unwrap()
796 .refresh_entries_for_paths(vec![Path::new("").into()])
797 })
798 .recv()
799 .await;
800
801 cx.read(|cx| {
802 let tree = tree.read(cx);
803 assert_entry_git_state(tree, "a.xml", None, false);
804 assert_entry_git_state(tree, "b.txt", None, true);
805 });
806
807 fs.atomic_write("/root/.gitignore".into(), "*.xml".into())
808 .await
809 .unwrap();
810
811 fs.set_status_for_repo_via_working_copy_change(
812 &Path::new("/root/.git"),
813 &[(Path::new("b.txt"), GitFileStatus::Added)],
814 );
815
816 cx.executor().run_until_parked();
817 cx.read(|cx| {
818 let tree = tree.read(cx);
819 assert_entry_git_state(tree, "a.xml", None, true);
820 assert_entry_git_state(tree, "b.txt", Some(GitFileStatus::Added), false);
821 });
822}
823
824#[gpui::test]
825async fn test_write_file(cx: &mut TestAppContext) {
826 init_test(cx);
827 cx.executor().allow_parking();
828 let dir = temp_tree(json!({
829 ".git": {},
830 ".gitignore": "ignored-dir\n",
831 "tracked-dir": {},
832 "ignored-dir": {}
833 }));
834
835 let tree = Worktree::local(
836 dir.path(),
837 true,
838 Arc::new(RealFs::default()),
839 Default::default(),
840 &mut cx.to_async(),
841 )
842 .await
843 .unwrap();
844
845 #[cfg(target_os = "linux")]
846 fs::watcher::global(|_| {}).unwrap();
847
848 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
849 .await;
850 tree.flush_fs_events(cx).await;
851
852 tree.update(cx, |tree, cx| {
853 tree.write_file(
854 Path::new("tracked-dir/file.txt"),
855 "hello".into(),
856 Default::default(),
857 cx,
858 )
859 })
860 .await
861 .unwrap();
862 tree.update(cx, |tree, cx| {
863 tree.write_file(
864 Path::new("ignored-dir/file.txt"),
865 "world".into(),
866 Default::default(),
867 cx,
868 )
869 })
870 .await
871 .unwrap();
872
873 tree.read_with(cx, |tree, _| {
874 let tracked = tree.entry_for_path("tracked-dir/file.txt").unwrap();
875 let ignored = tree.entry_for_path("ignored-dir/file.txt").unwrap();
876 assert!(!tracked.is_ignored);
877 assert!(ignored.is_ignored);
878 });
879}
880
881#[gpui::test]
882async fn test_file_scan_exclusions(cx: &mut TestAppContext) {
883 init_test(cx);
884 cx.executor().allow_parking();
885 let dir = temp_tree(json!({
886 ".gitignore": "**/target\n/node_modules\n",
887 "target": {
888 "index": "blah2"
889 },
890 "node_modules": {
891 ".DS_Store": "",
892 "prettier": {
893 "package.json": "{}",
894 },
895 },
896 "src": {
897 ".DS_Store": "",
898 "foo": {
899 "foo.rs": "mod another;\n",
900 "another.rs": "// another",
901 },
902 "bar": {
903 "bar.rs": "// bar",
904 },
905 "lib.rs": "mod foo;\nmod bar;\n",
906 },
907 ".DS_Store": "",
908 }));
909 cx.update(|cx| {
910 cx.update_global::<SettingsStore, _>(|store, cx| {
911 store.update_user_settings::<WorktreeSettings>(cx, |project_settings| {
912 project_settings.file_scan_exclusions =
913 Some(vec!["**/foo/**".to_string(), "**/.DS_Store".to_string()]);
914 });
915 });
916 });
917
918 let tree = Worktree::local(
919 dir.path(),
920 true,
921 Arc::new(RealFs::default()),
922 Default::default(),
923 &mut cx.to_async(),
924 )
925 .await
926 .unwrap();
927 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
928 .await;
929 tree.flush_fs_events(cx).await;
930 tree.read_with(cx, |tree, _| {
931 check_worktree_entries(
932 tree,
933 &[
934 "src/foo/foo.rs",
935 "src/foo/another.rs",
936 "node_modules/.DS_Store",
937 "src/.DS_Store",
938 ".DS_Store",
939 ],
940 &["target", "node_modules"],
941 &["src/lib.rs", "src/bar/bar.rs", ".gitignore"],
942 )
943 });
944
945 cx.update(|cx| {
946 cx.update_global::<SettingsStore, _>(|store, cx| {
947 store.update_user_settings::<WorktreeSettings>(cx, |project_settings| {
948 project_settings.file_scan_exclusions =
949 Some(vec!["**/node_modules/**".to_string()]);
950 });
951 });
952 });
953 tree.flush_fs_events(cx).await;
954 cx.executor().run_until_parked();
955 tree.read_with(cx, |tree, _| {
956 check_worktree_entries(
957 tree,
958 &[
959 "node_modules/prettier/package.json",
960 "node_modules/.DS_Store",
961 "node_modules",
962 ],
963 &["target"],
964 &[
965 ".gitignore",
966 "src/lib.rs",
967 "src/bar/bar.rs",
968 "src/foo/foo.rs",
969 "src/foo/another.rs",
970 "src/.DS_Store",
971 ".DS_Store",
972 ],
973 )
974 });
975}
976
977#[gpui::test]
978async fn test_fs_events_in_exclusions(cx: &mut TestAppContext) {
979 init_test(cx);
980 cx.executor().allow_parking();
981 let dir = temp_tree(json!({
982 ".git": {
983 "HEAD": "ref: refs/heads/main\n",
984 "foo": "bar",
985 },
986 ".gitignore": "**/target\n/node_modules\ntest_output\n",
987 "target": {
988 "index": "blah2"
989 },
990 "node_modules": {
991 ".DS_Store": "",
992 "prettier": {
993 "package.json": "{}",
994 },
995 },
996 "src": {
997 ".DS_Store": "",
998 "foo": {
999 "foo.rs": "mod another;\n",
1000 "another.rs": "// another",
1001 },
1002 "bar": {
1003 "bar.rs": "// bar",
1004 },
1005 "lib.rs": "mod foo;\nmod bar;\n",
1006 },
1007 ".DS_Store": "",
1008 }));
1009 cx.update(|cx| {
1010 cx.update_global::<SettingsStore, _>(|store, cx| {
1011 store.update_user_settings::<WorktreeSettings>(cx, |project_settings| {
1012 project_settings.file_scan_exclusions = Some(vec![
1013 "**/.git".to_string(),
1014 "node_modules/".to_string(),
1015 "build_output".to_string(),
1016 ]);
1017 });
1018 });
1019 });
1020
1021 let tree = Worktree::local(
1022 dir.path(),
1023 true,
1024 Arc::new(RealFs::default()),
1025 Default::default(),
1026 &mut cx.to_async(),
1027 )
1028 .await
1029 .unwrap();
1030 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
1031 .await;
1032 tree.flush_fs_events(cx).await;
1033 tree.read_with(cx, |tree, _| {
1034 check_worktree_entries(
1035 tree,
1036 &[
1037 ".git/HEAD",
1038 ".git/foo",
1039 "node_modules",
1040 "node_modules/.DS_Store",
1041 "node_modules/prettier",
1042 "node_modules/prettier/package.json",
1043 ],
1044 &["target"],
1045 &[
1046 ".DS_Store",
1047 "src/.DS_Store",
1048 "src/lib.rs",
1049 "src/foo/foo.rs",
1050 "src/foo/another.rs",
1051 "src/bar/bar.rs",
1052 ".gitignore",
1053 ],
1054 )
1055 });
1056
1057 let new_excluded_dir = dir.path().join("build_output");
1058 let new_ignored_dir = dir.path().join("test_output");
1059 std::fs::create_dir_all(&new_excluded_dir)
1060 .unwrap_or_else(|e| panic!("Failed to create a {new_excluded_dir:?} directory: {e}"));
1061 std::fs::create_dir_all(&new_ignored_dir)
1062 .unwrap_or_else(|e| panic!("Failed to create a {new_ignored_dir:?} directory: {e}"));
1063 let node_modules_dir = dir.path().join("node_modules");
1064 let dot_git_dir = dir.path().join(".git");
1065 let src_dir = dir.path().join("src");
1066 for existing_dir in [&node_modules_dir, &dot_git_dir, &src_dir] {
1067 assert!(
1068 existing_dir.is_dir(),
1069 "Expect {existing_dir:?} to be present in the FS already"
1070 );
1071 }
1072
1073 for directory_for_new_file in [
1074 new_excluded_dir,
1075 new_ignored_dir,
1076 node_modules_dir,
1077 dot_git_dir,
1078 src_dir,
1079 ] {
1080 std::fs::write(directory_for_new_file.join("new_file"), "new file contents")
1081 .unwrap_or_else(|e| {
1082 panic!("Failed to create in {directory_for_new_file:?} a new file: {e}")
1083 });
1084 }
1085 tree.flush_fs_events(cx).await;
1086
1087 tree.read_with(cx, |tree, _| {
1088 check_worktree_entries(
1089 tree,
1090 &[
1091 ".git/HEAD",
1092 ".git/foo",
1093 ".git/new_file",
1094 "node_modules",
1095 "node_modules/.DS_Store",
1096 "node_modules/prettier",
1097 "node_modules/prettier/package.json",
1098 "node_modules/new_file",
1099 "build_output",
1100 "build_output/new_file",
1101 "test_output/new_file",
1102 ],
1103 &["target", "test_output"],
1104 &[
1105 ".DS_Store",
1106 "src/.DS_Store",
1107 "src/lib.rs",
1108 "src/foo/foo.rs",
1109 "src/foo/another.rs",
1110 "src/bar/bar.rs",
1111 "src/new_file",
1112 ".gitignore",
1113 ],
1114 )
1115 });
1116}
1117
1118#[gpui::test]
1119async fn test_fs_events_in_dot_git_worktree(cx: &mut TestAppContext) {
1120 init_test(cx);
1121 cx.executor().allow_parking();
1122 let dir = temp_tree(json!({
1123 ".git": {
1124 "HEAD": "ref: refs/heads/main\n",
1125 "foo": "foo contents",
1126 },
1127 }));
1128 let dot_git_worktree_dir = dir.path().join(".git");
1129
1130 let tree = Worktree::local(
1131 dot_git_worktree_dir.clone(),
1132 true,
1133 Arc::new(RealFs::default()),
1134 Default::default(),
1135 &mut cx.to_async(),
1136 )
1137 .await
1138 .unwrap();
1139 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
1140 .await;
1141 tree.flush_fs_events(cx).await;
1142 tree.read_with(cx, |tree, _| {
1143 check_worktree_entries(tree, &[], &["HEAD", "foo"], &[])
1144 });
1145
1146 std::fs::write(dot_git_worktree_dir.join("new_file"), "new file contents")
1147 .unwrap_or_else(|e| panic!("Failed to create in {dot_git_worktree_dir:?} a new file: {e}"));
1148 tree.flush_fs_events(cx).await;
1149 tree.read_with(cx, |tree, _| {
1150 check_worktree_entries(tree, &[], &["HEAD", "foo", "new_file"], &[])
1151 });
1152}
1153
1154#[gpui::test(iterations = 30)]
1155async fn test_create_directory_during_initial_scan(cx: &mut TestAppContext) {
1156 init_test(cx);
1157 let fs = FakeFs::new(cx.background_executor.clone());
1158 fs.insert_tree(
1159 "/root",
1160 json!({
1161 "b": {},
1162 "c": {},
1163 "d": {},
1164 }),
1165 )
1166 .await;
1167
1168 let tree = Worktree::local(
1169 "/root".as_ref(),
1170 true,
1171 fs,
1172 Default::default(),
1173 &mut cx.to_async(),
1174 )
1175 .await
1176 .unwrap();
1177
1178 let snapshot1 = tree.update(cx, |tree, cx| {
1179 let tree = tree.as_local_mut().unwrap();
1180 let snapshot = Arc::new(Mutex::new(tree.snapshot()));
1181 tree.observe_updates(0, cx, {
1182 let snapshot = snapshot.clone();
1183 move |update| {
1184 snapshot.lock().apply_remote_update(update).unwrap();
1185 async { true }
1186 }
1187 });
1188 snapshot
1189 });
1190
1191 let entry = tree
1192 .update(cx, |tree, cx| {
1193 tree.as_local_mut()
1194 .unwrap()
1195 .create_entry("a/e".as_ref(), true, cx)
1196 })
1197 .await
1198 .unwrap()
1199 .to_included()
1200 .unwrap();
1201 assert!(entry.is_dir());
1202
1203 cx.executor().run_until_parked();
1204 tree.read_with(cx, |tree, _| {
1205 assert_eq!(tree.entry_for_path("a/e").unwrap().kind, EntryKind::Dir);
1206 });
1207
1208 let snapshot2 = tree.update(cx, |tree, _| tree.as_local().unwrap().snapshot());
1209 assert_eq!(
1210 snapshot1.lock().entries(true, 0).collect::<Vec<_>>(),
1211 snapshot2.entries(true, 0).collect::<Vec<_>>()
1212 );
1213}
1214
1215#[gpui::test]
1216async fn test_create_dir_all_on_create_entry(cx: &mut TestAppContext) {
1217 init_test(cx);
1218 cx.executor().allow_parking();
1219
1220 let fs_fake = FakeFs::new(cx.background_executor.clone());
1221 fs_fake
1222 .insert_tree(
1223 "/root",
1224 json!({
1225 "a": {},
1226 }),
1227 )
1228 .await;
1229
1230 let tree_fake = Worktree::local(
1231 "/root".as_ref(),
1232 true,
1233 fs_fake,
1234 Default::default(),
1235 &mut cx.to_async(),
1236 )
1237 .await
1238 .unwrap();
1239
1240 let entry = tree_fake
1241 .update(cx, |tree, cx| {
1242 tree.as_local_mut()
1243 .unwrap()
1244 .create_entry("a/b/c/d.txt".as_ref(), false, cx)
1245 })
1246 .await
1247 .unwrap()
1248 .to_included()
1249 .unwrap();
1250 assert!(entry.is_file());
1251
1252 cx.executor().run_until_parked();
1253 tree_fake.read_with(cx, |tree, _| {
1254 assert!(tree.entry_for_path("a/b/c/d.txt").unwrap().is_file());
1255 assert!(tree.entry_for_path("a/b/c/").unwrap().is_dir());
1256 assert!(tree.entry_for_path("a/b/").unwrap().is_dir());
1257 });
1258
1259 let fs_real = Arc::new(RealFs::default());
1260 let temp_root = temp_tree(json!({
1261 "a": {}
1262 }));
1263
1264 let tree_real = Worktree::local(
1265 temp_root.path(),
1266 true,
1267 fs_real,
1268 Default::default(),
1269 &mut cx.to_async(),
1270 )
1271 .await
1272 .unwrap();
1273
1274 let entry = tree_real
1275 .update(cx, |tree, cx| {
1276 tree.as_local_mut()
1277 .unwrap()
1278 .create_entry("a/b/c/d.txt".as_ref(), false, cx)
1279 })
1280 .await
1281 .unwrap()
1282 .to_included()
1283 .unwrap();
1284 assert!(entry.is_file());
1285
1286 cx.executor().run_until_parked();
1287 tree_real.read_with(cx, |tree, _| {
1288 assert!(tree.entry_for_path("a/b/c/d.txt").unwrap().is_file());
1289 assert!(tree.entry_for_path("a/b/c/").unwrap().is_dir());
1290 assert!(tree.entry_for_path("a/b/").unwrap().is_dir());
1291 });
1292
1293 // Test smallest change
1294 let entry = tree_real
1295 .update(cx, |tree, cx| {
1296 tree.as_local_mut()
1297 .unwrap()
1298 .create_entry("a/b/c/e.txt".as_ref(), false, cx)
1299 })
1300 .await
1301 .unwrap()
1302 .to_included()
1303 .unwrap();
1304 assert!(entry.is_file());
1305
1306 cx.executor().run_until_parked();
1307 tree_real.read_with(cx, |tree, _| {
1308 assert!(tree.entry_for_path("a/b/c/e.txt").unwrap().is_file());
1309 });
1310
1311 // Test largest change
1312 let entry = tree_real
1313 .update(cx, |tree, cx| {
1314 tree.as_local_mut()
1315 .unwrap()
1316 .create_entry("d/e/f/g.txt".as_ref(), false, cx)
1317 })
1318 .await
1319 .unwrap()
1320 .to_included()
1321 .unwrap();
1322 assert!(entry.is_file());
1323
1324 cx.executor().run_until_parked();
1325 tree_real.read_with(cx, |tree, _| {
1326 assert!(tree.entry_for_path("d/e/f/g.txt").unwrap().is_file());
1327 assert!(tree.entry_for_path("d/e/f").unwrap().is_dir());
1328 assert!(tree.entry_for_path("d/e/").unwrap().is_dir());
1329 assert!(tree.entry_for_path("d/").unwrap().is_dir());
1330 });
1331}
1332
1333#[gpui::test(iterations = 100)]
1334async fn test_random_worktree_operations_during_initial_scan(
1335 cx: &mut TestAppContext,
1336 mut rng: StdRng,
1337) {
1338 init_test(cx);
1339 let operations = env::var("OPERATIONS")
1340 .map(|o| o.parse().unwrap())
1341 .unwrap_or(5);
1342 let initial_entries = env::var("INITIAL_ENTRIES")
1343 .map(|o| o.parse().unwrap())
1344 .unwrap_or(20);
1345
1346 let root_dir = Path::new("/test");
1347 let fs = FakeFs::new(cx.background_executor.clone()) as Arc<dyn Fs>;
1348 fs.as_fake().insert_tree(root_dir, json!({})).await;
1349 for _ in 0..initial_entries {
1350 randomly_mutate_fs(&fs, root_dir, 1.0, &mut rng).await;
1351 }
1352 log::info!("generated initial tree");
1353
1354 let worktree = Worktree::local(
1355 root_dir,
1356 true,
1357 fs.clone(),
1358 Default::default(),
1359 &mut cx.to_async(),
1360 )
1361 .await
1362 .unwrap();
1363
1364 let mut snapshots = vec![worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot())];
1365 let updates = Arc::new(Mutex::new(Vec::new()));
1366 worktree.update(cx, |tree, cx| {
1367 check_worktree_change_events(tree, cx);
1368
1369 tree.as_local_mut().unwrap().observe_updates(0, cx, {
1370 let updates = updates.clone();
1371 move |update| {
1372 updates.lock().push(update);
1373 async { true }
1374 }
1375 });
1376 });
1377
1378 for _ in 0..operations {
1379 worktree
1380 .update(cx, |worktree, cx| {
1381 randomly_mutate_worktree(worktree, &mut rng, cx)
1382 })
1383 .await
1384 .log_err();
1385 worktree.read_with(cx, |tree, _| {
1386 tree.as_local().unwrap().snapshot().check_invariants(true)
1387 });
1388
1389 if rng.gen_bool(0.6) {
1390 snapshots.push(worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot()));
1391 }
1392 }
1393
1394 worktree
1395 .update(cx, |tree, _| tree.as_local_mut().unwrap().scan_complete())
1396 .await;
1397
1398 cx.executor().run_until_parked();
1399
1400 let final_snapshot = worktree.read_with(cx, |tree, _| {
1401 let tree = tree.as_local().unwrap();
1402 let snapshot = tree.snapshot();
1403 snapshot.check_invariants(true);
1404 snapshot
1405 });
1406
1407 for (i, snapshot) in snapshots.into_iter().enumerate().rev() {
1408 let mut updated_snapshot = snapshot.clone();
1409 for update in updates.lock().iter() {
1410 if update.scan_id >= updated_snapshot.scan_id() as u64 {
1411 updated_snapshot
1412 .apply_remote_update(update.clone())
1413 .unwrap();
1414 }
1415 }
1416
1417 assert_eq!(
1418 updated_snapshot.entries(true, 0).collect::<Vec<_>>(),
1419 final_snapshot.entries(true, 0).collect::<Vec<_>>(),
1420 "wrong updates after snapshot {i}: {snapshot:#?} {updates:#?}",
1421 );
1422 }
1423}
1424
1425#[gpui::test(iterations = 100)]
1426async fn test_random_worktree_changes(cx: &mut TestAppContext, mut rng: StdRng) {
1427 init_test(cx);
1428 let operations = env::var("OPERATIONS")
1429 .map(|o| o.parse().unwrap())
1430 .unwrap_or(40);
1431 let initial_entries = env::var("INITIAL_ENTRIES")
1432 .map(|o| o.parse().unwrap())
1433 .unwrap_or(20);
1434
1435 let root_dir = Path::new("/test");
1436 let fs = FakeFs::new(cx.background_executor.clone()) as Arc<dyn Fs>;
1437 fs.as_fake().insert_tree(root_dir, json!({})).await;
1438 for _ in 0..initial_entries {
1439 randomly_mutate_fs(&fs, root_dir, 1.0, &mut rng).await;
1440 }
1441 log::info!("generated initial tree");
1442
1443 let worktree = Worktree::local(
1444 root_dir,
1445 true,
1446 fs.clone(),
1447 Default::default(),
1448 &mut cx.to_async(),
1449 )
1450 .await
1451 .unwrap();
1452
1453 let updates = Arc::new(Mutex::new(Vec::new()));
1454 worktree.update(cx, |tree, cx| {
1455 check_worktree_change_events(tree, cx);
1456
1457 tree.as_local_mut().unwrap().observe_updates(0, cx, {
1458 let updates = updates.clone();
1459 move |update| {
1460 updates.lock().push(update);
1461 async { true }
1462 }
1463 });
1464 });
1465
1466 worktree
1467 .update(cx, |tree, _| tree.as_local_mut().unwrap().scan_complete())
1468 .await;
1469
1470 fs.as_fake().pause_events();
1471 let mut snapshots = Vec::new();
1472 let mut mutations_len = operations;
1473 while mutations_len > 1 {
1474 if rng.gen_bool(0.2) {
1475 worktree
1476 .update(cx, |worktree, cx| {
1477 randomly_mutate_worktree(worktree, &mut rng, cx)
1478 })
1479 .await
1480 .log_err();
1481 } else {
1482 randomly_mutate_fs(&fs, root_dir, 1.0, &mut rng).await;
1483 }
1484
1485 let buffered_event_count = fs.as_fake().buffered_event_count();
1486 if buffered_event_count > 0 && rng.gen_bool(0.3) {
1487 let len = rng.gen_range(0..=buffered_event_count);
1488 log::info!("flushing {} events", len);
1489 fs.as_fake().flush_events(len);
1490 } else {
1491 randomly_mutate_fs(&fs, root_dir, 0.6, &mut rng).await;
1492 mutations_len -= 1;
1493 }
1494
1495 cx.executor().run_until_parked();
1496 if rng.gen_bool(0.2) {
1497 log::info!("storing snapshot {}", snapshots.len());
1498 let snapshot = worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot());
1499 snapshots.push(snapshot);
1500 }
1501 }
1502
1503 log::info!("quiescing");
1504 fs.as_fake().flush_events(usize::MAX);
1505 cx.executor().run_until_parked();
1506
1507 let snapshot = worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot());
1508 snapshot.check_invariants(true);
1509 let expanded_paths = snapshot
1510 .expanded_entries()
1511 .map(|e| e.path.clone())
1512 .collect::<Vec<_>>();
1513
1514 {
1515 let new_worktree = Worktree::local(
1516 root_dir,
1517 true,
1518 fs.clone(),
1519 Default::default(),
1520 &mut cx.to_async(),
1521 )
1522 .await
1523 .unwrap();
1524 new_worktree
1525 .update(cx, |tree, _| tree.as_local_mut().unwrap().scan_complete())
1526 .await;
1527 new_worktree
1528 .update(cx, |tree, _| {
1529 tree.as_local_mut()
1530 .unwrap()
1531 .refresh_entries_for_paths(expanded_paths)
1532 })
1533 .recv()
1534 .await;
1535 let new_snapshot =
1536 new_worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot());
1537 assert_eq!(
1538 snapshot.entries_without_ids(true),
1539 new_snapshot.entries_without_ids(true)
1540 );
1541 }
1542
1543 for (i, mut prev_snapshot) in snapshots.into_iter().enumerate().rev() {
1544 for update in updates.lock().iter() {
1545 if update.scan_id >= prev_snapshot.scan_id() as u64 {
1546 prev_snapshot.apply_remote_update(update.clone()).unwrap();
1547 }
1548 }
1549
1550 assert_eq!(
1551 prev_snapshot
1552 .entries(true, 0)
1553 .map(ignore_pending_dir)
1554 .collect::<Vec<_>>(),
1555 snapshot
1556 .entries(true, 0)
1557 .map(ignore_pending_dir)
1558 .collect::<Vec<_>>(),
1559 "wrong updates after snapshot {i}: {updates:#?}",
1560 );
1561 }
1562
1563 fn ignore_pending_dir(entry: &Entry) -> Entry {
1564 let mut entry = entry.clone();
1565 if entry.kind.is_dir() {
1566 entry.kind = EntryKind::Dir
1567 }
1568 entry
1569 }
1570}
1571
1572// The worktree's `UpdatedEntries` event can be used to follow along with
1573// all changes to the worktree's snapshot.
1574fn check_worktree_change_events(tree: &mut Worktree, cx: &mut ModelContext<Worktree>) {
1575 let mut entries = tree.entries(true, 0).cloned().collect::<Vec<_>>();
1576 cx.subscribe(&cx.handle(), move |tree, _, event, _| {
1577 if let Event::UpdatedEntries(changes) = event {
1578 for (path, _, change_type) in changes.iter() {
1579 let entry = tree.entry_for_path(&path).cloned();
1580 let ix = match entries.binary_search_by_key(&path, |e| &e.path) {
1581 Ok(ix) | Err(ix) => ix,
1582 };
1583 match change_type {
1584 PathChange::Added => entries.insert(ix, entry.unwrap()),
1585 PathChange::Removed => drop(entries.remove(ix)),
1586 PathChange::Updated => {
1587 let entry = entry.unwrap();
1588 let existing_entry = entries.get_mut(ix).unwrap();
1589 assert_eq!(existing_entry.path, entry.path);
1590 *existing_entry = entry;
1591 }
1592 PathChange::AddedOrUpdated | PathChange::Loaded => {
1593 let entry = entry.unwrap();
1594 if entries.get(ix).map(|e| &e.path) == Some(&entry.path) {
1595 *entries.get_mut(ix).unwrap() = entry;
1596 } else {
1597 entries.insert(ix, entry);
1598 }
1599 }
1600 }
1601 }
1602
1603 let new_entries = tree.entries(true, 0).cloned().collect::<Vec<_>>();
1604 assert_eq!(entries, new_entries, "incorrect changes: {:?}", changes);
1605 }
1606 })
1607 .detach();
1608}
1609
1610fn randomly_mutate_worktree(
1611 worktree: &mut Worktree,
1612 rng: &mut impl Rng,
1613 cx: &mut ModelContext<Worktree>,
1614) -> Task<Result<()>> {
1615 log::info!("mutating worktree");
1616 let worktree = worktree.as_local_mut().unwrap();
1617 let snapshot = worktree.snapshot();
1618 let entry = snapshot.entries(false, 0).choose(rng).unwrap();
1619
1620 match rng.gen_range(0_u32..100) {
1621 0..=33 if entry.path.as_ref() != Path::new("") => {
1622 log::info!("deleting entry {:?} ({})", entry.path, entry.id.0);
1623 worktree.delete_entry(entry.id, false, cx).unwrap()
1624 }
1625 ..=66 if entry.path.as_ref() != Path::new("") => {
1626 let other_entry = snapshot.entries(false, 0).choose(rng).unwrap();
1627 let new_parent_path = if other_entry.is_dir() {
1628 other_entry.path.clone()
1629 } else {
1630 other_entry.path.parent().unwrap().into()
1631 };
1632 let mut new_path = new_parent_path.join(random_filename(rng));
1633 if new_path.starts_with(&entry.path) {
1634 new_path = random_filename(rng).into();
1635 }
1636
1637 log::info!(
1638 "renaming entry {:?} ({}) to {:?}",
1639 entry.path,
1640 entry.id.0,
1641 new_path
1642 );
1643 let task = worktree.rename_entry(entry.id, new_path, cx);
1644 cx.background_executor().spawn(async move {
1645 task.await?.to_included().unwrap();
1646 Ok(())
1647 })
1648 }
1649 _ => {
1650 if entry.is_dir() {
1651 let child_path = entry.path.join(random_filename(rng));
1652 let is_dir = rng.gen_bool(0.3);
1653 log::info!(
1654 "creating {} at {:?}",
1655 if is_dir { "dir" } else { "file" },
1656 child_path,
1657 );
1658 let task = worktree.create_entry(child_path, is_dir, cx);
1659 cx.background_executor().spawn(async move {
1660 task.await?;
1661 Ok(())
1662 })
1663 } else {
1664 log::info!("overwriting file {:?} ({})", entry.path, entry.id.0);
1665 let task =
1666 worktree.write_file(entry.path.clone(), "".into(), Default::default(), cx);
1667 cx.background_executor().spawn(async move {
1668 task.await?;
1669 Ok(())
1670 })
1671 }
1672 }
1673 }
1674}
1675
1676async fn randomly_mutate_fs(
1677 fs: &Arc<dyn Fs>,
1678 root_path: &Path,
1679 insertion_probability: f64,
1680 rng: &mut impl Rng,
1681) {
1682 log::info!("mutating fs");
1683 let mut files = Vec::new();
1684 let mut dirs = Vec::new();
1685 for path in fs.as_fake().paths(false) {
1686 if path.starts_with(root_path) {
1687 if fs.is_file(&path).await {
1688 files.push(path);
1689 } else {
1690 dirs.push(path);
1691 }
1692 }
1693 }
1694
1695 if (files.is_empty() && dirs.len() == 1) || rng.gen_bool(insertion_probability) {
1696 let path = dirs.choose(rng).unwrap();
1697 let new_path = path.join(random_filename(rng));
1698
1699 if rng.gen() {
1700 log::info!(
1701 "creating dir {:?}",
1702 new_path.strip_prefix(root_path).unwrap()
1703 );
1704 fs.create_dir(&new_path).await.unwrap();
1705 } else {
1706 log::info!(
1707 "creating file {:?}",
1708 new_path.strip_prefix(root_path).unwrap()
1709 );
1710 fs.create_file(&new_path, Default::default()).await.unwrap();
1711 }
1712 } else if rng.gen_bool(0.05) {
1713 let ignore_dir_path = dirs.choose(rng).unwrap();
1714 let ignore_path = ignore_dir_path.join(&*GITIGNORE);
1715
1716 let subdirs = dirs
1717 .iter()
1718 .filter(|d| d.starts_with(&ignore_dir_path))
1719 .cloned()
1720 .collect::<Vec<_>>();
1721 let subfiles = files
1722 .iter()
1723 .filter(|d| d.starts_with(&ignore_dir_path))
1724 .cloned()
1725 .collect::<Vec<_>>();
1726 let files_to_ignore = {
1727 let len = rng.gen_range(0..=subfiles.len());
1728 subfiles.choose_multiple(rng, len)
1729 };
1730 let dirs_to_ignore = {
1731 let len = rng.gen_range(0..subdirs.len());
1732 subdirs.choose_multiple(rng, len)
1733 };
1734
1735 let mut ignore_contents = String::new();
1736 for path_to_ignore in files_to_ignore.chain(dirs_to_ignore) {
1737 writeln!(
1738 ignore_contents,
1739 "{}",
1740 path_to_ignore
1741 .strip_prefix(&ignore_dir_path)
1742 .unwrap()
1743 .to_str()
1744 .unwrap()
1745 )
1746 .unwrap();
1747 }
1748 log::info!(
1749 "creating gitignore {:?} with contents:\n{}",
1750 ignore_path.strip_prefix(&root_path).unwrap(),
1751 ignore_contents
1752 );
1753 fs.save(
1754 &ignore_path,
1755 &ignore_contents.as_str().into(),
1756 Default::default(),
1757 )
1758 .await
1759 .unwrap();
1760 } else {
1761 let old_path = {
1762 let file_path = files.choose(rng);
1763 let dir_path = dirs[1..].choose(rng);
1764 file_path.into_iter().chain(dir_path).choose(rng).unwrap()
1765 };
1766
1767 let is_rename = rng.gen();
1768 if is_rename {
1769 let new_path_parent = dirs
1770 .iter()
1771 .filter(|d| !d.starts_with(old_path))
1772 .choose(rng)
1773 .unwrap();
1774
1775 let overwrite_existing_dir =
1776 !old_path.starts_with(&new_path_parent) && rng.gen_bool(0.3);
1777 let new_path = if overwrite_existing_dir {
1778 fs.remove_dir(
1779 &new_path_parent,
1780 RemoveOptions {
1781 recursive: true,
1782 ignore_if_not_exists: true,
1783 },
1784 )
1785 .await
1786 .unwrap();
1787 new_path_parent.to_path_buf()
1788 } else {
1789 new_path_parent.join(random_filename(rng))
1790 };
1791
1792 log::info!(
1793 "renaming {:?} to {}{:?}",
1794 old_path.strip_prefix(&root_path).unwrap(),
1795 if overwrite_existing_dir {
1796 "overwrite "
1797 } else {
1798 ""
1799 },
1800 new_path.strip_prefix(&root_path).unwrap()
1801 );
1802 fs.rename(
1803 &old_path,
1804 &new_path,
1805 fs::RenameOptions {
1806 overwrite: true,
1807 ignore_if_exists: true,
1808 },
1809 )
1810 .await
1811 .unwrap();
1812 } else if fs.is_file(&old_path).await {
1813 log::info!(
1814 "deleting file {:?}",
1815 old_path.strip_prefix(&root_path).unwrap()
1816 );
1817 fs.remove_file(old_path, Default::default()).await.unwrap();
1818 } else {
1819 log::info!(
1820 "deleting dir {:?}",
1821 old_path.strip_prefix(&root_path).unwrap()
1822 );
1823 fs.remove_dir(
1824 &old_path,
1825 RemoveOptions {
1826 recursive: true,
1827 ignore_if_not_exists: true,
1828 },
1829 )
1830 .await
1831 .unwrap();
1832 }
1833 }
1834}
1835
1836fn random_filename(rng: &mut impl Rng) -> String {
1837 (0..6)
1838 .map(|_| rng.sample(rand::distributions::Alphanumeric))
1839 .map(char::from)
1840 .collect()
1841}
1842
1843#[gpui::test]
1844async fn test_rename_work_directory(cx: &mut TestAppContext) {
1845 init_test(cx);
1846 cx.executor().allow_parking();
1847 let root = temp_tree(json!({
1848 "projects": {
1849 "project1": {
1850 "a": "",
1851 "b": "",
1852 }
1853 },
1854
1855 }));
1856 let root_path = root.path();
1857
1858 let tree = Worktree::local(
1859 root_path,
1860 true,
1861 Arc::new(RealFs::default()),
1862 Default::default(),
1863 &mut cx.to_async(),
1864 )
1865 .await
1866 .unwrap();
1867
1868 let repo = git_init(&root_path.join("projects/project1"));
1869 git_add("a", &repo);
1870 git_commit("init", &repo);
1871 std::fs::write(root_path.join("projects/project1/a"), "aa").ok();
1872
1873 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
1874 .await;
1875
1876 tree.flush_fs_events(cx).await;
1877
1878 cx.read(|cx| {
1879 let tree = tree.read(cx);
1880 let (work_dir, _) = tree.repositories().next().unwrap();
1881 assert_eq!(work_dir.as_ref(), Path::new("projects/project1"));
1882 assert_eq!(
1883 tree.status_for_file(Path::new("projects/project1/a")),
1884 Some(GitFileStatus::Modified)
1885 );
1886 assert_eq!(
1887 tree.status_for_file(Path::new("projects/project1/b")),
1888 Some(GitFileStatus::Added)
1889 );
1890 });
1891
1892 std::fs::rename(
1893 root_path.join("projects/project1"),
1894 root_path.join("projects/project2"),
1895 )
1896 .ok();
1897 tree.flush_fs_events(cx).await;
1898
1899 cx.read(|cx| {
1900 let tree = tree.read(cx);
1901 let (work_dir, _) = tree.repositories().next().unwrap();
1902 assert_eq!(work_dir.as_ref(), Path::new("projects/project2"));
1903 assert_eq!(
1904 tree.status_for_file(Path::new("projects/project2/a")),
1905 Some(GitFileStatus::Modified)
1906 );
1907 assert_eq!(
1908 tree.status_for_file(Path::new("projects/project2/b")),
1909 Some(GitFileStatus::Added)
1910 );
1911 });
1912}
1913
1914#[gpui::test]
1915async fn test_git_repository_for_path(cx: &mut TestAppContext) {
1916 init_test(cx);
1917 cx.executor().allow_parking();
1918 let root = temp_tree(json!({
1919 "c.txt": "",
1920 "dir1": {
1921 ".git": {},
1922 "deps": {
1923 "dep1": {
1924 ".git": {},
1925 "src": {
1926 "a.txt": ""
1927 }
1928 }
1929 },
1930 "src": {
1931 "b.txt": ""
1932 }
1933 },
1934 }));
1935
1936 let tree = Worktree::local(
1937 root.path(),
1938 true,
1939 Arc::new(RealFs::default()),
1940 Default::default(),
1941 &mut cx.to_async(),
1942 )
1943 .await
1944 .unwrap();
1945
1946 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
1947 .await;
1948 tree.flush_fs_events(cx).await;
1949
1950 tree.read_with(cx, |tree, _cx| {
1951 let tree = tree.as_local().unwrap();
1952
1953 assert!(tree.repository_for_path("c.txt".as_ref()).is_none());
1954
1955 let entry = tree.repository_for_path("dir1/src/b.txt".as_ref()).unwrap();
1956 assert_eq!(
1957 entry
1958 .work_directory(tree)
1959 .map(|directory| directory.as_ref().to_owned()),
1960 Some(Path::new("dir1").to_owned())
1961 );
1962
1963 let entry = tree
1964 .repository_for_path("dir1/deps/dep1/src/a.txt".as_ref())
1965 .unwrap();
1966 assert_eq!(
1967 entry
1968 .work_directory(tree)
1969 .map(|directory| directory.as_ref().to_owned()),
1970 Some(Path::new("dir1/deps/dep1").to_owned())
1971 );
1972
1973 let entries = tree.files(false, 0);
1974
1975 let paths_with_repos = tree
1976 .entries_with_repositories(entries)
1977 .map(|(entry, repo)| {
1978 (
1979 entry.path.as_ref(),
1980 repo.and_then(|repo| {
1981 repo.work_directory(&tree)
1982 .map(|work_directory| work_directory.0.to_path_buf())
1983 }),
1984 )
1985 })
1986 .collect::<Vec<_>>();
1987
1988 assert_eq!(
1989 paths_with_repos,
1990 &[
1991 (Path::new("c.txt"), None),
1992 (
1993 Path::new("dir1/deps/dep1/src/a.txt"),
1994 Some(Path::new("dir1/deps/dep1").into())
1995 ),
1996 (Path::new("dir1/src/b.txt"), Some(Path::new("dir1").into())),
1997 ]
1998 );
1999 });
2000
2001 let repo_update_events = Arc::new(Mutex::new(vec![]));
2002 tree.update(cx, |_, cx| {
2003 let repo_update_events = repo_update_events.clone();
2004 cx.subscribe(&tree, move |_, _, event, _| {
2005 if let Event::UpdatedGitRepositories(update) = event {
2006 repo_update_events.lock().push(update.clone());
2007 }
2008 })
2009 .detach();
2010 });
2011
2012 std::fs::write(root.path().join("dir1/.git/random_new_file"), "hello").unwrap();
2013 tree.flush_fs_events(cx).await;
2014
2015 assert_eq!(
2016 repo_update_events.lock()[0]
2017 .iter()
2018 .map(|e| e.0.clone())
2019 .collect::<Vec<Arc<Path>>>(),
2020 vec![Path::new("dir1").into()]
2021 );
2022
2023 std::fs::remove_dir_all(root.path().join("dir1/.git")).unwrap();
2024 tree.flush_fs_events(cx).await;
2025
2026 tree.read_with(cx, |tree, _cx| {
2027 let tree = tree.as_local().unwrap();
2028
2029 assert!(tree
2030 .repository_for_path("dir1/src/b.txt".as_ref())
2031 .is_none());
2032 });
2033}
2034
2035#[gpui::test]
2036async fn test_git_status(cx: &mut TestAppContext) {
2037 init_test(cx);
2038 cx.executor().allow_parking();
2039 const IGNORE_RULE: &str = "**/target";
2040
2041 let root = temp_tree(json!({
2042 "project": {
2043 "a.txt": "a",
2044 "b.txt": "bb",
2045 "c": {
2046 "d": {
2047 "e.txt": "eee"
2048 }
2049 },
2050 "f.txt": "ffff",
2051 "target": {
2052 "build_file": "???"
2053 },
2054 ".gitignore": IGNORE_RULE
2055 },
2056
2057 }));
2058
2059 const A_TXT: &str = "a.txt";
2060 const B_TXT: &str = "b.txt";
2061 const E_TXT: &str = "c/d/e.txt";
2062 const F_TXT: &str = "f.txt";
2063 const DOTGITIGNORE: &str = ".gitignore";
2064 const BUILD_FILE: &str = "target/build_file";
2065 let project_path = Path::new("project");
2066
2067 // Set up git repository before creating the worktree.
2068 let work_dir = root.path().join("project");
2069 let mut repo = git_init(work_dir.as_path());
2070 repo.add_ignore_rule(IGNORE_RULE).unwrap();
2071 git_add(A_TXT, &repo);
2072 git_add(E_TXT, &repo);
2073 git_add(DOTGITIGNORE, &repo);
2074 git_commit("Initial commit", &repo);
2075
2076 let tree = Worktree::local(
2077 root.path(),
2078 true,
2079 Arc::new(RealFs::default()),
2080 Default::default(),
2081 &mut cx.to_async(),
2082 )
2083 .await
2084 .unwrap();
2085
2086 tree.flush_fs_events(cx).await;
2087 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
2088 .await;
2089 cx.executor().run_until_parked();
2090
2091 // Check that the right git state is observed on startup
2092 tree.read_with(cx, |tree, _cx| {
2093 let snapshot = tree.snapshot();
2094 assert_eq!(snapshot.repositories().count(), 1);
2095 let (dir, repo_entry) = snapshot.repositories().next().unwrap();
2096 assert_eq!(dir.as_ref(), Path::new("project"));
2097 assert!(repo_entry.location_in_repo.is_none());
2098
2099 assert_eq!(
2100 snapshot.status_for_file(project_path.join(B_TXT)),
2101 Some(GitFileStatus::Added)
2102 );
2103 assert_eq!(
2104 snapshot.status_for_file(project_path.join(F_TXT)),
2105 Some(GitFileStatus::Added)
2106 );
2107 });
2108
2109 // Modify a file in the working copy.
2110 std::fs::write(work_dir.join(A_TXT), "aa").unwrap();
2111 tree.flush_fs_events(cx).await;
2112 cx.executor().run_until_parked();
2113
2114 // The worktree detects that the file's git status has changed.
2115 tree.read_with(cx, |tree, _cx| {
2116 let snapshot = tree.snapshot();
2117 assert_eq!(
2118 snapshot.status_for_file(project_path.join(A_TXT)),
2119 Some(GitFileStatus::Modified)
2120 );
2121 });
2122
2123 // Create a commit in the git repository.
2124 git_add(A_TXT, &repo);
2125 git_add(B_TXT, &repo);
2126 git_commit("Committing modified and added", &repo);
2127 tree.flush_fs_events(cx).await;
2128 cx.executor().run_until_parked();
2129
2130 // The worktree detects that the files' git status have changed.
2131 tree.read_with(cx, |tree, _cx| {
2132 let snapshot = tree.snapshot();
2133 assert_eq!(
2134 snapshot.status_for_file(project_path.join(F_TXT)),
2135 Some(GitFileStatus::Added)
2136 );
2137 assert_eq!(snapshot.status_for_file(project_path.join(B_TXT)), None);
2138 assert_eq!(snapshot.status_for_file(project_path.join(A_TXT)), None);
2139 });
2140
2141 // Modify files in the working copy and perform git operations on other files.
2142 git_reset(0, &repo);
2143 git_remove_index(Path::new(B_TXT), &repo);
2144 git_stash(&mut repo);
2145 std::fs::write(work_dir.join(E_TXT), "eeee").unwrap();
2146 std::fs::write(work_dir.join(BUILD_FILE), "this should be ignored").unwrap();
2147 tree.flush_fs_events(cx).await;
2148 cx.executor().run_until_parked();
2149
2150 // Check that more complex repo changes are tracked
2151 tree.read_with(cx, |tree, _cx| {
2152 let snapshot = tree.snapshot();
2153
2154 assert_eq!(snapshot.status_for_file(project_path.join(A_TXT)), None);
2155 assert_eq!(
2156 snapshot.status_for_file(project_path.join(B_TXT)),
2157 Some(GitFileStatus::Added)
2158 );
2159 assert_eq!(
2160 snapshot.status_for_file(project_path.join(E_TXT)),
2161 Some(GitFileStatus::Modified)
2162 );
2163 });
2164
2165 std::fs::remove_file(work_dir.join(B_TXT)).unwrap();
2166 std::fs::remove_dir_all(work_dir.join("c")).unwrap();
2167 std::fs::write(
2168 work_dir.join(DOTGITIGNORE),
2169 [IGNORE_RULE, "f.txt"].join("\n"),
2170 )
2171 .unwrap();
2172
2173 git_add(Path::new(DOTGITIGNORE), &repo);
2174 git_commit("Committing modified git ignore", &repo);
2175
2176 tree.flush_fs_events(cx).await;
2177 cx.executor().run_until_parked();
2178
2179 let mut renamed_dir_name = "first_directory/second_directory";
2180 const RENAMED_FILE: &str = "rf.txt";
2181
2182 std::fs::create_dir_all(work_dir.join(renamed_dir_name)).unwrap();
2183 std::fs::write(
2184 work_dir.join(renamed_dir_name).join(RENAMED_FILE),
2185 "new-contents",
2186 )
2187 .unwrap();
2188
2189 tree.flush_fs_events(cx).await;
2190 cx.executor().run_until_parked();
2191
2192 tree.read_with(cx, |tree, _cx| {
2193 let snapshot = tree.snapshot();
2194 assert_eq!(
2195 snapshot.status_for_file(&project_path.join(renamed_dir_name).join(RENAMED_FILE)),
2196 Some(GitFileStatus::Added)
2197 );
2198 });
2199
2200 renamed_dir_name = "new_first_directory/second_directory";
2201
2202 std::fs::rename(
2203 work_dir.join("first_directory"),
2204 work_dir.join("new_first_directory"),
2205 )
2206 .unwrap();
2207
2208 tree.flush_fs_events(cx).await;
2209 cx.executor().run_until_parked();
2210
2211 tree.read_with(cx, |tree, _cx| {
2212 let snapshot = tree.snapshot();
2213
2214 assert_eq!(
2215 snapshot.status_for_file(
2216 project_path
2217 .join(Path::new(renamed_dir_name))
2218 .join(RENAMED_FILE)
2219 ),
2220 Some(GitFileStatus::Added)
2221 );
2222 });
2223}
2224
2225#[gpui::test]
2226async fn test_repository_subfolder_git_status(cx: &mut TestAppContext) {
2227 init_test(cx);
2228 cx.executor().allow_parking();
2229
2230 let root = temp_tree(json!({
2231 "my-repo": {
2232 // .git folder will go here
2233 "a.txt": "a",
2234 "sub-folder-1": {
2235 "sub-folder-2": {
2236 "c.txt": "cc",
2237 "d": {
2238 "e.txt": "eee"
2239 }
2240 },
2241 }
2242 },
2243
2244 }));
2245
2246 const C_TXT: &str = "sub-folder-1/sub-folder-2/c.txt";
2247 const E_TXT: &str = "sub-folder-1/sub-folder-2/d/e.txt";
2248
2249 // Set up git repository before creating the worktree.
2250 let git_repo_work_dir = root.path().join("my-repo");
2251 let repo = git_init(git_repo_work_dir.as_path());
2252 git_add(C_TXT, &repo);
2253 git_commit("Initial commit", &repo);
2254
2255 // Open the worktree in subfolder
2256 let project_root = Path::new("my-repo/sub-folder-1/sub-folder-2");
2257 let tree = Worktree::local(
2258 root.path().join(project_root),
2259 true,
2260 Arc::new(RealFs::default()),
2261 Default::default(),
2262 &mut cx.to_async(),
2263 )
2264 .await
2265 .unwrap();
2266
2267 tree.flush_fs_events(cx).await;
2268 tree.flush_fs_events_in_root_git_repository(cx).await;
2269 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
2270 .await;
2271 cx.executor().run_until_parked();
2272
2273 // Ensure that the git status is loaded correctly
2274 tree.read_with(cx, |tree, _cx| {
2275 let snapshot = tree.snapshot();
2276 assert_eq!(snapshot.repositories().count(), 1);
2277 let (dir, repo_entry) = snapshot.repositories().next().unwrap();
2278 // Path is blank because the working directory of
2279 // the git repository is located at the root of the project
2280 assert_eq!(dir.as_ref(), Path::new(""));
2281
2282 // This is the missing path between the root of the project (sub-folder-2) and its
2283 // location relative to the root of the repository.
2284 assert_eq!(
2285 repo_entry.location_in_repo,
2286 Some(Arc::from(Path::new("sub-folder-1/sub-folder-2")))
2287 );
2288
2289 assert_eq!(snapshot.status_for_file("c.txt"), None);
2290 assert_eq!(
2291 snapshot.status_for_file("d/e.txt"),
2292 Some(GitFileStatus::Added)
2293 );
2294 });
2295
2296 // Now we simulate FS events, but ONLY in the .git folder that's outside
2297 // of out project root.
2298 // Meaning: we don't produce any FS events for files inside the project.
2299 git_add(E_TXT, &repo);
2300 git_commit("Second commit", &repo);
2301 tree.flush_fs_events_in_root_git_repository(cx).await;
2302 cx.executor().run_until_parked();
2303
2304 tree.read_with(cx, |tree, _cx| {
2305 let snapshot = tree.snapshot();
2306
2307 assert!(snapshot.repositories().next().is_some());
2308
2309 assert_eq!(snapshot.status_for_file("c.txt"), None);
2310 assert_eq!(snapshot.status_for_file("d/e.txt"), None);
2311 });
2312}
2313
2314#[gpui::test]
2315async fn test_propagate_git_statuses(cx: &mut TestAppContext) {
2316 init_test(cx);
2317 let fs = FakeFs::new(cx.background_executor.clone());
2318 fs.insert_tree(
2319 "/root",
2320 json!({
2321 ".git": {},
2322 "a": {
2323 "b": {
2324 "c1.txt": "",
2325 "c2.txt": "",
2326 },
2327 "d": {
2328 "e1.txt": "",
2329 "e2.txt": "",
2330 "e3.txt": "",
2331 }
2332 },
2333 "f": {
2334 "no-status.txt": ""
2335 },
2336 "g": {
2337 "h1.txt": "",
2338 "h2.txt": ""
2339 },
2340
2341 }),
2342 )
2343 .await;
2344
2345 fs.set_status_for_repo_via_git_operation(
2346 &Path::new("/root/.git"),
2347 &[
2348 (Path::new("a/b/c1.txt"), GitFileStatus::Added),
2349 (Path::new("a/d/e2.txt"), GitFileStatus::Modified),
2350 (Path::new("g/h2.txt"), GitFileStatus::Conflict),
2351 ],
2352 );
2353
2354 let tree = Worktree::local(
2355 Path::new("/root"),
2356 true,
2357 fs.clone(),
2358 Default::default(),
2359 &mut cx.to_async(),
2360 )
2361 .await
2362 .unwrap();
2363
2364 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
2365 .await;
2366
2367 cx.executor().run_until_parked();
2368 let snapshot = tree.read_with(cx, |tree, _| tree.snapshot());
2369
2370 check_propagated_statuses(
2371 &snapshot,
2372 &[
2373 (Path::new(""), Some(GitFileStatus::Conflict)),
2374 (Path::new("a"), Some(GitFileStatus::Modified)),
2375 (Path::new("a/b"), Some(GitFileStatus::Added)),
2376 (Path::new("a/b/c1.txt"), Some(GitFileStatus::Added)),
2377 (Path::new("a/b/c2.txt"), None),
2378 (Path::new("a/d"), Some(GitFileStatus::Modified)),
2379 (Path::new("a/d/e2.txt"), Some(GitFileStatus::Modified)),
2380 (Path::new("f"), None),
2381 (Path::new("f/no-status.txt"), None),
2382 (Path::new("g"), Some(GitFileStatus::Conflict)),
2383 (Path::new("g/h2.txt"), Some(GitFileStatus::Conflict)),
2384 ],
2385 );
2386
2387 check_propagated_statuses(
2388 &snapshot,
2389 &[
2390 (Path::new("a/b"), Some(GitFileStatus::Added)),
2391 (Path::new("a/b/c1.txt"), Some(GitFileStatus::Added)),
2392 (Path::new("a/b/c2.txt"), None),
2393 (Path::new("a/d"), Some(GitFileStatus::Modified)),
2394 (Path::new("a/d/e1.txt"), None),
2395 (Path::new("a/d/e2.txt"), Some(GitFileStatus::Modified)),
2396 (Path::new("f"), None),
2397 (Path::new("f/no-status.txt"), None),
2398 (Path::new("g"), Some(GitFileStatus::Conflict)),
2399 ],
2400 );
2401
2402 check_propagated_statuses(
2403 &snapshot,
2404 &[
2405 (Path::new("a/b/c1.txt"), Some(GitFileStatus::Added)),
2406 (Path::new("a/b/c2.txt"), None),
2407 (Path::new("a/d/e1.txt"), None),
2408 (Path::new("a/d/e2.txt"), Some(GitFileStatus::Modified)),
2409 (Path::new("f/no-status.txt"), None),
2410 ],
2411 );
2412
2413 #[track_caller]
2414 fn check_propagated_statuses(
2415 snapshot: &Snapshot,
2416 expected_statuses: &[(&Path, Option<GitFileStatus>)],
2417 ) {
2418 let mut entries = expected_statuses
2419 .iter()
2420 .map(|(path, _)| snapshot.entry_for_path(path).unwrap().clone())
2421 .collect::<Vec<_>>();
2422 snapshot.propagate_git_statuses(&mut entries);
2423 assert_eq!(
2424 entries
2425 .iter()
2426 .map(|e| (e.path.as_ref(), e.git_status))
2427 .collect::<Vec<_>>(),
2428 expected_statuses
2429 );
2430 }
2431}
2432
2433#[track_caller]
2434fn git_init(path: &Path) -> git2::Repository {
2435 git2::Repository::init(path).expect("Failed to initialize git repository")
2436}
2437
2438#[track_caller]
2439fn git_add<P: AsRef<Path>>(path: P, repo: &git2::Repository) {
2440 let path = path.as_ref();
2441 let mut index = repo.index().expect("Failed to get index");
2442 index.add_path(path).expect("Failed to add a.txt");
2443 index.write().expect("Failed to write index");
2444}
2445
2446#[track_caller]
2447fn git_remove_index(path: &Path, repo: &git2::Repository) {
2448 let mut index = repo.index().expect("Failed to get index");
2449 index.remove_path(path).expect("Failed to add a.txt");
2450 index.write().expect("Failed to write index");
2451}
2452
2453#[track_caller]
2454fn git_commit(msg: &'static str, repo: &git2::Repository) {
2455 use git2::Signature;
2456
2457 let signature = Signature::now("test", "test@zed.dev").unwrap();
2458 let oid = repo.index().unwrap().write_tree().unwrap();
2459 let tree = repo.find_tree(oid).unwrap();
2460 if let Some(head) = repo.head().ok() {
2461 let parent_obj = head.peel(git2::ObjectType::Commit).unwrap();
2462
2463 let parent_commit = parent_obj.as_commit().unwrap();
2464
2465 repo.commit(
2466 Some("HEAD"),
2467 &signature,
2468 &signature,
2469 msg,
2470 &tree,
2471 &[parent_commit],
2472 )
2473 .expect("Failed to commit with parent");
2474 } else {
2475 repo.commit(Some("HEAD"), &signature, &signature, msg, &tree, &[])
2476 .expect("Failed to commit");
2477 }
2478}
2479
2480#[track_caller]
2481fn git_stash(repo: &mut git2::Repository) {
2482 use git2::Signature;
2483
2484 let signature = Signature::now("test", "test@zed.dev").unwrap();
2485 repo.stash_save(&signature, "N/A", None)
2486 .expect("Failed to stash");
2487}
2488
2489#[track_caller]
2490fn git_reset(offset: usize, repo: &git2::Repository) {
2491 let head = repo.head().expect("Couldn't get repo head");
2492 let object = head.peel(git2::ObjectType::Commit).unwrap();
2493 let commit = object.as_commit().unwrap();
2494 let new_head = commit
2495 .parents()
2496 .inspect(|parnet| {
2497 parnet.message();
2498 })
2499 .skip(offset)
2500 .next()
2501 .expect("Not enough history");
2502 repo.reset(&new_head.as_object(), git2::ResetType::Soft, None)
2503 .expect("Could not reset");
2504}
2505
2506#[allow(dead_code)]
2507#[track_caller]
2508fn git_status(repo: &git2::Repository) -> collections::HashMap<String, git2::Status> {
2509 repo.statuses(None)
2510 .unwrap()
2511 .iter()
2512 .map(|status| (status.path().unwrap().to_string(), status.status()))
2513 .collect()
2514}
2515
2516#[track_caller]
2517fn check_worktree_entries(
2518 tree: &Worktree,
2519 expected_excluded_paths: &[&str],
2520 expected_ignored_paths: &[&str],
2521 expected_tracked_paths: &[&str],
2522) {
2523 for path in expected_excluded_paths {
2524 let entry = tree.entry_for_path(path);
2525 assert!(
2526 entry.is_none(),
2527 "expected path '{path}' to be excluded, but got entry: {entry:?}",
2528 );
2529 }
2530 for path in expected_ignored_paths {
2531 let entry = tree
2532 .entry_for_path(path)
2533 .unwrap_or_else(|| panic!("Missing entry for expected ignored path '{path}'"));
2534 assert!(
2535 entry.is_ignored,
2536 "expected path '{path}' to be ignored, but got entry: {entry:?}",
2537 );
2538 }
2539 for path in expected_tracked_paths {
2540 let entry = tree
2541 .entry_for_path(path)
2542 .unwrap_or_else(|| panic!("Missing entry for expected tracked path '{path}'"));
2543 assert!(
2544 !entry.is_ignored,
2545 "expected path '{path}' to be tracked, but got entry: {entry:?}",
2546 );
2547 }
2548}
2549
2550fn init_test(cx: &mut gpui::TestAppContext) {
2551 if std::env::var("RUST_LOG").is_ok() {
2552 env_logger::try_init().ok();
2553 }
2554
2555 cx.update(|cx| {
2556 let settings_store = SettingsStore::test(cx);
2557 cx.set_global(settings_store);
2558 WorktreeSettings::register(cx);
2559 });
2560}
2561
2562fn assert_entry_git_state(
2563 tree: &Worktree,
2564 path: &str,
2565 git_status: Option<GitFileStatus>,
2566 is_ignored: bool,
2567) {
2568 let entry = tree.entry_for_path(path).expect("entry {path} not found");
2569 assert_eq!(entry.git_status, git_status);
2570 assert_eq!(entry.is_ignored, is_ignored);
2571}