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 #[track_caller]
113 pub fn new_multibuffer<const COUNT: usize>(
114 cx: &mut gpui::TestAppContext,
115 excerpts: [&str; COUNT],
116 ) -> EditorTestContext {
117 let mut multibuffer = MultiBuffer::new(language::Capability::ReadWrite);
118 let buffer = cx.new(|cx| {
119 for excerpt in excerpts.into_iter() {
120 let (text, ranges) = marked_text_ranges(excerpt, false);
121 let buffer = cx.new(|cx| Buffer::local(text, cx));
122 multibuffer.push_excerpts(
123 buffer,
124 ranges
125 .into_iter()
126 .map(|range| ExcerptRange::new(range.clone())),
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(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 #[track_caller]
356 pub fn set_state(&mut self, marked_text: &str) -> ContextHandle {
357 let state_context = self.add_assertion_context(format!(
358 "Initial Editor State: \"{}\"",
359 marked_text.escape_debug()
360 ));
361 let (unmarked_text, selection_ranges) = marked_text_ranges(marked_text, true);
362 self.editor.update_in(&mut self.cx, |editor, window, cx| {
363 editor.set_text(unmarked_text, window, cx);
364 editor.change_selections(Some(Autoscroll::fit()), window, cx, |s| {
365 s.select_ranges(selection_ranges)
366 })
367 });
368 state_context
369 }
370
371 /// Only change the editor's selections
372 #[track_caller]
373 pub fn set_selections_state(&mut self, marked_text: &str) -> ContextHandle {
374 let state_context = self.add_assertion_context(format!(
375 "Initial Editor State: \"{}\"",
376 marked_text.escape_debug()
377 ));
378 let (unmarked_text, selection_ranges) = marked_text_ranges(marked_text, true);
379 self.editor.update_in(&mut self.cx, |editor, window, cx| {
380 assert_eq!(editor.text(cx), unmarked_text);
381 editor.change_selections(Some(Autoscroll::fit()), window, cx, |s| {
382 s.select_ranges(selection_ranges)
383 })
384 });
385 state_context
386 }
387
388 /// Assert about the text of the editor, the selections, and the expanded
389 /// diff hunks.
390 ///
391 /// Diff hunks are indicated by lines starting with `+` and `-`.
392 #[track_caller]
393 pub fn assert_state_with_diff(&mut self, expected_diff_text: String) {
394 assert_state_with_diff(&self.editor, &mut self.cx, &expected_diff_text);
395 }
396
397 #[track_caller]
398 pub fn assert_excerpts_with_selections(&mut self, marked_text: &str) {
399 let expected_excerpts = marked_text
400 .strip_prefix("[EXCERPT]\n")
401 .unwrap()
402 .split("[EXCERPT]\n")
403 .collect::<Vec<_>>();
404
405 let (multibuffer_snapshot, selections, excerpts) = self.update_editor(|editor, _, cx| {
406 let multibuffer_snapshot = editor.buffer.read(cx).snapshot(cx);
407
408 let selections = editor.selections.disjoint_anchors();
409 let excerpts = multibuffer_snapshot
410 .excerpts()
411 .map(|(e_id, snapshot, range)| (e_id, snapshot.clone(), range))
412 .collect::<Vec<_>>();
413
414 (multibuffer_snapshot, selections, excerpts)
415 });
416
417 assert!(
418 excerpts.len() == expected_excerpts.len(),
419 "should have {} excerpts, got {}",
420 expected_excerpts.len(),
421 excerpts.len()
422 );
423
424 for (ix, (excerpt_id, snapshot, range)) in excerpts.into_iter().enumerate() {
425 let is_folded = self
426 .update_editor(|editor, _, cx| editor.is_buffer_folded(snapshot.remote_id(), cx));
427 let (expected_text, expected_selections) =
428 marked_text_ranges(expected_excerpts[ix], true);
429 if expected_text == "[FOLDED]\n" {
430 assert!(is_folded, "excerpt {} should be folded", ix);
431 let is_selected = selections.iter().any(|s| s.head().excerpt_id == excerpt_id);
432 if expected_selections.len() > 0 {
433 assert!(
434 is_selected,
435 "excerpt {ix} should be selected. got {:?}",
436 self.editor_state(),
437 );
438 } else {
439 assert!(
440 !is_selected,
441 "excerpt {ix} should not be selected, got: {selections:?}",
442 );
443 }
444 continue;
445 }
446 assert!(!is_folded, "excerpt {} should not be folded", ix);
447 assert_eq!(
448 multibuffer_snapshot
449 .text_for_range(Anchor::range_in_buffer(
450 excerpt_id,
451 snapshot.remote_id(),
452 range.context.clone()
453 ))
454 .collect::<String>(),
455 expected_text
456 );
457
458 let selections = selections
459 .iter()
460 .filter(|s| s.head().excerpt_id == excerpt_id)
461 .map(|s| {
462 let head = text::ToOffset::to_offset(&s.head().text_anchor, &snapshot)
463 - text::ToOffset::to_offset(&range.context.start, &snapshot);
464 let tail = text::ToOffset::to_offset(&s.head().text_anchor, &snapshot)
465 - text::ToOffset::to_offset(&range.context.start, &snapshot);
466 tail..head
467 })
468 .collect::<Vec<_>>();
469 // todo: selections that cross excerpt boundaries..
470 assert_eq!(
471 selections, expected_selections,
472 "excerpt {} has incorrect selections",
473 ix,
474 );
475 }
476 }
477
478 /// Make an assertion about the editor's text and the ranges and directions
479 /// of its selections using a string containing embedded range markers.
480 ///
481 /// See the `util::test::marked_text_ranges` function for more information.
482 #[track_caller]
483 pub fn assert_editor_state(&mut self, marked_text: &str) {
484 let (expected_text, expected_selections) = marked_text_ranges(marked_text, true);
485 pretty_assertions::assert_eq!(self.buffer_text(), expected_text, "unexpected buffer text");
486 self.assert_selections(expected_selections, marked_text.to_string())
487 }
488
489 /// Make an assertion about the editor's text and the ranges and directions
490 /// of its selections using a string containing embedded range markers.
491 ///
492 /// See the `util::test::marked_text_ranges` function for more information.
493 #[track_caller]
494 pub fn assert_display_state(&mut self, marked_text: &str) {
495 let (expected_text, expected_selections) = marked_text_ranges(marked_text, true);
496 pretty_assertions::assert_eq!(self.display_text(), expected_text, "unexpected buffer text");
497 self.assert_selections(expected_selections, marked_text.to_string())
498 }
499
500 pub fn editor_state(&mut self) -> String {
501 generate_marked_text(self.buffer_text().as_str(), &self.editor_selections(), true)
502 }
503
504 #[track_caller]
505 pub fn assert_editor_background_highlights<Tag: 'static>(&mut self, marked_text: &str) {
506 let expected_ranges = self.ranges(marked_text);
507 let actual_ranges: Vec<Range<usize>> = self.update_editor(|editor, window, cx| {
508 let snapshot = editor.snapshot(window, cx);
509 editor
510 .background_highlights
511 .get(&TypeId::of::<Tag>())
512 .map(|h| h.1.clone())
513 .unwrap_or_default()
514 .iter()
515 .map(|range| range.to_offset(&snapshot.buffer_snapshot))
516 .collect()
517 });
518 assert_set_eq!(actual_ranges, expected_ranges);
519 }
520
521 #[track_caller]
522 pub fn assert_editor_text_highlights<Tag: ?Sized + 'static>(&mut self, marked_text: &str) {
523 let expected_ranges = self.ranges(marked_text);
524 let snapshot = self.update_editor(|editor, window, cx| editor.snapshot(window, cx));
525 let actual_ranges: Vec<Range<usize>> = snapshot
526 .text_highlight_ranges::<Tag>()
527 .map(|ranges| ranges.as_ref().clone().1)
528 .unwrap_or_default()
529 .into_iter()
530 .map(|range| range.to_offset(&snapshot.buffer_snapshot))
531 .collect();
532 assert_set_eq!(actual_ranges, expected_ranges);
533 }
534
535 #[track_caller]
536 pub fn assert_editor_selections(&mut self, expected_selections: Vec<Range<usize>>) {
537 let expected_marked_text =
538 generate_marked_text(&self.buffer_text(), &expected_selections, true)
539 .replace(" \n", "•\n");
540
541 self.assert_selections(expected_selections, expected_marked_text)
542 }
543
544 #[track_caller]
545 fn editor_selections(&mut self) -> Vec<Range<usize>> {
546 self.editor
547 .update(&mut self.cx, |editor, cx| {
548 editor.selections.all::<usize>(cx)
549 })
550 .into_iter()
551 .map(|s| {
552 if s.reversed {
553 s.end..s.start
554 } else {
555 s.start..s.end
556 }
557 })
558 .collect::<Vec<_>>()
559 }
560
561 #[track_caller]
562 fn assert_selections(
563 &mut self,
564 expected_selections: Vec<Range<usize>>,
565 expected_marked_text: String,
566 ) {
567 let actual_selections = self.editor_selections();
568 let actual_marked_text =
569 generate_marked_text(&self.buffer_text(), &actual_selections, true)
570 .replace(" \n", "•\n");
571 if expected_selections != actual_selections {
572 pretty_assertions::assert_eq!(
573 actual_marked_text,
574 expected_marked_text,
575 "{}Editor has unexpected selections",
576 self.assertion_context(),
577 );
578 }
579 }
580}
581
582#[track_caller]
583pub fn assert_state_with_diff(
584 editor: &Entity<Editor>,
585 cx: &mut VisualTestContext,
586 expected_diff_text: &str,
587) {
588 let (snapshot, selections) = editor.update_in(cx, |editor, window, cx| {
589 (
590 editor.snapshot(window, cx).buffer_snapshot.clone(),
591 editor.selections.ranges::<usize>(cx),
592 )
593 });
594
595 let actual_marked_text = generate_marked_text(&snapshot.text(), &selections, true);
596
597 // Read the actual diff.
598 let line_infos = snapshot.row_infos(MultiBufferRow(0)).collect::<Vec<_>>();
599 let has_diff = line_infos.iter().any(|info| info.diff_status.is_some());
600 let actual_diff = actual_marked_text
601 .split('\n')
602 .zip(line_infos)
603 .map(|(line, info)| {
604 let mut marker = match info.diff_status.map(|status| status.kind) {
605 Some(DiffHunkStatusKind::Added) => "+ ",
606 Some(DiffHunkStatusKind::Deleted) => "- ",
607 Some(DiffHunkStatusKind::Modified) => unreachable!(),
608 None => {
609 if has_diff {
610 " "
611 } else {
612 ""
613 }
614 }
615 };
616 if line.is_empty() {
617 marker = marker.trim();
618 }
619 format!("{marker}{line}")
620 })
621 .collect::<Vec<_>>()
622 .join("\n");
623
624 pretty_assertions::assert_eq!(actual_diff, expected_diff_text, "unexpected diff state");
625}
626
627impl Deref for EditorTestContext {
628 type Target = gpui::VisualTestContext;
629
630 fn deref(&self) -> &Self::Target {
631 &self.cx
632 }
633}
634
635impl DerefMut for EditorTestContext {
636 fn deref_mut(&mut self) -> &mut Self::Target {
637 &mut self.cx
638 }
639}
640
641/// Tracks string context to be printed when assertions fail.
642/// Often this is done by storing a context string in the manager and returning the handle.
643#[derive(Clone)]
644pub struct AssertionContextManager {
645 id: Arc<AtomicUsize>,
646 contexts: Arc<RwLock<BTreeMap<usize, String>>>,
647}
648
649impl Default for AssertionContextManager {
650 fn default() -> Self {
651 Self::new()
652 }
653}
654
655impl AssertionContextManager {
656 pub fn new() -> Self {
657 Self {
658 id: Arc::new(AtomicUsize::new(0)),
659 contexts: Arc::new(RwLock::new(BTreeMap::new())),
660 }
661 }
662
663 pub fn add_context(&self, context: String) -> ContextHandle {
664 let id = self.id.fetch_add(1, Ordering::Relaxed);
665 let mut contexts = self.contexts.write();
666 contexts.insert(id, context);
667 ContextHandle {
668 id,
669 manager: self.clone(),
670 }
671 }
672
673 pub fn context(&self) -> String {
674 let contexts = self.contexts.read();
675 format!("\n{}\n", contexts.values().join("\n"))
676 }
677}
678
679/// Used to track the lifetime of a piece of context so that it can be provided when an assertion fails.
680/// For example, in the EditorTestContext, `set_state` returns a context handle so that if an assertion fails,
681/// the state that was set initially for the failure can be printed in the error message
682pub struct ContextHandle {
683 id: usize,
684 manager: AssertionContextManager,
685}
686
687impl Drop for ContextHandle {
688 fn drop(&mut self) {
689 let mut contexts = self.manager.contexts.write();
690 contexts.remove(&self.id);
691 }
692}