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 pub fn simulate_prompt_answer(&self, button_ix: usize) {
290 self.test_platform.simulate_prompt_answer(button_ix);
291 }
292
293 /// Returns true if there's an alert dialog open.
294 pub fn has_pending_prompt(&self) -> bool {
295 self.test_platform.has_pending_prompt()
296 }
297
298 /// All the urls that have been opened with cx.open_url() during this test.
299 pub fn opened_url(&self) -> Option<String> {
300 self.test_platform.opened_url.borrow().clone()
301 }
302
303 /// Simulates the user resizing the window to the new size.
304 pub fn simulate_window_resize(&self, window_handle: AnyWindowHandle, size: Size<Pixels>) {
305 self.test_window(window_handle).simulate_resize(size);
306 }
307
308 /// Causes the given sources to be returned if the application queries for screen
309 /// capture sources.
310 pub fn set_screen_capture_sources(&self, sources: Vec<TestScreenCaptureSource>) {
311 self.test_platform.set_screen_capture_sources(sources);
312 }
313
314 /// Returns all windows open in the test.
315 pub fn windows(&self) -> Vec<AnyWindowHandle> {
316 self.app.borrow().windows().clone()
317 }
318
319 /// Run the given task on the main thread.
320 #[track_caller]
321 pub fn spawn<Fut, R>(&self, f: impl FnOnce(AsyncApp) -> Fut) -> Task<R>
322 where
323 Fut: Future<Output = R> + 'static,
324 R: 'static,
325 {
326 self.foreground_executor.spawn(f(self.to_async()))
327 }
328
329 /// true if the given global is defined
330 pub fn has_global<G: Global>(&self) -> bool {
331 let app = self.app.borrow();
332 app.has_global::<G>()
333 }
334
335 /// runs the given closure with a reference to the global
336 /// panics if `has_global` would return false.
337 pub fn read_global<G: Global, R>(&self, read: impl FnOnce(&G, &App) -> R) -> R {
338 let app = self.app.borrow();
339 read(app.global(), &app)
340 }
341
342 /// runs the given closure with a reference to the global (if set)
343 pub fn try_read_global<G: Global, R>(&self, read: impl FnOnce(&G, &App) -> R) -> Option<R> {
344 let lock = self.app.borrow();
345 Some(read(lock.try_global()?, &lock))
346 }
347
348 /// sets the global in this context.
349 pub fn set_global<G: Global>(&mut self, global: G) {
350 let mut lock = self.app.borrow_mut();
351 lock.update(|cx| cx.set_global(global))
352 }
353
354 /// updates the global in this context. (panics if `has_global` would return false)
355 pub fn update_global<G: Global, R>(&mut self, update: impl FnOnce(&mut G, &mut App) -> R) -> R {
356 let mut lock = self.app.borrow_mut();
357 lock.update(|cx| cx.update_global(update))
358 }
359
360 /// Returns an `AsyncApp` which can be used to run tasks that expect to be on a background
361 /// thread on the current thread in tests.
362 pub fn to_async(&self) -> AsyncApp {
363 AsyncApp {
364 app: Rc::downgrade(&self.app),
365 background_executor: self.background_executor.clone(),
366 foreground_executor: self.foreground_executor.clone(),
367 }
368 }
369
370 /// Wait until there are no more pending tasks.
371 pub fn run_until_parked(&mut self) {
372 self.background_executor.run_until_parked()
373 }
374
375 /// Simulate dispatching an action to the currently focused node in the window.
376 pub fn dispatch_action<A>(&mut self, window: AnyWindowHandle, action: A)
377 where
378 A: Action,
379 {
380 window
381 .update(self, |_, window, cx| {
382 window.dispatch_action(action.boxed_clone(), cx)
383 })
384 .unwrap();
385
386 self.background_executor.run_until_parked()
387 }
388
389 /// simulate_keystrokes takes a space-separated list of keys to type.
390 /// cx.simulate_keystrokes("cmd-shift-p b k s p enter")
391 /// in Zed, this will run backspace on the current editor through the command palette.
392 /// This will also run the background executor until it's parked.
393 pub fn simulate_keystrokes(&mut self, window: AnyWindowHandle, keystrokes: &str) {
394 for keystroke in keystrokes
395 .split(' ')
396 .map(Keystroke::parse)
397 .map(Result::unwrap)
398 {
399 self.dispatch_keystroke(window, keystroke);
400 }
401
402 self.background_executor.run_until_parked()
403 }
404
405 /// simulate_input takes a string of text to type.
406 /// cx.simulate_input("abc")
407 /// will type abc into your current editor
408 /// This will also run the background executor until it's parked.
409 pub fn simulate_input(&mut self, window: AnyWindowHandle, input: &str) {
410 for keystroke in input.split("").map(Keystroke::parse).map(Result::unwrap) {
411 self.dispatch_keystroke(window, keystroke);
412 }
413
414 self.background_executor.run_until_parked()
415 }
416
417 /// dispatches a single Keystroke (see also `simulate_keystrokes` and `simulate_input`)
418 pub fn dispatch_keystroke(&mut self, window: AnyWindowHandle, keystroke: Keystroke) {
419 self.update_window(window, |_, window, cx| {
420 window.dispatch_keystroke(keystroke, cx)
421 })
422 .unwrap();
423 }
424
425 /// Returns the `TestWindow` backing the given handle.
426 pub(crate) fn test_window(&self, window: AnyWindowHandle) -> TestWindow {
427 self.app
428 .borrow_mut()
429 .windows
430 .get_mut(window.id)
431 .unwrap()
432 .as_mut()
433 .unwrap()
434 .platform_window
435 .as_test()
436 .unwrap()
437 .clone()
438 }
439
440 /// Returns a stream of notifications whenever the Entity is updated.
441 pub fn notifications<T: 'static>(&mut self, entity: &Entity<T>) -> impl Stream<Item = ()> {
442 let (tx, rx) = futures::channel::mpsc::unbounded();
443 self.update(|cx| {
444 cx.observe(entity, {
445 let tx = tx.clone();
446 move |_, _| {
447 let _ = tx.unbounded_send(());
448 }
449 })
450 .detach();
451 cx.observe_release(entity, move |_, _| tx.close_channel())
452 .detach()
453 });
454 rx
455 }
456
457 /// Returns a stream of events emitted by the given Entity.
458 pub fn events<Evt, T: 'static + EventEmitter<Evt>>(
459 &mut self,
460 entity: &Entity<T>,
461 ) -> futures::channel::mpsc::UnboundedReceiver<Evt>
462 where
463 Evt: 'static + Clone,
464 {
465 let (tx, rx) = futures::channel::mpsc::unbounded();
466 entity
467 .update(self, |_, cx: &mut Context<T>| {
468 cx.subscribe(entity, move |_entity, _handle, event, _cx| {
469 let _ = tx.unbounded_send(event.clone());
470 })
471 })
472 .detach();
473 rx
474 }
475
476 /// Runs until the given condition becomes true. (Prefer `run_until_parked` if you
477 /// don't need to jump in at a specific time).
478 pub async fn condition<T: 'static>(
479 &mut self,
480 entity: &Entity<T>,
481 mut predicate: impl FnMut(&mut T, &mut Context<T>) -> bool,
482 ) {
483 let timer = self.executor().timer(Duration::from_secs(3));
484 let mut notifications = self.notifications(entity);
485
486 use futures::FutureExt as _;
487 use smol::future::FutureExt as _;
488
489 async {
490 loop {
491 if entity.update(self, &mut predicate) {
492 return Ok(());
493 }
494
495 if notifications.next().await.is_none() {
496 bail!("entity dropped")
497 }
498 }
499 }
500 .race(timer.map(|_| Err(anyhow!("condition timed out"))))
501 .await
502 .unwrap();
503 }
504
505 /// Set a name for this App.
506 #[cfg(any(test, feature = "test-support"))]
507 pub fn set_name(&mut self, name: &'static str) {
508 self.update(|cx| cx.name = Some(name))
509 }
510}
511
512impl<T: 'static> Entity<T> {
513 /// Block until the next event is emitted by the entity, then return it.
514 pub fn next_event<Event>(&self, cx: &mut TestAppContext) -> impl Future<Output = Event>
515 where
516 Event: Send + Clone + 'static,
517 T: EventEmitter<Event>,
518 {
519 let (tx, mut rx) = oneshot::channel();
520 let mut tx = Some(tx);
521 let subscription = self.update(cx, |_, cx| {
522 cx.subscribe(self, move |_, _, event, _| {
523 if let Some(tx) = tx.take() {
524 _ = tx.send(event.clone());
525 }
526 })
527 });
528
529 async move {
530 let event = rx.await.expect("no event emitted");
531 drop(subscription);
532 event
533 }
534 }
535}
536
537impl<V: 'static> Entity<V> {
538 /// Returns a future that resolves when the view is next updated.
539 pub fn next_notification(
540 &self,
541 advance_clock_by: Duration,
542 cx: &TestAppContext,
543 ) -> impl Future<Output = ()> {
544 use postage::prelude::{Sink as _, Stream as _};
545
546 let (mut tx, mut rx) = postage::mpsc::channel(1);
547 let subscription = cx.app.borrow_mut().observe(self, move |_, _| {
548 tx.try_send(()).ok();
549 });
550
551 let duration = if std::env::var("CI").is_ok() {
552 Duration::from_secs(5)
553 } else {
554 Duration::from_secs(1)
555 };
556
557 cx.executor().advance_clock(advance_clock_by);
558
559 async move {
560 let notification = crate::util::timeout(duration, rx.recv())
561 .await
562 .expect("next notification timed out");
563 drop(subscription);
564 notification.expect("entity dropped while test was waiting for its next notification")
565 }
566 }
567}
568
569impl<V> Entity<V> {
570 /// Returns a future that resolves when the condition becomes true.
571 pub fn condition<Evt>(
572 &self,
573 cx: &TestAppContext,
574 mut predicate: impl FnMut(&V, &App) -> bool,
575 ) -> impl Future<Output = ()>
576 where
577 Evt: 'static,
578 V: EventEmitter<Evt>,
579 {
580 use postage::prelude::{Sink as _, Stream as _};
581
582 let (tx, mut rx) = postage::mpsc::channel(1024);
583 let timeout_duration = if cfg!(target_os = "macos") {
584 Duration::from_millis(100)
585 } else {
586 Duration::from_secs(1)
587 };
588
589 let mut cx = cx.app.borrow_mut();
590 let subscriptions = (
591 cx.observe(self, {
592 let mut tx = tx.clone();
593 move |_, _| {
594 tx.blocking_send(()).ok();
595 }
596 }),
597 cx.subscribe(self, {
598 let mut tx = tx.clone();
599 move |_, _: &Evt, _| {
600 tx.blocking_send(()).ok();
601 }
602 }),
603 );
604
605 let cx = cx.this.upgrade().unwrap();
606 let handle = self.downgrade();
607
608 async move {
609 crate::util::timeout(timeout_duration, async move {
610 loop {
611 {
612 let cx = cx.borrow();
613 let cx = &*cx;
614 if predicate(
615 handle
616 .upgrade()
617 .expect("view dropped with pending condition")
618 .read(cx),
619 cx,
620 ) {
621 break;
622 }
623 }
624
625 cx.borrow().background_executor().start_waiting();
626 rx.recv()
627 .await
628 .expect("view dropped with pending condition");
629 cx.borrow().background_executor().finish_waiting();
630 }
631 })
632 .await
633 .expect("condition timed out");
634 drop(subscriptions);
635 }
636 }
637}
638
639use derive_more::{Deref, DerefMut};
640
641use super::{Context, Entity};
642#[derive(Deref, DerefMut, Clone)]
643/// A VisualTestContext is the test-equivalent of a `Window` and `App`. It allows you to
644/// run window-specific test code. It can be dereferenced to a `TextAppContext`.
645pub struct VisualTestContext {
646 #[deref]
647 #[deref_mut]
648 /// cx is the original TestAppContext (you can more easily access this using Deref)
649 pub cx: TestAppContext,
650 window: AnyWindowHandle,
651}
652
653impl VisualTestContext {
654 /// Provides a `Window` and `App` for the duration of the closure.
655 pub fn update<R>(&mut self, f: impl FnOnce(&mut Window, &mut App) -> R) -> R {
656 self.cx
657 .update_window(self.window, |_, window, cx| f(window, cx))
658 .unwrap()
659 }
660
661 /// Creates a new VisualTestContext. You would typically shadow the passed in
662 /// TestAppContext with this, as this is typically more useful.
663 /// `let cx = VisualTestContext::from_window(window, cx);`
664 pub fn from_window(window: AnyWindowHandle, cx: &TestAppContext) -> Self {
665 Self {
666 cx: cx.clone(),
667 window,
668 }
669 }
670
671 /// Wait until there are no more pending tasks.
672 pub fn run_until_parked(&self) {
673 self.cx.background_executor.run_until_parked();
674 }
675
676 /// Dispatch the action to the currently focused node.
677 pub fn dispatch_action<A>(&mut self, action: A)
678 where
679 A: Action,
680 {
681 self.cx.dispatch_action(self.window, action)
682 }
683
684 /// Read the title off the window (set by `Window#set_window_title`)
685 pub fn window_title(&mut self) -> Option<String> {
686 self.cx.test_window(self.window).0.lock().title.clone()
687 }
688
689 /// Simulate a sequence of keystrokes `cx.simulate_keystrokes("cmd-p escape")`
690 /// Automatically runs until parked.
691 pub fn simulate_keystrokes(&mut self, keystrokes: &str) {
692 self.cx.simulate_keystrokes(self.window, keystrokes)
693 }
694
695 /// Simulate typing text `cx.simulate_input("hello")`
696 /// Automatically runs until parked.
697 pub fn simulate_input(&mut self, input: &str) {
698 self.cx.simulate_input(self.window, input)
699 }
700
701 /// Simulate a mouse move event to the given point
702 pub fn simulate_mouse_move(
703 &mut self,
704 position: Point<Pixels>,
705 button: impl Into<Option<MouseButton>>,
706 modifiers: Modifiers,
707 ) {
708 self.simulate_event(MouseMoveEvent {
709 position,
710 modifiers,
711 pressed_button: button.into(),
712 })
713 }
714
715 /// Simulate a mouse down event to the given point
716 pub fn simulate_mouse_down(
717 &mut self,
718 position: Point<Pixels>,
719 button: MouseButton,
720 modifiers: Modifiers,
721 ) {
722 self.simulate_event(MouseDownEvent {
723 position,
724 modifiers,
725 button,
726 click_count: 1,
727 first_mouse: false,
728 })
729 }
730
731 /// Simulate a mouse up event to the given point
732 pub fn simulate_mouse_up(
733 &mut self,
734 position: Point<Pixels>,
735 button: MouseButton,
736 modifiers: Modifiers,
737 ) {
738 self.simulate_event(MouseUpEvent {
739 position,
740 modifiers,
741 button,
742 click_count: 1,
743 })
744 }
745
746 /// Simulate a primary mouse click at the given point
747 pub fn simulate_click(&mut self, position: Point<Pixels>, modifiers: Modifiers) {
748 self.simulate_event(MouseDownEvent {
749 position,
750 modifiers,
751 button: MouseButton::Left,
752 click_count: 1,
753 first_mouse: false,
754 });
755 self.simulate_event(MouseUpEvent {
756 position,
757 modifiers,
758 button: MouseButton::Left,
759 click_count: 1,
760 });
761 }
762
763 /// Simulate a modifiers changed event
764 pub fn simulate_modifiers_change(&mut self, modifiers: Modifiers) {
765 self.simulate_event(ModifiersChangedEvent { modifiers })
766 }
767
768 /// Simulates the user resizing the window to the new size.
769 pub fn simulate_resize(&self, size: Size<Pixels>) {
770 self.simulate_window_resize(self.window, size)
771 }
772
773 /// debug_bounds returns the bounds of the element with the given selector.
774 pub fn debug_bounds(&mut self, selector: &'static str) -> Option<Bounds<Pixels>> {
775 self.update(|window, _| window.rendered_frame.debug_bounds.get(selector).copied())
776 }
777
778 /// Draw an element to the window. Useful for simulating events or actions
779 pub fn draw<E>(
780 &mut self,
781 origin: Point<Pixels>,
782 space: impl Into<Size<AvailableSpace>>,
783 f: impl FnOnce(&mut Window, &mut App) -> E,
784 ) -> (E::RequestLayoutState, E::PrepaintState)
785 where
786 E: Element,
787 {
788 self.update(|window, cx| {
789 window.invalidator.set_phase(DrawPhase::Prepaint);
790 let mut element = Drawable::new(f(window, cx));
791 element.layout_as_root(space.into(), window, cx);
792 window.with_absolute_element_offset(origin, |window| element.prepaint(window, cx));
793
794 window.invalidator.set_phase(DrawPhase::Paint);
795 let (request_layout_state, prepaint_state) = element.paint(window, cx);
796
797 window.invalidator.set_phase(DrawPhase::None);
798 window.refresh();
799
800 (request_layout_state, prepaint_state)
801 })
802 }
803
804 /// Simulate an event from the platform, e.g. a SrollWheelEvent
805 /// Make sure you've called [VisualTestContext::draw] first!
806 pub fn simulate_event<E: InputEvent>(&mut self, event: E) {
807 self.test_window(self.window)
808 .simulate_input(event.to_platform_input());
809 self.background_executor.run_until_parked();
810 }
811
812 /// Simulates the user blurring the window.
813 pub fn deactivate_window(&mut self) {
814 if Some(self.window) == self.test_platform.active_window() {
815 self.test_platform.set_active_window(None)
816 }
817 self.background_executor.run_until_parked();
818 }
819
820 /// Simulates the user closing the window.
821 /// Returns true if the window was closed.
822 pub fn simulate_close(&mut self) -> bool {
823 let handler = self
824 .cx
825 .update_window(self.window, |_, window, _| {
826 window
827 .platform_window
828 .as_test()
829 .unwrap()
830 .0
831 .lock()
832 .should_close_handler
833 .take()
834 })
835 .unwrap();
836 if let Some(mut handler) = handler {
837 let should_close = handler();
838 self.cx
839 .update_window(self.window, |_, window, _| {
840 window.platform_window.on_should_close(handler);
841 })
842 .unwrap();
843 should_close
844 } else {
845 false
846 }
847 }
848
849 /// Get an &mut VisualTestContext (which is mostly what you need to pass to other methods).
850 /// This method internally retains the VisualTestContext until the end of the test.
851 pub fn as_mut(self) -> &'static mut Self {
852 let ptr = Box::into_raw(Box::new(self));
853 // safety: on_quit will be called after the test has finished.
854 // the executor will ensure that all tasks related to the test have stopped.
855 // so there is no way for cx to be accessed after on_quit is called.
856 let cx = Box::leak(unsafe { Box::from_raw(ptr) });
857 cx.on_quit(move || unsafe {
858 drop(Box::from_raw(ptr));
859 });
860 cx
861 }
862}
863
864impl AppContext for VisualTestContext {
865 type Result<T> = <TestAppContext as AppContext>::Result<T>;
866
867 fn new<T: 'static>(
868 &mut self,
869 build_entity: impl FnOnce(&mut Context<'_, T>) -> T,
870 ) -> Self::Result<Entity<T>> {
871 self.cx.new(build_entity)
872 }
873
874 fn reserve_entity<T: 'static>(&mut self) -> Self::Result<crate::Reservation<T>> {
875 self.cx.reserve_entity()
876 }
877
878 fn insert_entity<T: 'static>(
879 &mut self,
880 reservation: crate::Reservation<T>,
881 build_entity: impl FnOnce(&mut Context<'_, T>) -> T,
882 ) -> Self::Result<Entity<T>> {
883 self.cx.insert_entity(reservation, build_entity)
884 }
885
886 fn update_entity<T, R>(
887 &mut self,
888 handle: &Entity<T>,
889 update: impl FnOnce(&mut T, &mut Context<'_, T>) -> R,
890 ) -> Self::Result<R>
891 where
892 T: 'static,
893 {
894 self.cx.update_entity(handle, update)
895 }
896
897 fn read_entity<T, R>(
898 &self,
899 handle: &Entity<T>,
900 read: impl FnOnce(&T, &App) -> R,
901 ) -> Self::Result<R>
902 where
903 T: 'static,
904 {
905 self.cx.read_entity(handle, read)
906 }
907
908 fn update_window<T, F>(&mut self, window: AnyWindowHandle, f: F) -> Result<T>
909 where
910 F: FnOnce(AnyView, &mut Window, &mut App) -> T,
911 {
912 self.cx.update_window(window, f)
913 }
914
915 fn read_window<T, R>(
916 &self,
917 window: &WindowHandle<T>,
918 read: impl FnOnce(Entity<T>, &App) -> R,
919 ) -> Result<R>
920 where
921 T: 'static,
922 {
923 self.cx.read_window(window, read)
924 }
925
926 fn background_spawn<R>(&self, future: impl Future<Output = R> + Send + 'static) -> Task<R>
927 where
928 R: Send + 'static,
929 {
930 self.cx.background_spawn(future)
931 }
932
933 fn read_global<G, R>(&self, callback: impl FnOnce(&G, &App) -> R) -> Self::Result<R>
934 where
935 G: Global,
936 {
937 self.cx.read_global(callback)
938 }
939}
940
941impl VisualContext for VisualTestContext {
942 /// Get the underlying window handle underlying this context.
943 fn window_handle(&self) -> AnyWindowHandle {
944 self.window
945 }
946
947 fn new_window_entity<T: 'static>(
948 &mut self,
949 build_entity: impl FnOnce(&mut Window, &mut Context<'_, T>) -> T,
950 ) -> Self::Result<Entity<T>> {
951 self.window
952 .update(&mut self.cx, |_, window, cx| {
953 cx.new(|cx| build_entity(window, cx))
954 })
955 .unwrap()
956 }
957
958 fn update_window_entity<V: 'static, R>(
959 &mut self,
960 view: &Entity<V>,
961 update: impl FnOnce(&mut V, &mut Window, &mut Context<V>) -> R,
962 ) -> Self::Result<R> {
963 self.window
964 .update(&mut self.cx, |_, window, cx| {
965 view.update(cx, |v, cx| update(v, window, cx))
966 })
967 .unwrap()
968 }
969
970 fn replace_root_view<V>(
971 &mut self,
972 build_view: impl FnOnce(&mut Window, &mut Context<V>) -> V,
973 ) -> Self::Result<Entity<V>>
974 where
975 V: 'static + Render,
976 {
977 self.window
978 .update(&mut self.cx, |_, window, cx| {
979 window.replace_root(cx, build_view)
980 })
981 .unwrap()
982 }
983
984 fn focus<V: crate::Focusable>(&mut self, view: &Entity<V>) -> Self::Result<()> {
985 self.window
986 .update(&mut self.cx, |_, window, cx| {
987 view.read(cx).focus_handle(cx).clone().focus(window)
988 })
989 .unwrap()
990 }
991}
992
993impl AnyWindowHandle {
994 /// Creates the given view in this window.
995 pub fn build_entity<V: Render + 'static>(
996 &self,
997 cx: &mut TestAppContext,
998 build_view: impl FnOnce(&mut Window, &mut Context<V>) -> V,
999 ) -> Entity<V> {
1000 self.update(cx, |_, window, cx| cx.new(|cx| build_view(window, cx)))
1001 .unwrap()
1002 }
1003}