1use crate::{
2 AnchorRangeExt, Autoscroll, DisplayPoint, Editor, MultiBuffer, RowExt,
3 display_map::ToDisplayPoint,
4};
5use buffer_diff::DiffHunkStatusKind;
6use collections::BTreeMap;
7use futures::Future;
8
9use gpui::{
10 AnyWindowHandle, App, Context, Entity, Focusable as _, Keystroke, Pixels, Point,
11 VisualTestContext, Window, WindowHandle, prelude::*,
12};
13use itertools::Itertools;
14use language::{Buffer, BufferSnapshot, LanguageRegistry};
15use multi_buffer::{Anchor, ExcerptRange, MultiBufferRow};
16use parking_lot::RwLock;
17use project::{FakeFs, Project};
18use std::{
19 any::TypeId,
20 ops::{Deref, DerefMut, Range},
21 path::Path,
22 sync::{
23 Arc,
24 atomic::{AtomicUsize, Ordering},
25 },
26};
27use util::{
28 assert_set_eq,
29 test::{generate_marked_text, marked_text_ranges},
30};
31
32use super::{build_editor, build_editor_with_project};
33
34pub struct EditorTestContext {
35 pub cx: gpui::VisualTestContext,
36 pub window: AnyWindowHandle,
37 pub editor: Entity<Editor>,
38 pub assertion_cx: AssertionContextManager,
39}
40
41impl EditorTestContext {
42 pub async fn new(cx: &mut gpui::TestAppContext) -> EditorTestContext {
43 let fs = FakeFs::new(cx.executor());
44 let root = Self::root_path();
45 fs.insert_tree(
46 root,
47 serde_json::json!({
48 ".git": {},
49 "file": "",
50 }),
51 )
52 .await;
53 let project = Project::test(fs.clone(), [root], cx).await;
54 let buffer = project
55 .update(cx, |project, cx| {
56 project.open_local_buffer(root.join("file"), cx)
57 })
58 .await
59 .unwrap();
60 let editor = cx.add_window(|window, cx| {
61 let editor = build_editor_with_project(
62 project,
63 MultiBuffer::build_from_buffer(buffer, cx),
64 window,
65 cx,
66 );
67
68 window.focus(&editor.focus_handle(cx));
69 editor
70 });
71 let editor_view = editor.root(cx).unwrap();
72
73 cx.run_until_parked();
74 Self {
75 cx: VisualTestContext::from_window(*editor.deref(), cx),
76 window: editor.into(),
77 editor: editor_view,
78 assertion_cx: AssertionContextManager::new(),
79 }
80 }
81
82 #[cfg(target_os = "windows")]
83 fn root_path() -> &'static Path {
84 Path::new("C:\\root")
85 }
86
87 #[cfg(not(target_os = "windows"))]
88 fn root_path() -> &'static Path {
89 Path::new("/root")
90 }
91
92 pub async fn for_editor_in(editor: Entity<Editor>, cx: &mut gpui::VisualTestContext) -> Self {
93 cx.focus(&editor);
94 Self {
95 window: cx.windows()[0],
96 cx: cx.clone(),
97 editor,
98 assertion_cx: AssertionContextManager::new(),
99 }
100 }
101
102 pub async fn for_editor(editor: WindowHandle<Editor>, cx: &mut gpui::TestAppContext) -> Self {
103 let editor_view = editor.root(cx).unwrap();
104 Self {
105 cx: VisualTestContext::from_window(*editor.deref(), cx),
106 window: editor.into(),
107 editor: editor_view,
108 assertion_cx: AssertionContextManager::new(),
109 }
110 }
111
112 pub fn new_multibuffer<const COUNT: usize>(
113 cx: &mut gpui::TestAppContext,
114 excerpts: [&str; COUNT],
115 ) -> EditorTestContext {
116 let mut multibuffer = MultiBuffer::new(language::Capability::ReadWrite);
117 let buffer = cx.new(|cx| {
118 for excerpt in excerpts.into_iter() {
119 let (text, ranges) = marked_text_ranges(excerpt, false);
120 let buffer = cx.new(|cx| Buffer::local(text, cx));
121 multibuffer.push_excerpts(
122 buffer,
123 ranges.into_iter().map(|range| ExcerptRange {
124 context: range,
125 primary: None,
126 }),
127 cx,
128 );
129 }
130 multibuffer
131 });
132
133 let editor = cx.add_window(|window, cx| {
134 let editor = build_editor(buffer, window, cx);
135 window.focus(&editor.focus_handle(cx));
136
137 editor
138 });
139
140 let editor_view = editor.root(cx).unwrap();
141 Self {
142 cx: VisualTestContext::from_window(*editor.deref(), cx),
143 window: editor.into(),
144 editor: editor_view,
145 assertion_cx: AssertionContextManager::new(),
146 }
147 }
148
149 pub fn condition(
150 &self,
151 predicate: impl FnMut(&Editor, &App) -> bool,
152 ) -> impl Future<Output = ()> {
153 self.editor
154 .condition::<crate::EditorEvent>(&self.cx, predicate)
155 }
156
157 #[track_caller]
158 pub fn editor<F, T>(&mut self, read: F) -> T
159 where
160 F: FnOnce(&Editor, &Window, &mut Context<Editor>) -> T,
161 {
162 self.editor
163 .update_in(&mut self.cx, |this, window, cx| read(this, window, cx))
164 }
165
166 #[track_caller]
167 pub fn update_editor<F, T>(&mut self, update: F) -> T
168 where
169 F: FnOnce(&mut Editor, &mut Window, &mut Context<Editor>) -> T,
170 {
171 self.editor.update_in(&mut self.cx, update)
172 }
173
174 pub fn multibuffer<F, T>(&mut self, read: F) -> T
175 where
176 F: FnOnce(&MultiBuffer, &App) -> T,
177 {
178 self.editor(|editor, _, cx| read(editor.buffer().read(cx), cx))
179 }
180
181 pub fn update_multibuffer<F, T>(&mut self, update: F) -> T
182 where
183 F: FnOnce(&mut MultiBuffer, &mut Context<MultiBuffer>) -> T,
184 {
185 self.update_editor(|editor, _, cx| editor.buffer().update(cx, update))
186 }
187
188 pub fn buffer_text(&mut self) -> String {
189 self.multibuffer(|buffer, cx| buffer.snapshot(cx).text())
190 }
191
192 pub fn display_text(&mut self) -> String {
193 self.update_editor(|editor, _, cx| editor.display_text(cx))
194 }
195
196 pub fn buffer<F, T>(&mut self, read: F) -> T
197 where
198 F: FnOnce(&Buffer, &App) -> T,
199 {
200 self.multibuffer(|multibuffer, cx| {
201 let buffer = multibuffer.as_singleton().unwrap().read(cx);
202 read(buffer, cx)
203 })
204 }
205
206 pub fn language_registry(&mut self) -> Arc<LanguageRegistry> {
207 self.editor(|editor, _, cx| {
208 editor
209 .project
210 .as_ref()
211 .unwrap()
212 .read(cx)
213 .languages()
214 .clone()
215 })
216 }
217
218 pub fn update_buffer<F, T>(&mut self, update: F) -> T
219 where
220 F: FnOnce(&mut Buffer, &mut Context<Buffer>) -> T,
221 {
222 self.update_multibuffer(|multibuffer, cx| {
223 let buffer = multibuffer.as_singleton().unwrap();
224 buffer.update(cx, update)
225 })
226 }
227
228 pub fn buffer_snapshot(&mut self) -> BufferSnapshot {
229 self.buffer(|buffer, _| buffer.snapshot())
230 }
231
232 pub fn add_assertion_context(&self, context: String) -> ContextHandle {
233 self.assertion_cx.add_context(context)
234 }
235
236 pub fn assertion_context(&self) -> String {
237 self.assertion_cx.context()
238 }
239
240 // unlike cx.simulate_keystrokes(), this does not run_until_parked
241 // so you can use it to test detailed timing
242 pub fn simulate_keystroke(&mut self, keystroke_text: &str) {
243 let keystroke = Keystroke::parse_case_insensitive(keystroke_text).unwrap();
244 self.cx.dispatch_keystroke(self.window, keystroke);
245 }
246
247 pub fn run_until_parked(&mut self) {
248 self.cx.background_executor.run_until_parked();
249 }
250
251 #[track_caller]
252 pub fn ranges(&mut self, marked_text: &str) -> Vec<Range<usize>> {
253 let (unmarked_text, ranges) = marked_text_ranges(marked_text, false);
254 assert_eq!(self.buffer_text(), unmarked_text);
255 ranges
256 }
257
258 pub fn display_point(&mut self, marked_text: &str) -> DisplayPoint {
259 let ranges = self.ranges(marked_text);
260 let snapshot = self.editor.update_in(&mut self.cx, |editor, window, cx| {
261 editor.snapshot(window, cx)
262 });
263 ranges[0].start.to_display_point(&snapshot)
264 }
265
266 pub fn pixel_position(&mut self, marked_text: &str) -> Point<Pixels> {
267 let display_point = self.display_point(marked_text);
268 self.pixel_position_for(display_point)
269 }
270
271 pub fn pixel_position_for(&mut self, display_point: DisplayPoint) -> Point<Pixels> {
272 self.update_editor(|editor, window, cx| {
273 let newest_point = editor.selections.newest_display(cx).head();
274 let pixel_position = editor.pixel_position_of_newest_cursor.unwrap();
275 let line_height = editor
276 .style()
277 .unwrap()
278 .text
279 .line_height_in_pixels(window.rem_size());
280 let snapshot = editor.snapshot(window, cx);
281 let details = editor.text_layout_details(window);
282
283 let y = pixel_position.y
284 + line_height * (display_point.row().as_f32() - newest_point.row().as_f32());
285 let x = pixel_position.x + snapshot.x_for_display_point(display_point, &details)
286 - snapshot.x_for_display_point(newest_point, &details);
287 Point::new(x, y)
288 })
289 }
290
291 // Returns anchors for the current buffer using `«` and `»`
292 pub fn text_anchor_range(&mut self, marked_text: &str) -> Range<language::Anchor> {
293 let ranges = self.ranges(marked_text);
294 let snapshot = self.buffer_snapshot();
295 snapshot.anchor_before(ranges[0].start)..snapshot.anchor_after(ranges[0].end)
296 }
297
298 pub fn set_head_text(&mut self, diff_base: &str) {
299 self.cx.run_until_parked();
300 let fs = self.update_editor(|editor, _, cx| {
301 editor.project.as_ref().unwrap().read(cx).fs().as_fake()
302 });
303 let path = self.update_buffer(|buffer, _| buffer.file().unwrap().path().clone());
304 fs.set_head_for_repo(
305 &Self::root_path().join(".git"),
306 &[(path.into(), diff_base.to_string())],
307 );
308 self.cx.run_until_parked();
309 }
310
311 pub fn clear_index_text(&mut self) {
312 self.cx.run_until_parked();
313 let fs = self.update_editor(|editor, _, cx| {
314 editor.project.as_ref().unwrap().read(cx).fs().as_fake()
315 });
316 fs.set_index_for_repo(&Self::root_path().join(".git"), &[]);
317 self.cx.run_until_parked();
318 }
319
320 pub fn set_index_text(&mut self, diff_base: &str) {
321 self.cx.run_until_parked();
322 let fs = self.update_editor(|editor, _, cx| {
323 editor.project.as_ref().unwrap().read(cx).fs().as_fake()
324 });
325 let path = self.update_buffer(|buffer, _| buffer.file().unwrap().path().clone());
326 fs.set_index_for_repo(
327 &Self::root_path().join(".git"),
328 &[(path.into(), diff_base.to_string())],
329 );
330 self.cx.run_until_parked();
331 }
332
333 #[track_caller]
334 pub fn assert_index_text(&mut self, expected: Option<&str>) {
335 let fs = self.update_editor(|editor, _, cx| {
336 editor.project.as_ref().unwrap().read(cx).fs().as_fake()
337 });
338 let path = self.update_buffer(|buffer, _| buffer.file().unwrap().path().clone());
339 let mut found = None;
340 fs.with_git_state(&Self::root_path().join(".git"), false, |git_state| {
341 found = git_state.index_contents.get(path.as_ref()).cloned();
342 })
343 .unwrap();
344 assert_eq!(expected, found.as_deref());
345 }
346
347 /// Change the editor's text and selections using a string containing
348 /// embedded range markers that represent the ranges and directions of
349 /// each selection.
350 ///
351 /// Returns a context handle so that assertion failures can print what
352 /// editor state was needed to cause the failure.
353 ///
354 /// See the `util::test::marked_text_ranges` function for more information.
355 pub fn set_state(&mut self, marked_text: &str) -> ContextHandle {
356 let state_context = self.add_assertion_context(format!(
357 "Initial Editor State: \"{}\"",
358 marked_text.escape_debug()
359 ));
360 let (unmarked_text, selection_ranges) = marked_text_ranges(marked_text, true);
361 self.editor.update_in(&mut self.cx, |editor, window, cx| {
362 editor.set_text(unmarked_text, window, cx);
363 editor.change_selections(Some(Autoscroll::fit()), window, cx, |s| {
364 s.select_ranges(selection_ranges)
365 })
366 });
367 state_context
368 }
369
370 /// Only change the editor's selections
371 pub fn set_selections_state(&mut self, marked_text: &str) -> ContextHandle {
372 let state_context = self.add_assertion_context(format!(
373 "Initial Editor State: \"{}\"",
374 marked_text.escape_debug()
375 ));
376 let (unmarked_text, selection_ranges) = marked_text_ranges(marked_text, true);
377 self.editor.update_in(&mut self.cx, |editor, window, cx| {
378 assert_eq!(editor.text(cx), unmarked_text);
379 editor.change_selections(Some(Autoscroll::fit()), window, cx, |s| {
380 s.select_ranges(selection_ranges)
381 })
382 });
383 state_context
384 }
385
386 /// Assert about the text of the editor, the selections, and the expanded
387 /// diff hunks.
388 ///
389 /// Diff hunks are indicated by lines starting with `+` and `-`.
390 #[track_caller]
391 pub fn assert_state_with_diff(&mut self, expected_diff_text: String) {
392 assert_state_with_diff(&self.editor, &mut self.cx, &expected_diff_text);
393 }
394
395 #[track_caller]
396 pub fn assert_excerpts_with_selections(&mut self, marked_text: &str) {
397 let expected_excerpts = marked_text
398 .strip_prefix("[EXCERPT]\n")
399 .unwrap()
400 .split("[EXCERPT]\n")
401 .collect::<Vec<_>>();
402
403 let (multibuffer_snapshot, selections, excerpts) = self.update_editor(|editor, _, cx| {
404 let multibuffer_snapshot = editor.buffer.read(cx).snapshot(cx);
405
406 let selections = editor.selections.disjoint_anchors();
407 let excerpts = multibuffer_snapshot
408 .excerpts()
409 .map(|(e_id, snapshot, range)| (e_id, snapshot.clone(), range))
410 .collect::<Vec<_>>();
411
412 (multibuffer_snapshot, selections, excerpts)
413 });
414
415 assert!(
416 excerpts.len() == expected_excerpts.len(),
417 "should have {} excerpts, got {}",
418 expected_excerpts.len(),
419 excerpts.len()
420 );
421
422 for (ix, (excerpt_id, snapshot, range)) in excerpts.into_iter().enumerate() {
423 let is_folded = self
424 .update_editor(|editor, _, cx| editor.is_buffer_folded(snapshot.remote_id(), cx));
425 let (expected_text, expected_selections) =
426 marked_text_ranges(expected_excerpts[ix], true);
427 if expected_text == "[FOLDED]\n" {
428 assert!(is_folded, "excerpt {} should be folded", ix);
429 let is_selected = selections.iter().any(|s| s.head().excerpt_id == excerpt_id);
430 if expected_selections.len() > 0 {
431 assert!(
432 is_selected,
433 "excerpt {ix} should be selected. got {:?}",
434 self.editor_state(),
435 );
436 } else {
437 assert!(
438 !is_selected,
439 "excerpt {ix} should not be selected, got: {selections:?}",
440 );
441 }
442 continue;
443 }
444 assert!(!is_folded, "excerpt {} should not be folded", ix);
445 assert_eq!(
446 multibuffer_snapshot
447 .text_for_range(Anchor::range_in_buffer(
448 excerpt_id,
449 snapshot.remote_id(),
450 range.context.clone()
451 ))
452 .collect::<String>(),
453 expected_text
454 );
455
456 let selections = selections
457 .iter()
458 .filter(|s| s.head().excerpt_id == excerpt_id)
459 .map(|s| {
460 let head = text::ToOffset::to_offset(&s.head().text_anchor, &snapshot)
461 - text::ToOffset::to_offset(&range.context.start, &snapshot);
462 let tail = text::ToOffset::to_offset(&s.head().text_anchor, &snapshot)
463 - text::ToOffset::to_offset(&range.context.start, &snapshot);
464 tail..head
465 })
466 .collect::<Vec<_>>();
467 // todo: selections that cross excerpt boundaries..
468 assert_eq!(
469 selections, expected_selections,
470 "excerpt {} has incorrect selections",
471 ix,
472 );
473 }
474 }
475
476 /// Make an assertion about the editor's text and the ranges and directions
477 /// of its selections using a string containing embedded range markers.
478 ///
479 /// See the `util::test::marked_text_ranges` function for more information.
480 #[track_caller]
481 pub fn assert_editor_state(&mut self, marked_text: &str) {
482 let (expected_text, expected_selections) = marked_text_ranges(marked_text, true);
483 pretty_assertions::assert_eq!(self.buffer_text(), expected_text, "unexpected buffer text");
484 self.assert_selections(expected_selections, marked_text.to_string())
485 }
486
487 /// Make an assertion about the editor's text and the ranges and directions
488 /// of its selections using a string containing embedded range markers.
489 ///
490 /// See the `util::test::marked_text_ranges` function for more information.
491 #[track_caller]
492 pub fn assert_display_state(&mut self, marked_text: &str) {
493 let (expected_text, expected_selections) = marked_text_ranges(marked_text, true);
494 pretty_assertions::assert_eq!(self.display_text(), expected_text, "unexpected buffer text");
495 self.assert_selections(expected_selections, marked_text.to_string())
496 }
497
498 pub fn editor_state(&mut self) -> String {
499 generate_marked_text(self.buffer_text().as_str(), &self.editor_selections(), true)
500 }
501
502 #[track_caller]
503 pub fn assert_editor_background_highlights<Tag: 'static>(&mut self, marked_text: &str) {
504 let expected_ranges = self.ranges(marked_text);
505 let actual_ranges: Vec<Range<usize>> = self.update_editor(|editor, window, cx| {
506 let snapshot = editor.snapshot(window, cx);
507 editor
508 .background_highlights
509 .get(&TypeId::of::<Tag>())
510 .map(|h| h.1.clone())
511 .unwrap_or_default()
512 .iter()
513 .map(|range| range.to_offset(&snapshot.buffer_snapshot))
514 .collect()
515 });
516 assert_set_eq!(actual_ranges, expected_ranges);
517 }
518
519 #[track_caller]
520 pub fn assert_editor_text_highlights<Tag: ?Sized + 'static>(&mut self, marked_text: &str) {
521 let expected_ranges = self.ranges(marked_text);
522 let snapshot = self.update_editor(|editor, window, cx| editor.snapshot(window, cx));
523 let actual_ranges: Vec<Range<usize>> = snapshot
524 .text_highlight_ranges::<Tag>()
525 .map(|ranges| ranges.as_ref().clone().1)
526 .unwrap_or_default()
527 .into_iter()
528 .map(|range| range.to_offset(&snapshot.buffer_snapshot))
529 .collect();
530 assert_set_eq!(actual_ranges, expected_ranges);
531 }
532
533 #[track_caller]
534 pub fn assert_editor_selections(&mut self, expected_selections: Vec<Range<usize>>) {
535 let expected_marked_text =
536 generate_marked_text(&self.buffer_text(), &expected_selections, true);
537 self.assert_selections(expected_selections, expected_marked_text)
538 }
539
540 #[track_caller]
541 fn editor_selections(&mut self) -> Vec<Range<usize>> {
542 self.editor
543 .update(&mut self.cx, |editor, cx| {
544 editor.selections.all::<usize>(cx)
545 })
546 .into_iter()
547 .map(|s| {
548 if s.reversed {
549 s.end..s.start
550 } else {
551 s.start..s.end
552 }
553 })
554 .collect::<Vec<_>>()
555 }
556
557 #[track_caller]
558 fn assert_selections(
559 &mut self,
560 expected_selections: Vec<Range<usize>>,
561 expected_marked_text: String,
562 ) {
563 let actual_selections = self.editor_selections();
564 let actual_marked_text =
565 generate_marked_text(&self.buffer_text(), &actual_selections, true);
566 if expected_selections != actual_selections {
567 pretty_assertions::assert_eq!(
568 actual_marked_text,
569 expected_marked_text,
570 "{}Editor has unexpected selections",
571 self.assertion_context(),
572 );
573 }
574 }
575}
576
577#[track_caller]
578pub fn assert_state_with_diff(
579 editor: &Entity<Editor>,
580 cx: &mut VisualTestContext,
581 expected_diff_text: &str,
582) {
583 let (snapshot, selections) = editor.update_in(cx, |editor, window, cx| {
584 (
585 editor.snapshot(window, cx).buffer_snapshot.clone(),
586 editor.selections.ranges::<usize>(cx),
587 )
588 });
589
590 let actual_marked_text = generate_marked_text(&snapshot.text(), &selections, true);
591
592 // Read the actual diff.
593 let line_infos = snapshot.row_infos(MultiBufferRow(0)).collect::<Vec<_>>();
594 let has_diff = line_infos.iter().any(|info| info.diff_status.is_some());
595 let actual_diff = actual_marked_text
596 .split('\n')
597 .zip(line_infos)
598 .map(|(line, info)| {
599 let mut marker = match info.diff_status.map(|status| status.kind) {
600 Some(DiffHunkStatusKind::Added) => "+ ",
601 Some(DiffHunkStatusKind::Deleted) => "- ",
602 Some(DiffHunkStatusKind::Modified) => unreachable!(),
603 None => {
604 if has_diff {
605 " "
606 } else {
607 ""
608 }
609 }
610 };
611 if line.is_empty() {
612 marker = marker.trim();
613 }
614 format!("{marker}{line}")
615 })
616 .collect::<Vec<_>>()
617 .join("\n");
618
619 pretty_assertions::assert_eq!(actual_diff, expected_diff_text, "unexpected diff state");
620}
621
622impl Deref for EditorTestContext {
623 type Target = gpui::VisualTestContext;
624
625 fn deref(&self) -> &Self::Target {
626 &self.cx
627 }
628}
629
630impl DerefMut for EditorTestContext {
631 fn deref_mut(&mut self) -> &mut Self::Target {
632 &mut self.cx
633 }
634}
635
636/// Tracks string context to be printed when assertions fail.
637/// Often this is done by storing a context string in the manager and returning the handle.
638#[derive(Clone)]
639pub struct AssertionContextManager {
640 id: Arc<AtomicUsize>,
641 contexts: Arc<RwLock<BTreeMap<usize, String>>>,
642}
643
644impl Default for AssertionContextManager {
645 fn default() -> Self {
646 Self::new()
647 }
648}
649
650impl AssertionContextManager {
651 pub fn new() -> Self {
652 Self {
653 id: Arc::new(AtomicUsize::new(0)),
654 contexts: Arc::new(RwLock::new(BTreeMap::new())),
655 }
656 }
657
658 pub fn add_context(&self, context: String) -> ContextHandle {
659 let id = self.id.fetch_add(1, Ordering::Relaxed);
660 let mut contexts = self.contexts.write();
661 contexts.insert(id, context);
662 ContextHandle {
663 id,
664 manager: self.clone(),
665 }
666 }
667
668 pub fn context(&self) -> String {
669 let contexts = self.contexts.read();
670 format!("\n{}\n", contexts.values().join("\n"))
671 }
672}
673
674/// Used to track the lifetime of a piece of context so that it can be provided when an assertion fails.
675/// For example, in the EditorTestContext, `set_state` returns a context handle so that if an assertion fails,
676/// the state that was set initially for the failure can be printed in the error message
677pub struct ContextHandle {
678 id: usize,
679 manager: AssertionContextManager,
680}
681
682impl Drop for ContextHandle {
683 fn drop(&mut self) {
684 let mut contexts = self.manager.contexts.write();
685 contexts.remove(&self.id);
686 }
687}