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