test_server.rs

  1use anyhow::anyhow;
  2use call::ActiveCall;
  3use channel::{ChannelBuffer, ChannelStore};
  4use client::test::{make_get_authenticated_user_response, parse_authorization_header};
  5use client::{
  6    self, ChannelId, Client, Connection, Credentials, EstablishConnectionError, UserStore,
  7    proto::PeerId,
  8};
  9use clock::FakeSystemClock;
 10use collab::{
 11    AppState, Config,
 12    db::{NewUserParams, UserId},
 13    executor::Executor,
 14    rpc::{CLEANUP_TIMEOUT, Principal, RECONNECT_TIMEOUT, Server, ZedVersion},
 15};
 16use collab_ui::channel_view::ChannelView;
 17use collections::{HashMap, HashSet};
 18
 19use fs::FakeFs;
 20use futures::{StreamExt as _, channel::oneshot};
 21use git::GitHostingProviderRegistry;
 22use gpui::{AppContext as _, BackgroundExecutor, Entity, Task, TestAppContext, VisualTestContext};
 23use http_client::{FakeHttpClient, Method};
 24use language::LanguageRegistry;
 25use node_runtime::NodeRuntime;
 26use notifications::NotificationStore;
 27use parking_lot::Mutex;
 28use project::{Project, WorktreeId};
 29use remote::RemoteClient;
 30use rpc::{
 31    RECEIVE_TIMEOUT,
 32    proto::{self, ChannelRole},
 33};
 34use serde_json::json;
 35use session::{AppSession, Session};
 36use settings::SettingsStore;
 37use std::{
 38    cell::{Ref, RefCell, RefMut},
 39    env,
 40    ops::{Deref, DerefMut},
 41    path::Path,
 42    sync::{
 43        Arc,
 44        atomic::{AtomicBool, AtomicUsize, Ordering::SeqCst},
 45    },
 46};
 47use util::path;
 48use workspace::{MultiWorkspace, Workspace, WorkspaceStore};
 49
 50use livekit_client::test::TestServer as LivekitTestServer;
 51
 52use crate::db_tests::TestDb;
 53
 54pub struct TestServer {
 55    pub app_state: Arc<AppState>,
 56    pub test_livekit_server: Arc<LivekitTestServer>,
 57    pub test_db: TestDb,
 58    server: Arc<Server>,
 59    next_github_user_id: i32,
 60    connection_killers: Arc<Mutex<HashMap<PeerId, Arc<AtomicBool>>>>,
 61    forbid_connections: Arc<AtomicBool>,
 62}
 63
 64pub struct TestClient {
 65    pub username: String,
 66    pub app_state: Arc<workspace::AppState>,
 67    channel_store: Entity<ChannelStore>,
 68    notification_store: Entity<NotificationStore>,
 69    state: RefCell<TestClientState>,
 70}
 71
 72#[derive(Default)]
 73struct TestClientState {
 74    local_projects: Vec<Entity<Project>>,
 75    dev_server_projects: Vec<Entity<Project>>,
 76    buffers: HashMap<Entity<Project>, HashSet<Entity<language::Buffer>>>,
 77    channel_buffers: HashSet<Entity<ChannelBuffer>>,
 78}
 79
 80pub struct ContactsSummary {
 81    pub current: Vec<String>,
 82    pub outgoing_requests: Vec<String>,
 83    pub incoming_requests: Vec<String>,
 84}
 85
 86impl TestServer {
 87    pub async fn start(deterministic: BackgroundExecutor) -> Self {
 88        static NEXT_LIVEKIT_SERVER_ID: AtomicUsize = AtomicUsize::new(0);
 89
 90        let use_postgres = env::var("USE_POSTGRES").ok();
 91        let use_postgres = use_postgres.as_deref();
 92        let test_db = if use_postgres == Some("true") || use_postgres == Some("1") {
 93            TestDb::postgres(deterministic.clone())
 94        } else {
 95            TestDb::sqlite(deterministic.clone())
 96        };
 97        let livekit_server_id = NEXT_LIVEKIT_SERVER_ID.fetch_add(1, SeqCst);
 98        let livekit_server = LivekitTestServer::create(
 99            format!("http://livekit.{}.test", livekit_server_id),
100            format!("devkey-{}", livekit_server_id),
101            format!("secret-{}", livekit_server_id),
102            deterministic.clone(),
103        )
104        .unwrap();
105        let executor = Executor::Deterministic(deterministic.clone());
106        let app_state = Self::build_app_state(&test_db, &livekit_server, executor.clone()).await;
107        let epoch = app_state
108            .db
109            .create_server(&app_state.config.zed_environment)
110            .await
111            .unwrap();
112        let server = Server::new(epoch, app_state.clone());
113        server.start().await.unwrap();
114        // Advance clock to ensure the server's cleanup task is finished.
115        deterministic.advance_clock(CLEANUP_TIMEOUT);
116        Self {
117            app_state,
118            server,
119            connection_killers: Default::default(),
120            forbid_connections: Default::default(),
121            next_github_user_id: 0,
122            test_db,
123            test_livekit_server: livekit_server,
124        }
125    }
126
127    pub async fn start2(
128        cx_a: &mut TestAppContext,
129        cx_b: &mut TestAppContext,
130    ) -> (TestServer, TestClient, TestClient, ChannelId) {
131        let mut server = Self::start(cx_a.executor()).await;
132        let client_a = server.create_client(cx_a, "user_a").await;
133        let client_b = server.create_client(cx_b, "user_b").await;
134        let channel_id = server
135            .make_channel(
136                "test-channel",
137                None,
138                (&client_a, cx_a),
139                &mut [(&client_b, cx_b)],
140            )
141            .await;
142        cx_a.run_until_parked();
143
144        (server, client_a, client_b, channel_id)
145    }
146
147    pub async fn start1(cx: &mut TestAppContext) -> (TestServer, TestClient) {
148        let mut server = Self::start(cx.executor().clone()).await;
149        let client = server.create_client(cx, "user_a").await;
150        (server, client)
151    }
152
153    pub async fn reset(&self) {
154        self.app_state.db.reset();
155        let epoch = self
156            .app_state
157            .db
158            .create_server(&self.app_state.config.zed_environment)
159            .await
160            .unwrap();
161        self.server.reset(epoch);
162    }
163
164    pub async fn create_client(&mut self, cx: &mut TestAppContext, name: &str) -> TestClient {
165        const ACCESS_TOKEN: &str = "the-token";
166
167        let fs = FakeFs::new(cx.executor());
168
169        cx.update(|cx| {
170            gpui_tokio::init(cx);
171            if cx.has_global::<SettingsStore>() {
172                panic!("Same cx used to create two test clients")
173            }
174            let settings = SettingsStore::test(cx);
175            cx.set_global(settings);
176            theme_settings::init(theme::LoadThemes::JustBase, cx);
177            release_channel::init(semver::Version::new(0, 0, 0), cx);
178        });
179
180        let clock = Arc::new(FakeSystemClock::new());
181
182        let user_id = if let Ok(Some(user)) = self.app_state.db.get_user_by_github_login(name).await
183        {
184            user.id
185        } else {
186            let github_user_id = self.next_github_user_id;
187            self.next_github_user_id += 1;
188            self.app_state
189                .db
190                .create_user(
191                    &format!("{name}@example.com"),
192                    None,
193                    false,
194                    NewUserParams {
195                        github_login: name.into(),
196                        github_user_id,
197                    },
198                )
199                .await
200                .expect("creating user failed")
201                .user_id
202        };
203
204        let http = FakeHttpClient::create({
205            let name = name.to_string();
206            move |req| {
207                let name = name.clone();
208                async move {
209                    match (req.method(), req.uri().path()) {
210                        (&Method::GET, "/client/users/me") => {
211                            let credentials = parse_authorization_header(&req);
212                            if credentials
213                                != Some(Credentials {
214                                    user_id: user_id.to_proto(),
215                                    access_token: ACCESS_TOKEN.into(),
216                                })
217                            {
218                                return Ok(http_client::Response::builder()
219                                    .status(401)
220                                    .body("Unauthorized".into())
221                                    .unwrap());
222                            }
223
224                            Ok(http_client::Response::builder()
225                                .status(200)
226                                .body(
227                                    serde_json::to_string(&make_get_authenticated_user_response(
228                                        user_id.0, name,
229                                    ))
230                                    .unwrap()
231                                    .into(),
232                                )
233                                .unwrap())
234                        }
235                        _ => Ok(http_client::Response::builder()
236                            .status(404)
237                            .body("Not Found".into())
238                            .unwrap()),
239                    }
240                }
241            }
242        });
243
244        let client_name = name.to_string();
245        let client = cx.update(|cx| Client::new(clock, http.clone(), cx));
246        let server = self.server.clone();
247        let db = self.app_state.db.clone();
248        let connection_killers = self.connection_killers.clone();
249        let forbid_connections = self.forbid_connections.clone();
250
251        client
252            .set_id(user_id.to_proto())
253            .override_authenticate(move |cx| {
254                cx.spawn(async move |_| {
255                    Ok(Credentials {
256                        user_id: user_id.to_proto(),
257                        access_token: ACCESS_TOKEN.into(),
258                    })
259                })
260            })
261            .override_establish_connection(move |credentials, cx| {
262                assert_eq!(
263                    credentials,
264                    &Credentials {
265                        user_id: user_id.0 as u64,
266                        access_token: ACCESS_TOKEN.into(),
267                    }
268                );
269
270                let server = server.clone();
271                let db = db.clone();
272                let connection_killers = connection_killers.clone();
273                let forbid_connections = forbid_connections.clone();
274                let client_name = client_name.clone();
275                cx.spawn(async move |cx| {
276                    if forbid_connections.load(SeqCst) {
277                        Err(EstablishConnectionError::other(anyhow!(
278                            "server is forbidding connections"
279                        )))
280                    } else {
281                        let (client_conn, server_conn, killed) =
282                            Connection::in_memory(cx.background_executor().clone());
283                        let (connection_id_tx, connection_id_rx) = oneshot::channel();
284                        let user = db
285                            .get_user_by_id(user_id)
286                            .await
287                            .map_err(|e| {
288                                EstablishConnectionError::Other(anyhow!(
289                                    "retrieving user failed: {}",
290                                    e
291                                ))
292                            })?
293                            .unwrap();
294                        cx.background_spawn(server.handle_connection(
295                            server_conn,
296                            client_name,
297                            Principal::User(user),
298                            ZedVersion(semver::Version::new(1, 0, 0)),
299                            Some("test".to_string()),
300                            None,
301                            None,
302                            None,
303                            Some(connection_id_tx),
304                            Executor::Deterministic(cx.background_executor().clone()),
305                            None,
306                        ))
307                        .detach();
308                        let connection_id = connection_id_rx.await.map_err(|e| {
309                            EstablishConnectionError::Other(anyhow!(
310                                "{} (is server shutting down?)",
311                                e
312                            ))
313                        })?;
314                        connection_killers
315                            .lock()
316                            .insert(connection_id.into(), killed);
317                        Ok(client_conn)
318                    }
319                })
320            });
321
322        let git_hosting_provider_registry = cx.update(GitHostingProviderRegistry::default_global);
323        git_hosting_provider_registry
324            .register_hosting_provider(Arc::new(git_hosting_providers::Github::public_instance()));
325
326        let user_store = cx.new(|cx| UserStore::new(client.clone(), cx));
327        let workspace_store = cx.new(|cx| WorkspaceStore::new(client.clone(), cx));
328        let language_registry = Arc::new(LanguageRegistry::test(cx.executor()));
329        let session = cx.new(|cx| AppSession::new(Session::test(), cx));
330        let app_state = Arc::new(workspace::AppState {
331            client: client.clone(),
332            user_store: user_store.clone(),
333            workspace_store,
334            languages: language_registry,
335            fs: fs.clone(),
336            build_window_options: |_, _| Default::default(),
337            node_runtime: NodeRuntime::unavailable(),
338            session,
339        });
340
341        let os_keymap = "keymaps/default-macos.json";
342
343        cx.update(|cx| {
344            theme_settings::init(theme::LoadThemes::JustBase, cx);
345            Project::init(&client, cx);
346            client::init(&client, cx);
347            editor::init(cx);
348            workspace::init(app_state.clone(), cx);
349            call::init(client.clone(), user_store.clone(), cx);
350            channel::init(&client, user_store.clone(), cx);
351            notifications::init(client.clone(), user_store, cx);
352            collab_ui::init(&app_state, cx);
353            file_finder::init(cx);
354            menu::init();
355            cx.bind_keys(
356                settings::KeymapFile::load_asset_allow_partial_failure(os_keymap, cx).unwrap(),
357            );
358            language_model::LanguageModelRegistry::test(cx);
359        });
360
361        client
362            .connect(false, &cx.to_async())
363            .await
364            .into_response()
365            .unwrap();
366
367        let client = TestClient {
368            app_state,
369            username: name.to_string(),
370            channel_store: cx.read(ChannelStore::global),
371            notification_store: cx.read(NotificationStore::global),
372            state: Default::default(),
373        };
374        client.wait_for_current_user(cx).await;
375        client
376    }
377
378    pub fn disconnect_client(&self, peer_id: PeerId) {
379        self.connection_killers
380            .lock()
381            .remove(&peer_id)
382            .unwrap()
383            .store(true, SeqCst);
384    }
385
386    pub fn simulate_long_connection_interruption(
387        &self,
388        peer_id: PeerId,
389        deterministic: BackgroundExecutor,
390    ) {
391        self.forbid_connections();
392        self.disconnect_client(peer_id);
393        deterministic.advance_clock(RECEIVE_TIMEOUT + RECONNECT_TIMEOUT);
394        self.allow_connections();
395        deterministic.advance_clock(RECEIVE_TIMEOUT + RECONNECT_TIMEOUT);
396        deterministic.run_until_parked();
397    }
398
399    pub fn forbid_connections(&self) {
400        self.forbid_connections.store(true, SeqCst);
401    }
402
403    pub fn allow_connections(&self) {
404        self.forbid_connections.store(false, SeqCst);
405    }
406
407    pub async fn make_contacts(&self, clients: &mut [(&TestClient, &mut TestAppContext)]) {
408        for ix in 1..clients.len() {
409            let (left, right) = clients.split_at_mut(ix);
410            let (client_a, cx_a) = left.last_mut().unwrap();
411            for (client_b, cx_b) in right {
412                client_a
413                    .app_state
414                    .user_store
415                    .update(*cx_a, |store, cx| {
416                        store.request_contact(client_b.user_id().unwrap(), cx)
417                    })
418                    .await
419                    .unwrap();
420                cx_a.executor().run_until_parked();
421                client_b
422                    .app_state
423                    .user_store
424                    .update(*cx_b, |store, cx| {
425                        store.respond_to_contact_request(client_a.user_id().unwrap(), true, cx)
426                    })
427                    .await
428                    .unwrap();
429            }
430        }
431    }
432
433    pub async fn make_channel(
434        &self,
435        channel: &str,
436        parent: Option<ChannelId>,
437        admin: (&TestClient, &mut TestAppContext),
438        members: &mut [(&TestClient, &mut TestAppContext)],
439    ) -> ChannelId {
440        let (_, admin_cx) = admin;
441        let channel_id = admin_cx
442            .read(ChannelStore::global)
443            .update(admin_cx, |channel_store, cx| {
444                channel_store.create_channel(channel, parent, cx)
445            })
446            .await
447            .unwrap();
448
449        for (member_client, member_cx) in members {
450            admin_cx
451                .read(ChannelStore::global)
452                .update(admin_cx, |channel_store, cx| {
453                    channel_store.invite_member(
454                        channel_id,
455                        member_client.user_id().unwrap(),
456                        ChannelRole::Member,
457                        cx,
458                    )
459                })
460                .await
461                .unwrap();
462
463            admin_cx.executor().run_until_parked();
464
465            member_cx
466                .read(ChannelStore::global)
467                .update(*member_cx, |channels, cx| {
468                    channels.respond_to_channel_invite(channel_id, true, cx)
469                })
470                .await
471                .unwrap();
472        }
473
474        channel_id
475    }
476
477    pub async fn make_public_channel(
478        &self,
479        channel: &str,
480        client: &TestClient,
481        cx: &mut TestAppContext,
482    ) -> ChannelId {
483        let channel_id = self
484            .make_channel(channel, None, (client, cx), &mut [])
485            .await;
486
487        client
488            .channel_store()
489            .update(cx, |channel_store, cx| {
490                channel_store.set_channel_visibility(
491                    channel_id,
492                    proto::ChannelVisibility::Public,
493                    cx,
494                )
495            })
496            .await
497            .unwrap();
498
499        channel_id
500    }
501
502    pub async fn make_channel_tree(
503        &self,
504        channels: &[(&str, Option<&str>)],
505        creator: (&TestClient, &mut TestAppContext),
506    ) -> Vec<ChannelId> {
507        let mut observed_channels = HashMap::default();
508        let mut result = Vec::new();
509        for (channel, parent) in channels {
510            let id;
511            if let Some(parent) = parent {
512                if let Some(parent_id) = observed_channels.get(parent) {
513                    id = self
514                        .make_channel(channel, Some(*parent_id), (creator.0, creator.1), &mut [])
515                        .await;
516                } else {
517                    panic!(
518                        "Edge {}->{} referenced before {} was created",
519                        parent, channel, parent
520                    )
521                }
522            } else {
523                id = self
524                    .make_channel(channel, None, (creator.0, creator.1), &mut [])
525                    .await;
526            }
527
528            observed_channels.insert(channel, id);
529            result.push(id);
530        }
531
532        result
533    }
534
535    pub async fn create_room(&self, clients: &mut [(&TestClient, &mut TestAppContext)]) {
536        self.make_contacts(clients).await;
537
538        let (left, right) = clients.split_at_mut(1);
539        let (_client_a, cx_a) = &mut left[0];
540        let active_call_a = cx_a.read(ActiveCall::global);
541
542        for (client_b, cx_b) in right {
543            let user_id_b = client_b.current_user_id(cx_b).to_proto();
544            active_call_a
545                .update(*cx_a, |call, cx| call.invite(user_id_b, None, cx))
546                .await
547                .unwrap();
548
549            cx_b.executor().run_until_parked();
550            let active_call_b = cx_b.read(ActiveCall::global);
551            active_call_b
552                .update(*cx_b, |call, cx| call.accept_incoming(cx))
553                .await
554                .unwrap();
555        }
556    }
557
558    pub async fn build_app_state(
559        test_db: &TestDb,
560        livekit_test_server: &LivekitTestServer,
561        executor: Executor,
562    ) -> Arc<AppState> {
563        Arc::new(AppState {
564            db: test_db.db().clone(),
565            http_client: None,
566            livekit_client: Some(Arc::new(livekit_test_server.create_api_client())),
567            blob_store_client: None,
568            executor,
569            kinesis_client: None,
570            config: Config {
571                http_port: 0,
572                database_url: "".into(),
573                database_max_connections: 0,
574                api_token: "".into(),
575                livekit_server: None,
576                livekit_key: None,
577                livekit_secret: None,
578                rust_log: None,
579                log_json: None,
580                zed_environment: "test".into(),
581                blob_store_url: None,
582                blob_store_region: None,
583                blob_store_access_key: None,
584                blob_store_secret_key: None,
585                blob_store_bucket: None,
586                zed_client_checksum_seed: None,
587                seed_path: None,
588                kinesis_region: None,
589                kinesis_stream: None,
590                kinesis_access_key: None,
591                kinesis_secret_key: None,
592            },
593        })
594    }
595}
596
597impl Deref for TestServer {
598    type Target = Server;
599
600    fn deref(&self) -> &Self::Target {
601        &self.server
602    }
603}
604
605impl Drop for TestServer {
606    fn drop(&mut self) {
607        self.server.teardown();
608        self.test_livekit_server.teardown().unwrap();
609    }
610}
611
612impl Deref for TestClient {
613    type Target = Arc<Client>;
614
615    fn deref(&self) -> &Self::Target {
616        &self.app_state.client
617    }
618}
619
620impl TestClient {
621    pub fn fs(&self) -> Arc<FakeFs> {
622        self.app_state.fs.as_fake()
623    }
624
625    pub fn channel_store(&self) -> &Entity<ChannelStore> {
626        &self.channel_store
627    }
628
629    pub fn notification_store(&self) -> &Entity<NotificationStore> {
630        &self.notification_store
631    }
632
633    pub fn user_store(&self) -> &Entity<UserStore> {
634        &self.app_state.user_store
635    }
636
637    pub fn language_registry(&self) -> &Arc<LanguageRegistry> {
638        &self.app_state.languages
639    }
640
641    pub fn client(&self) -> &Arc<Client> {
642        &self.app_state.client
643    }
644
645    pub fn current_user_id(&self, cx: &TestAppContext) -> UserId {
646        UserId::from_proto(
647            self.app_state
648                .user_store
649                .read_with(cx, |user_store, _| user_store.current_user().unwrap().id),
650        )
651    }
652
653    pub async fn wait_for_current_user(&self, cx: &TestAppContext) {
654        let mut authed_user = self
655            .app_state
656            .user_store
657            .read_with(cx, |user_store, _| user_store.watch_current_user());
658        while authed_user.next().await.unwrap().is_none() {}
659    }
660
661    pub async fn clear_contacts(&self, cx: &mut TestAppContext) {
662        self.app_state
663            .user_store
664            .update(cx, |store, _| store.clear_contacts())
665            .await;
666    }
667
668    pub fn local_projects(&self) -> impl Deref<Target = Vec<Entity<Project>>> + '_ {
669        Ref::map(self.state.borrow(), |state| &state.local_projects)
670    }
671
672    pub fn dev_server_projects(&self) -> impl Deref<Target = Vec<Entity<Project>>> + '_ {
673        Ref::map(self.state.borrow(), |state| &state.dev_server_projects)
674    }
675
676    pub fn local_projects_mut(&self) -> impl DerefMut<Target = Vec<Entity<Project>>> + '_ {
677        RefMut::map(self.state.borrow_mut(), |state| &mut state.local_projects)
678    }
679
680    pub fn dev_server_projects_mut(&self) -> impl DerefMut<Target = Vec<Entity<Project>>> + '_ {
681        RefMut::map(self.state.borrow_mut(), |state| {
682            &mut state.dev_server_projects
683        })
684    }
685
686    pub fn buffers_for_project<'a>(
687        &'a self,
688        project: &Entity<Project>,
689    ) -> impl DerefMut<Target = HashSet<Entity<language::Buffer>>> + 'a {
690        RefMut::map(self.state.borrow_mut(), |state| {
691            state.buffers.entry(project.clone()).or_default()
692        })
693    }
694
695    pub fn buffers(
696        &self,
697    ) -> impl DerefMut<Target = HashMap<Entity<Project>, HashSet<Entity<language::Buffer>>>> + '_
698    {
699        RefMut::map(self.state.borrow_mut(), |state| &mut state.buffers)
700    }
701
702    pub fn channel_buffers(&self) -> impl DerefMut<Target = HashSet<Entity<ChannelBuffer>>> + '_ {
703        RefMut::map(self.state.borrow_mut(), |state| &mut state.channel_buffers)
704    }
705
706    pub fn summarize_contacts(&self, cx: &TestAppContext) -> ContactsSummary {
707        self.app_state
708            .user_store
709            .read_with(cx, |store, _| ContactsSummary {
710                current: store
711                    .contacts()
712                    .iter()
713                    .map(|contact| contact.user.github_login.clone().to_string())
714                    .collect(),
715                outgoing_requests: store
716                    .outgoing_contact_requests()
717                    .iter()
718                    .map(|user| user.github_login.clone().to_string())
719                    .collect(),
720                incoming_requests: store
721                    .incoming_contact_requests()
722                    .iter()
723                    .map(|user| user.github_login.clone().to_string())
724                    .collect(),
725            })
726    }
727
728    pub async fn build_local_project(
729        &self,
730        root_path: impl AsRef<Path>,
731        cx: &mut TestAppContext,
732    ) -> (Entity<Project>, WorktreeId) {
733        let project = self.build_empty_local_project(false, cx);
734        let (worktree, _) = project
735            .update(cx, |p, cx| p.find_or_create_worktree(root_path, true, cx))
736            .await
737            .unwrap();
738        worktree
739            .read_with(cx, |tree, _| tree.as_local().unwrap().scan_complete())
740            .await;
741        cx.run_until_parked();
742        (project, worktree.read_with(cx, |tree, _| tree.id()))
743    }
744
745    pub async fn build_local_project_with_trust(
746        &self,
747        root_path: impl AsRef<Path>,
748        cx: &mut TestAppContext,
749    ) -> (Entity<Project>, WorktreeId) {
750        let project = self.build_empty_local_project(true, cx);
751        let (worktree, _) = project
752            .update(cx, |p, cx| p.find_or_create_worktree(root_path, true, cx))
753            .await
754            .unwrap();
755        worktree
756            .read_with(cx, |tree, _| tree.as_local().unwrap().scan_complete())
757            .await;
758        cx.run_until_parked();
759        (project, worktree.read_with(cx, |tree, _| tree.id()))
760    }
761
762    pub async fn build_ssh_project(
763        &self,
764        root_path: impl AsRef<Path>,
765        ssh: Entity<RemoteClient>,
766        init_worktree_trust: bool,
767        cx: &mut TestAppContext,
768    ) -> (Entity<Project>, WorktreeId) {
769        let project = cx.update(|cx| {
770            Project::remote(
771                ssh,
772                self.client().clone(),
773                self.app_state.node_runtime.clone(),
774                self.app_state.user_store.clone(),
775                self.app_state.languages.clone(),
776                self.app_state.fs.clone(),
777                init_worktree_trust,
778                cx,
779            )
780        });
781        let (worktree, _) = project
782            .update(cx, |p, cx| p.find_or_create_worktree(root_path, true, cx))
783            .await
784            .unwrap();
785        (project, worktree.read_with(cx, |tree, _| tree.id()))
786    }
787
788    pub async fn build_test_project(&self, cx: &mut TestAppContext) -> Entity<Project> {
789        self.fs()
790            .insert_tree(
791                path!("/a"),
792                json!({
793                    "1.txt": "one\none\none",
794                    "2.js": "function two() { return 2; }",
795                    "3.rs": "mod test",
796                }),
797            )
798            .await;
799        self.build_local_project(path!("/a"), cx).await.0
800    }
801
802    pub async fn host_workspace(
803        &self,
804        workspace: &Entity<Workspace>,
805        channel_id: ChannelId,
806        cx: &mut VisualTestContext,
807    ) {
808        cx.update(|_, cx| {
809            let active_call = ActiveCall::global(cx);
810            active_call.update(cx, |call, cx| call.join_channel(channel_id, cx))
811        })
812        .await
813        .unwrap();
814        cx.update(|_, cx| {
815            let active_call = ActiveCall::global(cx);
816            let project = workspace.read(cx).project().clone();
817            active_call.update(cx, |call, cx| call.share_project(project, cx))
818        })
819        .await
820        .unwrap();
821        cx.executor().run_until_parked();
822    }
823
824    pub async fn join_workspace<'a>(
825        &'a self,
826        channel_id: ChannelId,
827        cx: &'a mut TestAppContext,
828    ) -> (Entity<Workspace>, &'a mut VisualTestContext) {
829        cx.update(|cx| workspace::join_channel(channel_id, self.app_state.clone(), None, None, cx))
830            .await
831            .unwrap();
832        cx.run_until_parked();
833
834        self.active_workspace(cx)
835    }
836
837    pub fn build_empty_local_project(
838        &self,
839        init_worktree_trust: bool,
840        cx: &mut TestAppContext,
841    ) -> Entity<Project> {
842        cx.update(|cx| {
843            Project::local(
844                self.client().clone(),
845                self.app_state.node_runtime.clone(),
846                self.app_state.user_store.clone(),
847                self.app_state.languages.clone(),
848                self.app_state.fs.clone(),
849                None,
850                project::LocalProjectFlags {
851                    init_worktree_trust,
852                    ..Default::default()
853                },
854                cx,
855            )
856        })
857    }
858
859    pub async fn join_remote_project(
860        &self,
861        host_project_id: u64,
862        guest_cx: &mut TestAppContext,
863    ) -> Entity<Project> {
864        let active_call = guest_cx.read(ActiveCall::global);
865        let room = active_call.read_with(guest_cx, |call, _| call.room().unwrap().clone());
866        room.update(guest_cx, |room, cx| {
867            room.join_project(
868                host_project_id,
869                self.app_state.languages.clone(),
870                self.app_state.fs.clone(),
871                cx,
872            )
873        })
874        .await
875        .unwrap()
876    }
877
878    pub fn build_workspace<'a>(
879        &'a self,
880        project: &Entity<Project>,
881        cx: &'a mut TestAppContext,
882    ) -> (Entity<Workspace>, &'a mut VisualTestContext) {
883        let app_state = self.app_state.clone();
884        let project = project.clone();
885        let window = cx.add_window(|window, cx| {
886            window.activate_window();
887            let workspace = cx.new(|cx| Workspace::new(None, project, app_state, window, cx));
888            MultiWorkspace::new(workspace, window, cx)
889        });
890        let cx = VisualTestContext::from_window(*window, cx).into_mut();
891        cx.run_until_parked();
892        let workspace = window
893            .read_with(cx, |mw, _| mw.workspace().clone())
894            .unwrap();
895        (workspace, cx)
896    }
897
898    pub async fn build_test_workspace<'a>(
899        &'a self,
900        cx: &'a mut TestAppContext,
901    ) -> (Entity<Workspace>, &'a mut VisualTestContext) {
902        let project = self.build_test_project(cx).await;
903        let app_state = self.app_state.clone();
904        let window = cx.add_window(|window, cx| {
905            window.activate_window();
906            let workspace = cx.new(|cx| Workspace::new(None, project, app_state, window, cx));
907            MultiWorkspace::new(workspace, window, cx)
908        });
909        let cx = VisualTestContext::from_window(*window, cx).into_mut();
910        let workspace = window
911            .read_with(cx, |mw, _| mw.workspace().clone())
912            .unwrap();
913        (workspace, cx)
914    }
915
916    pub fn active_workspace<'a>(
917        &'a self,
918        cx: &'a mut TestAppContext,
919    ) -> (Entity<Workspace>, &'a mut VisualTestContext) {
920        let window = cx.update(|cx| {
921            cx.active_window()
922                .unwrap()
923                .downcast::<MultiWorkspace>()
924                .unwrap()
925        });
926
927        let entity = window
928            .read_with(cx, |mw, _| mw.workspace().clone())
929            .unwrap();
930        let cx = VisualTestContext::from_window(*window.deref(), cx).into_mut();
931        // it might be nice to try and cleanup these at the end of each test.
932        (entity, cx)
933    }
934}
935
936pub fn open_channel_notes(
937    channel_id: ChannelId,
938    cx: &mut VisualTestContext,
939) -> Task<anyhow::Result<Entity<ChannelView>>> {
940    let window = cx.update(|_, cx| {
941        cx.active_window()
942            .unwrap()
943            .downcast::<MultiWorkspace>()
944            .unwrap()
945    });
946    let entity = window
947        .read_with(cx, |mw, _| mw.workspace().clone())
948        .unwrap();
949
950    cx.update(|window, cx| ChannelView::open(channel_id, None, entity.clone(), window, cx))
951}
952
953impl Drop for TestClient {
954    fn drop(&mut self) {
955        self.app_state.client.teardown();
956    }
957}