1use crate::{
2 Action, AnyView, AnyWindowHandle, App, AppCell, AppContext, AsyncApp, AvailableSpace,
3 BackgroundExecutor, BorrowAppContext, Bounds, ClipboardItem, DrawPhase, Drawable, Element,
4 Empty, EventEmitter, ForegroundExecutor, Global, InputEvent, Keystroke, Modifiers,
5 ModifiersChangedEvent, MouseButton, MouseDownEvent, MouseMoveEvent, MouseUpEvent, Pixels,
6 Platform, Point, Render, Result, Size, Task, TestDispatcher, TestPlatform,
7 TestScreenCaptureSource, TestWindow, TextSystem, VisualContext, Window, WindowBounds,
8 WindowHandle, WindowOptions,
9};
10use anyhow::{anyhow, bail};
11use futures::{channel::oneshot, Stream, StreamExt};
12use std::{cell::RefCell, future::Future, ops::Deref, rc::Rc, sync::Arc, time::Duration};
13
14/// A TestAppContext is provided to tests created with `#[gpui::test]`, it provides
15/// an implementation of `Context` with additional methods that are useful in tests.
16#[derive(Clone)]
17pub struct TestAppContext {
18 #[doc(hidden)]
19 pub app: Rc<AppCell>,
20 #[doc(hidden)]
21 pub background_executor: BackgroundExecutor,
22 #[doc(hidden)]
23 pub foreground_executor: ForegroundExecutor,
24 #[doc(hidden)]
25 pub dispatcher: TestDispatcher,
26 test_platform: Rc<TestPlatform>,
27 text_system: Arc<TextSystem>,
28 fn_name: Option<&'static str>,
29 on_quit: Rc<RefCell<Vec<Box<dyn FnOnce() + 'static>>>>,
30}
31
32impl AppContext for TestAppContext {
33 type Result<T> = T;
34
35 fn new<T: 'static>(
36 &mut self,
37 build_entity: impl FnOnce(&mut Context<'_, T>) -> T,
38 ) -> Self::Result<Entity<T>> {
39 let mut app = self.app.borrow_mut();
40 app.new(build_entity)
41 }
42
43 fn reserve_entity<T: 'static>(&mut self) -> Self::Result<crate::Reservation<T>> {
44 let mut app = self.app.borrow_mut();
45 app.reserve_entity()
46 }
47
48 fn insert_entity<T: 'static>(
49 &mut self,
50 reservation: crate::Reservation<T>,
51 build_entity: impl FnOnce(&mut Context<'_, T>) -> T,
52 ) -> Self::Result<Entity<T>> {
53 let mut app = self.app.borrow_mut();
54 app.insert_entity(reservation, build_entity)
55 }
56
57 fn update_entity<T: 'static, R>(
58 &mut self,
59 handle: &Entity<T>,
60 update: impl FnOnce(&mut T, &mut Context<'_, T>) -> R,
61 ) -> Self::Result<R> {
62 let mut app = self.app.borrow_mut();
63 app.update_entity(handle, update)
64 }
65
66 fn read_entity<T, R>(
67 &self,
68 handle: &Entity<T>,
69 read: impl FnOnce(&T, &App) -> R,
70 ) -> Self::Result<R>
71 where
72 T: 'static,
73 {
74 let app = self.app.borrow();
75 app.read_entity(handle, read)
76 }
77
78 fn update_window<T, F>(&mut self, window: AnyWindowHandle, f: F) -> Result<T>
79 where
80 F: FnOnce(AnyView, &mut Window, &mut App) -> T,
81 {
82 let mut lock = self.app.borrow_mut();
83 lock.update_window(window, f)
84 }
85
86 fn read_window<T, R>(
87 &self,
88 window: &WindowHandle<T>,
89 read: impl FnOnce(Entity<T>, &App) -> R,
90 ) -> Result<R>
91 where
92 T: 'static,
93 {
94 let app = self.app.borrow();
95 app.read_window(window, read)
96 }
97
98 fn background_spawn<R>(&self, future: impl Future<Output = R> + Send + 'static) -> Task<R>
99 where
100 R: Send + 'static,
101 {
102 self.background_executor.spawn(future)
103 }
104
105 fn read_global<G, R>(&self, callback: impl FnOnce(&G, &App) -> R) -> Self::Result<R>
106 where
107 G: Global,
108 {
109 let app = self.app.borrow();
110 app.read_global(callback)
111 }
112}
113
114impl TestAppContext {
115 /// Creates a new `TestAppContext`. Usually you can rely on `#[gpui::test]` to do this for you.
116 pub fn new(dispatcher: TestDispatcher, fn_name: Option<&'static str>) -> Self {
117 let arc_dispatcher = Arc::new(dispatcher.clone());
118 let background_executor = BackgroundExecutor::new(arc_dispatcher.clone());
119 let foreground_executor = ForegroundExecutor::new(arc_dispatcher);
120 let platform = TestPlatform::new(background_executor.clone(), foreground_executor.clone());
121 let asset_source = Arc::new(());
122 let http_client = http_client::FakeHttpClient::with_404_response();
123 let text_system = Arc::new(TextSystem::new(platform.text_system()));
124
125 Self {
126 app: App::new_app(platform.clone(), asset_source, http_client),
127 background_executor,
128 foreground_executor,
129 dispatcher: dispatcher.clone(),
130 test_platform: platform,
131 text_system,
132 fn_name,
133 on_quit: Rc::new(RefCell::new(Vec::default())),
134 }
135 }
136
137 /// The name of the test function that created this `TestAppContext`
138 pub fn test_function_name(&self) -> Option<&'static str> {
139 self.fn_name
140 }
141
142 /// Checks whether there have been any new path prompts received by the platform.
143 pub fn did_prompt_for_new_path(&self) -> bool {
144 self.test_platform.did_prompt_for_new_path()
145 }
146
147 /// returns a new `TestAppContext` re-using the same executors to interleave tasks.
148 pub fn new_app(&self) -> TestAppContext {
149 Self::new(self.dispatcher.clone(), self.fn_name)
150 }
151
152 /// Called by the test helper to end the test.
153 /// public so the macro can call it.
154 pub fn quit(&self) {
155 self.on_quit.borrow_mut().drain(..).for_each(|f| f());
156 self.app.borrow_mut().shutdown();
157 }
158
159 /// Register cleanup to run when the test ends.
160 pub fn on_quit(&mut self, f: impl FnOnce() + 'static) {
161 self.on_quit.borrow_mut().push(Box::new(f));
162 }
163
164 /// Schedules all windows to be redrawn on the next effect cycle.
165 pub fn refresh(&mut self) -> Result<()> {
166 let mut app = self.app.borrow_mut();
167 app.refresh_windows();
168 Ok(())
169 }
170
171 /// Returns an executor (for running tasks in the background)
172 pub fn executor(&self) -> BackgroundExecutor {
173 self.background_executor.clone()
174 }
175
176 /// Returns an executor (for running tasks on the main thread)
177 pub fn foreground_executor(&self) -> &ForegroundExecutor {
178 &self.foreground_executor
179 }
180
181 /// Gives you an `&mut App` for the duration of the closure
182 pub fn update<R>(&self, f: impl FnOnce(&mut App) -> R) -> R {
183 let mut cx = self.app.borrow_mut();
184 cx.update(f)
185 }
186
187 /// Gives you an `&App` for the duration of the closure
188 pub fn read<R>(&self, f: impl FnOnce(&App) -> R) -> R {
189 let cx = self.app.borrow();
190 f(&cx)
191 }
192
193 /// Adds a new window. The Window will always be backed by a `TestWindow` which
194 /// can be retrieved with `self.test_window(handle)`
195 pub fn add_window<F, V>(&mut self, build_window: F) -> WindowHandle<V>
196 where
197 F: FnOnce(&mut Window, &mut Context<V>) -> V,
198 V: 'static + Render,
199 {
200 let mut cx = self.app.borrow_mut();
201
202 // Some tests rely on the window size matching the bounds of the test display
203 let bounds = Bounds::maximized(None, &mut cx);
204 cx.open_window(
205 WindowOptions {
206 window_bounds: Some(WindowBounds::Windowed(bounds)),
207 ..Default::default()
208 },
209 |window, cx| cx.new(|cx| build_window(window, cx)),
210 )
211 .unwrap()
212 }
213
214 /// Adds a new window with no content.
215 pub fn add_empty_window(&mut self) -> &mut VisualTestContext {
216 let mut cx = self.app.borrow_mut();
217 let bounds = Bounds::maximized(None, &mut cx);
218 let window = cx
219 .open_window(
220 WindowOptions {
221 window_bounds: Some(WindowBounds::Windowed(bounds)),
222 ..Default::default()
223 },
224 |_, cx| cx.new(|_| Empty),
225 )
226 .unwrap();
227 drop(cx);
228 let cx = VisualTestContext::from_window(*window.deref(), self).as_mut();
229 cx.run_until_parked();
230 cx
231 }
232
233 /// Adds a new window, and returns its root view and a `VisualTestContext` which can be used
234 /// as a `Window` and `App` for the rest of the test. Typically you would shadow this context with
235 /// the returned one. `let (view, cx) = cx.add_window_view(...);`
236 pub fn add_window_view<F, V>(
237 &mut self,
238 build_root_view: F,
239 ) -> (Entity<V>, &mut VisualTestContext)
240 where
241 F: FnOnce(&mut Window, &mut Context<V>) -> V,
242 V: 'static + Render,
243 {
244 let mut cx = self.app.borrow_mut();
245 let bounds = Bounds::maximized(None, &mut cx);
246 let window = cx
247 .open_window(
248 WindowOptions {
249 window_bounds: Some(WindowBounds::Windowed(bounds)),
250 ..Default::default()
251 },
252 |window, cx| cx.new(|cx| build_root_view(window, cx)),
253 )
254 .unwrap();
255 drop(cx);
256 let view = window.root(self).unwrap();
257 let cx = VisualTestContext::from_window(*window.deref(), self).as_mut();
258 cx.run_until_parked();
259
260 // it might be nice to try and cleanup these at the end of each test.
261 (view, cx)
262 }
263
264 /// returns the TextSystem
265 pub fn text_system(&self) -> &Arc<TextSystem> {
266 &self.text_system
267 }
268
269 /// Simulates writing to the platform clipboard
270 pub fn write_to_clipboard(&self, item: ClipboardItem) {
271 self.test_platform.write_to_clipboard(item)
272 }
273
274 /// Simulates reading from the platform clipboard.
275 /// This will return the most recent value from `write_to_clipboard`.
276 pub fn read_from_clipboard(&self) -> Option<ClipboardItem> {
277 self.test_platform.read_from_clipboard()
278 }
279
280 /// Simulates choosing a File in the platform's "Open" dialog.
281 pub fn simulate_new_path_selection(
282 &self,
283 select_path: impl FnOnce(&std::path::Path) -> Option<std::path::PathBuf>,
284 ) {
285 self.test_platform.simulate_new_path_selection(select_path);
286 }
287
288 /// Simulates clicking a button in an platform-level alert dialog.
289 #[track_caller]
290 pub fn simulate_prompt_answer(&self, button: &str) {
291 self.test_platform.simulate_prompt_answer(button);
292 }
293
294 /// Returns true if there's an alert dialog open.
295 pub fn has_pending_prompt(&self) -> bool {
296 self.test_platform.has_pending_prompt()
297 }
298
299 /// Returns true if there's an alert dialog open.
300 pub fn pending_prompt(&self) -> Option<(String, String)> {
301 self.test_platform.pending_prompt()
302 }
303
304 /// All the urls that have been opened with cx.open_url() during this test.
305 pub fn opened_url(&self) -> Option<String> {
306 self.test_platform.opened_url.borrow().clone()
307 }
308
309 /// Simulates the user resizing the window to the new size.
310 pub fn simulate_window_resize(&self, window_handle: AnyWindowHandle, size: Size<Pixels>) {
311 self.test_window(window_handle).simulate_resize(size);
312 }
313
314 /// Causes the given sources to be returned if the application queries for screen
315 /// capture sources.
316 pub fn set_screen_capture_sources(&self, sources: Vec<TestScreenCaptureSource>) {
317 self.test_platform.set_screen_capture_sources(sources);
318 }
319
320 /// Returns all windows open in the test.
321 pub fn windows(&self) -> Vec<AnyWindowHandle> {
322 self.app.borrow().windows().clone()
323 }
324
325 /// Run the given task on the main thread.
326 #[track_caller]
327 pub fn spawn<Fut, R>(&self, f: impl FnOnce(AsyncApp) -> Fut) -> Task<R>
328 where
329 Fut: Future<Output = R> + 'static,
330 R: 'static,
331 {
332 self.foreground_executor.spawn(f(self.to_async()))
333 }
334
335 /// true if the given global is defined
336 pub fn has_global<G: Global>(&self) -> bool {
337 let app = self.app.borrow();
338 app.has_global::<G>()
339 }
340
341 /// runs the given closure with a reference to the global
342 /// panics if `has_global` would return false.
343 pub fn read_global<G: Global, R>(&self, read: impl FnOnce(&G, &App) -> R) -> R {
344 let app = self.app.borrow();
345 read(app.global(), &app)
346 }
347
348 /// runs the given closure with a reference to the global (if set)
349 pub fn try_read_global<G: Global, R>(&self, read: impl FnOnce(&G, &App) -> R) -> Option<R> {
350 let lock = self.app.borrow();
351 Some(read(lock.try_global()?, &lock))
352 }
353
354 /// sets the global in this context.
355 pub fn set_global<G: Global>(&mut self, global: G) {
356 let mut lock = self.app.borrow_mut();
357 lock.update(|cx| cx.set_global(global))
358 }
359
360 /// updates the global in this context. (panics if `has_global` would return false)
361 pub fn update_global<G: Global, R>(&mut self, update: impl FnOnce(&mut G, &mut App) -> R) -> R {
362 let mut lock = self.app.borrow_mut();
363 lock.update(|cx| cx.update_global(update))
364 }
365
366 /// Returns an `AsyncApp` which can be used to run tasks that expect to be on a background
367 /// thread on the current thread in tests.
368 pub fn to_async(&self) -> AsyncApp {
369 AsyncApp {
370 app: Rc::downgrade(&self.app),
371 background_executor: self.background_executor.clone(),
372 foreground_executor: self.foreground_executor.clone(),
373 }
374 }
375
376 /// Wait until there are no more pending tasks.
377 pub fn run_until_parked(&mut self) {
378 self.background_executor.run_until_parked()
379 }
380
381 /// Simulate dispatching an action to the currently focused node in the window.
382 pub fn dispatch_action<A>(&mut self, window: AnyWindowHandle, action: A)
383 where
384 A: Action,
385 {
386 window
387 .update(self, |_, window, cx| {
388 window.dispatch_action(action.boxed_clone(), cx)
389 })
390 .unwrap();
391
392 self.background_executor.run_until_parked()
393 }
394
395 /// simulate_keystrokes takes a space-separated list of keys to type.
396 /// cx.simulate_keystrokes("cmd-shift-p b k s p enter")
397 /// in Zed, this will run backspace on the current editor through the command palette.
398 /// This will also run the background executor until it's parked.
399 pub fn simulate_keystrokes(&mut self, window: AnyWindowHandle, keystrokes: &str) {
400 for keystroke in keystrokes
401 .split(' ')
402 .map(Keystroke::parse_case_insensitive)
403 .map(Result::unwrap)
404 {
405 self.dispatch_keystroke(window, keystroke);
406 }
407
408 self.background_executor.run_until_parked()
409 }
410
411 /// simulate_input takes a string of text to type.
412 /// cx.simulate_input("abc")
413 /// will type abc into your current editor
414 /// This will also run the background executor until it's parked.
415 pub fn simulate_input(&mut self, window: AnyWindowHandle, input: &str) {
416 for keystroke in input
417 .split("")
418 .map(Keystroke::parse_case_insensitive)
419 .map(Result::unwrap)
420 {
421 self.dispatch_keystroke(window, keystroke);
422 }
423
424 self.background_executor.run_until_parked()
425 }
426
427 /// dispatches a single Keystroke (see also `simulate_keystrokes` and `simulate_input`)
428 pub fn dispatch_keystroke(&mut self, window: AnyWindowHandle, keystroke: Keystroke) {
429 self.update_window(window, |_, window, cx| {
430 window.dispatch_keystroke(keystroke, cx)
431 })
432 .unwrap();
433 }
434
435 /// Returns the `TestWindow` backing the given handle.
436 pub(crate) fn test_window(&self, window: AnyWindowHandle) -> TestWindow {
437 self.app
438 .borrow_mut()
439 .windows
440 .get_mut(window.id)
441 .unwrap()
442 .as_mut()
443 .unwrap()
444 .platform_window
445 .as_test()
446 .unwrap()
447 .clone()
448 }
449
450 /// Returns a stream of notifications whenever the Entity is updated.
451 pub fn notifications<T: 'static>(&mut self, entity: &Entity<T>) -> impl Stream<Item = ()> {
452 let (tx, rx) = futures::channel::mpsc::unbounded();
453 self.update(|cx| {
454 cx.observe(entity, {
455 let tx = tx.clone();
456 move |_, _| {
457 let _ = tx.unbounded_send(());
458 }
459 })
460 .detach();
461 cx.observe_release(entity, move |_, _| tx.close_channel())
462 .detach()
463 });
464 rx
465 }
466
467 /// Returns a stream of events emitted by the given Entity.
468 pub fn events<Evt, T: 'static + EventEmitter<Evt>>(
469 &mut self,
470 entity: &Entity<T>,
471 ) -> futures::channel::mpsc::UnboundedReceiver<Evt>
472 where
473 Evt: 'static + Clone,
474 {
475 let (tx, rx) = futures::channel::mpsc::unbounded();
476 entity
477 .update(self, |_, cx: &mut Context<T>| {
478 cx.subscribe(entity, move |_entity, _handle, event, _cx| {
479 let _ = tx.unbounded_send(event.clone());
480 })
481 })
482 .detach();
483 rx
484 }
485
486 /// Runs until the given condition becomes true. (Prefer `run_until_parked` if you
487 /// don't need to jump in at a specific time).
488 pub async fn condition<T: 'static>(
489 &mut self,
490 entity: &Entity<T>,
491 mut predicate: impl FnMut(&mut T, &mut Context<T>) -> bool,
492 ) {
493 let timer = self.executor().timer(Duration::from_secs(3));
494 let mut notifications = self.notifications(entity);
495
496 use futures::FutureExt as _;
497 use smol::future::FutureExt as _;
498
499 async {
500 loop {
501 if entity.update(self, &mut predicate) {
502 return Ok(());
503 }
504
505 if notifications.next().await.is_none() {
506 bail!("entity dropped")
507 }
508 }
509 }
510 .race(timer.map(|_| Err(anyhow!("condition timed out"))))
511 .await
512 .unwrap();
513 }
514
515 /// Set a name for this App.
516 #[cfg(any(test, feature = "test-support"))]
517 pub fn set_name(&mut self, name: &'static str) {
518 self.update(|cx| cx.name = Some(name))
519 }
520}
521
522impl<T: 'static> Entity<T> {
523 /// Block until the next event is emitted by the entity, then return it.
524 pub fn next_event<Event>(&self, cx: &mut TestAppContext) -> impl Future<Output = Event>
525 where
526 Event: Send + Clone + 'static,
527 T: EventEmitter<Event>,
528 {
529 let (tx, mut rx) = oneshot::channel();
530 let mut tx = Some(tx);
531 let subscription = self.update(cx, |_, cx| {
532 cx.subscribe(self, move |_, _, event, _| {
533 if let Some(tx) = tx.take() {
534 _ = tx.send(event.clone());
535 }
536 })
537 });
538
539 async move {
540 let event = rx.await.expect("no event emitted");
541 drop(subscription);
542 event
543 }
544 }
545}
546
547impl<V: 'static> Entity<V> {
548 /// Returns a future that resolves when the view is next updated.
549 pub fn next_notification(
550 &self,
551 advance_clock_by: Duration,
552 cx: &TestAppContext,
553 ) -> impl Future<Output = ()> {
554 use postage::prelude::{Sink as _, Stream as _};
555
556 let (mut tx, mut rx) = postage::mpsc::channel(1);
557 let subscription = cx.app.borrow_mut().observe(self, move |_, _| {
558 tx.try_send(()).ok();
559 });
560
561 let duration = if std::env::var("CI").is_ok() {
562 Duration::from_secs(5)
563 } else {
564 Duration::from_secs(1)
565 };
566
567 cx.executor().advance_clock(advance_clock_by);
568
569 async move {
570 let notification = crate::util::timeout(duration, rx.recv())
571 .await
572 .expect("next notification timed out");
573 drop(subscription);
574 notification.expect("entity dropped while test was waiting for its next notification")
575 }
576 }
577}
578
579impl<V> Entity<V> {
580 /// Returns a future that resolves when the condition becomes true.
581 pub fn condition<Evt>(
582 &self,
583 cx: &TestAppContext,
584 mut predicate: impl FnMut(&V, &App) -> bool,
585 ) -> impl Future<Output = ()>
586 where
587 Evt: 'static,
588 V: EventEmitter<Evt>,
589 {
590 use postage::prelude::{Sink as _, Stream as _};
591
592 let (tx, mut rx) = postage::mpsc::channel(1024);
593 let timeout_duration = if cfg!(target_os = "macos") {
594 Duration::from_millis(100)
595 } else {
596 Duration::from_secs(1)
597 };
598
599 let mut cx = cx.app.borrow_mut();
600 let subscriptions = (
601 cx.observe(self, {
602 let mut tx = tx.clone();
603 move |_, _| {
604 tx.blocking_send(()).ok();
605 }
606 }),
607 cx.subscribe(self, {
608 let mut tx = tx.clone();
609 move |_, _: &Evt, _| {
610 tx.blocking_send(()).ok();
611 }
612 }),
613 );
614
615 let cx = cx.this.upgrade().unwrap();
616 let handle = self.downgrade();
617
618 async move {
619 crate::util::timeout(timeout_duration, async move {
620 loop {
621 {
622 let cx = cx.borrow();
623 let cx = &*cx;
624 if predicate(
625 handle
626 .upgrade()
627 .expect("view dropped with pending condition")
628 .read(cx),
629 cx,
630 ) {
631 break;
632 }
633 }
634
635 cx.borrow().background_executor().start_waiting();
636 rx.recv()
637 .await
638 .expect("view dropped with pending condition");
639 cx.borrow().background_executor().finish_waiting();
640 }
641 })
642 .await
643 .expect("condition timed out");
644 drop(subscriptions);
645 }
646 }
647}
648
649use derive_more::{Deref, DerefMut};
650
651use super::{Context, Entity};
652#[derive(Deref, DerefMut, Clone)]
653/// A VisualTestContext is the test-equivalent of a `Window` and `App`. It allows you to
654/// run window-specific test code. It can be dereferenced to a `TextAppContext`.
655pub struct VisualTestContext {
656 #[deref]
657 #[deref_mut]
658 /// cx is the original TestAppContext (you can more easily access this using Deref)
659 pub cx: TestAppContext,
660 window: AnyWindowHandle,
661}
662
663impl VisualTestContext {
664 /// Provides a `Window` and `App` for the duration of the closure.
665 pub fn update<R>(&mut self, f: impl FnOnce(&mut Window, &mut App) -> R) -> R {
666 self.cx
667 .update_window(self.window, |_, window, cx| f(window, cx))
668 .unwrap()
669 }
670
671 /// Creates a new VisualTestContext. You would typically shadow the passed in
672 /// TestAppContext with this, as this is typically more useful.
673 /// `let cx = VisualTestContext::from_window(window, cx);`
674 pub fn from_window(window: AnyWindowHandle, cx: &TestAppContext) -> Self {
675 Self {
676 cx: cx.clone(),
677 window,
678 }
679 }
680
681 /// Wait until there are no more pending tasks.
682 pub fn run_until_parked(&self) {
683 self.cx.background_executor.run_until_parked();
684 }
685
686 /// Dispatch the action to the currently focused node.
687 pub fn dispatch_action<A>(&mut self, action: A)
688 where
689 A: Action,
690 {
691 self.cx.dispatch_action(self.window, action)
692 }
693
694 /// Read the title off the window (set by `Window#set_window_title`)
695 pub fn window_title(&mut self) -> Option<String> {
696 self.cx.test_window(self.window).0.lock().title.clone()
697 }
698
699 /// Simulate a sequence of keystrokes `cx.simulate_keystrokes("cmd-p escape")`
700 /// Automatically runs until parked.
701 pub fn simulate_keystrokes(&mut self, keystrokes: &str) {
702 self.cx.simulate_keystrokes(self.window, keystrokes)
703 }
704
705 /// Simulate typing text `cx.simulate_input("hello")`
706 /// Automatically runs until parked.
707 pub fn simulate_input(&mut self, input: &str) {
708 self.cx.simulate_input(self.window, input)
709 }
710
711 /// Simulate a mouse move event to the given point
712 pub fn simulate_mouse_move(
713 &mut self,
714 position: Point<Pixels>,
715 button: impl Into<Option<MouseButton>>,
716 modifiers: Modifiers,
717 ) {
718 self.simulate_event(MouseMoveEvent {
719 position,
720 modifiers,
721 pressed_button: button.into(),
722 })
723 }
724
725 /// Simulate a mouse down event to the given point
726 pub fn simulate_mouse_down(
727 &mut self,
728 position: Point<Pixels>,
729 button: MouseButton,
730 modifiers: Modifiers,
731 ) {
732 self.simulate_event(MouseDownEvent {
733 position,
734 modifiers,
735 button,
736 click_count: 1,
737 first_mouse: false,
738 })
739 }
740
741 /// Simulate a mouse up event to the given point
742 pub fn simulate_mouse_up(
743 &mut self,
744 position: Point<Pixels>,
745 button: MouseButton,
746 modifiers: Modifiers,
747 ) {
748 self.simulate_event(MouseUpEvent {
749 position,
750 modifiers,
751 button,
752 click_count: 1,
753 })
754 }
755
756 /// Simulate a primary mouse click at the given point
757 pub fn simulate_click(&mut self, position: Point<Pixels>, modifiers: Modifiers) {
758 self.simulate_event(MouseDownEvent {
759 position,
760 modifiers,
761 button: MouseButton::Left,
762 click_count: 1,
763 first_mouse: false,
764 });
765 self.simulate_event(MouseUpEvent {
766 position,
767 modifiers,
768 button: MouseButton::Left,
769 click_count: 1,
770 });
771 }
772
773 /// Simulate a modifiers changed event
774 pub fn simulate_modifiers_change(&mut self, modifiers: Modifiers) {
775 self.simulate_event(ModifiersChangedEvent { modifiers })
776 }
777
778 /// Simulates the user resizing the window to the new size.
779 pub fn simulate_resize(&self, size: Size<Pixels>) {
780 self.simulate_window_resize(self.window, size)
781 }
782
783 /// debug_bounds returns the bounds of the element with the given selector.
784 pub fn debug_bounds(&mut self, selector: &'static str) -> Option<Bounds<Pixels>> {
785 self.update(|window, _| window.rendered_frame.debug_bounds.get(selector).copied())
786 }
787
788 /// Draw an element to the window. Useful for simulating events or actions
789 pub fn draw<E>(
790 &mut self,
791 origin: Point<Pixels>,
792 space: impl Into<Size<AvailableSpace>>,
793 f: impl FnOnce(&mut Window, &mut App) -> E,
794 ) -> (E::RequestLayoutState, E::PrepaintState)
795 where
796 E: Element,
797 {
798 self.update(|window, cx| {
799 window.invalidator.set_phase(DrawPhase::Prepaint);
800 let mut element = Drawable::new(f(window, cx));
801 element.layout_as_root(space.into(), window, cx);
802 window.with_absolute_element_offset(origin, |window| element.prepaint(window, cx));
803
804 window.invalidator.set_phase(DrawPhase::Paint);
805 let (request_layout_state, prepaint_state) = element.paint(window, cx);
806
807 window.invalidator.set_phase(DrawPhase::None);
808 window.refresh();
809
810 (request_layout_state, prepaint_state)
811 })
812 }
813
814 /// Simulate an event from the platform, e.g. a SrollWheelEvent
815 /// Make sure you've called [VisualTestContext::draw] first!
816 pub fn simulate_event<E: InputEvent>(&mut self, event: E) {
817 self.test_window(self.window)
818 .simulate_input(event.to_platform_input());
819 self.background_executor.run_until_parked();
820 }
821
822 /// Simulates the user blurring the window.
823 pub fn deactivate_window(&mut self) {
824 if Some(self.window) == self.test_platform.active_window() {
825 self.test_platform.set_active_window(None)
826 }
827 self.background_executor.run_until_parked();
828 }
829
830 /// Simulates the user closing the window.
831 /// Returns true if the window was closed.
832 pub fn simulate_close(&mut self) -> bool {
833 let handler = self
834 .cx
835 .update_window(self.window, |_, window, _| {
836 window
837 .platform_window
838 .as_test()
839 .unwrap()
840 .0
841 .lock()
842 .should_close_handler
843 .take()
844 })
845 .unwrap();
846 if let Some(mut handler) = handler {
847 let should_close = handler();
848 self.cx
849 .update_window(self.window, |_, window, _| {
850 window.platform_window.on_should_close(handler);
851 })
852 .unwrap();
853 should_close
854 } else {
855 false
856 }
857 }
858
859 /// Get an &mut VisualTestContext (which is mostly what you need to pass to other methods).
860 /// This method internally retains the VisualTestContext until the end of the test.
861 pub fn as_mut(self) -> &'static mut Self {
862 let ptr = Box::into_raw(Box::new(self));
863 // safety: on_quit will be called after the test has finished.
864 // the executor will ensure that all tasks related to the test have stopped.
865 // so there is no way for cx to be accessed after on_quit is called.
866 let cx = Box::leak(unsafe { Box::from_raw(ptr) });
867 cx.on_quit(move || unsafe {
868 drop(Box::from_raw(ptr));
869 });
870 cx
871 }
872}
873
874impl AppContext for VisualTestContext {
875 type Result<T> = <TestAppContext as AppContext>::Result<T>;
876
877 fn new<T: 'static>(
878 &mut self,
879 build_entity: impl FnOnce(&mut Context<'_, T>) -> T,
880 ) -> Self::Result<Entity<T>> {
881 self.cx.new(build_entity)
882 }
883
884 fn reserve_entity<T: 'static>(&mut self) -> Self::Result<crate::Reservation<T>> {
885 self.cx.reserve_entity()
886 }
887
888 fn insert_entity<T: 'static>(
889 &mut self,
890 reservation: crate::Reservation<T>,
891 build_entity: impl FnOnce(&mut Context<'_, T>) -> T,
892 ) -> Self::Result<Entity<T>> {
893 self.cx.insert_entity(reservation, build_entity)
894 }
895
896 fn update_entity<T, R>(
897 &mut self,
898 handle: &Entity<T>,
899 update: impl FnOnce(&mut T, &mut Context<'_, T>) -> R,
900 ) -> Self::Result<R>
901 where
902 T: 'static,
903 {
904 self.cx.update_entity(handle, update)
905 }
906
907 fn read_entity<T, R>(
908 &self,
909 handle: &Entity<T>,
910 read: impl FnOnce(&T, &App) -> R,
911 ) -> Self::Result<R>
912 where
913 T: 'static,
914 {
915 self.cx.read_entity(handle, read)
916 }
917
918 fn update_window<T, F>(&mut self, window: AnyWindowHandle, f: F) -> Result<T>
919 where
920 F: FnOnce(AnyView, &mut Window, &mut App) -> T,
921 {
922 self.cx.update_window(window, f)
923 }
924
925 fn read_window<T, R>(
926 &self,
927 window: &WindowHandle<T>,
928 read: impl FnOnce(Entity<T>, &App) -> R,
929 ) -> Result<R>
930 where
931 T: 'static,
932 {
933 self.cx.read_window(window, read)
934 }
935
936 fn background_spawn<R>(&self, future: impl Future<Output = R> + Send + 'static) -> Task<R>
937 where
938 R: Send + 'static,
939 {
940 self.cx.background_spawn(future)
941 }
942
943 fn read_global<G, R>(&self, callback: impl FnOnce(&G, &App) -> R) -> Self::Result<R>
944 where
945 G: Global,
946 {
947 self.cx.read_global(callback)
948 }
949}
950
951impl VisualContext for VisualTestContext {
952 /// Get the underlying window handle underlying this context.
953 fn window_handle(&self) -> AnyWindowHandle {
954 self.window
955 }
956
957 fn new_window_entity<T: 'static>(
958 &mut self,
959 build_entity: impl FnOnce(&mut Window, &mut Context<'_, T>) -> T,
960 ) -> Self::Result<Entity<T>> {
961 self.window
962 .update(&mut self.cx, |_, window, cx| {
963 cx.new(|cx| build_entity(window, cx))
964 })
965 .unwrap()
966 }
967
968 fn update_window_entity<V: 'static, R>(
969 &mut self,
970 view: &Entity<V>,
971 update: impl FnOnce(&mut V, &mut Window, &mut Context<V>) -> R,
972 ) -> Self::Result<R> {
973 self.window
974 .update(&mut self.cx, |_, window, cx| {
975 view.update(cx, |v, cx| update(v, window, cx))
976 })
977 .unwrap()
978 }
979
980 fn replace_root_view<V>(
981 &mut self,
982 build_view: impl FnOnce(&mut Window, &mut Context<V>) -> V,
983 ) -> Self::Result<Entity<V>>
984 where
985 V: 'static + Render,
986 {
987 self.window
988 .update(&mut self.cx, |_, window, cx| {
989 window.replace_root(cx, build_view)
990 })
991 .unwrap()
992 }
993
994 fn focus<V: crate::Focusable>(&mut self, view: &Entity<V>) -> Self::Result<()> {
995 self.window
996 .update(&mut self.cx, |_, window, cx| {
997 view.read(cx).focus_handle(cx).clone().focus(window)
998 })
999 .unwrap()
1000 }
1001}
1002
1003impl AnyWindowHandle {
1004 /// Creates the given view in this window.
1005 pub fn build_entity<V: Render + 'static>(
1006 &self,
1007 cx: &mut TestAppContext,
1008 build_view: impl FnOnce(&mut Window, &mut Context<V>) -> V,
1009 ) -> Entity<V> {
1010 self.update(cx, |_, window, cx| cx.new(|cx| build_view(window, cx)))
1011 .unwrap()
1012 }
1013}