test_server.rs

  1use crate::stripe_client::FakeStripeClient;
  2use crate::{
  3    AppState, Config,
  4    db::{NewUserParams, UserId, tests::TestDb},
  5    executor::Executor,
  6    rpc::{CLEANUP_TIMEOUT, Principal, RECONNECT_TIMEOUT, Server, ZedVersion},
  7};
  8use anyhow::anyhow;
  9use call::ActiveCall;
 10use channel::{ChannelBuffer, ChannelStore};
 11use client::test::{make_get_authenticated_user_response, parse_authorization_header};
 12use client::{
 13    self, ChannelId, Client, Connection, Credentials, EstablishConnectionError, UserStore,
 14    proto::PeerId,
 15};
 16use clock::FakeSystemClock;
 17use collab_ui::channel_view::ChannelView;
 18use collections::{HashMap, HashSet};
 19
 20use fs::FakeFs;
 21use futures::{StreamExt as _, channel::oneshot};
 22use git::GitHostingProviderRegistry;
 23use gpui::{AppContext as _, BackgroundExecutor, Entity, Task, TestAppContext, VisualTestContext};
 24use http_client::{FakeHttpClient, Method};
 25use language::LanguageRegistry;
 26use node_runtime::NodeRuntime;
 27use notifications::NotificationStore;
 28use parking_lot::Mutex;
 29use project::{Project, WorktreeId};
 30use remote::SshRemoteClient;
 31use rpc::{
 32    RECEIVE_TIMEOUT,
 33    proto::{self, ChannelRole},
 34};
 35use semantic_version::SemanticVersion;
 36use serde_json::json;
 37use session::{AppSession, Session};
 38use settings::SettingsStore;
 39use std::{
 40    cell::{Ref, RefCell, RefMut},
 41    env,
 42    ops::{Deref, DerefMut},
 43    path::Path,
 44    sync::{
 45        Arc,
 46        atomic::{AtomicBool, AtomicUsize, Ordering::SeqCst},
 47    },
 48};
 49use util::path;
 50use workspace::{Workspace, WorkspaceStore};
 51
 52use livekit_client::test::TestServer as LivekitTestServer;
 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            release_channel::init(SemanticVersion::default(), cx);
