1337 lines · 43.5 KB · Rust
RawDownload
use crate::{    Action, AnyView, AnyWindowHandle, App, AppCell, AppContext, AsyncApp, AvailableSpace,    BackgroundExecutor, BorrowAppContext, Bounds, Capslock, ClipboardItem, DrawPhase, Drawable,    Element, Empty, EntityId, EventEmitter, ForegroundExecutor, Global, InputEvent, Keystroke,    Modifiers, ModifiersChangedEvent, MouseButton, MouseDownEvent, MouseMoveEvent, MouseUpEvent,    Pixels, Platform, Point, Render, Result, SharedString, Size, SystemNotification,    SystemNotificationResponse, Task, TestDispatcher, TestPlatform, TestScreenCaptureSource,    TestWindow, TextSystem, VisualContext, Window, WindowBounds, WindowHandle, WindowOptions,    app::GpuiMode, window::ElementArenaScope,};use anyhow::{anyhow, bail};use futures::{Stream, StreamExt, channel::oneshot}; use std::{    cell::RefCell, future::Future, ops::Deref, path::PathBuf, rc::Rc, sync::Arc, time::Duration,}; /// A TestAppContext is provided to tests created with `#[gpui::test]`, it provides/// an implementation of `Context` with additional methods that are useful in tests.#[derive(Clone)]pub struct TestAppContext {    #[doc(hidden)]    pub background_executor: BackgroundExecutor,    #[doc(hidden)]    pub foreground_executor: ForegroundExecutor,    #[doc(hidden)]    pub dispatcher: TestDispatcher,    test_platform: Rc<TestPlatform>,    text_system: Arc<TextSystem>,    fn_name: Option<&'static str>,    on_quit: Rc<RefCell<Vec<Box<dyn FnOnce() + 'static>>>>,    #[doc(hidden)]    pub app: Rc<AppCell>,} impl AppContext for TestAppContext {    fn new<T: 'static>(&mut self, build_entity: impl FnOnce(&mut Context<T>) -> T) -> Entity<T> {        let mut app = self.app.borrow_mut();        app.new(build_entity)    }     fn reserve_entity<T: 'static>(&mut self) -> crate::Reservation<T> {        let mut app = self.app.borrow_mut();        app.reserve_entity()    }     fn insert_entity<T: 'static>(        &mut self,        reservation: crate::Reservation<T>,        build_entity: impl FnOnce(&mut Context<T>) -> T,    ) -> Entity<T> {        let mut app = self.app.borrow_mut();        app.insert_entity(reservation, build_entity)    }     fn update_entity<T: 'static, R>(        &mut self,        handle: &Entity<T>,        update: impl FnOnce(&mut T, &mut Context<T>) -> R,    ) -> R {        let mut app = self.app.borrow_mut();        app.update_entity(handle, update)    }     fn as_mut<'a, T>(&'a mut self, _: &Entity<T>) -> super::GpuiBorrow<'a, T>    where        T: 'static,    {        panic!("Cannot use as_mut with a test app context. Try calling update() first")    }     fn read_entity<T, R>(&self, handle: &Entity<T>, read: impl FnOnce(&T, &App) -> R) -> R    where        T: 'static,    {        let app = self.app.borrow();        app.read_entity(handle, read)    }     fn update_window<T, F>(&mut self, window: AnyWindowHandle, f: F) -> Result<T>    where        F: FnOnce(AnyView, &mut Window, &mut App) -> T,    {        let mut lock = self.app.borrow_mut();        lock.update_window(window, f)    }     fn with_window<R>(        &mut self,        entity_id: EntityId,        f: impl FnOnce(&mut Window, &mut App) -> R,    ) -> Option<R> {        let mut lock = self.app.borrow_mut();        lock.with_window(entity_id, f)    }     fn read_window<T, R>(        &self,        window: &WindowHandle<T>,        read: impl FnOnce(Entity<T>, &App) -> R,    ) -> Result<R>    where        T: 'static,    {        let app = self.app.borrow();        app.read_window(window, read)    }     fn background_spawn<R>(&self, future: impl Future<Output = R> + Send + 'static) -> Task<R>    where        R: Send + 'static,    {        self.background_executor.spawn(future)    }     fn read_global<G, R>(&self, callback: impl FnOnce(&G, &App) -> R) -> R    where        G: Global,    {        let app = self.app.borrow();        app.read_global(callback)    }} impl TestAppContext {    /// Creates a new `TestAppContext`. Usually you can rely on `#[gpui::test]` to do this for you.    pub fn build(dispatcher: TestDispatcher, fn_name: Option<&'static str>) -> Self {        let arc_dispatcher = Arc::new(dispatcher.clone());        let background_executor = BackgroundExecutor::new(arc_dispatcher.clone());        let foreground_executor = ForegroundExecutor::new(arc_dispatcher);        let platform = TestPlatform::new(background_executor.clone(), foreground_executor.clone());        let asset_source = Arc::new(());        let http_client = http_client::FakeHttpClient::with_404_response();        let text_system = Arc::new(TextSystem::new(platform.text_system()));         let app = App::new_app(platform.clone(), asset_source, http_client);        app.borrow_mut().mode = GpuiMode::test();         Self {            app,            background_executor,            foreground_executor,            dispatcher,            test_platform: platform,            text_system,            fn_name,            on_quit: Rc::new(RefCell::new(Vec::default())),        }    }     /// Skip all drawing operations for the duration of this test.    pub fn skip_drawing(&mut self) {        self.app.borrow_mut().mode = GpuiMode::Test { skip_drawing: true };    }     /// Create a single TestAppContext, for non-multi-client tests    pub fn single() -> Self {        let dispatcher = TestDispatcher::new(0);        Self::build(dispatcher, None)    }     /// The name of the test function that created this `TestAppContext`    pub fn test_function_name(&self) -> Option<&'static str> {        self.fn_name    }     /// Checks whether there have been any new path prompts received by the platform.    pub fn did_prompt_for_new_path(&self) -> bool {        self.test_platform.did_prompt_for_new_path()    }     /// returns a new `TestAppContext` re-using the same executors to interleave tasks.    pub fn new_app(&self) -> TestAppContext {        Self::build(self.dispatcher.clone(), self.fn_name)    }     /// Called by the test helper to end the test.    /// public so the macro can call it.    pub fn quit(&self) {        self.on_quit.borrow_mut().drain(..).for_each(|f| f());        self.app.borrow_mut().shutdown();    }     /// Register cleanup to run when the test ends.    pub fn on_quit(&mut self, f: impl FnOnce() + 'static) {        self.on_quit.borrow_mut().push(Box::new(f));    }     /// Schedules all windows to be redrawn on the next effect cycle.    pub fn refresh(&mut self) -> Result<()> {        let mut app = self.app.borrow_mut();        app.refresh_windows();        Ok(())    }     /// Returns an executor (for running tasks in the background)    pub fn executor(&self) -> BackgroundExecutor {        self.background_executor.clone()    }     /// Returns an executor (for running tasks on the main thread)    pub fn foreground_executor(&self) -> &ForegroundExecutor {        &self.foreground_executor    }     /// Gives you an `&mut App` for the duration of the closure    pub fn update<R>(&self, f: impl FnOnce(&mut App) -> R) -> R {        let mut cx = self.app.borrow_mut();        cx.update(f)    }     /// Gives you an `&App` for the duration of the closure    pub fn read<R>(&self, f: impl FnOnce(&App) -> R) -> R {        let cx = self.app.borrow();        f(&cx)    }     /// Adds a new window. The Window will always be backed by a `TestWindow` which    /// can be retrieved with `self.test_window(handle)`    pub fn add_window<F, V>(&mut self, build_window: F) -> WindowHandle<V>    where        F: FnOnce(&mut Window, &mut Context<V>) -> V,        V: 'static + Render,    {        let mut cx = self.app.borrow_mut();         // Some tests rely on the window size matching the bounds of the test display        let bounds = Bounds::maximized(None, &cx);        cx.open_window(            WindowOptions {                window_bounds: Some(WindowBounds::Windowed(bounds)),                ..Default::default()            },            |window, cx| cx.new(|cx| build_window(window, cx)),        )        .unwrap()    }     /// Opens a new window with a specific size.    ///    /// Unlike `add_window` which uses maximized bounds, this allows controlling    /// the window dimensions, which is important for layout-sensitive tests.    pub fn open_window<F, V>(        &mut self,        window_size: Size<Pixels>,        build_window: F,    ) -> WindowHandle<V>    where        F: FnOnce(&mut Window, &mut Context<V>) -> V,        V: 'static + Render,    {        let mut cx = self.app.borrow_mut();        cx.open_window(            WindowOptions {                window_bounds: Some(WindowBounds::Windowed(Bounds {                    origin: Point::default(),                    size: window_size,                })),                ..Default::default()            },            |window, cx| cx.new(|cx| build_window(window, cx)),        )        .unwrap()    }     /// Adds a new window with no content.    pub fn add_empty_window(&mut self) -> &mut VisualTestContext {        let mut cx = self.app.borrow_mut();        let bounds = Bounds::maximized(None, &cx);        let window = cx            .open_window(                WindowOptions {                    window_bounds: Some(WindowBounds::Windowed(bounds)),                    ..Default::default()                },                |_, cx| cx.new(|_| Empty),            )            .unwrap();        drop(cx);        let cx = VisualTestContext::from_window(*window.deref(), self).into_mut();        cx.run_until_parked();        cx    }     /// Adds a new window, and returns its root view and a `VisualTestContext` which can be used    /// as a `Window` and `App` for the rest of the test. Typically you would shadow this context with    /// the returned one. `let (view, cx) = cx.add_window_view(...);`    pub fn add_window_view<F, V>(        &mut self,        build_root_view: F,    ) -> (Entity<V>, &mut VisualTestContext)    where        F: FnOnce(&mut Window, &mut Context<V>) -> V,        V: 'static + Render,    {        let mut cx = self.app.borrow_mut();        let bounds = Bounds::maximized(None, &cx);        let window = cx            .open_window(                WindowOptions {                    window_bounds: Some(WindowBounds::Windowed(bounds)),                    ..Default::default()                },                |window, cx| cx.new(|cx| build_root_view(window, cx)),            )            .unwrap();        drop(cx);        let view = window.root(self).unwrap();        let cx = VisualTestContext::from_window(*window.deref(), self).into_mut();        cx.run_until_parked();         // it might be nice to try and cleanup these at the end of each test.        (view, cx)    }     /// returns the TextSystem    pub fn text_system(&self) -> &Arc<TextSystem> {        &self.text_system    }     /// Simulates writing to the platform clipboard    pub fn write_to_clipboard(&self, item: ClipboardItem) {        self.test_platform.write_to_clipboard(item)    }     /// Simulates reading from the platform clipboard.    /// This will return the most recent value from `write_to_clipboard`.    pub fn read_from_clipboard(&self) -> Option<ClipboardItem> {        self.test_platform.read_from_clipboard()    }     /// Simulates choosing a File in the platform's "Open" dialog.    pub fn simulate_new_path_selection(        &self,        select_path: impl FnOnce(&std::path::Path) -> Option<std::path::PathBuf>,    ) {        self.test_platform.simulate_new_path_selection(select_path);    }     /// Simulates responding to a `prompt_for_paths` ("Open") dialog.    pub fn simulate_path_prompt_response(        &self,        select_paths: impl FnOnce(&crate::PathPromptOptions) -> Option<Vec<std::path::PathBuf>>,    ) {        self.test_platform            .simulate_path_prompt_response(select_paths);    }     /// Returns true if there's a path selection dialog pending.    pub fn did_prompt_for_paths(&self) -> bool {        self.test_platform.did_prompt_for_paths()    }     /// Simulates clicking a button in an platform-level alert dialog.    #[track_caller]    pub fn simulate_prompt_answer(&self, button: &str) {        self.test_platform.simulate_prompt_answer(button);    }     /// Returns true if there's an alert dialog open.    pub fn has_pending_prompt(&self) -> bool {        self.test_platform.has_pending_prompt()    }     /// Returns true if there's an alert dialog open.    pub fn pending_prompt(&self) -> Option<(String, String)> {        self.test_platform.pending_prompt()    }     /// All the urls that have been opened with cx.open_url() during this test.    pub fn opened_url(&self) -> Option<String> {        self.test_platform.opened_url.borrow().clone()    }     /// Returns the application identity configured during this test.    pub fn app_identity(&self) -> Option<(SharedString, SharedString)> {        self.test_platform.app_identity()    }     /// Returns all system notifications shown during this test, in order.    pub fn shown_system_notifications(&self) -> Vec<SystemNotification> {        self.test_platform.shown_system_notifications()    }     /// Returns the system notifications currently delivered by the test platform.    pub fn delivered_system_notifications(&self) -> Vec<SystemNotification> {        self.test_platform.delivered_system_notifications()    }     /// Returns the tags of all system notifications dismissed during this test, in order.    pub fn dismissed_system_notifications(&self) -> Vec<SharedString> {        self.test_platform.dismissed_system_notifications()    }     /// Simulates the user activating a system notification.    pub fn simulate_system_notification_response(&self, response: SystemNotificationResponse) {        self.test_platform            .simulate_system_notification_response(response);    }     /// Simulates the user resizing the window to the new size.    pub fn simulate_window_resize(&self, window_handle: AnyWindowHandle, size: Size<Pixels>) {        self.test_window(window_handle).simulate_resize(size);    }     /// Returns true if there's an alert dialog open.    pub fn expect_restart(&self) -> oneshot::Receiver<Option<PathBuf>> {        let (tx, rx) = futures::channel::oneshot::channel();        self.test_platform.expect_restart.borrow_mut().replace(tx);        rx    }     /// Causes the given sources to be returned if the application queries for screen    /// capture sources.    pub fn set_screen_capture_sources(&self, sources: Vec<TestScreenCaptureSource>) {        self.test_platform.set_screen_capture_sources(sources);    }     /// Returns all windows open in the test.    pub fn windows(&self) -> Vec<AnyWindowHandle> {        self.app.borrow().windows()    }     /// Run the given task on the main thread.    #[track_caller]    pub fn spawn<Fut, R>(&self, f: impl FnOnce(AsyncApp) -> Fut) -> Task<R>    where        Fut: Future<Output = R> + 'static,        R: 'static,    {        self.foreground_executor.spawn(f(self.to_async()))    }     /// true if the given global is defined    pub fn has_global<G: Global>(&self) -> bool {        let app = self.app.borrow();        app.has_global::<G>()    }     /// runs the given closure with a reference to the global    /// panics if `has_global` would return false.    pub fn read_global<G: Global, R>(&self, read: impl FnOnce(&G, &App) -> R) -> R {        let app = self.app.borrow();        read(app.global(), &app)    }     /// runs the given closure with a reference to the global (if set)    pub fn try_read_global<G: Global, R>(&self, read: impl FnOnce(&G, &App) -> R) -> Option<R> {        let lock = self.app.borrow();        Some(read(lock.try_global()?, &lock))    }     /// sets the global in this context.    pub fn set_global<G: Global>(&mut self, global: G) {        let mut lock = self.app.borrow_mut();        lock.update(|cx| cx.set_global(global))    }     /// updates the global in this context. (panics if `has_global` would return false)    pub fn update_global<G: Global, R>(&mut self, update: impl FnOnce(&mut G, &mut App) -> R) -> R {        let mut lock = self.app.borrow_mut();        lock.update(|cx| cx.update_global(update))    }     /// Returns an `AsyncApp` which can be used to run tasks that expect to be on a background    /// thread on the current thread in tests.    pub fn to_async(&self) -> AsyncApp {        AsyncApp {            app: Rc::downgrade(&self.app),            background_executor: self.background_executor.clone(),            foreground_executor: self.foreground_executor.clone(),        }    }     /// Wait until there are no more pending tasks.    pub fn run_until_parked(&self) {        self.dispatcher.run_until_parked();    }     /// Simulate dispatching an action to the currently focused node in the window.    pub fn dispatch_action<A>(&mut self, window: AnyWindowHandle, action: A)    where        A: Action,    {        window            .update(self, |_, window, cx| {                window.dispatch_action(action.boxed_clone(), cx)            })            .unwrap();         self.background_executor.run_until_parked()    }     /// simulate_keystrokes takes a space-separated list of keys to type.    /// cx.simulate_keystrokes("cmd-shift-p b k s p enter")    /// in Zed, this will run backspace on the current editor through the command palette.    /// This will also run the background executor until it's parked.    pub fn simulate_keystrokes(&mut self, window: AnyWindowHandle, keystrokes: &str) {        for keystroke in keystrokes            .split(' ')

Lines 1–500 of 1337.