1use crate::{
2 db::{self, NewUserParams, UserId},
3 rpc::{CLEANUP_TIMEOUT, RECONNECT_TIMEOUT},
4 tests::{TestClient, TestServer},
5};
6use anyhow::{anyhow, Result};
7use call::ActiveCall;
8use client::RECEIVE_TIMEOUT;
9use collections::BTreeMap;
10use editor::Bias;
11use fs::{repository::GitFileStatus, FakeFs, Fs as _};
12use futures::StreamExt as _;
13use gpui::{executor::Deterministic, ModelHandle, Task, TestAppContext};
14use language::{range_to_lsp, FakeLspAdapter, Language, LanguageConfig, PointUtf16};
15use lsp::FakeLanguageServer;
16use parking_lot::Mutex;
17use pretty_assertions::assert_eq;
18use project::{search::SearchQuery, Project, ProjectPath};
19use rand::{
20 distributions::{Alphanumeric, DistString},
21 prelude::*,
22};
23use serde::{Deserialize, Serialize};
24use settings::SettingsStore;
25use std::{
26 env,
27 ops::Range,
28 path::{Path, PathBuf},
29 rc::Rc,
30 sync::{
31 atomic::{AtomicBool, Ordering::SeqCst},
32 Arc,
33 },
34};
35use util::ResultExt;
36
37lazy_static::lazy_static! {
38 static ref PLAN_LOAD_PATH: Option<PathBuf> = path_env_var("LOAD_PLAN");
39 static ref PLAN_SAVE_PATH: Option<PathBuf> = path_env_var("SAVE_PLAN");
40 static ref LOADED_PLAN_JSON: Mutex<Option<Vec<u8>>> = Default::default();
41 static ref PLAN: Mutex<Option<Arc<Mutex<TestPlan>>>> = Default::default();
42}
43
44#[gpui::test(iterations = 100, on_failure = "on_failure")]
45async fn test_random_collaboration(
46 cx: &mut TestAppContext,
47 deterministic: Arc<Deterministic>,
48 rng: StdRng,
49) {
50 deterministic.forbid_parking();
51
52 let max_peers = env::var("MAX_PEERS")
53 .map(|i| i.parse().expect("invalid `MAX_PEERS` variable"))
54 .unwrap_or(3);
55 let max_operations = env::var("OPERATIONS")
56 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
57 .unwrap_or(10);
58
59 let mut server = TestServer::start(&deterministic).await;
60 let db = server.app_state.db.clone();
61
62 let mut users = Vec::new();
63 for ix in 0..max_peers {
64 let username = format!("user-{}", ix + 1);
65 let user_id = db
66 .create_user(
67 &format!("{username}@example.com"),
68 false,
69 NewUserParams {
70 github_login: username.clone(),
71 github_user_id: (ix + 1) as i32,
72 invite_count: 0,
73 },
74 )
75 .await
76 .unwrap()
77 .user_id;
78 users.push(UserTestPlan {
79 user_id,
80 username,
81 online: false,
82 next_root_id: 0,
83 operation_ix: 0,
84 });
85 }
86
87 for (ix, user_a) in users.iter().enumerate() {
88 for user_b in &users[ix + 1..] {
89 server
90 .app_state
91 .db
92 .send_contact_request(user_a.user_id, user_b.user_id)
93 .await
94 .unwrap();
95 server
96 .app_state
97 .db
98 .respond_to_contact_request(user_b.user_id, user_a.user_id, true)
99 .await
100 .unwrap();
101 }
102 }
103
104 let plan = Arc::new(Mutex::new(TestPlan::new(rng, users, max_operations)));
105
106 if let Some(path) = &*PLAN_LOAD_PATH {
107 let json = LOADED_PLAN_JSON
108 .lock()
109 .get_or_insert_with(|| {
110 eprintln!("loaded test plan from path {:?}", path);
111 std::fs::read(path).unwrap()
112 })
113 .clone();
114 plan.lock().deserialize(json);
115 }
116
117 PLAN.lock().replace(plan.clone());
118
119 let mut clients = Vec::new();
120 let mut client_tasks = Vec::new();
121 let mut operation_channels = Vec::new();
122
123 loop {
124 let Some((next_operation, applied)) = plan.lock().next_server_operation(&clients) else { break };
125 applied.store(true, SeqCst);
126 let did_apply = apply_server_operation(
127 deterministic.clone(),
128 &mut server,
129 &mut clients,
130 &mut client_tasks,
131 &mut operation_channels,
132 plan.clone(),
133 next_operation,
134 cx,
135 )
136 .await;
137 if !did_apply {
138 applied.store(false, SeqCst);
139 }
140 }
141
142 drop(operation_channels);
143 deterministic.start_waiting();
144 futures::future::join_all(client_tasks).await;
145 deterministic.finish_waiting();
146 deterministic.run_until_parked();
147
148 check_consistency_between_clients(&clients);
149
150 for (client, mut cx) in clients {
151 cx.update(|cx| {
152 let store = cx.remove_global::<SettingsStore>();
153 cx.clear_globals();
154 cx.set_global(store);
155 drop(client);
156 });
157 }
158
159 deterministic.run_until_parked();
160}
161
162fn on_failure() {
163 if let Some(plan) = PLAN.lock().clone() {
164 if let Some(path) = &*PLAN_SAVE_PATH {
165 eprintln!("saved test plan to path {:?}", path);
166 std::fs::write(path, plan.lock().serialize()).unwrap();
167 }
168 }
169}
170
171async fn apply_server_operation(
172 deterministic: Arc<Deterministic>,
173 server: &mut TestServer,
174 clients: &mut Vec<(Rc<TestClient>, TestAppContext)>,
175 client_tasks: &mut Vec<Task<()>>,
176 operation_channels: &mut Vec<futures::channel::mpsc::UnboundedSender<usize>>,
177 plan: Arc<Mutex<TestPlan>>,
178 operation: Operation,
179 cx: &mut TestAppContext,
180) -> bool {
181 match operation {
182 Operation::AddConnection { user_id } => {
183 let username;
184 {
185 let mut plan = plan.lock();
186 let mut user = plan.user(user_id);
187 if user.online {
188 return false;
189 }
190 user.online = true;
191 username = user.username.clone();
192 };
193 log::info!("Adding new connection for {}", username);
194 let next_entity_id = (user_id.0 * 10_000) as usize;
195 let mut client_cx = TestAppContext::new(
196 cx.foreground_platform(),
197 cx.platform(),
198 deterministic.build_foreground(user_id.0 as usize),
199 deterministic.build_background(),
200 cx.font_cache(),
201 cx.leak_detector(),
202 next_entity_id,
203 cx.function_name.clone(),
204 );
205
206 let (operation_tx, operation_rx) = futures::channel::mpsc::unbounded();
207 let client = Rc::new(server.create_client(&mut client_cx, &username).await);
208 operation_channels.push(operation_tx);
209 clients.push((client.clone(), client_cx.clone()));
210 client_tasks.push(client_cx.foreground().spawn(simulate_client(
211 client,
212 operation_rx,
213 plan.clone(),
214 client_cx,
215 )));
216
217 log::info!("Added connection for {}", username);
218 }
219
220 Operation::RemoveConnection {
221 user_id: removed_user_id,
222 } => {
223 log::info!("Simulating full disconnection of user {}", removed_user_id);
224 let client_ix = clients
225 .iter()
226 .position(|(client, cx)| client.current_user_id(cx) == removed_user_id);
227 let Some(client_ix) = client_ix else { return false };
228 let user_connection_ids = server
229 .connection_pool
230 .lock()
231 .user_connection_ids(removed_user_id)
232 .collect::<Vec<_>>();
233 assert_eq!(user_connection_ids.len(), 1);
234 let removed_peer_id = user_connection_ids[0].into();
235 let (client, mut client_cx) = clients.remove(client_ix);
236 let client_task = client_tasks.remove(client_ix);
237 operation_channels.remove(client_ix);
238 server.forbid_connections();
239 server.disconnect_client(removed_peer_id);
240 deterministic.advance_clock(RECEIVE_TIMEOUT + RECONNECT_TIMEOUT);
241 deterministic.start_waiting();
242 log::info!("Waiting for user {} to exit...", removed_user_id);
243 client_task.await;
244 deterministic.finish_waiting();
245 server.allow_connections();
246
247 for project in client.remote_projects().iter() {
248 project.read_with(&client_cx, |project, _| {
249 assert!(
250 project.is_read_only(),
251 "project {:?} should be read only",
252 project.remote_id()
253 )
254 });
255 }
256
257 for (client, cx) in clients {
258 let contacts = server
259 .app_state
260 .db
261 .get_contacts(client.current_user_id(cx))
262 .await
263 .unwrap();
264 let pool = server.connection_pool.lock();
265 for contact in contacts {
266 if let db::Contact::Accepted { user_id, busy, .. } = contact {
267 if user_id == removed_user_id {
268 assert!(!pool.is_user_online(user_id));
269 assert!(!busy);
270 }
271 }
272 }
273 }
274
275 log::info!("{} removed", client.username);
276 plan.lock().user(removed_user_id).online = false;
277 client_cx.update(|cx| {
278 cx.clear_globals();
279 drop(client);
280 });
281 }
282
283 Operation::BounceConnection { user_id } => {
284 log::info!("Simulating temporary disconnection of user {}", user_id);
285 let user_connection_ids = server
286 .connection_pool
287 .lock()
288 .user_connection_ids(user_id)
289 .collect::<Vec<_>>();
290 if user_connection_ids.is_empty() {
291 return false;
292 }
293 assert_eq!(user_connection_ids.len(), 1);
294 let peer_id = user_connection_ids[0].into();
295 server.disconnect_client(peer_id);
296 deterministic.advance_clock(RECEIVE_TIMEOUT + RECONNECT_TIMEOUT);
297 }
298
299 Operation::RestartServer => {
300 log::info!("Simulating server restart");
301 server.reset().await;
302 deterministic.advance_clock(RECEIVE_TIMEOUT);
303 server.start().await.unwrap();
304 deterministic.advance_clock(CLEANUP_TIMEOUT);
305 let environment = &server.app_state.config.zed_environment;
306 let stale_room_ids = server
307 .app_state
308 .db
309 .stale_room_ids(environment, server.id())
310 .await
311 .unwrap();
312 assert_eq!(stale_room_ids, vec![]);
313 }
314
315 Operation::MutateClients {
316 user_ids,
317 batch_id,
318 quiesce,
319 } => {
320 let mut applied = false;
321 for user_id in user_ids {
322 let client_ix = clients
323 .iter()
324 .position(|(client, cx)| client.current_user_id(cx) == user_id);
325 let Some(client_ix) = client_ix else { continue };
326 applied = true;
327 if let Err(err) = operation_channels[client_ix].unbounded_send(batch_id) {
328 log::error!("error signaling user {user_id}: {err}");
329 }
330 }
331
332 if quiesce && applied {
333 deterministic.run_until_parked();
334 check_consistency_between_clients(&clients);
335 }
336
337 return applied;
338 }
339 }
340 true
341}
342
343async fn apply_client_operation(
344 client: &TestClient,
345 operation: ClientOperation,
346 cx: &mut TestAppContext,
347) -> Result<(), TestError> {
348 match operation {
349 ClientOperation::AcceptIncomingCall => {
350 let active_call = cx.read(ActiveCall::global);
351 if active_call.read_with(cx, |call, _| call.incoming().borrow().is_none()) {
352 Err(TestError::Inapplicable)?;
353 }
354
355 log::info!("{}: accepting incoming call", client.username);
356 active_call
357 .update(cx, |call, cx| call.accept_incoming(cx))
358 .await?;
359 }
360
361 ClientOperation::RejectIncomingCall => {
362 let active_call = cx.read(ActiveCall::global);
363 if active_call.read_with(cx, |call, _| call.incoming().borrow().is_none()) {
364 Err(TestError::Inapplicable)?;
365 }
366
367 log::info!("{}: declining incoming call", client.username);
368 active_call.update(cx, |call, _| call.decline_incoming())?;
369 }
370
371 ClientOperation::LeaveCall => {
372 let active_call = cx.read(ActiveCall::global);
373 if active_call.read_with(cx, |call, _| call.room().is_none()) {
374 Err(TestError::Inapplicable)?;
375 }
376
377 log::info!("{}: hanging up", client.username);
378 active_call.update(cx, |call, cx| call.hang_up(cx)).await?;
379 }
380
381 ClientOperation::InviteContactToCall { user_id } => {
382 let active_call = cx.read(ActiveCall::global);
383
384 log::info!("{}: inviting {}", client.username, user_id,);
385 active_call
386 .update(cx, |call, cx| call.invite(user_id.to_proto(), None, cx))
387 .await
388 .log_err();
389 }
390
391 ClientOperation::OpenLocalProject { first_root_name } => {
392 log::info!(
393 "{}: opening local project at {:?}",
394 client.username,
395 first_root_name
396 );
397
398 let root_path = Path::new("/").join(&first_root_name);
399 client.fs.create_dir(&root_path).await.unwrap();
400 client
401 .fs
402 .create_file(&root_path.join("main.rs"), Default::default())
403 .await
404 .unwrap();
405 let project = client.build_local_project(root_path, cx).await.0;
406 ensure_project_shared(&project, client, cx).await;
407 client.local_projects_mut().push(project.clone());
408 }
409
410 ClientOperation::AddWorktreeToProject {
411 project_root_name,
412 new_root_path,
413 } => {
414 let project = project_for_root_name(client, &project_root_name, cx)
415 .ok_or(TestError::Inapplicable)?;
416
417 log::info!(
418 "{}: finding/creating local worktree at {:?} to project with root path {}",
419 client.username,
420 new_root_path,
421 project_root_name
422 );
423
424 ensure_project_shared(&project, client, cx).await;
425 if !client.fs.paths(false).contains(&new_root_path) {
426 client.fs.create_dir(&new_root_path).await.unwrap();
427 }
428 project
429 .update(cx, |project, cx| {
430 project.find_or_create_local_worktree(&new_root_path, true, cx)
431 })
432 .await
433 .unwrap();
434 }
435
436 ClientOperation::CloseRemoteProject { project_root_name } => {
437 let project = project_for_root_name(client, &project_root_name, cx)
438 .ok_or(TestError::Inapplicable)?;
439
440 log::info!(
441 "{}: closing remote project with root path {}",
442 client.username,
443 project_root_name,
444 );
445
446 let ix = client
447 .remote_projects()
448 .iter()
449 .position(|p| p == &project)
450 .unwrap();
451 cx.update(|_| {
452 client.remote_projects_mut().remove(ix);
453 client.buffers().retain(|p, _| *p != project);
454 drop(project);
455 });
456 }
457
458 ClientOperation::OpenRemoteProject {
459 host_id,
460 first_root_name,
461 } => {
462 let active_call = cx.read(ActiveCall::global);
463 let project = active_call
464 .update(cx, |call, cx| {
465 let room = call.room().cloned()?;
466 let participant = room
467 .read(cx)
468 .remote_participants()
469 .get(&host_id.to_proto())?;
470 let project_id = participant
471 .projects
472 .iter()
473 .find(|project| project.worktree_root_names[0] == first_root_name)?
474 .id;
475 Some(room.update(cx, |room, cx| {
476 room.join_project(
477 project_id,
478 client.language_registry.clone(),
479 FakeFs::new(cx.background().clone()),
480 cx,
481 )
482 }))
483 })
484 .ok_or(TestError::Inapplicable)?;
485
486 log::info!(
487 "{}: joining remote project of user {}, root name {}",
488 client.username,
489 host_id,
490 first_root_name,
491 );
492
493 let project = project.await?;
494 client.remote_projects_mut().push(project.clone());
495 }
496
497 ClientOperation::CreateWorktreeEntry {
498 project_root_name,
499 is_local,
500 full_path,
501 is_dir,
502 } => {
503 let project = project_for_root_name(client, &project_root_name, cx)
504 .ok_or(TestError::Inapplicable)?;
505 let project_path = project_path_for_full_path(&project, &full_path, cx)
506 .ok_or(TestError::Inapplicable)?;
507
508 log::info!(
509 "{}: creating {} at path {:?} in {} project {}",
510 client.username,
511 if is_dir { "dir" } else { "file" },
512 full_path,
513 if is_local { "local" } else { "remote" },
514 project_root_name,
515 );
516
517 ensure_project_shared(&project, client, cx).await;
518 project
519 .update(cx, |p, cx| p.create_entry(project_path, is_dir, cx))
520 .unwrap()
521 .await?;
522 }
523
524 ClientOperation::OpenBuffer {
525 project_root_name,
526 is_local,
527 full_path,
528 } => {
529 let project = project_for_root_name(client, &project_root_name, cx)
530 .ok_or(TestError::Inapplicable)?;
531 let project_path = project_path_for_full_path(&project, &full_path, cx)
532 .ok_or(TestError::Inapplicable)?;
533
534 log::info!(
535 "{}: opening buffer {:?} in {} project {}",
536 client.username,
537 full_path,
538 if is_local { "local" } else { "remote" },
539 project_root_name,
540 );
541
542 ensure_project_shared(&project, client, cx).await;
543 let buffer = project
544 .update(cx, |project, cx| project.open_buffer(project_path, cx))
545 .await?;
546 client.buffers_for_project(&project).insert(buffer);
547 }
548
549 ClientOperation::EditBuffer {
550 project_root_name,
551 is_local,
552 full_path,
553 edits,
554 } => {
555 let project = project_for_root_name(client, &project_root_name, cx)
556 .ok_or(TestError::Inapplicable)?;
557 let buffer = buffer_for_full_path(client, &project, &full_path, cx)
558 .ok_or(TestError::Inapplicable)?;
559
560 log::info!(
561 "{}: editing buffer {:?} in {} project {} with {:?}",
562 client.username,
563 full_path,
564 if is_local { "local" } else { "remote" },
565 project_root_name,
566 edits
567 );
568
569 ensure_project_shared(&project, client, cx).await;
570 buffer.update(cx, |buffer, cx| {
571 let snapshot = buffer.snapshot();
572 buffer.edit(
573 edits.into_iter().map(|(range, text)| {
574 let start = snapshot.clip_offset(range.start, Bias::Left);
575 let end = snapshot.clip_offset(range.end, Bias::Right);
576 (start..end, text)
577 }),
578 None,
579 cx,
580 );
581 });
582 }
583
584 ClientOperation::CloseBuffer {
585 project_root_name,
586 is_local,
587 full_path,
588 } => {
589 let project = project_for_root_name(client, &project_root_name, cx)
590 .ok_or(TestError::Inapplicable)?;
591 let buffer = buffer_for_full_path(client, &project, &full_path, cx)
592 .ok_or(TestError::Inapplicable)?;
593
594 log::info!(
595 "{}: closing buffer {:?} in {} project {}",
596 client.username,
597 full_path,
598 if is_local { "local" } else { "remote" },
599 project_root_name
600 );
601
602 ensure_project_shared(&project, client, cx).await;
603 cx.update(|_| {
604 client.buffers_for_project(&project).remove(&buffer);
605 drop(buffer);
606 });
607 }
608
609 ClientOperation::SaveBuffer {
610 project_root_name,
611 is_local,
612 full_path,
613 detach,
614 } => {
615 let project = project_for_root_name(client, &project_root_name, cx)
616 .ok_or(TestError::Inapplicable)?;
617 let buffer = buffer_for_full_path(client, &project, &full_path, cx)
618 .ok_or(TestError::Inapplicable)?;
619
620 log::info!(
621 "{}: saving buffer {:?} in {} project {}, {}",
622 client.username,
623 full_path,
624 if is_local { "local" } else { "remote" },
625 project_root_name,
626 if detach { "detaching" } else { "awaiting" }
627 );
628
629 ensure_project_shared(&project, client, cx).await;
630 let requested_version = buffer.read_with(cx, |buffer, _| buffer.version());
631 let save = project.update(cx, |project, cx| project.save_buffer(buffer, cx));
632 let save = cx.background().spawn(async move {
633 let (saved_version, _, _) = save
634 .await
635 .map_err(|err| anyhow!("save request failed: {:?}", err))?;
636 assert!(saved_version.observed_all(&requested_version));
637 anyhow::Ok(())
638 });
639 if detach {
640 cx.update(|cx| save.detach_and_log_err(cx));
641 } else {
642 save.await?;
643 }
644 }
645
646 ClientOperation::RequestLspDataInBuffer {
647 project_root_name,
648 is_local,
649 full_path,
650 offset,
651 kind,
652 detach,
653 } => {
654 let project = project_for_root_name(client, &project_root_name, cx)
655 .ok_or(TestError::Inapplicable)?;
656 let buffer = buffer_for_full_path(client, &project, &full_path, cx)
657 .ok_or(TestError::Inapplicable)?;
658
659 log::info!(
660 "{}: request LSP {:?} for buffer {:?} in {} project {}, {}",
661 client.username,
662 kind,
663 full_path,
664 if is_local { "local" } else { "remote" },
665 project_root_name,
666 if detach { "detaching" } else { "awaiting" }
667 );
668
669 use futures::{FutureExt as _, TryFutureExt as _};
670 let offset = buffer.read_with(cx, |b, _| b.clip_offset(offset, Bias::Left));
671 let request = cx.foreground().spawn(project.update(cx, |project, cx| {
672 match kind {
673 LspRequestKind::Rename => project
674 .prepare_rename(buffer, offset, cx)
675 .map_ok(|_| ())
676 .boxed(),
677 LspRequestKind::Completion => project
678 .completions(&buffer, offset, cx)
679 .map_ok(|_| ())
680 .boxed(),
681 LspRequestKind::CodeAction => project
682 .code_actions(&buffer, offset..offset, cx)
683 .map_ok(|_| ())
684 .boxed(),
685 LspRequestKind::Definition => project
686 .definition(&buffer, offset, cx)
687 .map_ok(|_| ())
688 .boxed(),
689 LspRequestKind::Highlights => project
690 .document_highlights(&buffer, offset, cx)
691 .map_ok(|_| ())
692 .boxed(),
693 }
694 }));
695 if detach {
696 request.detach();
697 } else {
698 request.await?;
699 }
700 }
701
702 ClientOperation::SearchProject {
703 project_root_name,
704 is_local,
705 query,
706 detach,
707 } => {
708 let project = project_for_root_name(client, &project_root_name, cx)
709 .ok_or(TestError::Inapplicable)?;
710
711 log::info!(
712 "{}: search {} project {} for {:?}, {}",
713 client.username,
714 if is_local { "local" } else { "remote" },
715 project_root_name,
716 query,
717 if detach { "detaching" } else { "awaiting" }
718 );
719
720 let search = project.update(cx, |project, cx| {
721 project.search(
722 SearchQuery::text(query, false, false, Vec::new(), Vec::new()),
723 cx,
724 )
725 });
726 drop(project);
727 let search = cx.background().spawn(async move {
728 search
729 .await
730 .map_err(|err| anyhow!("search request failed: {:?}", err))
731 });
732 if detach {
733 cx.update(|cx| search.detach_and_log_err(cx));
734 } else {
735 search.await?;
736 }
737 }
738
739 ClientOperation::WriteFsEntry {
740 path,
741 is_dir,
742 content,
743 } => {
744 if !client
745 .fs
746 .directories(false)
747 .contains(&path.parent().unwrap().to_owned())
748 {
749 return Err(TestError::Inapplicable);
750 }
751
752 if is_dir {
753 log::info!("{}: creating dir at {:?}", client.username, path);
754 client.fs.create_dir(&path).await.unwrap();
755 } else {
756 let exists = client.fs.metadata(&path).await?.is_some();
757 let verb = if exists { "updating" } else { "creating" };
758 log::info!("{}: {} file at {:?}", verb, client.username, path);
759
760 client
761 .fs
762 .save(&path, &content.as_str().into(), fs::LineEnding::Unix)
763 .await
764 .unwrap();
765 }
766 }
767
768 ClientOperation::GitOperation { operation } => match operation {
769 GitOperation::WriteGitIndex {
770 repo_path,
771 contents,
772 } => {
773 if !client.fs.directories(false).contains(&repo_path) {
774 return Err(TestError::Inapplicable);
775 }
776
777 for (path, _) in contents.iter() {
778 if !client.fs.files().contains(&repo_path.join(path)) {
779 return Err(TestError::Inapplicable);
780 }
781 }
782
783 log::info!(
784 "{}: writing git index for repo {:?}: {:?}",
785 client.username,
786 repo_path,
787 contents
788 );
789
790 let dot_git_dir = repo_path.join(".git");
791 let contents = contents
792 .iter()
793 .map(|(path, contents)| (path.as_path(), contents.clone()))
794 .collect::<Vec<_>>();
795 if client.fs.metadata(&dot_git_dir).await?.is_none() {
796 client.fs.create_dir(&dot_git_dir).await?;
797 }
798 client.fs.set_index_for_repo(&dot_git_dir, &contents);
799 }
800 GitOperation::WriteGitBranch {
801 repo_path,
802 new_branch,
803 } => {
804 if !client.fs.directories(false).contains(&repo_path) {
805 return Err(TestError::Inapplicable);
806 }
807
808 log::info!(
809 "{}: writing git branch for repo {:?}: {:?}",
810 client.username,
811 repo_path,
812 new_branch
813 );
814
815 let dot_git_dir = repo_path.join(".git");
816 if client.fs.metadata(&dot_git_dir).await?.is_none() {
817 client.fs.create_dir(&dot_git_dir).await?;
818 }
819 client.fs.set_branch_name(&dot_git_dir, new_branch);
820 }
821 GitOperation::WriteGitStatuses {
822 repo_path,
823 statuses,
824 git_operation,
825 } => {
826 if !client.fs.directories(false).contains(&repo_path) {
827 return Err(TestError::Inapplicable);
828 }
829 for (path, _) in statuses.iter() {
830 if !client.fs.files().contains(&repo_path.join(path)) {
831 return Err(TestError::Inapplicable);
832 }
833 }
834
835 log::info!(
836 "{}: writing git statuses for repo {:?}: {:?}",
837 client.username,
838 repo_path,
839 statuses
840 );
841
842 let dot_git_dir = repo_path.join(".git");
843
844 let statuses = statuses
845 .iter()
846 .map(|(path, val)| (path.as_path(), val.clone()))
847 .collect::<Vec<_>>();
848
849 if client.fs.metadata(&dot_git_dir).await?.is_none() {
850 client.fs.create_dir(&dot_git_dir).await?;
851 }
852
853 if git_operation {
854 client
855 .fs
856 .set_status_for_repo_via_git_operation(&dot_git_dir, statuses.as_slice());
857 } else {
858 client.fs.set_status_for_repo_via_working_copy_change(
859 &dot_git_dir,
860 statuses.as_slice(),
861 );
862 }
863 }
864 },
865 }
866 Ok(())
867}
868
869fn check_consistency_between_clients(clients: &[(Rc<TestClient>, TestAppContext)]) {
870 for (client, client_cx) in clients {
871 for guest_project in client.remote_projects().iter() {
872 guest_project.read_with(client_cx, |guest_project, cx| {
873 let host_project = clients.iter().find_map(|(client, cx)| {
874 let project = client
875 .local_projects()
876 .iter()
877 .find(|host_project| {
878 host_project.read_with(cx, |host_project, _| {
879 host_project.remote_id() == guest_project.remote_id()
880 })
881 })?
882 .clone();
883 Some((project, cx))
884 });
885
886 if !guest_project.is_read_only() {
887 if let Some((host_project, host_cx)) = host_project {
888 let host_worktree_snapshots =
889 host_project.read_with(host_cx, |host_project, cx| {
890 host_project
891 .worktrees(cx)
892 .map(|worktree| {
893 let worktree = worktree.read(cx);
894 (worktree.id(), worktree.snapshot())
895 })
896 .collect::<BTreeMap<_, _>>()
897 });
898 let guest_worktree_snapshots = guest_project
899 .worktrees(cx)
900 .map(|worktree| {
901 let worktree = worktree.read(cx);
902 (worktree.id(), worktree.snapshot())
903 })
904 .collect::<BTreeMap<_, _>>();
905
906 assert_eq!(
907 guest_worktree_snapshots.values().map(|w| w.abs_path()).collect::<Vec<_>>(),
908 host_worktree_snapshots.values().map(|w| w.abs_path()).collect::<Vec<_>>(),
909 "{} has different worktrees than the host for project {:?}",
910 client.username, guest_project.remote_id(),
911 );
912
913 for (id, host_snapshot) in &host_worktree_snapshots {
914 let guest_snapshot = &guest_worktree_snapshots[id];
915 assert_eq!(
916 guest_snapshot.root_name(),
917 host_snapshot.root_name(),
918 "{} has different root name than the host for worktree {}, project {:?}",
919 client.username,
920 id,
921 guest_project.remote_id(),
922 );
923 assert_eq!(
924 guest_snapshot.abs_path(),
925 host_snapshot.abs_path(),
926 "{} has different abs path than the host for worktree {}, project: {:?}",
927 client.username,
928 id,
929 guest_project.remote_id(),
930 );
931 assert_eq!(
932 guest_snapshot.entries(false).collect::<Vec<_>>(),
933 host_snapshot.entries(false).collect::<Vec<_>>(),
934 "{} has different snapshot than the host for worktree {:?} ({:?}) and project {:?}",
935 client.username,
936 host_snapshot.abs_path(),
937 id,
938 guest_project.remote_id(),
939 );
940 assert_eq!(guest_snapshot.repositories().collect::<Vec<_>>(), host_snapshot.repositories().collect::<Vec<_>>(),
941 "{} has different repositories than the host for worktree {:?} and project {:?}",
942 client.username,
943 host_snapshot.abs_path(),
944 guest_project.remote_id(),
945 );
946 assert_eq!(guest_snapshot.scan_id(), host_snapshot.scan_id(),
947 "{} has different scan id than the host for worktree {:?} and project {:?}",
948 client.username,
949 host_snapshot.abs_path(),
950 guest_project.remote_id(),
951 );
952 }
953 }
954 }
955
956 for buffer in guest_project.opened_buffers(cx) {
957 let buffer = buffer.read(cx);
958 assert_eq!(
959 buffer.deferred_ops_len(),
960 0,
961 "{} has deferred operations for buffer {:?} in project {:?}",
962 client.username,
963 buffer.file().unwrap().full_path(cx),
964 guest_project.remote_id(),
965 );
966 }
967 });
968 }
969
970 let buffers = client.buffers().clone();
971 for (guest_project, guest_buffers) in &buffers {
972 let project_id = if guest_project.read_with(client_cx, |project, _| {
973 project.is_local() || project.is_read_only()
974 }) {
975 continue;
976 } else {
977 guest_project
978 .read_with(client_cx, |project, _| project.remote_id())
979 .unwrap()
980 };
981 let guest_user_id = client.user_id().unwrap();
982
983 let host_project = clients.iter().find_map(|(client, cx)| {
984 let project = client
985 .local_projects()
986 .iter()
987 .find(|host_project| {
988 host_project.read_with(cx, |host_project, _| {
989 host_project.remote_id() == Some(project_id)
990 })
991 })?
992 .clone();
993 Some((client.user_id().unwrap(), project, cx))
994 });
995
996 let (host_user_id, host_project, host_cx) =
997 if let Some((host_user_id, host_project, host_cx)) = host_project {
998 (host_user_id, host_project, host_cx)
999 } else {
1000 continue;
1001 };
1002
1003 for guest_buffer in guest_buffers {
1004 let buffer_id = guest_buffer.read_with(client_cx, |buffer, _| buffer.remote_id());
1005 let host_buffer = host_project.read_with(host_cx, |project, cx| {
1006 project.buffer_for_id(buffer_id, cx).unwrap_or_else(|| {
1007 panic!(
1008 "host does not have buffer for guest:{}, peer:{:?}, id:{}",
1009 client.username,
1010 client.peer_id(),
1011 buffer_id
1012 )
1013 })
1014 });
1015 let path = host_buffer
1016 .read_with(host_cx, |buffer, cx| buffer.file().unwrap().full_path(cx));
1017
1018 assert_eq!(
1019 guest_buffer.read_with(client_cx, |buffer, _| buffer.deferred_ops_len()),
1020 0,
1021 "{}, buffer {}, path {:?} has deferred operations",
1022 client.username,
1023 buffer_id,
1024 path,
1025 );
1026 assert_eq!(
1027 guest_buffer.read_with(client_cx, |buffer, _| buffer.text()),
1028 host_buffer.read_with(host_cx, |buffer, _| buffer.text()),
1029 "{}, buffer {}, path {:?}, differs from the host's buffer",
1030 client.username,
1031 buffer_id,
1032 path
1033 );
1034
1035 let host_file = host_buffer.read_with(host_cx, |b, _| b.file().cloned());
1036 let guest_file = guest_buffer.read_with(client_cx, |b, _| b.file().cloned());
1037 match (host_file, guest_file) {
1038 (Some(host_file), Some(guest_file)) => {
1039 assert_eq!(guest_file.path(), host_file.path());
1040 assert_eq!(guest_file.is_deleted(), host_file.is_deleted());
1041 assert_eq!(
1042 guest_file.mtime(),
1043 host_file.mtime(),
1044 "guest {} mtime does not match host {} for path {:?} in project {}",
1045 guest_user_id,
1046 host_user_id,
1047 guest_file.path(),
1048 project_id,
1049 );
1050 }
1051 (None, None) => {}
1052 (None, _) => panic!("host's file is None, guest's isn't"),
1053 (_, None) => panic!("guest's file is None, hosts's isn't"),
1054 }
1055
1056 let host_diff_base =
1057 host_buffer.read_with(host_cx, |b, _| b.diff_base().map(ToString::to_string));
1058 let guest_diff_base = guest_buffer
1059 .read_with(client_cx, |b, _| b.diff_base().map(ToString::to_string));
1060 assert_eq!(
1061 guest_diff_base, host_diff_base,
1062 "guest {} diff base does not match host's for path {path:?} in project {project_id}",
1063 client.username
1064 );
1065
1066 let host_saved_version =
1067 host_buffer.read_with(host_cx, |b, _| b.saved_version().clone());
1068 let guest_saved_version =
1069 guest_buffer.read_with(client_cx, |b, _| b.saved_version().clone());
1070 assert_eq!(
1071 guest_saved_version, host_saved_version,
1072 "guest {} saved version does not match host's for path {path:?} in project {project_id}",
1073 client.username
1074 );
1075
1076 let host_saved_version_fingerprint =
1077 host_buffer.read_with(host_cx, |b, _| b.saved_version_fingerprint());
1078 let guest_saved_version_fingerprint =
1079 guest_buffer.read_with(client_cx, |b, _| b.saved_version_fingerprint());
1080 assert_eq!(
1081 guest_saved_version_fingerprint, host_saved_version_fingerprint,
1082 "guest {} saved fingerprint does not match host's for path {path:?} in project {project_id}",
1083 client.username
1084 );
1085
1086 let host_saved_mtime = host_buffer.read_with(host_cx, |b, _| b.saved_mtime());
1087 let guest_saved_mtime = guest_buffer.read_with(client_cx, |b, _| b.saved_mtime());
1088 assert_eq!(
1089 guest_saved_mtime, host_saved_mtime,
1090 "guest {} saved mtime does not match host's for path {path:?} in project {project_id}",
1091 client.username
1092 );
1093
1094 let host_is_dirty = host_buffer.read_with(host_cx, |b, _| b.is_dirty());
1095 let guest_is_dirty = guest_buffer.read_with(client_cx, |b, _| b.is_dirty());
1096 assert_eq!(guest_is_dirty, host_is_dirty,
1097 "guest {} dirty status does not match host's for path {path:?} in project {project_id}",
1098 client.username
1099 );
1100
1101 let host_has_conflict = host_buffer.read_with(host_cx, |b, _| b.has_conflict());
1102 let guest_has_conflict = guest_buffer.read_with(client_cx, |b, _| b.has_conflict());
1103 assert_eq!(guest_has_conflict, host_has_conflict,
1104 "guest {} conflict status does not match host's for path {path:?} in project {project_id}",
1105 client.username
1106 );
1107 }
1108 }
1109 }
1110}
1111
1112struct TestPlan {
1113 rng: StdRng,
1114 replay: bool,
1115 stored_operations: Vec<(StoredOperation, Arc<AtomicBool>)>,
1116 max_operations: usize,
1117 operation_ix: usize,
1118 users: Vec<UserTestPlan>,
1119 next_batch_id: usize,
1120 allow_server_restarts: bool,
1121 allow_client_reconnection: bool,
1122 allow_client_disconnection: bool,
1123}
1124
1125struct UserTestPlan {
1126 user_id: UserId,
1127 username: String,
1128 next_root_id: usize,
1129 operation_ix: usize,
1130 online: bool,
1131}
1132
1133#[derive(Clone, Debug, Serialize, Deserialize)]
1134#[serde(untagged)]
1135enum StoredOperation {
1136 Server(Operation),
1137 Client {
1138 user_id: UserId,
1139 batch_id: usize,
1140 operation: ClientOperation,
1141 },
1142}
1143
1144#[derive(Clone, Debug, Serialize, Deserialize)]
1145enum Operation {
1146 AddConnection {
1147 user_id: UserId,
1148 },
1149 RemoveConnection {
1150 user_id: UserId,
1151 },
1152 BounceConnection {
1153 user_id: UserId,
1154 },
1155 RestartServer,
1156 MutateClients {
1157 batch_id: usize,
1158 #[serde(skip_serializing)]
1159 #[serde(skip_deserializing)]
1160 user_ids: Vec<UserId>,
1161 quiesce: bool,
1162 },
1163}
1164
1165#[derive(Clone, Debug, Serialize, Deserialize)]
1166enum ClientOperation {
1167 AcceptIncomingCall,
1168 RejectIncomingCall,
1169 LeaveCall,
1170 InviteContactToCall {
1171 user_id: UserId,
1172 },
1173 OpenLocalProject {
1174 first_root_name: String,
1175 },
1176 OpenRemoteProject {
1177 host_id: UserId,
1178 first_root_name: String,
1179 },
1180 AddWorktreeToProject {
1181 project_root_name: String,
1182 new_root_path: PathBuf,
1183 },
1184 CloseRemoteProject {
1185 project_root_name: String,
1186 },
1187 OpenBuffer {
1188 project_root_name: String,
1189 is_local: bool,
1190 full_path: PathBuf,
1191 },
1192 SearchProject {
1193 project_root_name: String,
1194 is_local: bool,
1195 query: String,
1196 detach: bool,
1197 },
1198 EditBuffer {
1199 project_root_name: String,
1200 is_local: bool,
1201 full_path: PathBuf,
1202 edits: Vec<(Range<usize>, Arc<str>)>,
1203 },
1204 CloseBuffer {
1205 project_root_name: String,
1206 is_local: bool,
1207 full_path: PathBuf,
1208 },
1209 SaveBuffer {
1210 project_root_name: String,
1211 is_local: bool,
1212 full_path: PathBuf,
1213 detach: bool,
1214 },
1215 RequestLspDataInBuffer {
1216 project_root_name: String,
1217 is_local: bool,
1218 full_path: PathBuf,
1219 offset: usize,
1220 kind: LspRequestKind,
1221 detach: bool,
1222 },
1223 CreateWorktreeEntry {
1224 project_root_name: String,
1225 is_local: bool,
1226 full_path: PathBuf,
1227 is_dir: bool,
1228 },
1229 WriteFsEntry {
1230 path: PathBuf,
1231 is_dir: bool,
1232 content: String,
1233 },
1234 GitOperation {
1235 operation: GitOperation,
1236 },
1237}
1238
1239#[derive(Clone, Debug, Serialize, Deserialize)]
1240enum GitOperation {
1241 WriteGitIndex {
1242 repo_path: PathBuf,
1243 contents: Vec<(PathBuf, String)>,
1244 },
1245 WriteGitBranch {
1246 repo_path: PathBuf,
1247 new_branch: Option<String>,
1248 },
1249 WriteGitStatuses {
1250 repo_path: PathBuf,
1251 statuses: Vec<(PathBuf, GitFileStatus)>,
1252 git_operation: bool,
1253 },
1254}
1255
1256#[derive(Clone, Debug, Serialize, Deserialize)]
1257enum LspRequestKind {
1258 Rename,
1259 Completion,
1260 CodeAction,
1261 Definition,
1262 Highlights,
1263}
1264
1265enum TestError {
1266 Inapplicable,
1267 Other(anyhow::Error),
1268}
1269
1270impl From<anyhow::Error> for TestError {
1271 fn from(value: anyhow::Error) -> Self {
1272 Self::Other(value)
1273 }
1274}
1275
1276impl TestPlan {
1277 fn new(mut rng: StdRng, users: Vec<UserTestPlan>, max_operations: usize) -> Self {
1278 Self {
1279 replay: false,
1280 allow_server_restarts: rng.gen_bool(0.7),
1281 allow_client_reconnection: rng.gen_bool(0.7),
1282 allow_client_disconnection: rng.gen_bool(0.1),
1283 stored_operations: Vec::new(),
1284 operation_ix: 0,
1285 next_batch_id: 0,
1286 max_operations,
1287 users,
1288 rng,
1289 }
1290 }
1291
1292 fn deserialize(&mut self, json: Vec<u8>) {
1293 let stored_operations: Vec<StoredOperation> = serde_json::from_slice(&json).unwrap();
1294 self.replay = true;
1295 self.stored_operations = stored_operations
1296 .iter()
1297 .cloned()
1298 .enumerate()
1299 .map(|(i, mut operation)| {
1300 if let StoredOperation::Server(Operation::MutateClients {
1301 batch_id: current_batch_id,
1302 user_ids,
1303 ..
1304 }) = &mut operation
1305 {
1306 assert!(user_ids.is_empty());
1307 user_ids.extend(stored_operations[i + 1..].iter().filter_map(|operation| {
1308 if let StoredOperation::Client {
1309 user_id, batch_id, ..
1310 } = operation
1311 {
1312 if batch_id == current_batch_id {
1313 return Some(user_id);
1314 }
1315 }
1316 None
1317 }));
1318 user_ids.sort_unstable();
1319 }
1320 (operation, Arc::new(AtomicBool::new(false)))
1321 })
1322 .collect()
1323 }
1324
1325 fn serialize(&mut self) -> Vec<u8> {
1326 // Format each operation as one line
1327 let mut json = Vec::new();
1328 json.push(b'[');
1329 for (operation, applied) in &self.stored_operations {
1330 if !applied.load(SeqCst) {
1331 continue;
1332 }
1333 if json.len() > 1 {
1334 json.push(b',');
1335 }
1336 json.extend_from_slice(b"\n ");
1337 serde_json::to_writer(&mut json, operation).unwrap();
1338 }
1339 json.extend_from_slice(b"\n]\n");
1340 json
1341 }
1342
1343 fn next_server_operation(
1344 &mut self,
1345 clients: &[(Rc<TestClient>, TestAppContext)],
1346 ) -> Option<(Operation, Arc<AtomicBool>)> {
1347 if self.replay {
1348 while let Some(stored_operation) = self.stored_operations.get(self.operation_ix) {
1349 self.operation_ix += 1;
1350 if let (StoredOperation::Server(operation), applied) = stored_operation {
1351 return Some((operation.clone(), applied.clone()));
1352 }
1353 }
1354 None
1355 } else {
1356 let operation = self.generate_server_operation(clients)?;
1357 let applied = Arc::new(AtomicBool::new(false));
1358 self.stored_operations
1359 .push((StoredOperation::Server(operation.clone()), applied.clone()));
1360 Some((operation, applied))
1361 }
1362 }
1363
1364 fn next_client_operation(
1365 &mut self,
1366 client: &TestClient,
1367 current_batch_id: usize,
1368 cx: &TestAppContext,
1369 ) -> Option<(ClientOperation, Arc<AtomicBool>)> {
1370 let current_user_id = client.current_user_id(cx);
1371 let user_ix = self
1372 .users
1373 .iter()
1374 .position(|user| user.user_id == current_user_id)
1375 .unwrap();
1376 let user_plan = &mut self.users[user_ix];
1377
1378 if self.replay {
1379 while let Some(stored_operation) = self.stored_operations.get(user_plan.operation_ix) {
1380 user_plan.operation_ix += 1;
1381 if let (
1382 StoredOperation::Client {
1383 user_id, operation, ..
1384 },
1385 applied,
1386 ) = stored_operation
1387 {
1388 if user_id == ¤t_user_id {
1389 return Some((operation.clone(), applied.clone()));
1390 }
1391 }
1392 }
1393 None
1394 } else {
1395 let operation = self.generate_client_operation(current_user_id, client, cx)?;
1396 let applied = Arc::new(AtomicBool::new(false));
1397 self.stored_operations.push((
1398 StoredOperation::Client {
1399 user_id: current_user_id,
1400 batch_id: current_batch_id,
1401 operation: operation.clone(),
1402 },
1403 applied.clone(),
1404 ));
1405 Some((operation, applied))
1406 }
1407 }
1408
1409 fn generate_server_operation(
1410 &mut self,
1411 clients: &[(Rc<TestClient>, TestAppContext)],
1412 ) -> Option<Operation> {
1413 if self.operation_ix == self.max_operations {
1414 return None;
1415 }
1416
1417 Some(loop {
1418 break match self.rng.gen_range(0..100) {
1419 0..=29 if clients.len() < self.users.len() => {
1420 let user = self
1421 .users
1422 .iter()
1423 .filter(|u| !u.online)
1424 .choose(&mut self.rng)
1425 .unwrap();
1426 self.operation_ix += 1;
1427 Operation::AddConnection {
1428 user_id: user.user_id,
1429 }
1430 }
1431 30..=34 if clients.len() > 1 && self.allow_client_disconnection => {
1432 let (client, cx) = &clients[self.rng.gen_range(0..clients.len())];
1433 let user_id = client.current_user_id(cx);
1434 self.operation_ix += 1;
1435 Operation::RemoveConnection { user_id }
1436 }
1437 35..=39 if clients.len() > 1 && self.allow_client_reconnection => {
1438 let (client, cx) = &clients[self.rng.gen_range(0..clients.len())];
1439 let user_id = client.current_user_id(cx);
1440 self.operation_ix += 1;
1441 Operation::BounceConnection { user_id }
1442 }
1443 40..=44 if self.allow_server_restarts && clients.len() > 1 => {
1444 self.operation_ix += 1;
1445 Operation::RestartServer
1446 }
1447 _ if !clients.is_empty() => {
1448 let count = self
1449 .rng
1450 .gen_range(1..10)
1451 .min(self.max_operations - self.operation_ix);
1452 let batch_id = util::post_inc(&mut self.next_batch_id);
1453 let mut user_ids = (0..count)
1454 .map(|_| {
1455 let ix = self.rng.gen_range(0..clients.len());
1456 let (client, cx) = &clients[ix];
1457 client.current_user_id(cx)
1458 })
1459 .collect::<Vec<_>>();
1460 user_ids.sort_unstable();
1461 Operation::MutateClients {
1462 user_ids,
1463 batch_id,
1464 quiesce: self.rng.gen_bool(0.7),
1465 }
1466 }
1467 _ => continue,
1468 };
1469 })
1470 }
1471
1472 fn generate_client_operation(
1473 &mut self,
1474 user_id: UserId,
1475 client: &TestClient,
1476 cx: &TestAppContext,
1477 ) -> Option<ClientOperation> {
1478 if self.operation_ix == self.max_operations {
1479 return None;
1480 }
1481
1482 self.operation_ix += 1;
1483 let call = cx.read(ActiveCall::global);
1484 Some(loop {
1485 match self.rng.gen_range(0..100_u32) {
1486 // Mutate the call
1487 0..=29 => {
1488 // Respond to an incoming call
1489 if call.read_with(cx, |call, _| call.incoming().borrow().is_some()) {
1490 break if self.rng.gen_bool(0.7) {
1491 ClientOperation::AcceptIncomingCall
1492 } else {
1493 ClientOperation::RejectIncomingCall
1494 };
1495 }
1496
1497 match self.rng.gen_range(0..100_u32) {
1498 // Invite a contact to the current call
1499 0..=70 => {
1500 let available_contacts =
1501 client.user_store.read_with(cx, |user_store, _| {
1502 user_store
1503 .contacts()
1504 .iter()
1505 .filter(|contact| contact.online && !contact.busy)
1506 .cloned()
1507 .collect::<Vec<_>>()
1508 });
1509 if !available_contacts.is_empty() {
1510 let contact = available_contacts.choose(&mut self.rng).unwrap();
1511 break ClientOperation::InviteContactToCall {
1512 user_id: UserId(contact.user.id as i32),
1513 };
1514 }
1515 }
1516
1517 // Leave the current call
1518 71.. => {
1519 if self.allow_client_disconnection
1520 && call.read_with(cx, |call, _| call.room().is_some())
1521 {
1522 break ClientOperation::LeaveCall;
1523 }
1524 }
1525 }
1526 }
1527
1528 // Mutate projects
1529 30..=59 => match self.rng.gen_range(0..100_u32) {
1530 // Open a new project
1531 0..=70 => {
1532 // Open a remote project
1533 if let Some(room) = call.read_with(cx, |call, _| call.room().cloned()) {
1534 let existing_remote_project_ids = cx.read(|cx| {
1535 client
1536 .remote_projects()
1537 .iter()
1538 .map(|p| p.read(cx).remote_id().unwrap())
1539 .collect::<Vec<_>>()
1540 });
1541 let new_remote_projects = room.read_with(cx, |room, _| {
1542 room.remote_participants()
1543 .values()
1544 .flat_map(|participant| {
1545 participant.projects.iter().filter_map(|project| {
1546 if existing_remote_project_ids.contains(&project.id) {
1547 None
1548 } else {
1549 Some((
1550 UserId::from_proto(participant.user.id),
1551 project.worktree_root_names[0].clone(),
1552 ))
1553 }
1554 })
1555 })
1556 .collect::<Vec<_>>()
1557 });
1558 if !new_remote_projects.is_empty() {
1559 let (host_id, first_root_name) =
1560 new_remote_projects.choose(&mut self.rng).unwrap().clone();
1561 break ClientOperation::OpenRemoteProject {
1562 host_id,
1563 first_root_name,
1564 };
1565 }
1566 }
1567 // Open a local project
1568 else {
1569 let first_root_name = self.next_root_dir_name(user_id);
1570 break ClientOperation::OpenLocalProject { first_root_name };
1571 }
1572 }
1573
1574 // Close a remote project
1575 71..=80 => {
1576 if !client.remote_projects().is_empty() {
1577 let project = client
1578 .remote_projects()
1579 .choose(&mut self.rng)
1580 .unwrap()
1581 .clone();
1582 let first_root_name = root_name_for_project(&project, cx);
1583 break ClientOperation::CloseRemoteProject {
1584 project_root_name: first_root_name,
1585 };
1586 }
1587 }
1588
1589 // Mutate project worktrees
1590 81.. => match self.rng.gen_range(0..100_u32) {
1591 // Add a worktree to a local project
1592 0..=50 => {
1593 let Some(project) = client
1594 .local_projects()
1595 .choose(&mut self.rng)
1596 .cloned() else { continue };
1597 let project_root_name = root_name_for_project(&project, cx);
1598 let mut paths = client.fs.paths(false);
1599 paths.remove(0);
1600 let new_root_path = if paths.is_empty() || self.rng.gen() {
1601 Path::new("/").join(&self.next_root_dir_name(user_id))
1602 } else {
1603 paths.choose(&mut self.rng).unwrap().clone()
1604 };
1605 break ClientOperation::AddWorktreeToProject {
1606 project_root_name,
1607 new_root_path,
1608 };
1609 }
1610
1611 // Add an entry to a worktree
1612 _ => {
1613 let Some(project) = choose_random_project(client, &mut self.rng) else { continue };
1614 let project_root_name = root_name_for_project(&project, cx);
1615 let is_local = project.read_with(cx, |project, _| project.is_local());
1616 let worktree = project.read_with(cx, |project, cx| {
1617 project
1618 .worktrees(cx)
1619 .filter(|worktree| {
1620 let worktree = worktree.read(cx);
1621 worktree.is_visible()
1622 && worktree.entries(false).any(|e| e.is_file())
1623 && worktree.root_entry().map_or(false, |e| e.is_dir())
1624 })
1625 .choose(&mut self.rng)
1626 });
1627 let Some(worktree) = worktree else { continue };
1628 let is_dir = self.rng.gen::<bool>();
1629 let mut full_path =
1630 worktree.read_with(cx, |w, _| PathBuf::from(w.root_name()));
1631 full_path.push(gen_file_name(&mut self.rng));
1632 if !is_dir {
1633 full_path.set_extension("rs");
1634 }
1635 break ClientOperation::CreateWorktreeEntry {
1636 project_root_name,
1637 is_local,
1638 full_path,
1639 is_dir,
1640 };
1641 }
1642 },
1643 },
1644
1645 // Query and mutate buffers
1646 60..=90 => {
1647 let Some(project) = choose_random_project(client, &mut self.rng) else { continue };
1648 let project_root_name = root_name_for_project(&project, cx);
1649 let is_local = project.read_with(cx, |project, _| project.is_local());
1650
1651 match self.rng.gen_range(0..100_u32) {
1652 // Manipulate an existing buffer
1653 0..=70 => {
1654 let Some(buffer) = client
1655 .buffers_for_project(&project)
1656 .iter()
1657 .choose(&mut self.rng)
1658 .cloned() else { continue };
1659
1660 let full_path = buffer
1661 .read_with(cx, |buffer, cx| buffer.file().unwrap().full_path(cx));
1662
1663 match self.rng.gen_range(0..100_u32) {
1664 // Close the buffer
1665 0..=15 => {
1666 break ClientOperation::CloseBuffer {
1667 project_root_name,
1668 is_local,
1669 full_path,
1670 };
1671 }
1672 // Save the buffer
1673 16..=29 if buffer.read_with(cx, |b, _| b.is_dirty()) => {
1674 let detach = self.rng.gen_bool(0.3);
1675 break ClientOperation::SaveBuffer {
1676 project_root_name,
1677 is_local,
1678 full_path,
1679 detach,
1680 };
1681 }
1682 // Edit the buffer
1683 30..=69 => {
1684 let edits = buffer.read_with(cx, |buffer, _| {
1685 buffer.get_random_edits(&mut self.rng, 3)
1686 });
1687 break ClientOperation::EditBuffer {
1688 project_root_name,
1689 is_local,
1690 full_path,
1691 edits,
1692 };
1693 }
1694 // Make an LSP request
1695 _ => {
1696 let offset = buffer.read_with(cx, |buffer, _| {
1697 buffer.clip_offset(
1698 self.rng.gen_range(0..=buffer.len()),
1699 language::Bias::Left,
1700 )
1701 });
1702 let detach = self.rng.gen();
1703 break ClientOperation::RequestLspDataInBuffer {
1704 project_root_name,
1705 full_path,
1706 offset,
1707 is_local,
1708 kind: match self.rng.gen_range(0..5_u32) {
1709 0 => LspRequestKind::Rename,
1710 1 => LspRequestKind::Highlights,
1711 2 => LspRequestKind::Definition,
1712 3 => LspRequestKind::CodeAction,
1713 4.. => LspRequestKind::Completion,
1714 },
1715 detach,
1716 };
1717 }
1718 }
1719 }
1720
1721 71..=80 => {
1722 let query = self.rng.gen_range('a'..='z').to_string();
1723 let detach = self.rng.gen_bool(0.3);
1724 break ClientOperation::SearchProject {
1725 project_root_name,
1726 is_local,
1727 query,
1728 detach,
1729 };
1730 }
1731
1732 // Open a buffer
1733 81.. => {
1734 let worktree = project.read_with(cx, |project, cx| {
1735 project
1736 .worktrees(cx)
1737 .filter(|worktree| {
1738 let worktree = worktree.read(cx);
1739 worktree.is_visible()
1740 && worktree.entries(false).any(|e| e.is_file())
1741 })
1742 .choose(&mut self.rng)
1743 });
1744 let Some(worktree) = worktree else { continue };
1745 let full_path = worktree.read_with(cx, |worktree, _| {
1746 let entry = worktree
1747 .entries(false)
1748 .filter(|e| e.is_file())
1749 .choose(&mut self.rng)
1750 .unwrap();
1751 if entry.path.as_ref() == Path::new("") {
1752 Path::new(worktree.root_name()).into()
1753 } else {
1754 Path::new(worktree.root_name()).join(&entry.path)
1755 }
1756 });
1757 break ClientOperation::OpenBuffer {
1758 project_root_name,
1759 is_local,
1760 full_path,
1761 };
1762 }
1763 }
1764 }
1765
1766 // Update a git related action
1767 91..=95 => {
1768 break ClientOperation::GitOperation {
1769 operation: self.generate_git_operation(client),
1770 };
1771 }
1772
1773 // Create or update a file or directory
1774 96.. => {
1775 let is_dir = self.rng.gen::<bool>();
1776 let content;
1777 let mut path;
1778 let dir_paths = client.fs.directories(false);
1779
1780 if is_dir {
1781 content = String::new();
1782 path = dir_paths.choose(&mut self.rng).unwrap().clone();
1783 path.push(gen_file_name(&mut self.rng));
1784 } else {
1785 content = Alphanumeric.sample_string(&mut self.rng, 16);
1786
1787 // Create a new file or overwrite an existing file
1788 let file_paths = client.fs.files();
1789 if file_paths.is_empty() || self.rng.gen_bool(0.5) {
1790 path = dir_paths.choose(&mut self.rng).unwrap().clone();
1791 path.push(gen_file_name(&mut self.rng));
1792 path.set_extension("rs");
1793 } else {
1794 path = file_paths.choose(&mut self.rng).unwrap().clone()
1795 };
1796 }
1797 break ClientOperation::WriteFsEntry {
1798 path,
1799 is_dir,
1800 content,
1801 };
1802 }
1803 }
1804 })
1805 }
1806
1807 fn generate_git_operation(&mut self, client: &TestClient) -> GitOperation {
1808 fn generate_file_paths(
1809 repo_path: &Path,
1810 rng: &mut StdRng,
1811 client: &TestClient,
1812 ) -> Vec<PathBuf> {
1813 let mut paths = client
1814 .fs
1815 .files()
1816 .into_iter()
1817 .filter(|path| path.starts_with(repo_path))
1818 .collect::<Vec<_>>();
1819
1820 let count = rng.gen_range(0..=paths.len());
1821 paths.shuffle(rng);
1822 paths.truncate(count);
1823
1824 paths
1825 .iter()
1826 .map(|path| path.strip_prefix(repo_path).unwrap().to_path_buf())
1827 .collect::<Vec<_>>()
1828 }
1829
1830 let repo_path = client
1831 .fs
1832 .directories(false)
1833 .choose(&mut self.rng)
1834 .unwrap()
1835 .clone();
1836
1837 match self.rng.gen_range(0..100_u32) {
1838 0..=25 => {
1839 let file_paths = generate_file_paths(&repo_path, &mut self.rng, client);
1840
1841 let contents = file_paths
1842 .into_iter()
1843 .map(|path| (path, Alphanumeric.sample_string(&mut self.rng, 16)))
1844 .collect();
1845
1846 GitOperation::WriteGitIndex {
1847 repo_path,
1848 contents,
1849 }
1850 }
1851 26..=63 => {
1852 let new_branch = (self.rng.gen_range(0..10) > 3)
1853 .then(|| Alphanumeric.sample_string(&mut self.rng, 8));
1854
1855 GitOperation::WriteGitBranch {
1856 repo_path,
1857 new_branch,
1858 }
1859 }
1860 64..=100 => {
1861 let file_paths = generate_file_paths(&repo_path, &mut self.rng, client);
1862
1863 let statuses = file_paths
1864 .into_iter()
1865 .map(|paths| {
1866 (
1867 paths,
1868 match self.rng.gen_range(0..3_u32) {
1869 0 => GitFileStatus::Added,
1870 1 => GitFileStatus::Modified,
1871 2 => GitFileStatus::Conflict,
1872 _ => unreachable!(),
1873 },
1874 )
1875 })
1876 .collect::<Vec<_>>();
1877
1878 let git_operation = self.rng.gen::<bool>();
1879
1880 GitOperation::WriteGitStatuses {
1881 repo_path,
1882 statuses,
1883 git_operation,
1884 }
1885 }
1886 _ => unreachable!(),
1887 }
1888 }
1889
1890 fn next_root_dir_name(&mut self, user_id: UserId) -> String {
1891 let user_ix = self
1892 .users
1893 .iter()
1894 .position(|user| user.user_id == user_id)
1895 .unwrap();
1896 let root_id = util::post_inc(&mut self.users[user_ix].next_root_id);
1897 format!("dir-{user_id}-{root_id}")
1898 }
1899
1900 fn user(&mut self, user_id: UserId) -> &mut UserTestPlan {
1901 let ix = self
1902 .users
1903 .iter()
1904 .position(|user| user.user_id == user_id)
1905 .unwrap();
1906 &mut self.users[ix]
1907 }
1908}
1909
1910async fn simulate_client(
1911 client: Rc<TestClient>,
1912 mut operation_rx: futures::channel::mpsc::UnboundedReceiver<usize>,
1913 plan: Arc<Mutex<TestPlan>>,
1914 mut cx: TestAppContext,
1915) {
1916 // Setup language server
1917 let mut language = Language::new(
1918 LanguageConfig {
1919 name: "Rust".into(),
1920 path_suffixes: vec!["rs".to_string()],
1921 ..Default::default()
1922 },
1923 None,
1924 );
1925 let _fake_language_servers = language
1926 .set_fake_lsp_adapter(Arc::new(FakeLspAdapter {
1927 name: "the-fake-language-server",
1928 capabilities: lsp::LanguageServer::full_capabilities(),
1929 initializer: Some(Box::new({
1930 let fs = client.fs.clone();
1931 move |fake_server: &mut FakeLanguageServer| {
1932 fake_server.handle_request::<lsp::request::Completion, _, _>(
1933 |_, _| async move {
1934 Ok(Some(lsp::CompletionResponse::Array(vec![
1935 lsp::CompletionItem {
1936 text_edit: Some(lsp::CompletionTextEdit::Edit(lsp::TextEdit {
1937 range: lsp::Range::new(
1938 lsp::Position::new(0, 0),
1939 lsp::Position::new(0, 0),
1940 ),
1941 new_text: "the-new-text".to_string(),
1942 })),
1943 ..Default::default()
1944 },
1945 ])))
1946 },
1947 );
1948
1949 fake_server.handle_request::<lsp::request::CodeActionRequest, _, _>(
1950 |_, _| async move {
1951 Ok(Some(vec![lsp::CodeActionOrCommand::CodeAction(
1952 lsp::CodeAction {
1953 title: "the-code-action".to_string(),
1954 ..Default::default()
1955 },
1956 )]))
1957 },
1958 );
1959
1960 fake_server.handle_request::<lsp::request::PrepareRenameRequest, _, _>(
1961 |params, _| async move {
1962 Ok(Some(lsp::PrepareRenameResponse::Range(lsp::Range::new(
1963 params.position,
1964 params.position,
1965 ))))
1966 },
1967 );
1968
1969 fake_server.handle_request::<lsp::request::GotoDefinition, _, _>({
1970 let fs = fs.clone();
1971 move |_, cx| {
1972 let background = cx.background();
1973 let mut rng = background.rng();
1974 let count = rng.gen_range::<usize, _>(1..3);
1975 let files = fs.files();
1976 let files = (0..count)
1977 .map(|_| files.choose(&mut *rng).unwrap().clone())
1978 .collect::<Vec<_>>();
1979 async move {
1980 log::info!("LSP: Returning definitions in files {:?}", &files);
1981 Ok(Some(lsp::GotoDefinitionResponse::Array(
1982 files
1983 .into_iter()
1984 .map(|file| lsp::Location {
1985 uri: lsp::Url::from_file_path(file).unwrap(),
1986 range: Default::default(),
1987 })
1988 .collect(),
1989 )))
1990 }
1991 }
1992 });
1993
1994 fake_server.handle_request::<lsp::request::DocumentHighlightRequest, _, _>(
1995 move |_, cx| {
1996 let mut highlights = Vec::new();
1997 let background = cx.background();
1998 let mut rng = background.rng();
1999
2000 let highlight_count = rng.gen_range(1..=5);
2001 for _ in 0..highlight_count {
2002 let start_row = rng.gen_range(0..100);
2003 let start_column = rng.gen_range(0..100);
2004 let end_row = rng.gen_range(0..100);
2005 let end_column = rng.gen_range(0..100);
2006 let start = PointUtf16::new(start_row, start_column);
2007 let end = PointUtf16::new(end_row, end_column);
2008 let range = if start > end { end..start } else { start..end };
2009 highlights.push(lsp::DocumentHighlight {
2010 range: range_to_lsp(range.clone()),
2011 kind: Some(lsp::DocumentHighlightKind::READ),
2012 });
2013 }
2014 highlights.sort_unstable_by_key(|highlight| {
2015 (highlight.range.start, highlight.range.end)
2016 });
2017 async move { Ok(Some(highlights)) }
2018 },
2019 );
2020 }
2021 })),
2022 ..Default::default()
2023 }))
2024 .await;
2025 client.language_registry.add(Arc::new(language));
2026
2027 while let Some(batch_id) = operation_rx.next().await {
2028 let Some((operation, applied)) = plan.lock().next_client_operation(&client, batch_id, &cx) else { break };
2029 applied.store(true, SeqCst);
2030 match apply_client_operation(&client, operation, &mut cx).await {
2031 Ok(()) => {}
2032 Err(TestError::Inapplicable) => {
2033 applied.store(false, SeqCst);
2034 log::info!("skipped operation");
2035 }
2036 Err(TestError::Other(error)) => {
2037 log::error!("{} error: {}", client.username, error);
2038 }
2039 }
2040 cx.background().simulate_random_delay().await;
2041 }
2042 log::info!("{}: done", client.username);
2043}
2044
2045fn buffer_for_full_path(
2046 client: &TestClient,
2047 project: &ModelHandle<Project>,
2048 full_path: &PathBuf,
2049 cx: &TestAppContext,
2050) -> Option<ModelHandle<language::Buffer>> {
2051 client
2052 .buffers_for_project(project)
2053 .iter()
2054 .find(|buffer| {
2055 buffer.read_with(cx, |buffer, cx| {
2056 buffer.file().unwrap().full_path(cx) == *full_path
2057 })
2058 })
2059 .cloned()
2060}
2061
2062fn project_for_root_name(
2063 client: &TestClient,
2064 root_name: &str,
2065 cx: &TestAppContext,
2066) -> Option<ModelHandle<Project>> {
2067 if let Some(ix) = project_ix_for_root_name(&*client.local_projects(), root_name, cx) {
2068 return Some(client.local_projects()[ix].clone());
2069 }
2070 if let Some(ix) = project_ix_for_root_name(&*client.remote_projects(), root_name, cx) {
2071 return Some(client.remote_projects()[ix].clone());
2072 }
2073 None
2074}
2075
2076fn project_ix_for_root_name(
2077 projects: &[ModelHandle<Project>],
2078 root_name: &str,
2079 cx: &TestAppContext,
2080) -> Option<usize> {
2081 projects.iter().position(|project| {
2082 project.read_with(cx, |project, cx| {
2083 let worktree = project.visible_worktrees(cx).next().unwrap();
2084 worktree.read(cx).root_name() == root_name
2085 })
2086 })
2087}
2088
2089fn root_name_for_project(project: &ModelHandle<Project>, cx: &TestAppContext) -> String {
2090 project.read_with(cx, |project, cx| {
2091 project
2092 .visible_worktrees(cx)
2093 .next()
2094 .unwrap()
2095 .read(cx)
2096 .root_name()
2097 .to_string()
2098 })
2099}
2100
2101fn project_path_for_full_path(
2102 project: &ModelHandle<Project>,
2103 full_path: &Path,
2104 cx: &TestAppContext,
2105) -> Option<ProjectPath> {
2106 let mut components = full_path.components();
2107 let root_name = components.next().unwrap().as_os_str().to_str().unwrap();
2108 let path = components.as_path().into();
2109 let worktree_id = project.read_with(cx, |project, cx| {
2110 project.worktrees(cx).find_map(|worktree| {
2111 let worktree = worktree.read(cx);
2112 if worktree.root_name() == root_name {
2113 Some(worktree.id())
2114 } else {
2115 None
2116 }
2117 })
2118 })?;
2119 Some(ProjectPath { worktree_id, path })
2120}
2121
2122async fn ensure_project_shared(
2123 project: &ModelHandle<Project>,
2124 client: &TestClient,
2125 cx: &mut TestAppContext,
2126) {
2127 let first_root_name = root_name_for_project(project, cx);
2128 let active_call = cx.read(ActiveCall::global);
2129 if active_call.read_with(cx, |call, _| call.room().is_some())
2130 && project.read_with(cx, |project, _| project.is_local() && !project.is_shared())
2131 {
2132 match active_call
2133 .update(cx, |call, cx| call.share_project(project.clone(), cx))
2134 .await
2135 {
2136 Ok(project_id) => {
2137 log::info!(
2138 "{}: shared project {} with id {}",
2139 client.username,
2140 first_root_name,
2141 project_id
2142 );
2143 }
2144 Err(error) => {
2145 log::error!(
2146 "{}: error sharing project {}: {:?}",
2147 client.username,
2148 first_root_name,
2149 error
2150 );
2151 }
2152 }
2153 }
2154}
2155
2156fn choose_random_project(client: &TestClient, rng: &mut StdRng) -> Option<ModelHandle<Project>> {
2157 client
2158 .local_projects()
2159 .iter()
2160 .chain(client.remote_projects().iter())
2161 .choose(rng)
2162 .cloned()
2163}
2164
2165fn gen_file_name(rng: &mut StdRng) -> String {
2166 let mut name = String::new();
2167 for _ in 0..10 {
2168 let letter = rng.gen_range('a'..='z');
2169 name.push(letter);
2170 }
2171 name
2172}
2173
2174fn path_env_var(name: &str) -> Option<PathBuf> {
2175 let value = env::var(name).ok()?;
2176 let mut path = PathBuf::from(value);
2177 if path.is_relative() {
2178 let mut abs_path = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
2179 abs_path.pop();
2180 abs_path.pop();
2181 abs_path.push(path);
2182 path = abs_path
2183 }
2184 Some(path)
2185}