177            client::init_settings(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 mut 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        Arc::get_mut(&mut client)
252            .unwrap()
253            .set_id(user_id.to_proto())
254            .override_authenticate(move |cx| {
255                cx.spawn(async move |_| {
256                    Ok(Credentials {
257                        user_id: user_id.to_proto(),
258                        access_token: ACCESS_TOKEN.into(),
259                    })
260                })
261            })
262            .override_establish_connection(move |credentials, cx| {
263                assert_eq!(
264                    credentials,
265                    &Credentials {
266                        user_id: user_id.0 as u64,
267                        access_token: ACCESS_TOKEN.into(),
268                    }
269                );
270
271                let server = server.clone();
272                let db = db.clone();
273                let connection_killers = connection_killers.clone();
274                let forbid_connections = forbid_connections.clone();
275                let client_name = client_name.clone();
276                cx.spawn(async move |cx| {
277                    if forbid_connections.load(SeqCst) {
278                        Err(EstablishConnectionError::other(anyhow!(
279                            "server is forbidding connections"
280                        )))
281                    } else {
282                        let (client_conn, server_conn, killed) =
283                            Connection::in_memory(cx.background_executor().clone());
284                        let (connection_id_tx, connection_id_rx) = oneshot::channel();
285                        let user = db
286                            .get_user_by_id(user_id)
287                            .await
288                            .map_err(|e| {
289                                EstablishConnectionError::Other(anyhow!(
290                                    "retrieving user failed: {}",
291                                    e
292                                ))
293                            })?
294                            .unwrap();
295                        cx.background_spawn(server.handle_connection(
296                            server_conn,
297                            client_name,
298                            Principal::User(user),
299                            ZedVersion(SemanticVersion::new(1, 0, 0)),
300                            Some("test".to_string()),
301                            None,
302                            None,
303                            None,
304                            Some(connection_id_tx),
305                            Executor::Deterministic(cx.background_executor().clone()),
306                            None,
307                        ))
308                        .detach();
309                        let connection_id = connection_id_rx.await.map_err(|e| {
310                            EstablishConnectionError::Other(anyhow!(
311                                "{} (is server shutting down?)",
312                                e
313                            ))
314                        })?;
315                        connection_killers
316                            .lock()
317                            .insert(connection_id.into(), killed);
318                        Ok(client_conn)
319                    }
320                })
321            });
322
323        let git_hosting_provider_registry = cx.update(GitHostingProviderRegistry::default_global);
324        git_hosting_provider_registry
325            .register_hosting_provider(Arc::new(git_hosting_providers::Github::public_instance()));
326
327        let user_store = cx.new(|cx| UserStore::new(client.clone(), cx));
328        let workspace_store = cx.new(|cx| WorkspaceStore::new(client.clone(), cx));
329        let language_registry = Arc::new(LanguageRegistry::test(cx.executor()));
330        let session = cx.new(|cx| AppSession::new(Session::test(), cx));
331        let app_state = Arc::new(workspace::AppState {
332            client: client.clone(),
333            user_store: user_store.clone(),
334            workspace_store,
335            languages: language_registry,
336            fs: fs.clone(),
337            build_window_options: |_, _| Default::default(),
338            node_runtime: NodeRuntime::unavailable(),
339            session,
340        });
341
342        let os_keymap = "keymaps/default-macos.json";
343
344        cx.update(|cx| {
345            theme::init(theme::LoadThemes::JustBase, cx);
346            Project::init(&client, cx);
347            client::init(&client, cx);
348            language::init(cx);
349            editor::init(cx);
350            workspace::init(app_state.clone(), cx);
351            call::init(client.clone(), user_store.clone(), cx);
352            channel::init(&client, user_store.clone(), cx);
353            notifications::init(client.clone(), user_store, cx);
354            collab_ui::init(&app_state, cx);
355            file_finder::init(cx);
356            menu::init();
357            cx.bind_keys(
358                settings::KeymapFile::load_asset_allow_partial_failure(os_keymap, cx).unwrap(),
359            );
360            language_model::LanguageModelRegistry::test(cx);
361            assistant_context::init(client.clone(), cx);
362            agent_settings::init(cx);
363        });
364
365        client
366            .connect(false, &cx.to_async())
367            .await
368            .into_response()
369            .unwrap();
370
371        let client = TestClient {
372            app_state,
373            username: name.to_string(),
374            channel_store: cx.read(ChannelStore::global).clone(),
375            notification_store: cx.read(NotificationStore::global).clone(),
376            state: Default::default(),
377        };
378        client.wait_for_current_user(cx).await;
379        client
380    }
381
382    pub fn disconnect_client(&self, peer_id: PeerId) {
383        self.connection_killers
384            .lock()
385            .remove(&peer_id)
386            .unwrap()
387            .store(true, SeqCst);
388    }
389
390    pub fn simulate_long_connection_interruption(
391        &self,
392        peer_id: PeerId,
393        deterministic: BackgroundExecutor,
394    ) {
395        self.forbid_connections();
396        self.disconnect_client(peer_id);
397        deterministic.advance_clock(RECEIVE_TIMEOUT + RECONNECT_TIMEOUT);
398        self.allow_connections();
399        deterministic.advance_clock(RECEIVE_TIMEOUT + RECONNECT_TIMEOUT);
400        deterministic.run_until_parked();
401    }
402
403    pub fn forbid_connections(&self) {
404        self.forbid_connections.store(true, SeqCst);
405    }
406
407    pub fn allow_connections(&self) {
408        self.forbid_connections.store(false, SeqCst);
409    }
410
411    pub async fn make_contacts(&self, clients: &mut [(&TestClient, &mut TestAppContext)]) {
412        for ix in 1..clients.len() {
413            let (left, right) = clients.split_at_mut(ix);
414            let (client_a, cx_a) = left.last_mut().unwrap();
415            for (client_b, cx_b) in right {
416                client_a
417                    .app_state
418                    .user_store
419                    .update(*cx_a, |store, cx| {
420                        store.request_contact(client_b.user_id().unwrap(), cx)
421                    })
422                    .await
423                    .unwrap();
424                cx_a.executor().run_until_parked();
425                client_b
426                    .app_state
427                    .user_store
428                    .update(*cx_b, |store, cx| {
429                        store.respond_to_contact_request(client_a.user_id().unwrap(), true, cx)
430                    })
431                    .await
432                    .unwrap();
433            }
434        }
435    }
436
437    pub async fn make_channel(
438        &self,
439        channel: &str,
440        parent: Option<ChannelId>,
441        admin: (&TestClient, &mut TestAppContext),
442        members: &mut [(&TestClient, &mut TestAppContext)],
443    ) -> ChannelId {
444        let (_, admin_cx) = admin;
445        let channel_id = admin_cx
446            .read(ChannelStore::global)
447            .update(admin_cx, |channel_store, cx| {
448                channel_store.create_channel(channel, parent, cx)
449            })
450            .await
451            .unwrap();
452
453        for (member_client, member_cx) in members {
454            admin_cx
455                .read(ChannelStore::global)
456                .update(admin_cx, |channel_store, cx| {
457                    channel_store.invite_member(
458                        channel_id,
459                        member_client.user_id().unwrap(),
460                        ChannelRole::Member,
461                        cx,
462                    )
463                })
464                .await
465                .unwrap();
466
467            admin_cx.executor().run_until_parked();
468
469            member_cx
470                .read(ChannelStore::global)
471                .update(*member_cx, |channels, cx| {
472                    channels.respond_to_channel_invite(channel_id, true, cx)
473                })
474                .await
475                .unwrap();
476        }
477
478        channel_id
479    }
480
481    pub async fn make_public_channel(
482        &self,
483        channel: &str,
484        client: &TestClient,
485        cx: &mut TestAppContext,
486    ) -> ChannelId {
487        let channel_id = self
488            .make_channel(channel, None, (client, cx), &mut [])
489            .await;
490
491        client
492            .channel_store()
493            .update(cx, |channel_store, cx| {
494                channel_store.set_channel_visibility(
495                    channel_id,
496                    proto::ChannelVisibility::Public,
497                    cx,
498                )
499            })
500            .await
501            .unwrap();
502
503        channel_id
504    }
505
506    pub async fn make_channel_tree(
507        &self,
508        channels: &[(&str, Option<&str>)],
509        creator: (&TestClient, &mut TestAppContext),
510    ) -> Vec<ChannelId> {
511        let mut observed_channels = HashMap::default();
512        let mut result = Vec::new();
513        for (channel, parent) in channels {
514            let id;
515            if let Some(parent) = parent {
516                if let Some(parent_id) = observed_channels.get(parent) {
517                    id = self
518                        .make_channel(channel, Some(*parent_id), (creator.0, creator.1), &mut [])
519                        .await;
520                } else {
521                    panic!(
522                        "Edge {}->{} referenced before {} was created",
523                        parent, channel, parent
524                    )
525                }
526            } else {
527                id = self
528                    .make_channel(channel, None, (creator.0, creator.1), &mut [])
529                    .await;
530            }
531
532            observed_channels.insert(channel, id);
533            result.push(id);
534        }
535
536        result
537    }
538
539    pub async fn create_room(&self, clients: &mut [(&TestClient, &mut TestAppContext)]) {
540        self.make_contacts(clients).await;
541
542        let (left, right) = clients.split_at_mut(1);
543        let (_client_a, cx_a) = &mut left[0];
544        let active_call_a = cx_a.read(ActiveCall::global);
545
546        for (client_b, cx_b) in right {
547            let user_id_b = client_b.current_user_id(cx_b).to_proto();
548            active_call_a
549                .update(*cx_a, |call, cx| call.invite(user_id_b, None, cx))
550                .await
551                .unwrap();
552
553            cx_b.executor().run_until_parked();
554            let active_call_b = cx_b.read(ActiveCall::global);
555            active_call_b
556                .update(*cx_b, |call, cx| call.accept_incoming(cx))
557                .await
558                .unwrap();
559        }
560    }
561
562    pub async fn build_app_state(
563        test_db: &TestDb,
564        livekit_test_server: &LivekitTestServer,
565        executor: Executor,
566    ) -> Arc<AppState> {
567        Arc::new(AppState {
568            db: test_db.db().clone(),
569            llm_db: None,
570            livekit_client: Some(Arc::new(livekit_test_server.create_api_client())),
571            blob_store_client: None,
572            real_stripe_client: None,
573            stripe_client: Some(Arc::new(FakeStripeClient::new())),
574            stripe_billing: None,
575            executor,
576            kinesis_client: None,
577            config: Config {
578                http_port: 0,
579                database_url: "".into(),
580                database_max_connections: 0,
581                api_token: "".into(),
582                invite_link_prefix: "".into(),
583                livekit_server: None,
584                livekit_key: None,
585                livekit_secret: None,
586                llm_database_url: None,
587                llm_database_max_connections: None,
588                llm_database_migrations_path: None,
589                llm_api_secret: None,
590                rust_log: None,
591                log_json: None,
592                zed_environment: "test".into(),
593                blob_store_url: None,
594                blob_store_region: None,
595                blob_store_access_key: None,
596                blob_store_secret_key: None,
597                blob_store_bucket: None,
598                openai_api_key: None,
599                google_ai_api_key: None,
600                anthropic_api_key: None,
601                anthropic_staff_api_key: None,
602                llm_closed_beta_model_name: None,
603                prediction_api_url: None,
604                prediction_api_key: None,
605                prediction_model: None,
606                zed_client_checksum_seed: None,
607                slack_panics_webhook: None,
608                auto_join_channel_id: None,
609                migrations_path: None,
610                seed_path: None,
611                stripe_api_key: None,
612                supermaven_admin_api_key: None,
613                user_backfiller_github_access_token: None,
614                kinesis_region: None,
615                kinesis_stream: None,
616                kinesis_access_key: None,
617                kinesis_secret_key: None,
618            },
619        })
620    }
621}
622
623impl Deref for TestServer {
624    type Target = Server;
625
626    fn deref(&self) -> &Self::Target {
627        &self.server
628    }
629}
630
631impl Drop for TestServer {
632    fn drop(&mut self) {
633        self.server.teardown();
634        self.test_livekit_server.teardown().unwrap();
635    }
636}
637
638impl Deref for TestClient {
639    type Target = Arc<Client>;
640
641    fn deref(&self) -> &Self::Target {
642        &self.app_state.client
643    }
644}
645
646impl TestClient {
647    pub fn fs(&self) -> Arc<FakeFs> {
648        self.app_state.fs.as_fake()
649    }
650
651    pub fn channel_store(&self) -> &Entity<ChannelStore> {
652        &self.channel_store
653    }
654
655    pub fn notification_store(&self) -> &Entity<NotificationStore> {
656        &self.notification_store
657    }
658
659    pub fn user_store(&self) -> &Entity<UserStore> {
660        &self.app_state.user_store
661    }
662
663    pub fn language_registry(&self) -> &Arc<LanguageRegistry> {
664        &self.app_state.languages
665    }
666
667    pub fn client(&self) -> &Arc<Client> {
668        &self.app_state.client
669    }
670
671    pub fn current_user_id(&self, cx: &TestAppContext) -> UserId {
672        UserId::from_proto(
673            self.app_state
674                .user_store
675                .read_with(cx, |user_store, _| user_store.current_user().unwrap().id),
676        )
677    }
678
679    pub async fn wait_for_current_user(&self, cx: &TestAppContext) {
680        let mut authed_user = self
681            .app_state
682            .user_store
683            .read_with(cx, |user_store, _| user_store.watch_current_user());
684        while authed_user.next().await.unwrap().is_none() {}
685    }
686
687    pub async fn clear_contacts(&self, cx: &mut TestAppContext) {
688        self.app_state
689            .user_store
690            .update(cx, |store, _| store.clear_contacts())
691            .await;
692    }
693
694    pub fn local_projects(&self) -> impl Deref<Target = Vec<Entity<Project>>> + '_ {
695        Ref::map(self.state.borrow(), |state| &state.local_projects)
696    }
697
698    pub fn dev_server_projects(&self) -> impl Deref<Target = Vec<Entity<Project>>> + '_ {
699        Ref::map(self.state.borrow(), |state| &state.dev_server_projects)
700    }
701
702    pub fn local_projects_mut(&self) -> impl DerefMut<Target = Vec<Entity<Project>>> + '_ {
703        RefMut::map(self.state.borrow_mut(), |state| &mut state.local_projects)
704    }
705
706    pub fn dev_server_projects_mut(&self) -> impl DerefMut<Target = Vec<Entity<Project>>> + '_ {
707        RefMut::map(self.state.borrow_mut(), |state| {
708            &mut state.dev_server_projects
709        })
710    }
711
712    pub fn buffers_for_project<'a>(
713        &'a self,
714        project: &Entity<Project>,
715    ) -> impl DerefMut<Target = HashSet<Entity<language::Buffer>>> + 'a {
716        RefMut::map(self.state.borrow_mut(), |state| {
717            state.buffers.entry(project.clone()).or_default()
718        })
719    }
720
721    pub fn buffers(
722        &self,
723    ) -> impl DerefMut<Target = HashMap<Entity<Project>, HashSet<Entity<language::Buffer>>>> + '_
724    {
725        RefMut::map(self.state.borrow_mut(), |state| &mut state.buffers)
726    }
727
728    pub fn channel_buffers(&self) -> impl DerefMut<Target = HashSet<Entity<ChannelBuffer>>> + '_ {
729        RefMut::map(self.state.borrow_mut(), |state| &mut state.channel_buffers)
730    }
731
732    pub fn summarize_contacts(&self, cx: &TestAppContext) -> ContactsSummary {
733        self.app_state
734            .user_store
735            .read_with(cx, |store, _| ContactsSummary {
736                current: store
737                    .contacts()
738                    .iter()
739                    .map(|contact| contact.user.github_login.clone().to_string())
740                    .collect(),
741                outgoing_requests: store
742                    .outgoing_contact_requests()
743                    .iter()
744                    .map(|user| user.github_login.clone().to_string())
745                    .collect(),
746                incoming_requests: store
747                    .incoming_contact_requests()
748                    .iter()
749                    .map(|user| user.github_login.clone().to_string())
750                    .collect(),
751            })
752    }
753
754    pub async fn build_local_project(
755        &self,
756        root_path: impl AsRef<Path>,
757        cx: &mut TestAppContext,
758    ) -> (Entity<Project>, WorktreeId) {
759        let project = self.build_empty_local_project(cx);
760        let (worktree, _) = project
761            .update(cx, |p, cx| p.find_or_create_worktree(root_path, true, cx))
762            .await
763            .unwrap();
764        worktree
765            .read_with(cx, |tree, _| tree.as_local().unwrap().scan_complete())
766            .await;
767        cx.run_until_parked();
768        (project, worktree.read_with(cx, |tree, _| tree.id()))
769    }
770
771    pub async fn build_ssh_project(
772        &self,
773        root_path: impl AsRef<Path>,
774        ssh: Entity<SshRemoteClient>,
775        cx: &mut TestAppContext,
776    ) -> (Entity<Project>, WorktreeId) {
777        let project = cx.update(|cx| {
778            Project::ssh(
779                ssh,
780                self.client().clone(),
781                self.app_state.node_runtime.clone(),
782                self.app_state.user_store.clone(),
783                self.app_state.languages.clone(),
784                self.app_state.fs.clone(),
785                cx,
786            )
787        });
788        let (worktree, _) = project
789            .update(cx, |p, cx| p.find_or_create_worktree(root_path, true, cx))
790            .await
791            .unwrap();
792        (project, worktree.read_with(cx, |tree, _| tree.id()))
793    }
794
795    pub async fn build_test_project(&self, cx: &mut TestAppContext) -> Entity<Project> {
796        self.fs()
797            .insert_tree(
798                path!("/a"),
799                json!({
800                    "1.txt": "one\none\none",
801                    "2.js": "function two() { return 2; }",
802                    "3.rs": "mod test",
803                }),
804            )
805            .await;
806        self.build_local_project(path!("/a"), cx).await.0
807    }
808
809    pub async fn host_workspace(
810        &self,
811        workspace: &Entity<Workspace>,
812        channel_id: ChannelId,
813        cx: &mut VisualTestContext,
814    ) {
815        cx.update(|_, cx| {
816            let active_call = ActiveCall::global(cx);
817            active_call.update(cx, |call, cx| call.join_channel(channel_id, cx))
818        })
819        .await
820        .unwrap();
821        cx.update(|_, cx| {
822            let active_call = ActiveCall::global(cx);
823            let project = workspace.read(cx).project().clone();
824            active_call.update(cx, |call, cx| call.share_project(project, cx))
825        })
826        .await
827        .unwrap();
828        cx.executor().run_until_parked();
829    }
830
831    pub async fn join_workspace<'a>(
832        &'a self,
833        channel_id: ChannelId,
834        cx: &'a mut TestAppContext,
835    ) -> (Entity<Workspace>, &'a mut VisualTestContext) {
836        cx.update(|cx| workspace::join_channel(channel_id, self.app_state.clone(), None, cx))
837            .await
838            .unwrap();
839        cx.run_until_parked();
840
841        self.active_workspace(cx)
842    }
843
844    pub fn build_empty_local_project(&self, cx: &mut TestAppContext) -> Entity<Project> {
845        cx.update(|cx| {
846            Project::local(
847                self.client().clone(),
848                self.app_state.node_runtime.clone(),
849                self.app_state.user_store.clone(),
850                self.app_state.languages.clone(),
851                self.app_state.fs.clone(),
852                None,
853                cx,
854            )
855        })
856    }
857
858    pub async fn join_remote_project(
859        &self,
860        host_project_id: u64,
861        guest_cx: &mut TestAppContext,
862    ) -> Entity<Project> {
863        let active_call = guest_cx.read(ActiveCall::global);
864        let room = active_call.read_with(guest_cx, |call, _| call.room().unwrap().clone());
865        room.update(guest_cx, |room, cx| {
866            room.join_project(
867                host_project_id,
868                self.app_state.languages.clone(),
869                self.app_state.fs.clone(),
870                cx,
871            )
872        })
873        .await
874        .unwrap()
875    }
876
877    pub fn build_workspace<'a>(
878        &'a self,
879        project: &Entity<Project>,
880        cx: &'a mut TestAppContext,
881    ) -> (Entity<Workspace>, &'a mut VisualTestContext) {
882        cx.add_window_view(|window, cx| {
883            window.activate_window();
884            Workspace::new(None, project.clone(), self.app_state.clone(), window, cx)
885        })
886    }
887
888    pub async fn build_test_workspace<'a>(
889        &'a self,
890        cx: &'a mut TestAppContext,
891    ) -> (Entity<Workspace>, &'a mut VisualTestContext) {
892        let project = self.build_test_project(cx).await;
893        cx.add_window_view(|window, cx| {
894            window.activate_window();
895            Workspace::new(None, project.clone(), self.app_state.clone(), window, cx)
896        })
897    }
898
899    pub fn active_workspace<'a>(
900        &'a self,
901        cx: &'a mut TestAppContext,
902    ) -> (Entity<Workspace>, &'a mut VisualTestContext) {
903        let window = cx.update(|cx| cx.active_window().unwrap().downcast::<Workspace>().unwrap());
904
905        let entity = window.root(cx).unwrap();
906        let cx = VisualTestContext::from_window(*window.deref(), cx).as_mut();
907        // it might be nice to try and cleanup these at the end of each test.
908        (entity, cx)
909    }
910}
911
912pub fn open_channel_notes(
913    channel_id: ChannelId,
914    cx: &mut VisualTestContext,
915) -> Task<anyhow::Result<Entity<ChannelView>>> {
916    let window = cx.update(|_, cx| cx.active_window().unwrap().downcast::<Workspace>().unwrap());
917    let entity = window.root(cx).unwrap();
918
919    cx.update(|window, cx| ChannelView::open(channel_id, None, entity.clone(), window, cx))
920}
921
922impl Drop for TestClient {
923    fn drop(&mut self) {
924        self.app_state.client.teardown();
925    }
926}