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().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()
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().contains(&repo_path) {
774 return Err(TestError::Inapplicable);
775 }
776
777 log::info!(
778 "{}: writing git index for repo {:?}: {:?}",
779 client.username,
780 repo_path,
781 contents
782 );
783
784 let dot_git_dir = repo_path.join(".git");
785 let contents = contents
786 .iter()
787 .map(|(path, contents)| (path.as_path(), contents.clone()))
788 .collect::<Vec<_>>();
789 if client.fs.metadata(&dot_git_dir).await?.is_none() {
790 client.fs.create_dir(&dot_git_dir).await?;
791 }
792 client.fs.set_index_for_repo(&dot_git_dir, &contents);
793 }
794 GitOperation::WriteGitBranch {
795 repo_path,
796 new_branch,
797 } => {
798 if !client.fs.directories().contains(&repo_path) {
799 return Err(TestError::Inapplicable);
800 }
801
802 log::info!(
803 "{}: writing git branch for repo {:?}: {:?}",
804 client.username,
805 repo_path,
806 new_branch
807 );
808
809 let dot_git_dir = repo_path.join(".git");
810 if client.fs.metadata(&dot_git_dir).await?.is_none() {
811 client.fs.create_dir(&dot_git_dir).await?;
812 }
813 client.fs.set_branch_name(&dot_git_dir, new_branch);
814 }
815 GitOperation::WriteGitStatuses {
816 repo_path,
817 statuses,
818 } => {
819 if !client.fs.directories().contains(&repo_path) {
820 return Err(TestError::Inapplicable);
821 }
822
823 log::info!(
824 "{}: writing git statuses for repo {:?}: {:?}",
825 client.username,
826 repo_path,
827 statuses
828 );
829
830 let dot_git_dir = repo_path.join(".git");
831
832 let statuses = statuses
833 .iter()
834 .map(|(path, val)| (path.as_path(), val.clone()))
835 .collect::<Vec<_>>();
836
837 if client.fs.metadata(&dot_git_dir).await?.is_none() {
838 client.fs.create_dir(&dot_git_dir).await?;
839 }
840
841 client
842 .fs
843 .set_status_for_repo(&dot_git_dir, statuses.as_slice());
844 }
845 },
846 }
847 Ok(())
848}
849
850fn check_consistency_between_clients(clients: &[(Rc<TestClient>, TestAppContext)]) {
851 for (client, client_cx) in clients {
852 for guest_project in client.remote_projects().iter() {
853 guest_project.read_with(client_cx, |guest_project, cx| {
854 let host_project = clients.iter().find_map(|(client, cx)| {
855 let project = client
856 .local_projects()
857 .iter()
858 .find(|host_project| {
859 host_project.read_with(cx, |host_project, _| {
860 host_project.remote_id() == guest_project.remote_id()
861 })
862 })?
863 .clone();
864 Some((project, cx))
865 });
866
867 if !guest_project.is_read_only() {
868 if let Some((host_project, host_cx)) = host_project {
869 let host_worktree_snapshots =
870 host_project.read_with(host_cx, |host_project, cx| {
871 host_project
872 .worktrees(cx)
873 .map(|worktree| {
874 let worktree = worktree.read(cx);
875 (worktree.id(), worktree.snapshot())
876 })
877 .collect::<BTreeMap<_, _>>()
878 });
879 let guest_worktree_snapshots = guest_project
880 .worktrees(cx)
881 .map(|worktree| {
882 let worktree = worktree.read(cx);
883 (worktree.id(), worktree.snapshot())
884 })
885 .collect::<BTreeMap<_, _>>();
886
887 assert_eq!(
888 guest_worktree_snapshots.values().map(|w| w.abs_path()).collect::<Vec<_>>(),
889 host_worktree_snapshots.values().map(|w| w.abs_path()).collect::<Vec<_>>(),
890 "{} has different worktrees than the host for project {:?}",
891 client.username, guest_project.remote_id(),
892 );
893
894 for (id, host_snapshot) in &host_worktree_snapshots {
895 let guest_snapshot = &guest_worktree_snapshots[id];
896 assert_eq!(
897 guest_snapshot.root_name(),
898 host_snapshot.root_name(),
899 "{} has different root name than the host for worktree {}, project {:?}",
900 client.username,
901 id,
902 guest_project.remote_id(),
903 );
904 assert_eq!(
905 guest_snapshot.abs_path(),
906 host_snapshot.abs_path(),
907 "{} has different abs path than the host for worktree {}, project: {:?}",
908 client.username,
909 id,
910 guest_project.remote_id(),
911 );
912 assert_eq!(
913 guest_snapshot.entries(false).collect::<Vec<_>>(),
914 host_snapshot.entries(false).collect::<Vec<_>>(),
915 "{} has different snapshot than the host for worktree {:?} and project {:?}",
916 client.username,
917 host_snapshot.abs_path(),
918 guest_project.remote_id(),
919 );
920 assert_eq!(guest_snapshot.repositories().collect::<Vec<_>>(), host_snapshot.repositories().collect::<Vec<_>>(),
921 "{} has different repositories than the host for worktree {:?} and project {:?}",
922 client.username,
923 host_snapshot.abs_path(),
924 guest_project.remote_id(),
925 );
926 assert_eq!(guest_snapshot.scan_id(), host_snapshot.scan_id(),
927 "{} has different scan id than the host for worktree {:?} and project {:?}",
928 client.username,
929 host_snapshot.abs_path(),
930 guest_project.remote_id(),
931 );
932 }
933 }
934 }
935
936 for buffer in guest_project.opened_buffers(cx) {
937 let buffer = buffer.read(cx);
938 assert_eq!(
939 buffer.deferred_ops_len(),
940 0,
941 "{} has deferred operations for buffer {:?} in project {:?}",
942 client.username,
943 buffer.file().unwrap().full_path(cx),
944 guest_project.remote_id(),
945 );
946 }
947 });
948 }
949
950 let buffers = client.buffers().clone();
951 for (guest_project, guest_buffers) in &buffers {
952 let project_id = if guest_project.read_with(client_cx, |project, _| {
953 project.is_local() || project.is_read_only()
954 }) {
955 continue;
956 } else {
957 guest_project
958 .read_with(client_cx, |project, _| project.remote_id())
959 .unwrap()
960 };
961 let guest_user_id = client.user_id().unwrap();
962
963 let host_project = clients.iter().find_map(|(client, cx)| {
964 let project = client
965 .local_projects()
966 .iter()
967 .find(|host_project| {
968 host_project.read_with(cx, |host_project, _| {
969 host_project.remote_id() == Some(project_id)
970 })
971 })?
972 .clone();
973 Some((client.user_id().unwrap(), project, cx))
974 });
975
976 let (host_user_id, host_project, host_cx) =
977 if let Some((host_user_id, host_project, host_cx)) = host_project {
978 (host_user_id, host_project, host_cx)
979 } else {
980 continue;
981 };
982
983 for guest_buffer in guest_buffers {
984 let buffer_id = guest_buffer.read_with(client_cx, |buffer, _| buffer.remote_id());
985 let host_buffer = host_project.read_with(host_cx, |project, cx| {
986 project.buffer_for_id(buffer_id, cx).unwrap_or_else(|| {
987 panic!(
988 "host does not have buffer for guest:{}, peer:{:?}, id:{}",
989 client.username,
990 client.peer_id(),
991 buffer_id
992 )
993 })
994 });
995 let path = host_buffer
996 .read_with(host_cx, |buffer, cx| buffer.file().unwrap().full_path(cx));
997
998 assert_eq!(
999 guest_buffer.read_with(client_cx, |buffer, _| buffer.deferred_ops_len()),
1000 0,
1001 "{}, buffer {}, path {:?} has deferred operations",
1002 client.username,
1003 buffer_id,
1004 path,
1005 );
1006 assert_eq!(
1007 guest_buffer.read_with(client_cx, |buffer, _| buffer.text()),
1008 host_buffer.read_with(host_cx, |buffer, _| buffer.text()),
1009 "{}, buffer {}, path {:?}, differs from the host's buffer",
1010 client.username,
1011 buffer_id,
1012 path
1013 );
1014
1015 let host_file = host_buffer.read_with(host_cx, |b, _| b.file().cloned());
1016 let guest_file = guest_buffer.read_with(client_cx, |b, _| b.file().cloned());
1017 match (host_file, guest_file) {
1018 (Some(host_file), Some(guest_file)) => {
1019 assert_eq!(guest_file.path(), host_file.path());
1020 assert_eq!(guest_file.is_deleted(), host_file.is_deleted());
1021 assert_eq!(
1022 guest_file.mtime(),
1023 host_file.mtime(),
1024 "guest {} mtime does not match host {} for path {:?} in project {}",
1025 guest_user_id,
1026 host_user_id,
1027 guest_file.path(),
1028 project_id,
1029 );
1030 }
1031 (None, None) => {}
1032 (None, _) => panic!("host's file is None, guest's isn't"),
1033 (_, None) => panic!("guest's file is None, hosts's isn't"),
1034 }
1035
1036 let host_diff_base =
1037 host_buffer.read_with(host_cx, |b, _| b.diff_base().map(ToString::to_string));
1038 let guest_diff_base = guest_buffer
1039 .read_with(client_cx, |b, _| b.diff_base().map(ToString::to_string));
1040 assert_eq!(
1041 guest_diff_base, host_diff_base,
1042 "guest {} diff base does not match host's for path {path:?} in project {project_id}",
1043 client.username
1044 );
1045
1046 let host_saved_version =
1047 host_buffer.read_with(host_cx, |b, _| b.saved_version().clone());
1048 let guest_saved_version =
1049 guest_buffer.read_with(client_cx, |b, _| b.saved_version().clone());
1050 assert_eq!(
1051 guest_saved_version, host_saved_version,
1052 "guest {} saved version does not match host's for path {path:?} in project {project_id}",
1053 client.username
1054 );
1055
1056 let host_saved_version_fingerprint =
1057 host_buffer.read_with(host_cx, |b, _| b.saved_version_fingerprint());
1058 let guest_saved_version_fingerprint =
1059 guest_buffer.read_with(client_cx, |b, _| b.saved_version_fingerprint());
1060 assert_eq!(
1061 guest_saved_version_fingerprint, host_saved_version_fingerprint,
1062 "guest {} saved fingerprint does not match host's for path {path:?} in project {project_id}",
1063 client.username
1064 );
1065
1066 let host_saved_mtime = host_buffer.read_with(host_cx, |b, _| b.saved_mtime());
1067 let guest_saved_mtime = guest_buffer.read_with(client_cx, |b, _| b.saved_mtime());
1068 assert_eq!(
1069 guest_saved_mtime, host_saved_mtime,
1070 "guest {} saved mtime does not match host's for path {path:?} in project {project_id}",
1071 client.username
1072 );
1073
1074 let host_is_dirty = host_buffer.read_with(host_cx, |b, _| b.is_dirty());
1075 let guest_is_dirty = guest_buffer.read_with(client_cx, |b, _| b.is_dirty());
1076 assert_eq!(guest_is_dirty, host_is_dirty,
1077 "guest {} dirty status does not match host's for path {path:?} in project {project_id}",
1078 client.username
1079 );
1080
1081 let host_has_conflict = host_buffer.read_with(host_cx, |b, _| b.has_conflict());
1082 let guest_has_conflict = guest_buffer.read_with(client_cx, |b, _| b.has_conflict());
1083 assert_eq!(guest_has_conflict, host_has_conflict,
1084 "guest {} conflict status does not match host's for path {path:?} in project {project_id}",
1085 client.username
1086 );
1087 }
1088 }
1089 }
1090}
1091
1092struct TestPlan {
1093 rng: StdRng,
1094 replay: bool,
1095 stored_operations: Vec<(StoredOperation, Arc<AtomicBool>)>,
1096 max_operations: usize,
1097 operation_ix: usize,
1098 users: Vec<UserTestPlan>,
1099 next_batch_id: usize,
1100 allow_server_restarts: bool,
1101 allow_client_reconnection: bool,
1102 allow_client_disconnection: bool,
1103}
1104
1105struct UserTestPlan {
1106 user_id: UserId,
1107 username: String,
1108 next_root_id: usize,
1109 operation_ix: usize,
1110 online: bool,
1111}
1112
1113#[derive(Clone, Debug, Serialize, Deserialize)]
1114#[serde(untagged)]
1115enum StoredOperation {
1116 Server(Operation),
1117 Client {
1118 user_id: UserId,
1119 batch_id: usize,
1120 operation: ClientOperation,
1121 },
1122}
1123
1124#[derive(Clone, Debug, Serialize, Deserialize)]
1125enum Operation {
1126 AddConnection {
1127 user_id: UserId,
1128 },
1129 RemoveConnection {
1130 user_id: UserId,
1131 },
1132 BounceConnection {
1133 user_id: UserId,
1134 },
1135 RestartServer,
1136 MutateClients {
1137 batch_id: usize,
1138 #[serde(skip_serializing)]
1139 #[serde(skip_deserializing)]
1140 user_ids: Vec<UserId>,
1141 quiesce: bool,
1142 },
1143}
1144
1145#[derive(Clone, Debug, Serialize, Deserialize)]
1146enum ClientOperation {
1147 AcceptIncomingCall,
1148 RejectIncomingCall,
1149 LeaveCall,
1150 InviteContactToCall {
1151 user_id: UserId,
1152 },
1153 OpenLocalProject {
1154 first_root_name: String,
1155 },
1156 OpenRemoteProject {
1157 host_id: UserId,
1158 first_root_name: String,
1159 },
1160 AddWorktreeToProject {
1161 project_root_name: String,
1162 new_root_path: PathBuf,
1163 },
1164 CloseRemoteProject {
1165 project_root_name: String,
1166 },
1167 OpenBuffer {
1168 project_root_name: String,
1169 is_local: bool,
1170 full_path: PathBuf,
1171 },
1172 SearchProject {
1173 project_root_name: String,
1174 is_local: bool,
1175 query: String,
1176 detach: bool,
1177 },
1178 EditBuffer {
1179 project_root_name: String,
1180 is_local: bool,
1181 full_path: PathBuf,
1182 edits: Vec<(Range<usize>, Arc<str>)>,
1183 },
1184 CloseBuffer {
1185 project_root_name: String,
1186 is_local: bool,
1187 full_path: PathBuf,
1188 },
1189 SaveBuffer {
1190 project_root_name: String,
1191 is_local: bool,
1192 full_path: PathBuf,
1193 detach: bool,
1194 },
1195 RequestLspDataInBuffer {
1196 project_root_name: String,
1197 is_local: bool,
1198 full_path: PathBuf,
1199 offset: usize,
1200 kind: LspRequestKind,
1201 detach: bool,
1202 },
1203 CreateWorktreeEntry {
1204 project_root_name: String,
1205 is_local: bool,
1206 full_path: PathBuf,
1207 is_dir: bool,
1208 },
1209 WriteFsEntry {
1210 path: PathBuf,
1211 is_dir: bool,
1212 content: String,
1213 },
1214 GitOperation {
1215 operation: GitOperation,
1216 },
1217}
1218
1219#[derive(Clone, Debug, Serialize, Deserialize)]
1220enum GitOperation {
1221 WriteGitIndex {
1222 repo_path: PathBuf,
1223 contents: Vec<(PathBuf, String)>,
1224 },
1225 WriteGitBranch {
1226 repo_path: PathBuf,
1227 new_branch: Option<String>,
1228 },
1229 WriteGitStatuses {
1230 repo_path: PathBuf,
1231 statuses: Vec<(PathBuf, GitFileStatus)>,
1232 },
1233}
1234
1235#[derive(Clone, Debug, Serialize, Deserialize)]
1236enum LspRequestKind {
1237 Rename,
1238 Completion,
1239 CodeAction,
1240 Definition,
1241 Highlights,
1242}
1243
1244enum TestError {
1245 Inapplicable,
1246 Other(anyhow::Error),
1247}
1248
1249impl From<anyhow::Error> for TestError {
1250 fn from(value: anyhow::Error) -> Self {
1251 Self::Other(value)
1252 }
1253}
1254
1255impl TestPlan {
1256 fn new(mut rng: StdRng, users: Vec<UserTestPlan>, max_operations: usize) -> Self {
1257 Self {
1258 replay: false,
1259 allow_server_restarts: rng.gen_bool(0.7),
1260 allow_client_reconnection: rng.gen_bool(0.7),
1261 allow_client_disconnection: rng.gen_bool(0.1),
1262 stored_operations: Vec::new(),
1263 operation_ix: 0,
1264 next_batch_id: 0,
1265 max_operations,
1266 users,
1267 rng,
1268 }
1269 }
1270
1271 fn deserialize(&mut self, json: Vec<u8>) {
1272 let stored_operations: Vec<StoredOperation> = serde_json::from_slice(&json).unwrap();
1273 self.replay = true;
1274 self.stored_operations = stored_operations
1275 .iter()
1276 .cloned()
1277 .enumerate()
1278 .map(|(i, mut operation)| {
1279 if let StoredOperation::Server(Operation::MutateClients {
1280 batch_id: current_batch_id,
1281 user_ids,
1282 ..
1283 }) = &mut operation
1284 {
1285 assert!(user_ids.is_empty());
1286 user_ids.extend(stored_operations[i + 1..].iter().filter_map(|operation| {
1287 if let StoredOperation::Client {
1288 user_id, batch_id, ..
1289 } = operation
1290 {
1291 if batch_id == current_batch_id {
1292 return Some(user_id);
1293 }
1294 }
1295 None
1296 }));
1297 user_ids.sort_unstable();
1298 }
1299 (operation, Arc::new(AtomicBool::new(false)))
1300 })
1301 .collect()
1302 }
1303
1304 fn serialize(&mut self) -> Vec<u8> {
1305 // Format each operation as one line
1306 let mut json = Vec::new();
1307 json.push(b'[');
1308 for (operation, applied) in &self.stored_operations {
1309 if !applied.load(SeqCst) {
1310 continue;
1311 }
1312 if json.len() > 1 {
1313 json.push(b',');
1314 }
1315 json.extend_from_slice(b"\n ");
1316 serde_json::to_writer(&mut json, operation).unwrap();
1317 }
1318 json.extend_from_slice(b"\n]\n");
1319 json
1320 }
1321
1322 fn next_server_operation(
1323 &mut self,
1324 clients: &[(Rc<TestClient>, TestAppContext)],
1325 ) -> Option<(Operation, Arc<AtomicBool>)> {
1326 if self.replay {
1327 while let Some(stored_operation) = self.stored_operations.get(self.operation_ix) {
1328 self.operation_ix += 1;
1329 if let (StoredOperation::Server(operation), applied) = stored_operation {
1330 return Some((operation.clone(), applied.clone()));
1331 }
1332 }
1333 None
1334 } else {
1335 let operation = self.generate_server_operation(clients)?;
1336 let applied = Arc::new(AtomicBool::new(false));
1337 self.stored_operations
1338 .push((StoredOperation::Server(operation.clone()), applied.clone()));
1339 Some((operation, applied))
1340 }
1341 }
1342
1343 fn next_client_operation(
1344 &mut self,
1345 client: &TestClient,
1346 current_batch_id: usize,
1347 cx: &TestAppContext,
1348 ) -> Option<(ClientOperation, Arc<AtomicBool>)> {
1349 let current_user_id = client.current_user_id(cx);
1350 let user_ix = self
1351 .users
1352 .iter()
1353 .position(|user| user.user_id == current_user_id)
1354 .unwrap();
1355 let user_plan = &mut self.users[user_ix];
1356
1357 if self.replay {
1358 while let Some(stored_operation) = self.stored_operations.get(user_plan.operation_ix) {
1359 user_plan.operation_ix += 1;
1360 if let (
1361 StoredOperation::Client {
1362 user_id, operation, ..
1363 },
1364 applied,
1365 ) = stored_operation
1366 {
1367 if user_id == ¤t_user_id {
1368 return Some((operation.clone(), applied.clone()));
1369 }
1370 }
1371 }
1372 None
1373 } else {
1374 let operation = self.generate_client_operation(current_user_id, client, cx)?;
1375 let applied = Arc::new(AtomicBool::new(false));
1376 self.stored_operations.push((
1377 StoredOperation::Client {
1378 user_id: current_user_id,
1379 batch_id: current_batch_id,
1380 operation: operation.clone(),
1381 },
1382 applied.clone(),
1383 ));
1384 Some((operation, applied))
1385 }
1386 }
1387
1388 fn generate_server_operation(
1389 &mut self,
1390 clients: &[(Rc<TestClient>, TestAppContext)],
1391 ) -> Option<Operation> {
1392 if self.operation_ix == self.max_operations {
1393 return None;
1394 }
1395
1396 Some(loop {
1397 break match self.rng.gen_range(0..100) {
1398 0..=29 if clients.len() < self.users.len() => {
1399 let user = self
1400 .users
1401 .iter()
1402 .filter(|u| !u.online)
1403 .choose(&mut self.rng)
1404 .unwrap();
1405 self.operation_ix += 1;
1406 Operation::AddConnection {
1407 user_id: user.user_id,
1408 }
1409 }
1410 30..=34 if clients.len() > 1 && self.allow_client_disconnection => {
1411 let (client, cx) = &clients[self.rng.gen_range(0..clients.len())];
1412 let user_id = client.current_user_id(cx);
1413 self.operation_ix += 1;
1414 Operation::RemoveConnection { user_id }
1415 }
1416 35..=39 if clients.len() > 1 && self.allow_client_reconnection => {
1417 let (client, cx) = &clients[self.rng.gen_range(0..clients.len())];
1418 let user_id = client.current_user_id(cx);
1419 self.operation_ix += 1;
1420 Operation::BounceConnection { user_id }
1421 }
1422 40..=44 if self.allow_server_restarts && clients.len() > 1 => {
1423 self.operation_ix += 1;
1424 Operation::RestartServer
1425 }
1426 _ if !clients.is_empty() => {
1427 let count = self
1428 .rng
1429 .gen_range(1..10)
1430 .min(self.max_operations - self.operation_ix);
1431 let batch_id = util::post_inc(&mut self.next_batch_id);
1432 let mut user_ids = (0..count)
1433 .map(|_| {
1434 let ix = self.rng.gen_range(0..clients.len());
1435 let (client, cx) = &clients[ix];
1436 client.current_user_id(cx)
1437 })
1438 .collect::<Vec<_>>();
1439 user_ids.sort_unstable();
1440 Operation::MutateClients {
1441 user_ids,
1442 batch_id,
1443 quiesce: self.rng.gen_bool(0.7),
1444 }
1445 }
1446 _ => continue,
1447 };
1448 })
1449 }
1450
1451 fn generate_client_operation(
1452 &mut self,
1453 user_id: UserId,
1454 client: &TestClient,
1455 cx: &TestAppContext,
1456 ) -> Option<ClientOperation> {
1457 if self.operation_ix == self.max_operations {
1458 return None;
1459 }
1460
1461 self.operation_ix += 1;
1462 let call = cx.read(ActiveCall::global);
1463 Some(loop {
1464 match self.rng.gen_range(0..100_u32) {
1465 // Mutate the call
1466 0..=29 => {
1467 // Respond to an incoming call
1468 if call.read_with(cx, |call, _| call.incoming().borrow().is_some()) {
1469 break if self.rng.gen_bool(0.7) {
1470 ClientOperation::AcceptIncomingCall
1471 } else {
1472 ClientOperation::RejectIncomingCall
1473 };
1474 }
1475
1476 match self.rng.gen_range(0..100_u32) {
1477 // Invite a contact to the current call
1478 0..=70 => {
1479 let available_contacts =
1480 client.user_store.read_with(cx, |user_store, _| {
1481 user_store
1482 .contacts()
1483 .iter()
1484 .filter(|contact| contact.online && !contact.busy)
1485 .cloned()
1486 .collect::<Vec<_>>()
1487 });
1488 if !available_contacts.is_empty() {
1489 let contact = available_contacts.choose(&mut self.rng).unwrap();
1490 break ClientOperation::InviteContactToCall {
1491 user_id: UserId(contact.user.id as i32),
1492 };
1493 }
1494 }
1495
1496 // Leave the current call
1497 71.. => {
1498 if self.allow_client_disconnection
1499 && call.read_with(cx, |call, _| call.room().is_some())
1500 {
1501 break ClientOperation::LeaveCall;
1502 }
1503 }
1504 }
1505 }
1506
1507 // Mutate projects
1508 30..=59 => match self.rng.gen_range(0..100_u32) {
1509 // Open a new project
1510 0..=70 => {
1511 // Open a remote project
1512 if let Some(room) = call.read_with(cx, |call, _| call.room().cloned()) {
1513 let existing_remote_project_ids = cx.read(|cx| {
1514 client
1515 .remote_projects()
1516 .iter()
1517 .map(|p| p.read(cx).remote_id().unwrap())
1518 .collect::<Vec<_>>()
1519 });
1520 let new_remote_projects = room.read_with(cx, |room, _| {
1521 room.remote_participants()
1522 .values()
1523 .flat_map(|participant| {
1524 participant.projects.iter().filter_map(|project| {
1525 if existing_remote_project_ids.contains(&project.id) {
1526 None
1527 } else {
1528 Some((
1529 UserId::from_proto(participant.user.id),
1530 project.worktree_root_names[0].clone(),
1531 ))
1532 }
1533 })
1534 })
1535 .collect::<Vec<_>>()
1536 });
1537 if !new_remote_projects.is_empty() {
1538 let (host_id, first_root_name) =
1539 new_remote_projects.choose(&mut self.rng).unwrap().clone();
1540 break ClientOperation::OpenRemoteProject {
1541 host_id,
1542 first_root_name,
1543 };
1544 }
1545 }
1546 // Open a local project
1547 else {
1548 let first_root_name = self.next_root_dir_name(user_id);
1549 break ClientOperation::OpenLocalProject { first_root_name };
1550 }
1551 }
1552
1553 // Close a remote project
1554 71..=80 => {
1555 if !client.remote_projects().is_empty() {
1556 let project = client
1557 .remote_projects()
1558 .choose(&mut self.rng)
1559 .unwrap()
1560 .clone();
1561 let first_root_name = root_name_for_project(&project, cx);
1562 break ClientOperation::CloseRemoteProject {
1563 project_root_name: first_root_name,
1564 };
1565 }
1566 }
1567
1568 // Mutate project worktrees
1569 81.. => match self.rng.gen_range(0..100_u32) {
1570 // Add a worktree to a local project
1571 0..=50 => {
1572 let Some(project) = client
1573 .local_projects()
1574 .choose(&mut self.rng)
1575 .cloned() else { continue };
1576 let project_root_name = root_name_for_project(&project, cx);
1577 let mut paths = client.fs.paths();
1578 paths.remove(0);
1579 let new_root_path = if paths.is_empty() || self.rng.gen() {
1580 Path::new("/").join(&self.next_root_dir_name(user_id))
1581 } else {
1582 paths.choose(&mut self.rng).unwrap().clone()
1583 };
1584 break ClientOperation::AddWorktreeToProject {
1585 project_root_name,
1586 new_root_path,
1587 };
1588 }
1589
1590 // Add an entry to a worktree
1591 _ => {
1592 let Some(project) = choose_random_project(client, &mut self.rng) else { continue };
1593 let project_root_name = root_name_for_project(&project, cx);
1594 let is_local = project.read_with(cx, |project, _| project.is_local());
1595 let worktree = project.read_with(cx, |project, cx| {
1596 project
1597 .worktrees(cx)
1598 .filter(|worktree| {
1599 let worktree = worktree.read(cx);
1600 worktree.is_visible()
1601 && worktree.entries(false).any(|e| e.is_file())
1602 && worktree.root_entry().map_or(false, |e| e.is_dir())
1603 })
1604 .choose(&mut self.rng)
1605 });
1606 let Some(worktree) = worktree else { continue };
1607 let is_dir = self.rng.gen::<bool>();
1608 let mut full_path =
1609 worktree.read_with(cx, |w, _| PathBuf::from(w.root_name()));
1610 full_path.push(gen_file_name(&mut self.rng));
1611 if !is_dir {
1612 full_path.set_extension("rs");
1613 }
1614 break ClientOperation::CreateWorktreeEntry {
1615 project_root_name,
1616 is_local,
1617 full_path,
1618 is_dir,
1619 };
1620 }
1621 },
1622 },
1623
1624 // Query and mutate buffers
1625 60..=90 => {
1626 let Some(project) = choose_random_project(client, &mut self.rng) else { continue };
1627 let project_root_name = root_name_for_project(&project, cx);
1628 let is_local = project.read_with(cx, |project, _| project.is_local());
1629
1630 match self.rng.gen_range(0..100_u32) {
1631 // Manipulate an existing buffer
1632 0..=70 => {
1633 let Some(buffer) = client
1634 .buffers_for_project(&project)
1635 .iter()
1636 .choose(&mut self.rng)
1637 .cloned() else { continue };
1638
1639 let full_path = buffer
1640 .read_with(cx, |buffer, cx| buffer.file().unwrap().full_path(cx));
1641
1642 match self.rng.gen_range(0..100_u32) {
1643 // Close the buffer
1644 0..=15 => {
1645 break ClientOperation::CloseBuffer {
1646 project_root_name,
1647 is_local,
1648 full_path,
1649 };
1650 }
1651 // Save the buffer
1652 16..=29 if buffer.read_with(cx, |b, _| b.is_dirty()) => {
1653 let detach = self.rng.gen_bool(0.3);
1654 break ClientOperation::SaveBuffer {
1655 project_root_name,
1656 is_local,
1657 full_path,
1658 detach,
1659 };
1660 }
1661 // Edit the buffer
1662 30..=69 => {
1663 let edits = buffer.read_with(cx, |buffer, _| {
1664 buffer.get_random_edits(&mut self.rng, 3)
1665 });
1666 break ClientOperation::EditBuffer {
1667 project_root_name,
1668 is_local,
1669 full_path,
1670 edits,
1671 };
1672 }
1673 // Make an LSP request
1674 _ => {
1675 let offset = buffer.read_with(cx, |buffer, _| {
1676 buffer.clip_offset(
1677 self.rng.gen_range(0..=buffer.len()),
1678 language::Bias::Left,
1679 )
1680 });
1681 let detach = self.rng.gen();
1682 break ClientOperation::RequestLspDataInBuffer {
1683 project_root_name,
1684 full_path,
1685 offset,
1686 is_local,
1687 kind: match self.rng.gen_range(0..5_u32) {
1688 0 => LspRequestKind::Rename,
1689 1 => LspRequestKind::Highlights,
1690 2 => LspRequestKind::Definition,
1691 3 => LspRequestKind::CodeAction,
1692 4.. => LspRequestKind::Completion,
1693 },
1694 detach,
1695 };
1696 }
1697 }
1698 }
1699
1700 71..=80 => {
1701 let query = self.rng.gen_range('a'..='z').to_string();
1702 let detach = self.rng.gen_bool(0.3);
1703 break ClientOperation::SearchProject {
1704 project_root_name,
1705 is_local,
1706 query,
1707 detach,
1708 };
1709 }
1710
1711 // Open a buffer
1712 81.. => {
1713 let worktree = project.read_with(cx, |project, cx| {
1714 project
1715 .worktrees(cx)
1716 .filter(|worktree| {
1717 let worktree = worktree.read(cx);
1718 worktree.is_visible()
1719 && worktree.entries(false).any(|e| e.is_file())
1720 })
1721 .choose(&mut self.rng)
1722 });
1723 let Some(worktree) = worktree else { continue };
1724 let full_path = worktree.read_with(cx, |worktree, _| {
1725 let entry = worktree
1726 .entries(false)
1727 .filter(|e| e.is_file())
1728 .choose(&mut self.rng)
1729 .unwrap();
1730 if entry.path.as_ref() == Path::new("") {
1731 Path::new(worktree.root_name()).into()
1732 } else {
1733 Path::new(worktree.root_name()).join(&entry.path)
1734 }
1735 });
1736 break ClientOperation::OpenBuffer {
1737 project_root_name,
1738 is_local,
1739 full_path,
1740 };
1741 }
1742 }
1743 }
1744
1745 // Update a git related action
1746 91..=95 => {
1747 break ClientOperation::GitOperation {
1748 operation: self.generate_git_operation(client),
1749 };
1750 }
1751
1752 // Create or update a file or directory
1753 96.. => {
1754 let is_dir = self.rng.gen::<bool>();
1755 let content;
1756 let mut path;
1757 let dir_paths = client.fs.directories();
1758
1759 if is_dir {
1760 content = String::new();
1761 path = dir_paths.choose(&mut self.rng).unwrap().clone();
1762 path.push(gen_file_name(&mut self.rng));
1763 } else {
1764 content = Alphanumeric.sample_string(&mut self.rng, 16);
1765
1766 // Create a new file or overwrite an existing file
1767 let file_paths = client.fs.files();
1768 if file_paths.is_empty() || self.rng.gen_bool(0.5) {
1769 path = dir_paths.choose(&mut self.rng).unwrap().clone();
1770 path.push(gen_file_name(&mut self.rng));
1771 path.set_extension("rs");
1772 } else {
1773 path = file_paths.choose(&mut self.rng).unwrap().clone()
1774 };
1775 }
1776 break ClientOperation::WriteFsEntry {
1777 path,
1778 is_dir,
1779 content,
1780 };
1781 }
1782 }
1783 })
1784 }
1785
1786 fn generate_git_operation(&mut self, client: &TestClient) -> GitOperation {
1787 fn generate_file_paths(
1788 repo_path: &Path,
1789 rng: &mut StdRng,
1790 client: &TestClient,
1791 ) -> Vec<PathBuf> {
1792 let mut paths = client
1793 .fs
1794 .files()
1795 .into_iter()
1796 .filter(|path| path.starts_with(repo_path))
1797 .collect::<Vec<_>>();
1798
1799 let count = rng.gen_range(0..=paths.len());
1800 paths.shuffle(rng);
1801 paths.truncate(count);
1802
1803 paths
1804 .iter()
1805 .map(|path| path.strip_prefix(repo_path).unwrap().to_path_buf())
1806 .collect::<Vec<_>>()
1807 }
1808
1809 let repo_path = client
1810 .fs
1811 .directories()
1812 .choose(&mut self.rng)
1813 .unwrap()
1814 .clone();
1815
1816 match self.rng.gen_range(0..100_u32) {
1817 0..=25 => {
1818 let file_paths = generate_file_paths(&repo_path, &mut self.rng, client);
1819
1820 let contents = file_paths
1821 .into_iter()
1822 .map(|path| (path, Alphanumeric.sample_string(&mut self.rng, 16)))
1823 .collect();
1824
1825 GitOperation::WriteGitIndex {
1826 repo_path,
1827 contents,
1828 }
1829 }
1830 26..=63 => {
1831 let new_branch = (self.rng.gen_range(0..10) > 3)
1832 .then(|| Alphanumeric.sample_string(&mut self.rng, 8));
1833
1834 GitOperation::WriteGitBranch {
1835 repo_path,
1836 new_branch,
1837 }
1838 }
1839 64..=100 => {
1840 let file_paths = generate_file_paths(&repo_path, &mut self.rng, client);
1841
1842 let statuses = file_paths
1843 .into_iter()
1844 .map(|paths| {
1845 (
1846 paths,
1847 match self.rng.gen_range(0..3_u32) {
1848 0 => GitFileStatus::Added,
1849 1 => GitFileStatus::Modified,
1850 2 => GitFileStatus::Conflict,
1851 _ => unreachable!(),
1852 },
1853 )
1854 })
1855 .collect::<Vec<_>>();
1856
1857 GitOperation::WriteGitStatuses {
1858 repo_path,
1859 statuses,
1860 }
1861 }
1862 _ => unreachable!(),
1863 }
1864 }
1865
1866 fn next_root_dir_name(&mut self, user_id: UserId) -> String {
1867 let user_ix = self
1868 .users
1869 .iter()
1870 .position(|user| user.user_id == user_id)
1871 .unwrap();
1872 let root_id = util::post_inc(&mut self.users[user_ix].next_root_id);
1873 format!("dir-{user_id}-{root_id}")
1874 }
1875
1876 fn user(&mut self, user_id: UserId) -> &mut UserTestPlan {
1877 let ix = self
1878 .users
1879 .iter()
1880 .position(|user| user.user_id == user_id)
1881 .unwrap();
1882 &mut self.users[ix]
1883 }
1884}
1885
1886async fn simulate_client(
1887 client: Rc<TestClient>,
1888 mut operation_rx: futures::channel::mpsc::UnboundedReceiver<usize>,
1889 plan: Arc<Mutex<TestPlan>>,
1890 mut cx: TestAppContext,
1891) {
1892 // Setup language server
1893 let mut language = Language::new(
1894 LanguageConfig {
1895 name: "Rust".into(),
1896 path_suffixes: vec!["rs".to_string()],
1897 ..Default::default()
1898 },
1899 None,
1900 );
1901 let _fake_language_servers = language
1902 .set_fake_lsp_adapter(Arc::new(FakeLspAdapter {
1903 name: "the-fake-language-server",
1904 capabilities: lsp::LanguageServer::full_capabilities(),
1905 initializer: Some(Box::new({
1906 let fs = client.fs.clone();
1907 move |fake_server: &mut FakeLanguageServer| {
1908 fake_server.handle_request::<lsp::request::Completion, _, _>(
1909 |_, _| async move {
1910 Ok(Some(lsp::CompletionResponse::Array(vec![
1911 lsp::CompletionItem {
1912 text_edit: Some(lsp::CompletionTextEdit::Edit(lsp::TextEdit {
1913 range: lsp::Range::new(
1914 lsp::Position::new(0, 0),
1915 lsp::Position::new(0, 0),
1916 ),
1917 new_text: "the-new-text".to_string(),
1918 })),
1919 ..Default::default()
1920 },
1921 ])))
1922 },
1923 );
1924
1925 fake_server.handle_request::<lsp::request::CodeActionRequest, _, _>(
1926 |_, _| async move {
1927 Ok(Some(vec![lsp::CodeActionOrCommand::CodeAction(
1928 lsp::CodeAction {
1929 title: "the-code-action".to_string(),
1930 ..Default::default()
1931 },
1932 )]))
1933 },
1934 );
1935
1936 fake_server.handle_request::<lsp::request::PrepareRenameRequest, _, _>(
1937 |params, _| async move {
1938 Ok(Some(lsp::PrepareRenameResponse::Range(lsp::Range::new(
1939 params.position,
1940 params.position,
1941 ))))
1942 },
1943 );
1944
1945 fake_server.handle_request::<lsp::request::GotoDefinition, _, _>({
1946 let fs = fs.clone();
1947 move |_, cx| {
1948 let background = cx.background();
1949 let mut rng = background.rng();
1950 let count = rng.gen_range::<usize, _>(1..3);
1951 let files = fs.files();
1952 let files = (0..count)
1953 .map(|_| files.choose(&mut *rng).unwrap().clone())
1954 .collect::<Vec<_>>();
1955 async move {
1956 log::info!("LSP: Returning definitions in files {:?}", &files);
1957 Ok(Some(lsp::GotoDefinitionResponse::Array(
1958 files
1959 .into_iter()
1960 .map(|file| lsp::Location {
1961 uri: lsp::Url::from_file_path(file).unwrap(),
1962 range: Default::default(),
1963 })
1964 .collect(),
1965 )))
1966 }
1967 }
1968 });
1969
1970 fake_server.handle_request::<lsp::request::DocumentHighlightRequest, _, _>(
1971 move |_, cx| {
1972 let mut highlights = Vec::new();
1973 let background = cx.background();
1974 let mut rng = background.rng();
1975
1976 let highlight_count = rng.gen_range(1..=5);
1977 for _ in 0..highlight_count {
1978 let start_row = rng.gen_range(0..100);
1979 let start_column = rng.gen_range(0..100);
1980 let end_row = rng.gen_range(0..100);
1981 let end_column = rng.gen_range(0..100);
1982 let start = PointUtf16::new(start_row, start_column);
1983 let end = PointUtf16::new(end_row, end_column);
1984 let range = if start > end { end..start } else { start..end };
1985 highlights.push(lsp::DocumentHighlight {
1986 range: range_to_lsp(range.clone()),
1987 kind: Some(lsp::DocumentHighlightKind::READ),
1988 });
1989 }
1990 highlights.sort_unstable_by_key(|highlight| {
1991 (highlight.range.start, highlight.range.end)
1992 });
1993 async move { Ok(Some(highlights)) }
1994 },
1995 );
1996 }
1997 })),
1998 ..Default::default()
1999 }))
2000 .await;
2001 client.language_registry.add(Arc::new(language));
2002
2003 while let Some(batch_id) = operation_rx.next().await {
2004 let Some((operation, applied)) = plan.lock().next_client_operation(&client, batch_id, &cx) else { break };
2005 applied.store(true, SeqCst);
2006 match apply_client_operation(&client, operation, &mut cx).await {
2007 Ok(()) => {}
2008 Err(TestError::Inapplicable) => {
2009 applied.store(false, SeqCst);
2010 log::info!("skipped operation");
2011 }
2012 Err(TestError::Other(error)) => {
2013 log::error!("{} error: {}", client.username, error);
2014 }
2015 }
2016 cx.background().simulate_random_delay().await;
2017 }
2018 log::info!("{}: done", client.username);
2019}
2020
2021fn buffer_for_full_path(
2022 client: &TestClient,
2023 project: &ModelHandle<Project>,
2024 full_path: &PathBuf,
2025 cx: &TestAppContext,
2026) -> Option<ModelHandle<language::Buffer>> {
2027 client
2028 .buffers_for_project(project)
2029 .iter()
2030 .find(|buffer| {
2031 buffer.read_with(cx, |buffer, cx| {
2032 buffer.file().unwrap().full_path(cx) == *full_path
2033 })
2034 })
2035 .cloned()
2036}
2037
2038fn project_for_root_name(
2039 client: &TestClient,
2040 root_name: &str,
2041 cx: &TestAppContext,
2042) -> Option<ModelHandle<Project>> {
2043 if let Some(ix) = project_ix_for_root_name(&*client.local_projects(), root_name, cx) {
2044 return Some(client.local_projects()[ix].clone());
2045 }
2046 if let Some(ix) = project_ix_for_root_name(&*client.remote_projects(), root_name, cx) {
2047 return Some(client.remote_projects()[ix].clone());
2048 }
2049 None
2050}
2051
2052fn project_ix_for_root_name(
2053 projects: &[ModelHandle<Project>],
2054 root_name: &str,
2055 cx: &TestAppContext,
2056) -> Option<usize> {
2057 projects.iter().position(|project| {
2058 project.read_with(cx, |project, cx| {
2059 let worktree = project.visible_worktrees(cx).next().unwrap();
2060 worktree.read(cx).root_name() == root_name
2061 })
2062 })
2063}
2064
2065fn root_name_for_project(project: &ModelHandle<Project>, cx: &TestAppContext) -> String {
2066 project.read_with(cx, |project, cx| {
2067 project
2068 .visible_worktrees(cx)
2069 .next()
2070 .unwrap()
2071 .read(cx)
2072 .root_name()
2073 .to_string()
2074 })
2075}
2076
2077fn project_path_for_full_path(
2078 project: &ModelHandle<Project>,
2079 full_path: &Path,
2080 cx: &TestAppContext,
2081) -> Option<ProjectPath> {
2082 let mut components = full_path.components();
2083 let root_name = components.next().unwrap().as_os_str().to_str().unwrap();
2084 let path = components.as_path().into();
2085 let worktree_id = project.read_with(cx, |project, cx| {
2086 project.worktrees(cx).find_map(|worktree| {
2087 let worktree = worktree.read(cx);
2088 if worktree.root_name() == root_name {
2089 Some(worktree.id())
2090 } else {
2091 None
2092 }
2093 })
2094 })?;
2095 Some(ProjectPath { worktree_id, path })
2096}
2097
2098async fn ensure_project_shared(
2099 project: &ModelHandle<Project>,
2100 client: &TestClient,
2101 cx: &mut TestAppContext,
2102) {
2103 let first_root_name = root_name_for_project(project, cx);
2104 let active_call = cx.read(ActiveCall::global);
2105 if active_call.read_with(cx, |call, _| call.room().is_some())
2106 && project.read_with(cx, |project, _| project.is_local() && !project.is_shared())
2107 {
2108 match active_call
2109 .update(cx, |call, cx| call.share_project(project.clone(), cx))
2110 .await
2111 {
2112 Ok(project_id) => {
2113 log::info!(
2114 "{}: shared project {} with id {}",
2115 client.username,
2116 first_root_name,
2117 project_id
2118 );
2119 }
2120 Err(error) => {
2121 log::error!(
2122 "{}: error sharing project {}: {:?}",
2123 client.username,
2124 first_root_name,
2125 error
2126 );
2127 }
2128 }
2129 }
2130}
2131
2132fn choose_random_project(client: &TestClient, rng: &mut StdRng) -> Option<ModelHandle<Project>> {
2133 client
2134 .local_projects()
2135 .iter()
2136 .chain(client.remote_projects().iter())
2137 .choose(rng)
2138 .cloned()
2139}
2140
2141fn gen_file_name(rng: &mut StdRng) -> String {
2142 let mut name = String::new();
2143 for _ in 0..10 {
2144 let letter = rng.gen_range('a'..='z');
2145 name.push(letter);
2146 }
2147 name
2148}
2149
2150fn path_env_var(name: &str) -> Option<PathBuf> {
2151 let value = env::var(name).ok()?;
2152 let mut path = PathBuf::from(value);
2153 if path.is_relative() {
2154 let mut abs_path = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
2155 abs_path.pop();
2156 abs_path.pop();
2157 abs_path.push(path);
2158 path = abs_path
2159 }
2160 Some(path)
2161}